> ## Documentation Index > Fetch the complete documentation index at: https://docs.parley.so/llms.txt > Use this file to discover all available pages before exploring further. # Run an automation now > Start a run of an automation now, without waiting for a trigger. A paused automation can be run too. Returns the run as soon as it's queued; follow its progress by listing the automation's runs. Returns 429 USAGE_LIMIT_REACHED when the organization has reached its limit of automation runs for a given period; don't retry until older runs fall outside that window. ## OpenAPI ````yaml https://api.parley.so/openapi.json post /automations/{id}/runs openapi: 3.1.1 info: title: Parley API version: 1.0.0 description: >- Manage Parley's projects (matters or cases), accounts (client organizations), contacts (people), tasks, custom fields, notes, files, activity, automations, and skills. Records refer to each other as { type, id, name } references; writes take IDs. Errors are { error: { code, message, details } }, where code names what went wrong and each operation lists the codes it can return. In a query string, write a timestamp's offset as Z or %2B, because a raw + arrives as a space. The MCP server at /mcp offers the same data as a smaller set of tools. servers: - url: https://api.parley.so/v1 security: - bearerAuth: [] tags: - name: Projects description: >- A project is a matter or case: it groups the files, notes, activity, and tasks for one engagement, and links to the accounts and contacts it involves. - name: Accounts description: >- An account is a client organization. Contacts belong to it, and projects link to it. - name: Contacts description: >- A contact is a person, optionally belonging to one account and linked to projects. - name: Tasks description: >- A task is a to-do with a status, assignee, and due date, optionally about one project, account, or contact. - name: Fields description: >- Custom fields defined for projects, accounts, contacts, or tasks. Records carry their values in fields, keyed by field name. - name: Notes description: >- Markdown notes on a project, account, or contact. Updates take the version you last read, so concurrent edits fail with 409 VERSION_CONFLICT instead of overwriting. - name: Files description: >- Files and folders of a project, account, contact, or intake, or the organization's Library. Add a file by creating an upload, PUTting its bytes, and adding the upload to a location. - name: Activity description: >- What happened across the organization or on one record: changes, links, notes, files, USCIS case updates, and synced emails and meetings. Each item's kind says which details it carries. - name: Sessions description: >- Conversations with Parley's assistant, from the web app, Word, Outlook, automation runs, and the API. Start one with a message, follow up or steer it while it works, and read its replies. - name: Automations description: >- Instructions Parley's assistant carries out on a schedule, as the person who created them, with nobody present. - name: Skills description: >- Reusable playbooks for Parley's assistant: a SKILL.md plus optional bundled documents, addressed by slug. - name: Users description: The people in your organization, and the caller. paths: /automations/{id}/runs: post: tags: - Automations summary: Run an automation now description: >- Start a run of an automation now, without waiting for a trigger. A paused automation can be run too. Returns the run as soon as it's queued; follow its progress by listing the automation's runs. Returns 429 USAGE_LIMIT_REACHED when the organization has reached its limit of automation runs for a given period; don't retry until older runs fall outside that window. operationId: runAutomation parameters: - name: id in: path required: true schema: type: string minLength: 1 description: The automation ID. responses: '201': description: Created. content: application/json: schema: $ref: '#/components/schemas/AutomationRun' '400': description: The request was invalid. VALIDATION_FAILED. content: application/json: schema: $ref: '#/components/schemas/ValidationFailedError' '401': description: Missing or invalid credentials. UNAUTHORIZED. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' '403': description: You don't have permission. FORBIDDEN. content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' '404': description: Not found. NOT_FOUND. content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '429': description: >- Too many requests, or a usage limit was reached. TOO_MANY_REQUESTS, USAGE_LIMIT_REACHED. content: application/json: schema: oneOf: - $ref: '#/components/schemas/TooManyRequestsError' - $ref: '#/components/schemas/UsageLimitReachedError' components: schemas: AutomationRun: type: object properties: id: type: string minLength: 1 description: The run ID. automation: type: object properties: type: const: automation id: type: string description: Its ID. name: type: string description: The automation name. required: - type - id - name description: The automation that ran. status: enum: - pending - running - succeeded - failed - canceled - timed_out type: string description: >- pending: queued and not yet started. running: in progress. succeeded, failed, canceled, and timed_out are final. triggerType: enum: - cron - manual - event type: string description: >- What started the run: a trigger of this type, or manual for a run someone started themselves. event: anyOf: - type: object properties: type: enum: - project.created - account.created - contact.created type: string description: >- What happens in Parley to start a run: someone creates a project, an account, or a contact. Records that email and calendar sync create don't count. record: anyOf: - $ref: '#/components/schemas/RecordRef' - type: 'null' description: >- The record the event happened to, or null when it has since been deleted or you can no longer see it. required: - type - record - type: 'null' description: >- The event that started the run and the record it happened to, or null for a run that no event started. triggerId: anyOf: - type: string minLength: 1 description: The trigger ID. - type: 'null' description: >- The trigger that started the run, or null for a manual run or a trigger that has since been removed. scheduledFor: anyOf: - type: string format: date-time - type: 'null' description: >- The time a cron trigger set for the run, or null for a run that no cron trigger started. startedAt: anyOf: - type: string format: date-time - type: 'null' description: When the run started. endedAt: anyOf: - type: string format: date-time - type: 'null' description: When the run finished. error: anyOf: - type: object properties: code: type: string description: Machine-readable reason, such as USAGE_LIMIT_REACHED. message: type: string description: Human-readable description. required: - code - message - type: 'null' description: Why the run didn't succeed, or null. sessionId: anyOf: - type: string - type: 'null' description: >- The session the run worked in, whose messages hold its report, or null once that session is deleted. createdAt: type: string format: date-time description: When the run was queued. required: - id - automation - status - triggerType - event - triggerId - scheduledFor - startedAt - endedAt - error - sessionId - createdAt ValidationFailedError: type: object properties: error: type: object properties: code: type: string const: VALIDATION_FAILED message: type: string examples: - The request is invalid. details: type: object properties: issues: type: array items: type: object properties: path: type: string description: >- Where the problem is, as a dotted path into the input such as accountIds.add.0 or reminder.remindAt. Empty for the input as a whole. message: type: string description: What is wrong with the value. required: - path - message description: Each problem with the input. required: - issues required: - code - message - details required: - error UnauthorizedError: type: object properties: error: type: object properties: code: type: string const: UNAUTHORIZED message: type: string examples: - Missing or invalid credentials. required: - code - message required: - error ForbiddenError: type: object properties: error: type: object properties: code: type: string const: FORBIDDEN message: type: string examples: - You don't have permission to do this. required: - code - message required: - error NotFoundError: type: object properties: error: type: object properties: code: type: string const: NOT_FOUND message: type: string examples: - Not found. required: - code - message required: - error TooManyRequestsError: type: object properties: error: type: object properties: code: type: string const: TOO_MANY_REQUESTS message: type: string examples: - Too many requests. required: - code - message required: - error UsageLimitReachedError: type: object properties: error: type: object properties: code: type: string const: USAGE_LIMIT_REACHED message: type: string examples: - The organization has reached its usage limit. required: - code - message required: - error RecordRef: type: object properties: type: enum: - project - account - contact type: string description: 'The kind of record: project, account, or contact.' id: type: string description: Its ID. name: type: string description: >- The record's name. A contact's is its first and last name, or an email address when it has no name. required: - type - id - name description: A reference to a project, account, or contact. securitySchemes: bearerAuth: type: http scheme: bearer description: A Parley API key. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.