Pipelines

Submit multi-step video processing runs instead of chaining individual jobs manually. The API auto-includes transcription when downstream steps need a transcript, runs downstream steps in parallel after transcription completes, and exposes aggregate status on the pipeline object.

Requires the same project API key permission as job creation: job:create.

Preview pipelinePOST/v1/pipelines/previewchevron_right
Create pipelinePOST/v1/pipelineschevron_right
Get pipelineGET/v1/pipelines/{pipelineId}chevron_right
Retry failed stepsPOST/v1/pipelines/{pipelineId}/retrychevron_right

The Pipeline object

pipelineIdstring: Unique pipeline id (pip_…).
statusstring: pending, running, completed, partial, failed, or cancelled. partial means mixed step outcomes.
stepsarray: Per-capability step status and linked jobId.
videoSourceobject: S3 direct source when starting from a video.
textSourceIdstring: Text source id once transcription completes.

{
  "pipelineId": "pip_01HX2K9V3JEK4WYZN6F0XQ2W8M",
  "status": "running",
  "workspaceId": "wsp_01HX2K9V3JEK4WYZN6F0XQ2W8M",
  "projectId": "prj_01HX2K9V3JEK4WYZN6F0XQ2W8M",
  "videoSource": {
    "connectionId": "conn_…",
    "bucket": "my-bucket",
    "sourceKey": "media/video.mp4"
  },
  "textSourceJobId": "job_…",
  "textSourceId": "txt_…",
  "versionName": "Version 2",
  "selectedSteps": ["transcription", "clip_generation", "metadata"],
  "steps": [
    {
      "stepId": "transcription",
      "serviceType": "transcription",
      "status": "completed",
      "jobId": "job_…",
      "error": null,
      "autoIncluded": false
    }
  ],
  "userMetadata": { "customerJobRef": "pipeline-pip_…" },
  "webhookUrl": null,
  "startedAt": "2026-06-01T12:00:00Z",
  "completedAt": null,
  "createdAt": "2026-06-01T12:00:00Z",
  "updatedAt": "2026-06-01T12:00:01Z"
}

Preview pipeline

POST/v1/pipelines/preview

Resolve selected steps (including auto-added transcription), platform-injected config per step, and estimated credits. Does not create a pipeline.

Requires permission

job:create

Parameters

selectedStepsarray: Capability service types to run (e.g. clip_generation, metadata).
videoSourceobject: connectionId, bucket, sourceKey for a new video run.

Returns

Returns resolvedSteps and estimatedCredits.

See the the pipeline object for attribute details.

curl -X POST "https://perchat-media-api-csa4e2e0gedvgyfc.westus-01.azurewebsites.net/v1/pipelines/preview" \
  -H "Authorization: Bearer sk_prj_..." \
  -H "Content-Type: application/json" \
-d '"{\n  \"videoSource\": {\n    \"connectionId\": \"conn_…\",\n    \"bucket\": \"my-bucket\",\n    \"sourceKey\": \"media/video.mp4\"\n  },\n  \"selectedSteps\": [\n    \"clip_generation\",\n    \"metadata\"\n  ]\n}"'

{
  "data": {
  "resolvedSteps": [
    {
      "stepId": "transcription",
      "serviceType": "transcription",
      "autoIncluded": true
    },
    {
      "stepId": "clip_generation",
      "serviceType": "clip_generation",
      "autoIncluded": false
    }
  ],
  "estimatedCredits": {
    "transcription": 1,
    "clip_generation": 5,
    "metadata": 1
  }
},
  "metadata": {
    "requestId": "req_01HX...",
    "responseTime": 42,
    "timestamp": "2026-05-18T12:34:56Z",
    "version": "v1"
  }
}

Create pipeline

POST/v1/pipelines

Create and start a pipeline. Poll GET /v1/pipelines/{pipelineId} until status is terminal. Filter jobs with GET /v1/jobs?pipelineId=….

Requires permission

job:create

Returns

Returns the Pipeline object (201).

See the the pipeline object for attribute details.

curl -X POST "https://perchat-media-api-csa4e2e0gedvgyfc.westus-01.azurewebsites.net/v1/pipelines" \
  -H "Authorization: Bearer sk_prj_..." \
  -H "Content-Type: application/json" \
-d '"{\n  \"videoSource\": {\n    \"connectionId\": \"conn_…\",\n    \"bucket\": \"my-bucket\",\n    \"sourceKey\": \"media/video.mp4\"\n  },\n  \"selectedSteps\": [\n    \"transcription\",\n    \"thumbnail\",\n    \"clip_generation\",\n    \"metadata\",\n    \"summarization\",\n    \"translation\",\n    \"indexer\"\n  ],\n  \"versionName\": \"Full run\",\n  \"stepOverrides\": {\n    \"translation\": {\n      \"targetLanguage\": \"ta\"\n    }\n  }\n}"'

{
  "data": {
  "pipelineId": "pip_01HX2K9V3JEK4WYZN6F0XQ2W8M",
  "status": "running",
  "workspaceId": "wsp_01HX2K9V3JEK4WYZN6F0XQ2W8M",
  "projectId": "prj_01HX2K9V3JEK4WYZN6F0XQ2W8M",
  "videoSource": {
    "connectionId": "conn_…",
    "bucket": "my-bucket",
    "sourceKey": "media/video.mp4"
  },
  "textSourceJobId": "job_…",
  "textSourceId": "txt_…",
  "versionName": "Version 2",
  "selectedSteps": ["transcription", "clip_generation", "metadata"],
  "steps": [
    {
      "stepId": "transcription",
      "serviceType": "transcription",
      "status": "completed",
      "jobId": "job_…",
      "error": null,
      "autoIncluded": false
    }
  ],
  "userMetadata": { "customerJobRef": "pipeline-pip_…" },
  "webhookUrl": null,
  "startedAt": "2026-06-01T12:00:00Z",
  "completedAt": null,
  "createdAt": "2026-06-01T12:00:00Z",
  "updatedAt": "2026-06-01T12:00:01Z"
},
  "metadata": {
    "requestId": "req_01HX...",
    "responseTime": 42,
    "timestamp": "2026-05-18T12:34:56Z",
    "version": "v1"
  }
}

Get pipeline

GET/v1/pipelines/{pipelineId}

Retrieve pipeline status and per-step job links.

Requires permission

job:read

Parameters

pipelineIdstring: Pipeline id (pip_…).

Returns

Returns the Pipeline object.

See the the pipeline object for attribute details.

curl "https://perchat-media-api-csa4e2e0gedvgyfc.westus-01.azurewebsites.net/v1/pipelines/pip_YOUR_PIPELINE_ID" \
  -H "Authorization: Bearer sk_prj_..."

{
  "data": {
  "pipelineId": "pip_01HX2K9V3JEK4WYZN6F0XQ2W8M",
  "status": "running",
  "workspaceId": "wsp_01HX2K9V3JEK4WYZN6F0XQ2W8M",
  "projectId": "prj_01HX2K9V3JEK4WYZN6F0XQ2W8M",
  "videoSource": {
    "connectionId": "conn_…",
    "bucket": "my-bucket",
    "sourceKey": "media/video.mp4"
  },
  "textSourceJobId": "job_…",
  "textSourceId": "txt_…",
  "versionName": "Version 2",
  "selectedSteps": ["transcription", "clip_generation", "metadata"],
  "steps": [
    {
      "stepId": "transcription",
      "serviceType": "transcription",
      "status": "completed",
      "jobId": "job_…",
      "error": null,
      "autoIncluded": false
    }
  ],
  "userMetadata": { "customerJobRef": "pipeline-pip_…" },
  "webhookUrl": null,
  "startedAt": "2026-06-01T12:00:00Z",
  "completedAt": null,
  "createdAt": "2026-06-01T12:00:00Z",
  "updatedAt": "2026-06-01T12:00:01Z"
},
  "metadata": {
    "requestId": "req_01HX...",
    "responseTime": 42,
    "timestamp": "2026-05-18T12:34:56Z",
    "version": "v1"
  }
}

Retry failed steps

POST/v1/pipelines/{pipelineId}/retry

Re-submit failed steps on a partial or failed pipeline. Optional body: { "stepIds": ["clip_generation"] }.

Requires permission

job:create

curl -X POST "https://perchat-media-api-csa4e2e0gedvgyfc.westus-01.azurewebsites.net/v1/pipelines/pip_YOUR_PIPELINE_ID/retry" \
  -H "Authorization: Bearer sk_prj_..." \
  -H "Content-Type: application/json" \
-d '"{}"'

{
  "data": {
  "pipelineId": "pip_01HX2K9V3JEK4WYZN6F0XQ2W8M",
  "status": "running",
  "workspaceId": "wsp_01HX2K9V3JEK4WYZN6F0XQ2W8M",
  "projectId": "prj_01HX2K9V3JEK4WYZN6F0XQ2W8M",
  "videoSource": {
    "connectionId": "conn_…",
    "bucket": "my-bucket",
    "sourceKey": "media/video.mp4"
  },
  "textSourceJobId": "job_…",
  "textSourceId": "txt_…",
  "versionName": "Version 2",
  "selectedSteps": ["transcription", "clip_generation", "metadata"],
  "steps": [
    {
      "stepId": "transcription",
      "serviceType": "transcription",
      "status": "completed",
      "jobId": "job_…",
      "error": null,
      "autoIncluded": false
    }
  ],
  "userMetadata": { "customerJobRef": "pipeline-pip_…" },
  "webhookUrl": null,
  "startedAt": "2026-06-01T12:00:00Z",
  "completedAt": null,
  "createdAt": "2026-06-01T12:00:00Z",
  "updatedAt": "2026-06-01T12:00:01Z"
},
  "metadata": {
    "requestId": "req_01HX...",
    "responseTime": 42,
    "timestamp": "2026-05-18T12:34:56Z",
    "version": "v1"
  }
}