Sources API

Sources identify website areas available to an API client. This API is read-only: sources are configured in the Dzen Chat project interface and an API client only sees the sources assigned to it.

List sources

GET /api/sources
Authorization: Bearer CLIENT_ID.CLIENT_SECRET

200 OK returns assigned sources ordered by title:

{
  "items": [
    {
      "id": "src_123",
      "title": "Help centre",
      "url": "https://example.com/help/",
      "is_paused": false,
      "enable_triggers": true,
      "blocked_reason": null,
      "last_reindexed_at": "2026-09-11T08:30:00+00:00"
    }
  ]
}

Field	Description
id	Source ID used by page responses.
url	Root URL of the source.
is_paused	Whether indexing for the source is paused.
enable_triggers	Whether the source permits trigger generation.
blocked_reason	Reason indexing is blocked, or null.
last_reindexed_at	Time of the last reindex, or null when it has not completed.

Get one source

GET /api/sources/{source_id}
Authorization: Bearer CLIENT_ID.CLIENT_SECRET

Path parameter	Description
source_id	The source ID returned by GET /api/sources.

The successful response is one source object with the fields above. An unknown or unassigned ID returns 404. Source credentials and private crawler configuration are never included.