Documents

List documents

get/v1/documents

Request

  • Base URL: https://api.talonic.com
  • URL: https://api.talonic.com/v1/documents
  • Auth: HTTP bearer

Query parameters

limitinteger

Maximum number of items to return (1–100).

cursorstring

Opaque pagination cursor from a previous response's pagination.next_cursor.

order'asc' | 'desc'

Sort order by creation date.

source_idstring uuid
Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

Filter by source connection ID.

source_typestring

Filter by source type (e.g. api, manual).

status'pending' | 'processing' | 'completed' | 'duplicate' | 'error'

Filter by document status.

text_degraded'true' | 'false'

Only documents whose markdown is (true) or is not (false) flagged as a non-verbatim transcription.

text_source'ocr' | 'local_parser' | 'vision_fallback'

Filter by the converter that produced the markdown.

afterstring date-time

Return documents created after this timestamp (ISO 8601).

beforestring date-time

Return documents created before this timestamp (ISO 8601).

searchstring

Case-insensitive filename search.

Response

Paginated list of documents.

Example response

{
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "filename": "contract-2024.pdf",
      "pages": 12,
      "size_bytes": 1048576,
      "mime_type": "application/pdf",
      "type_detected": "Service Contract",
      "language_detected": "en",
      "text_source": "ocr",
      "text_degraded_reasons": [
        "summary_phrasing",
        "language_mismatch:en!=de"
      ],
      "status": "completed",
      "error": "Extraction failed",
      "source": {
        "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "type": "manual"
      },
      "field_count": 42,
      "triage": {
        "sensitivity": "internal",
        "department": "finance",
        "jurisdiction": "DE",
        "pii_detected": true,
        "pii_categories": [
          "name",
          "email"
        ],
        "confidentiality_marking": "Vertraulich"
      },
      "original_path": "/invoices/2026/04",
      "batch_id": "2026-07-14-run-042",
      "metadata": {
        "customer": "bridgeway",
        "source": "sftp"
      },
      "extraction_count": 1,
      "latest_extraction_id": "d1a2b3c4-5678-9abc-def0-1234567890ab",
      "processing_log": [
        {
          "step": "ocr",
          "status": "completed",
          "duration_ms": 3120
        }
      ],
      "created_at": "2026-04-25T14:30:00.000Z"
    }
  ],
  "pagination": {
    "total": 142,
    "limit": 20,
    "has_more": true,
    "next_cursor": "ZDFhMmIzYzR8MjAyNi0wNC0wM1QxMjowMDowMC4wMDBa"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.