Skip to main content
The Developer API is the HTTPS surface the official SDKs call. Every client.agents.*, client.conversations.*, client.messages.*, and related method maps to one of the endpoints in this section.
Prefer the SDKs when you can. Use these raw requests when you are writing a new language binding, debugging with cURL, or calling the API from a tool that cannot import @chatatp/studio or chatatp-studio.

Base URL

Override it in the SDKs with baseUrl / base_url for self-hosted environments.

Two API surfaces

This tab documents /v1/. Dashboard (/dapi/) paths live under Dashboard API.

Conventions

  • Paths end with a trailing slash.
  • JSON request and response bodies use Content-Type: application/json.
  • List endpoints return { "data": [ ... ] }.
  • Successful deletes return 204 No Content.
  • File upload uses multipart/form-data with a file field.
  • Streaming uses POST + Accept: text/event-stream (SSE).
  • Transient failures (429, 5xx) are retried by the SDKs with exponential backoff.

Resource map