Skip to main content
GET
/
projects
/
{project_id}
/
pipeline-runs
List pipeline runs
import requests

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

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

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

print(response.text)
{
  "count": 123,
  "next": "<string>",
  "previous": "<string>",
  "results": [
    {
      "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_count": 123,
      "chunk_count": 123,
      "raw_logs": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.clarifeye.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Use Authorization: Bearer

Path Parameters

project_id
string<uuid>
required

UUID of the project

Query Parameters

status
enum<string>

Filter pipeline runs by status (e.g. pending, running, completed, failed). 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
limit
integer
default:100

Maximum number of results per page

Required range: 1 <= x <= 1000
offset
integer
default:0

Number of results to skip for pagination

Required range: x >= 0

Response

Successful response

count
integer

Total number of results

next
string<uri> | null

URL to next page of results

previous
string<uri> | null

URL to previous page of results

results
object[]