POST /v1/pipelines/{pipeline_id}/trigger

Family: Pipelines · Operation ID: v1_trigger_pipeline

Access

Workspace API key: Authorization: Bearer <key>. The key is scoped to its workspace; the backend checks operation permissions and quota.

Open pipelines

Required scope: pipelines.trigger

Create a key in Developer settings. Set API_BASE_URL to the current app origin.

Request example

curl --fail-with-body -X POST "$API_BASE_URL/v1/pipelines/{pipeline_id}/trigger" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  --data-binary @request.json

Replace each {parameter} segment in the path with its URL-encoded value.

Parameters

[
  {
    "description": "Pipeline identifier",
    "in": "path",
    "name": "pipeline_id",
    "required": true,
    "schema": {
      "format": "int64",
      "type": "integer"
    }
  }
]

Request body · application/json

{
  "$ref": "#/components/schemas/TriggerPipelineInput",
  "definition": {
    "properties": {
      "force": {
        "type": "boolean"
      },
      "reason": {
        "nullable": true,
        "type": "string"
      }
    },
    "type": "object"
  }
}

Responses

202

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/TriggerPipelineResponse"
      }
    }
  },
  "description": "Pipeline run triggered"
}

400

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/PipelineErrorResponse"
      }
    }
  },
  "description": "Bad request"
}

403

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/PipelineErrorResponse"
      }
    }
  },
  "description": "Forbidden"
}

404

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/PipelineErrorResponse"
      }
    }
  },
  "description": "Not found"
}

409

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/PipelineErrorResponse"
      }
    }
  },
  "description": "Conflict"
}

500

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/PipelineErrorResponse"
      }
    }
  },
  "description": "Internal server error"
}

503

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/PipelineErrorResponse"
      }
    }
  },
  "description": "Service unavailable"
}

default

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ErrorEnvelope"
      }
    }
  },
  "description": "Request error"
}

Download the full OpenAPI contract