> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pineyard.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Trigger a run of an ACTIVE workflow

**Required scope:** `workflows.run`

**Idempotency:** an `Idempotency-Key` header is required when calling with an API key. See [Idempotency](/concepts/idempotency).

<Note>Requires workflows enabled for your workspace. Otherwise the request is refused; see [Errors](/concepts/errors).</Note>


## OpenAPI

````yaml /api-reference/openapi.json post /workflows/{id}/runs
openapi: 3.0.3
info:
  title: Pineyard API
  version: 1.0.0
  description: >-
    Programmatic access to agents, campaigns, calls, phone numbers, WhatsApp and
    results in your Pineyard workspace.
servers:
  - url: https://api.pineyard.ai
    description: Production
security:
  - bearerAuth: []
paths:
  /workflows/{id}/runs:
    post:
      summary: Trigger a run of an ACTIVE workflow
      parameters:
        - schema:
            type: string
          required: true
          name: id
          in: path
        - name: Idempotency-Key
          in: header
          required: true
          description: >-
            Unique value (e.g. a UUID) per action, up to 200 printable ASCII
            characters. Reuse it only to retry the same request; the first
            response is replayed for 24 hours.
          schema:
            type: string
            maxLength: 200
            example: f1d2c3b4-0000-4000-8000-000000000000
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                phone:
                  type: string
                  maxLength: 64
                name:
                  type: string
                  maxLength: 200
                fields:
                  type: object
                  additionalProperties:
                    nullable: true
                externalRef:
                  type: string
                  minLength: 1
                  maxLength: 255
                origin:
                  type: string
                  enum:
                    - TRIGGER
                    - TEST
                  default: TRIGGER
                shortenWaits:
                  type: boolean
              additionalProperties: false
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  status:
                    type: string
                    enum:
                      - RUNNING
                      - WAITING
                      - NEEDS_ATTENTION
                      - DONE
                      - FAILED
                      - CANCELED
                  origin:
                    type: string
                    enum:
                      - TRIGGER
                      - TEST
                  currentNodeId:
                    type: string
                    nullable: true
                  startedAt:
                    type: string
                required:
                  - id
                  - status
                  - origin
                  - currentNodeId
                  - startedAt
        '400':
          description: >-
            - `idempotency_key_invalid`: Idempotency-Key is over 200 chars or
            has non-printable or non-ASCII characters.

            - `idempotency_key_required`: A billed endpoint was called without
            an `Idempotency-Key` header (`400`), or a `/v1` lead push without
            `idempotencyKey` in the body (`422`).

            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.

            - `invalid_body`: The request body (or query) failed validation.
            Details are in `issues` (or `detail`). `422` on `POST
            /v1/campaigns/{campaignId}/leads`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    enum:
                      - invalid_body
                  issues:
                    type: array
                    items:
                      nullable: true
                required:
                  - error
        '401':
          description: >-
            - `invalid_api_key`: The API key is unknown, revoked or expired, or
            its workspace was deleted.

            - `unauthorized`: No `Authorization: Bearer` header, or an empty
            token.
        '403':
          description: >-
            - `api_key_not_scoped`: A key issued without scopes was used outside
            `/v1`.

            - `api_key_owner_inactive`: The member the key acts for was removed
            or suspended.

            - `forbidden`: The key lacks the permission named in
            `requiredPermission`, or the resource belongs to another workspace.

            - `workspace_pending_approval`: The workspace has not been approved
            yet.

            - `workspace_suspended`: The workspace is suspended.
        '404':
          description: >-
            - `not_found`: The resource does not exist in your workspace, or the
            feature is not enabled for it.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    enum:
                      - not_found
                required:
                  - error
        '409':
          description: >-
            - `idempotency_in_progress`: A request with the same Idempotency-Key
            is still running.

            - `workflow_not_active`: Workflow is not ACTIVE (not published or
            archived).
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    enum:
                      - workflow_not_active
                required:
                  - error
        '413':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.
        '422':
          description: >-
            - `idempotency_key_reused`: The `Idempotency-Key` was already used
            for a different request (`422`). On `POST /calls/test`, `409` means
            a call with this key already exists.

            - `workflow_invalid`: Stored or submitted workflow definition fails
            parsing or validation (details included).
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    enum:
                      - workflow_invalid
                  details:
                    type: array
                    items:
                      type: string
                required:
                  - error
                  - details
        '429':
          description: '- `rate_limited`: Too many requests.'
        '500':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.
        '502':
          description: >-
            - `provider_error`: The calling service rejected the request
            (`upstreamStatus` 4xx) or was unavailable (5xx).
        '503':
          description: >-
            - `database_unavailable`: The service is temporarily unavailable.

            - `idempotency_unavailable`: The idempotency check could not run.
            Nothing was done.
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Your API key, e.g. `pk_live_xxxxxxxxxxxxxxxxxxxxxxxx`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.