Get pipeline run details and status

Retrieve the full details of a single pipeline run, including its current status, the list of executed steps with their per-step status, and the aggregated raw_logs produced during execution.

Poll this endpoint to track the progress of a run started via an extraction flow run-sync or publish call. A run is in a terminal state when status is one of completed, completed_with_warnings, failed, or aborted.

GET /projects/{project_id}/pipeline-runs/{pipeline_run_id}

Get pipeline run details and status

Python

import requests

url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/pipeline-runs/{pipeline_run_id}/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "status": "pending",
  "project": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pipeline_name": "<string>",
  "mode": "<string>",
  "celery_task_id": "<string>",
  "user": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tables": {},
  "steps": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "step": "<string>",
      "name": "<string>",
      "status": "pending",
      "inputs": {},
      "outputs": {},
      "warnings": "<unknown>",
      "depends_on": [
        "<string>"
      ],
      "params": {},
      "tag_extractor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "object_extractor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "chunks_extractor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "document_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "chunk_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "raw_logs": "<string>"
}

Authorizations

BearerAuthTokenAuth

Authorization · string · header · required

Use Authorization: Bearer

Path Parameters

project_id · string<uuid> · required

UUID of the project

pipeline_run_id · string<uuid> · required

UUID of the pipeline run

Response

200

application/json

Pipeline run details

Full pipeline run payload returned by the detail endpoint.

id · string<uuid>

created_at · string<date-time>

updated_at · string<date-time>

status · enum<string>

Lifecycle status of a pipeline run or step:

• pending — queued, not yet started
• running — currently executing
• completed — finished successfully
• completed_with_warnings — finished, but some steps emitted warnings
• failed — terminated with an error
• aborted — cancelled via the abort action

Available options: pending, running, completed, completed_with_warnings, failed, aborted

project · string<uuid>

pipeline_name · string

mode · string

Run mode (e.g. recreate-all, recreate-single, upsert-single, upsert-all).

celery_task_id · string

user · string<uuid> | null

ID of the user who triggered the run.

tables · object

Map of table name → table version UUID for the run.

steps · object[]

Show child attributes

document_ids · string<uuid>[] | null

UUIDs of documents this run targets.

chunk_ids · string<uuid>[] | null

UUIDs of chunks this run targets.

raw_logs · string

Concatenated logs produced during execution.