> ## 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.

# Get document indexing status

> Returns the indexing status for each `(document, extractor node)` pair in the project.
Callers poll this endpoint until documents reach `active` (queryable by AI) or `deleted`.

**States:**
| Value | Meaning |
|---|---|
| `created` | Document saved, processing not yet started |
| `indexing` | Processing pipeline running |
| `ready_to_publish` | Pipeline done, waiting for publish |
| `active` | Published to search backends — queryable by AI |
| `failed` | Document could not be parsed; will not be retried automatically |
| `pending_delete` | Delete requested, blocking new pipeline steps |
| `deleting` | Warehouse rows being cleared |
| `deleted` | Fully removed from warehouse and search indexes |




## OpenAPI

````yaml /api-reference/openapi-public.yaml get /projects/{project_id}/documents/indexing-status/
openapi: 3.0.3
info:
  title: Clarifeye Platform API — Public API
  description: >
    Forward-facing, supported REST API for new integrators of the Clarifeye
    Platform.


    Covers the curated public surface: authentication, knowledge management

    (documents), users & teams, signals, and tool execution. New integrations

    should target these endpoints.


    ## Authentication

    All endpoints require authentication. Include the Authorization header in
    every request using either format:

    - `Authorization: Token <token_key>`

    - `Authorization: Bearer <token_key>`
  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: Signals
    description: Submit signals about the project's content for domain experts to review
  - name: Tools
    description: Execute configured AI tools with custom parameters
  - name: Interviews
    description: Assign and review structured interview conversations
paths:
  /projects/{project_id}/documents/indexing-status/:
    get:
      tags:
        - Documents
      summary: Get document indexing status
      description: >
        Returns the indexing status for each `(document, extractor node)` pair
        in the project.

        Callers poll this endpoint until documents reach `active` (queryable by
        AI) or `deleted`.


        **States:**

        | Value | Meaning |

        |---|---|

        | `created` | Document saved, processing not yet started |

        | `indexing` | Processing pipeline running |

        | `ready_to_publish` | Pipeline done, waiting for publish |

        | `active` | Published to search backends — queryable by AI |

        | `failed` | Document could not be parsed; will not be retried
        automatically |

        | `pending_delete` | Delete requested, blocking new pipeline steps |

        | `deleting` | Warehouse rows being cleared |

        | `deleted` | Fully removed from warehouse and search indexes |
      operationId: getDocumentIndexingStatus
      parameters:
        - $ref: '#/components/parameters/ProjectId'
        - name: document_ids
          in: query
          required: false
          description: |
            Comma-separated list of document UUIDs to filter the response.
            When omitted, returns statuses for all documents in the project.
          schema:
            type: string
          example: >-
            550e8400-e29b-41d4-a716-446655440000,660e8400-e29b-41d4-a716-446655440001
      responses:
        '200':
          description: Indexing statuses for the requested documents
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    document_id:
                      type: string
                      format: uuid
                    extractor_type:
                      type: string
                      description: >-
                        Extractor node type (e.g. "TagExtractor",
                        "ObjectExtractor")
                    extractor_id:
                      type: string
                      format: uuid
                    extractor_version_id:
                      type: string
                      format: uuid
                    status:
                      type: string
                      enum:
                        - created
                        - indexing
                        - ready_to_publish
                        - active
                        - failed
                        - pending_delete
                        - deleting
                        - deleted
              example:
                - document_id: 550e8400-e29b-41d4-a716-446655440000
                  extractor_type: TagExtractor
                  extractor_id: 660e8400-e29b-41d4-a716-446655440001
                  extractor_version_id: 770e8400-e29b-41d4-a716-446655440002
                  status: active
        '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
  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.
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error message
      example:
        error: User not found
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: 'Use Authorization: Bearer <token>'
    TokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: 'Use Authorization: Token <token>'

````