Get / Update / Delete

Get source details, update a source name, or delete a source. Documents are retained but unlinked when a source is deleted.

Manage an individual source with GET, PATCH, and DELETE operations on the same path. Retrieve source details, update its name, or permanently delete it. When a source is deleted, its documents are retained but unlinked from the source.

Use GET to inspect a source's current status, document count, and default schema assignment. Use PATCH to rename a source. Use DELETE when a source is no longer needed — this immediately invalidates the source-scoped API key, so any integration using it will start receiving 401 errors.

The GET response includes document_count, default_schema (with its id if set), and the endpoint URL for document ingestion. The status field shows the current state — active for API sources, or sync status values for connector-based sources (Google Drive, SharePoint, etc.).

Deleting a source retains all its documents in your workspace — they remain accessible via the documents API and any existing extractions are preserved. Only the source-to-document link is removed. Pair GET /v1/sources/:id with GET /v1/sources/:id/documents to see documents belonging to a specific source.

Deleting a source immediately invalidates its API key. Any integration using that key will receive 401 errors. Documents are retained but unlinked from the source.

GET/v1/sources/:id

Response

Response fields

idstringSource UUID.

namestringSource name.

typestringSource type.

statusstringCurrent status.

document_countintegerTotal documents ingested through this source.

default_schemaobject | nullDefault schema or null.

endpointstringDocument ingestion URL.

created_atstringISO 8601 creation timestamp.

linksobjectRelated resource URLs (self, documents, dashboard).

Response

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "Invoice Pipeline",
  "type": "api",
  "status": "active",
  "document_count": 234,
  "default_schema": { "id": "c3d4e5f6-a7b8-9012-cdef-123456789012" },
  "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.

404not_foundNo source with this ID exists for your organization.

429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.

PATCH/v1/sources/:id

Response

Response fields

idstringSource UUID.

namestringUpdated source name.

typestringSource type.

statusstringCurrent status.

document_countintegerTotal documents ingested through this source.

default_schemaobject | nullDefault schema or null.

endpointstringDocument ingestion URL.

created_atstringISO 8601 creation timestamp.

linksobjectRelated resource URLs (self, documents, dashboard).

Response

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "Invoice Pipeline v2",
  "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.

404not_foundNo source with this ID exists for your organization.

429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.

DELETE/v1/sources/:id

Response

Response fields

deletedbooleanAlways true on success.

idstringID of the deleted source.

Response

{
  "deleted": true,
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Errors

Error responses

401unauthorizedMissing or invalid API key.

404not_foundNo source with this ID exists for your organization.

429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.

List Inputs

Source Documents