> ## 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. # List pipeline runs > List all pipeline runs in the project, ordered by creation date (most recent first). Use this to discover the `id` of a run returned by an extraction flow `run-sync` / `publish` call, or to monitor recent activity. The list response uses a lightweight serializer that omits the very large `chunk_ids` / `document_ids` arrays and truncates `raw_logs` to the most recent entries. Fetch a single run via the detail endpoint to get the full payload. ## OpenAPI ````yaml /api-reference/openapi-full.yaml get /projects/{project_id}/pipeline-runs/ openapi: 3.0.3 info: title: Clarifeye Platform API — Full API Documentation description: > Complete REST API reference for the Clarifeye Platform. Documents every endpoint exposed by the platform — the public surface plus the advanced surface: pipeline customization (extraction flows, pipeline runs, warehouse tables, document tag/metadata configuration), the pre-MCP AI surface (agent settings, playground conversations, conversation-scoped feedback views, notifications), and the impersonation header. New AI integrations should consume knowledge via MCP rather than the conversation/agent-settings endpoints documented here. ## Authentication All endpoints require authentication. Include the Authorization header in every request using either format: - `Authorization: Token ` - `Authorization: Bearer ` ## Organization API Key Authentication The user-provisioning endpoints authenticate with an **org-scoped API key** instead of a user token: - `Authorization: Api-Key ` The key is minted internally by Clarifeye (not self-service) and is scoped to a single organization — it can only act on the organization whose UUID matches the `{id}` in the request path. The email domains a key may pre-create accounts for are configured by Clarifeye on the organization (`allowed_provisioning_domains`). Once you have a key and your domains are set, call `POST /organizations/{id}/provision-user/` to pre-create users and `POST /organizations/{id}/deprovision-user/` to remove them. ## Impersonation Certain endpoints support user impersonation for creating or listing data on behalf of other users. This is useful for integrating external systems that need to attribute actions to specific users. **Header:** `X-Impersonate-Email` **Required Permission:** `CAN_IMPERSONATE_OTHER_USERS` (contact Clarifeye to enable this permission) **Behavior:** - If the header is provided and the impersonator has the required permission, the action is performed as the target user - If the target user is not found, the request proceeds as the original authenticated user - If the target user does not have access to the project, the request proceeds as the original authenticated user - If the impersonator lacks the `CAN_IMPERSONATE_OTHER_USERS` permission, the header is ignored version: 1.0.0 contact: name: Clarifeye Support servers: - url: https://eu.app.clarifeye.ai/api/v1 description: EU - url: https://us.app.clarifeye.ai/api/v1 description: US security: - BearerAuth: [] - TokenAuth: [] tags: - name: Users description: Manage users within a project - name: Invitations description: Manage project invitations - name: Documents description: Manage documents within a project - name: Agent Settings description: Manage AI agent configurations - name: Conversations description: Create and interact with AI-powered conversations - name: Interviews description: Assign and review structured interview conversations - name: Feedback description: >- Submit and review feedback — standalone (content-only), agent-submitted (MCP), or linked to a conversation message - name: Tools description: Execute configured AI tools with custom parameters - name: Tables description: Perform CRUD operations on warehouse tables - name: Notifications description: Manage project-scoped notifications for users - name: Extraction Flows description: >- Manage extraction flows (auto-sync DAGs) — list, run, inspect statistics, update, and publish - name: Object Extractors description: | Extract structured data (instances of a Pydantic model) from chunks or blocks of documents. Update auto-creates a new `ObjectExtractorVersion` when version-bearing fields change. - name: Tag Extractors description: | Apply hierarchical metadata tags to chunks or documents using an LLM. Update auto-creates a new `TagExtractorVersion` when version-bearing fields change. - name: Chunks Extractors description: | Segment parsed documents into chunks for downstream processing. Update auto-creates a new `ChunksExtractorVersion` when version-bearing fields change. - name: Parsing Extractors description: | Convert source documents to text blocks via the parsing pipeline. Update auto-creates a new `ParsingExtractorVersion` when version-bearing fields change. - name: Document Filter Extractors description: | Restrict a downstream pipeline branch to documents matching a filter. Update auto-creates a new version when the filter changes. - name: Chunk Tag Filter Extractors description: | Restrict a downstream pipeline branch to chunks carrying specific tags. Update auto-creates a new version when the filter changes. - name: Document Tag Extractors description: | Apply a flat set of metadata tags to each document. Update auto-creates a new version when version-bearing fields change. - name: Tag Alerts Extractors description: | Run LLM-based alerts over already-extracted tag rows. Update auto-creates a new version when version-bearing fields change. - name: Object Alerts Extractors description: > Run LLM-based alerts over already-extracted object rows. Update auto-creates a new version when version-bearing fields change. - name: Imported Object Extractors description: | Hold objects imported from an external system (rather than extracted by an LLM). Useful for hydrating the warehouse with data produced outside the platform. - name: Pipeline Runs description: >- Inspect pipeline runs queued by extraction flows or other pipeline triggers — list runs and fetch the details/status of a single run - name: User Provisioning description: > Pre-create and de-provision org users via an org-scoped API key (`Authorization: Api-Key `). The organization is resolved from the key. - name: Organization API Keys description: > Superuser management of org-scoped provisioning API keys. Minting and revoking are superuser-only; org admins can list/retrieve/reveal their own org's keys. - name: Design System Templates description: Reference/example files attached to a design template. - name: Artifacts description: | Knowledge-store artifact catalog — list artifacts, create/edit custom artifacts, manage scope membership, read and publish versions, configure the cohesion guide, and export/import the whole catalog. For type-aware reads and edits of artifact content, prefer the `read-write-*-artifact` tool endpoints. paths: /projects/{project_id}/pipeline-runs/: get: tags: - Pipeline Runs summary: List pipeline runs description: | List all pipeline runs in the project, ordered by creation date (most recent first). Use this to discover the `id` of a run returned by an extraction flow `run-sync` / `publish` call, or to monitor recent activity. The list response uses a lightweight serializer that omits the very large `chunk_ids` / `document_ids` arrays and truncates `raw_logs` to the most recent entries. Fetch a single run via the detail endpoint to get the full payload. operationId: listPipelineRuns parameters: - $ref: '#/components/parameters/ProjectId' - name: status in: query description: >- Filter pipeline runs by status (e.g. `pending`, `running`, `completed`, `failed`). schema: $ref: '#/components/schemas/PipelineRunStatus' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' responses: '200': description: Successful response content: application/json: schema: allOf: - $ref: '#/components/schemas/PaginatedResponse' - type: object properties: results: type: array items: $ref: '#/components/schemas/PipelineRunListItem' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' components: parameters: ProjectId: name: project_id in: path required: true description: UUID of the project schema: type: string format: uuid Limit: name: limit in: query description: Maximum number of results per page schema: type: integer default: 100 minimum: 1 maximum: 1000 Offset: name: offset in: query description: Number of results to skip for pagination schema: type: integer default: 0 minimum: 0 schemas: PipelineRunStatus: type: string description: | 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 enum: - pending - running - completed - completed_with_warnings - failed - aborted PaginatedResponse: type: object properties: count: type: integer description: Total number of results next: type: string format: uri nullable: true description: URL to next page of results previous: type: string format: uri nullable: true description: URL to previous page of results results: type: array items: {} PipelineRunListItem: type: object description: | Lightweight pipeline run representation returned by the list endpoint. Excludes the large `chunk_ids` / `document_ids` arrays and truncates `raw_logs` to the most recent entries. Use the detail endpoint to get the full payload. properties: id: type: string format: uuid created_at: type: string format: date-time updated_at: type: string format: date-time status: $ref: '#/components/schemas/PipelineRunStatus' project: type: string format: uuid pipeline_name: type: string mode: type: string description: >- Run mode (e.g. `recreate-all`, `recreate-single`, `upsert-single`, `upsert-all`). celery_task_id: type: string user: type: string format: uuid nullable: true description: ID of the user who triggered the run. tables: type: object nullable: true description: Map of table name → table version UUID for the run. steps: type: array items: $ref: '#/components/schemas/PipelineRunStep' document_count: type: integer description: Number of documents this run targets. chunk_count: type: integer description: Number of chunks this run targets. raw_logs: type: string description: Truncated tail of run logs (most recent entries only). PipelineRunStep: type: object description: One step within a pipeline run's DAG. properties: id: type: string format: uuid created_at: type: string format: date-time updated_at: type: string format: date-time step: type: string description: The pipeline step type (parsing, chunking, tag-extraction, etc.). name: type: string nullable: true description: Human-readable name of the step within the DAG. status: $ref: '#/components/schemas/PipelineRunStatus' inputs: type: object description: Map of input table name → resolved table version UUID. additionalProperties: type: string format: uuid nullable: true outputs: type: object description: Map of output table name → resolved table version UUID. additionalProperties: type: string format: uuid nullable: true warnings: nullable: true description: Warnings emitted by the step, when any. depends_on: type: array items: type: string description: Names of the steps this step depends on. params: type: object description: Step-specific parameters used at execution time. tag_extractor_id: type: string format: uuid nullable: true object_extractor_id: type: string format: uuid nullable: true chunks_extractor_id: type: string format: uuid nullable: true Error: type: object properties: error: type: string description: Error message example: error: User not found responses: Unauthorized: description: Unauthorized - missing or invalid authentication content: application/json: schema: $ref: '#/components/schemas/Error' example: error: Authentication credentials were not provided. Forbidden: description: Forbidden - insufficient permissions content: application/json: schema: $ref: '#/components/schemas/Error' example: error: You do not have permission to perform this action. NotFound: description: Not found - resource does not exist content: application/json: schema: $ref: '#/components/schemas/Error' example: error: Not found. securitySchemes: BearerAuth: type: http scheme: bearer description: 'Use Authorization: Bearer ' TokenAuth: type: apiKey in: header name: Authorization description: 'Use Authorization: Token ' ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.