> ## Documentation Index
> Fetch the complete documentation index at: https://docs.trycaesar.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get indexing run status

> Progress and outcome of one files indexing run.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/files/index/{sync_id}
openapi: 3.1.0
info:
  description: >-
    Local implementation of the v1 search, document, feedback, and internal
    operational APIs.
  title: Agent Search API (Public)
  version: 0.1.0
servers:
  - description: Staging
    url: https://alpha.api.trycaesar.com
  - description: Local development
    url: http://localhost:8080
security: []
tags:
  - description: Public search APIs.
    name: Search
  - description: Public document inspection APIs.
    name: Documents
  - description: Public feedback ingestion APIs.
    name: Feedback
  - description: Asynchronous deep-research APIs.
    name: Research
  - description: Internal health, readiness, and metrics APIs.
    name: Operations
paths:
  /v1/files/index/{sync_id}:
    get:
      tags:
        - Files
      summary: Get indexing run status
      description: Progress and outcome of one files indexing run.
      operationId: get-files-index-status
      parameters:
        - description: Indexing run identifier returned by POST /v1/files/index.
          in: path
          name: sync_id
          required: true
          schema:
            description: Indexing run identifier returned by POST /v1/files/index.
            maxLength: 128
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileIndexStatusResponse'
          description: Indexing run status.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Missing or invalid API key.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: API key does not have the required scope.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Indexing run not found.
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Rate limited.
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: File service unreachable.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: File endpoints are not configured.
      security:
        - bearerApiKey: []
components:
  schemas:
    FileIndexStatusResponse:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
            - https://alpha.api.trycaesar.com/FileIndexStatusResponse.json
          format: uri
          readOnly: true
          type: string
        completed_at:
          description: Run completion time (RFC 3339), null while in flight.
          type:
            - string
            - 'null'
        error:
          description: Terminal error detail, null while healthy.
          type:
            - string
            - 'null'
        started_at:
          description: Run start time (RFC 3339), null before it starts.
          type:
            - string
            - 'null'
        state:
          description: Run state (queued, planning, running, completed, failed, …).
          type: string
        stats:
          $ref: '#/components/schemas/FileIndexStats'
          description: Progress counters.
        sync_id:
          description: Indexing run identifier.
          type: string
      required:
        - sync_id
        - state
        - stats
        - error
        - started_at
        - completed_at
      type: object
    ErrorEnvelope:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
            - https://alpha.api.trycaesar.com/ErrorEnvelope.json
          format: uri
          readOnly: true
          type: string
        error:
          $ref: '#/components/schemas/ErrorBody'
          description: Error details.
        request_id:
          description: Server request identifier.
          type: string
        type:
          description: Envelope discriminator.
          enum:
            - error
          type: string
      required:
        - type
        - request_id
        - error
      type: object
    FileIndexStats:
      additionalProperties: false
      properties:
        bytes:
          description: Bytes fetched.
          format: int64
          type: integer
        deleted:
          description: Documents removed because the object is gone.
          format: int64
          type: integer
        enumerated:
          description: Objects discovered.
          format: int64
          type: integer
        failed:
          description: Objects that failed processing.
          format: int64
          type: integer
        fetched:
          description: Objects downloaded for extraction.
          format: int64
          type: integer
        indexed:
          description: Documents now searchable.
          format: int64
          type: integer
        skipped_unsupported:
          description: Objects skipped as unsupported types.
          format: int64
          type: integer
      required:
        - enumerated
        - fetched
        - indexed
        - failed
        - skipped_unsupported
        - deleted
        - bytes
      type: object
    ErrorBody:
      additionalProperties: false
      properties:
        code:
          description: Stable machine-readable error code.
          type: string
        details:
          additionalProperties: {}
          description: Optional structured error details.
          type: object
        message:
          description: Human-readable error message.
          type: string
      required:
        - code
        - message
      type: object
  securitySchemes:
    bearerApiKey:
      bearerFormat: API key
      scheme: bearer
      type: http

````