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

# Get a document

> Returns a document's file details, its status, and the `reference` and `metadata` the trigger stored with it. `status` is `held` while the document waits for a person to run it.

Requires the `documents:read` [scope](/api-reference/authentication#scopes). Returns the `reference` and `metadata` sent with the [trigger](/api-reference/trigger-webhook#reference-and-metadata). When a run the trigger returned stays `404`, the document's `status` tells you why.


## OpenAPI

````yaml GET /documents/{documentId}
openapi: 3.1.1
info:
  title: Ingestly API
  description: >-
    Public Ingestly API. Authenticate every request with an API key in the
    `X-Api-Key` header. A key belongs to one organization and carries scopes
    (such as `workflows:trigger` or `runs:read`); each operation requires one
    scope, and a key without it is rejected with 403. Errors use RFC 7807
    problem details.
  version: 1.0.0
servers:
  - url: https://api.ingestly.ai
security:
  - ApiKey: []
tags:
  - name: Workflows
  - name: Runs
  - name: Review Tasks
  - name: Events
  - name: Documents
paths:
  /documents/{documentId}:
    get:
      tags:
        - Documents
      summary: Get a document
      description: >-
        Returns a document's file details, its status, and the `reference` and
        `metadata` the trigger stored with it. `status` is `held` while the
        document waits for a person to run it.
      operationId: getDocument
      parameters:
        - name: documentId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          headers:
            X-Correlation-ID:
              description: >-
                Server-generated request identifier. Quote it when contacting
                support.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDocumentResponse'
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetailResponse'
        '401':
          description: >-
            Unauthorized. The API key is missing, invalid, expired or
            deactivated.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetailResponse'
        '403':
          description: >-
            Forbidden. The API key lacks the `documents:read` scope, or the plan
            does not include API access.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetailResponse'
        '404':
          description: >-
            Not Found. No document with this id exists in the key's organization
            and environment.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetailResponse'
        '429':
          description: >-
            Too Many Requests. The plan's rate limit was exceeded; retry after
            the seconds in Retry-After.
          headers:
            Retry-After:
              description: Seconds until the rate limit window resets.
              schema:
                type: integer
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetailResponse'
        '500':
          description: Internal Server Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetailResponse'
components:
  schemas:
    GetDocumentResponse:
      required:
        - id
        - contentType
        - size
        - pageCount
        - status
        - createdOn
      type: object
      properties:
        id:
          examples:
            - 0199a6c2-3f1e-7b2a-9c4d-5e6f7a8b9c0d
          type: string
          format: uuid
        workflowId:
          examples:
            - 0199a6c1-9e2f-7c3d-8a4b-1c2d3e4f5a6b
          type:
            - 'null'
            - string
          format: uuid
        name:
          examples:
            - po-1182.pdf
          type:
            - 'null'
            - string
        contentType:
          examples:
            - application/pdf
          type: string
        size:
          examples:
            - 184320
          type: integer
          format: int64
        pageCount:
          examples:
            - 2
          type: integer
          format: int32
        status:
          examples:
            - completed
          enum:
            - pending
            - uploaded
            - processing
            - completed
            - failed
            - review
            - cancelled
            - held
            - unassigned
            - queued
          type: string
        reference:
          examples:
            - PO-1182
          type:
            - 'null'
            - string
        metadata:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/JsonObject'
        createdOn:
          examples:
            - '2026-10-02T14:03:09+00:00'
          type: string
          format: date-time
    ProblemDetailResponse:
      required:
        - status
        - title
        - type
        - instance
        - traceId
      type: object
      properties:
        status:
          type: integer
          format: int32
        title:
          type: string
        type:
          type: string
        instance:
          type: string
        traceId:
          type: string
        detail:
          type:
            - 'null'
            - string
        errors:
          type:
            - 'null'
            - object
          additionalProperties:
            type: array
            items:
              type: string
    JsonObject:
      type: object
  securitySchemes:
    ApiKey:
      type: apiKey
      name: X-Api-Key
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.