Dzen Chat API

The Dzen Chat API is a JSON HTTP API for a registered external client. It works with the client’s project and its assigned sources; a request cannot use a project_id to select another project.

Every route begins with /api/. The instance OpenAPI document is available at /api/openapi.json, and the interactive reference is available at /api-docs/.

Before you call an endpoint

1. Create an API client in the Dzen Chat project interface and copy its ID and secret when they are shown.
2. Store both values in the server-side environment of the calling application.
3. Send Authorization: Bearer CLIENT_ID.CLIENT_SECRET with management API requests.
4. Use only resource IDs returned by the API; do not use database IDs from a browser URL or another project.

Read authentication and common responses first. It defines the bearer format, JSON request convention and shared error responses.

Resources

Resource	Methods	What it does
Update	POST /update	Queues a new or existing page URL for crawling and reindexing.
Pages	GET /pages, GET /pages/{id}	Reads indexed pages and their processing state.
Sources	GET /sources, GET /sources/{id}	Shows sources assigned to the client.
Widgets	GET, POST, PATCH /widgets; GET /triggers/resolve	Manages project widgets and resolves public page suggestions.
Files	GET, POST, PATCH, DELETE /files	Submits text content for indexing without a source URL.
Chats and feedback	GET /chats, messages and GET /feedback	Reads anonymized chat history, visible messages and feedback.

Each resource page contains its request parameters, response fields, successful status codes and examples. The interactive reference is generated from the same operation declarations as the running API.