List Inputs

List every document ingestion source in your workspace with GET /v1/sources: status, document counts, default schema, and each source's own upload endpoint.

The GET /v1/sources endpoint lists every document ingestion source in your Talonic workspace, newest first. A source groups documents by origin, such as an invoice feed or a contract inbox, and each source carries its own scoped API key and a dedicated endpoint URL for programmatic document uploads.

Sources are the entry point for document ingestion in Talonic. Each source represents a distinct document stream or integration — for example, an invoice intake or a contract review workflow. Documents ingested through a source inherit its configuration, including any default schema, and every document keeps a link back to the source that ingested it, so downstream reads can always answer "where did this file come from".

The type field distinguishes how documents arrive: sources created through this API have type api (push ingestion via the endpoint URL), while connector-backed sources configured in the dashboard carry their connector type (Google Drive, SharePoint, S3, SQL, and others). The status field reads active when the source is idle and ready, a syncing state while a connector is pulling documents, or error when the last sync failed.

Use the listing as your ingestion inventory: document_count shows volume per stream, default_schema shows which extraction schema is stamped on new documents, and the links object carries ready-made URLs for the source detail, its document list (GET /v1/sources/:id/documents), and the dashboard view. The response is a plain array with no pagination — workspaces hold a bounded number of sources, so one call always returns all of them.

Each source has a unique endpoint URL for document ingestion. Use the source-scoped API key (returned once at creation) to authenticate uploads to that endpoint, or any workspace key with the extract scope.

GET/v1/sources

Request

curl https://api.talonic.com/v1/sources \
  -H "Authorization: Bearer $TALONIC_API_KEY"

Response

Response fields

dataarrayArray of source objects.

data[].idstringSource UUID.

data[].namestringHuman-readable name.

data[].typestringSource type (e.g. `api`).

data[].statusstringCurrent status: `active`, `syncing`, or `error`.

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.

Frequently asked questions

What is the difference between a source and a schema?+

A source groups documents by origin (e.g. an API integration or upload pipeline). A schema defines the fields to extract from documents. A source can optionally have a default schema applied to all its documents.

Can I see the API key for an existing source?+

No. The source-scoped API key is only shown once in the creation response. If lost, delete the source and create a new one.

How do I upload documents to a source?+

POST a multipart file to the source's `endpoint` URL (`/v1/sources/:id/documents`), authenticating with the source-scoped API key returned at creation or any key carrying the extract scope. The document is queued for extraction automatically.

Are connector sources (Google Drive, SharePoint) listed here too?+

Yes. The listing covers every source in the workspace regardless of how it was created. Connector-backed sources show their connector type and a syncing status while pulling documents; only sources of type api are created through this endpoint's POST counterpart.

Is the source list paginated?+

No. GET /v1/sources returns the full set in one response, ordered by creation date descending. Paginate the documents within a source instead, via GET /v1/sources/:id/documents with limit and cursor.