Skip to main content

List Inputs

List all input sources that group documents by origin. Each source has its own API key for programmatic document ingestion.

Inputs group documents by origin. Each input source has its own API key for programmatic document ingestion.

Sources are the entry point for document ingestion in Talonic. Each source represents a distinct pipeline or integration — for example, an invoice processing pipeline or a contract review workflow. Documents ingested through a source inherit its configuration, including any default schema.

Each source has a unique endpoint URL for document ingestion. Use the source-scoped API key (returned at creation) to authenticate uploads to that endpoint.
GET/v1/sources

Response

Response fields

dataarrayArray of source objects.
data[].idstringSource UUID.
data[].namestringHuman-readable name.
data[].typestringSource type (e.g. `api`).
data[].statusstringCurrent status: `active` or sync status value.
data[].document_countintegerNumber of documents ingested through this source.
data[].default_schemaobject | nullDefault schema for this source, or null if none is set. Contains `id`.
data[].endpointstringURL to POST documents to this source.
data[].created_atstringISO 8601 creation timestamp.
data[].linksobjectRelated resource URLs (self, documents, dashboard).

Response

{
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Invoice Pipeline",
      "type": "api",
      "status": "active",
      "document_count": 234,
      "default_schema": null,
      "endpoint": "/v1/sources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/documents",
      "created_at": "2024-08-01T09:00:00.000Z",
      "links": {
        "self": "/v1/sources/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "documents": "/v1/sources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/documents",
        "dashboard": "https://app.talonic.com/sources/a1b2c3d4-e5f6-7890-abcd-ef1234567890"
      }
    }
  ]
}

Errors

Error responses

401unauthorizedMissing or invalid API key.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.