DocsAPI reference

Get conversation

get/api/agents/{agent_id}/conversations/{conversation_id}
Authentication
Bearer token
Retries
Safe to repeat
Body
None
Version
2026-09-03

Path parameters#

  • agent_idstringrequired
  • conversation_idstringrequired

Responses#

  • 200OKapplication/json

    ConversationDetail

    • idstringrequired
    • last_message_atstring (date-time)required
    • started_atstring (date-time)required
    • statusstringrequired
    • visitor_idstringrequired
    • consentstring

      Default: unknown

    • contact_emailstring | null
    • contact_idstring | null
    • contact_namestring | null
    • contact_phonestring | null
    • custom_fieldsobject
    • ended_atstring (date-time) | null
    • is_leadboolean

      Default: false

    • message_countinteger

      Default: 0

    • messagesarray of MessageRead
      13 fieldsMessageRead
      • contentstringrequired
      • created_atstring (date-time)required
      • idstringrequired
      • rolestringrequired
      • citationsarray of object | null
      • creditsnumber | null
      • error_codestring | null
      • input_tokensinteger | null
      • is_errorboolean

        Default: false

      • latency_msinteger | null
      • modelstring | null
      • output_tokensinteger | null
      • ttft_msinteger | null
    • page_urlstring | null
    • ratinginteger | null
    • referrerstring | null
    • resolvedboolean | null
    • sentimentstring | null
    • summarystring | null
    • titlestring | null
    • total_creditsnumber

      Default: 0

    • total_input_tokensinteger

      Default: 0

    • total_output_tokensinteger

      Default: 0

    5 response headers
    RateLimit-Limit

    Requests permitted in the current window.

    RateLimit-Remaining

    Requests left in the current window. Back off before it reaches 0.

    RateLimit-Reset

    Seconds until the current window resets.

    X-API-Version

    The dated version of the API contract that served this response, e.g. 2026-09-03. Pin against it; it changes only when a response shape changes incompatibly.

    X-Request-ID

    Quote this in a support request to identify the call.

  • 422Validation error

    The shared error envelope, served as application/problem+json with error.code set to validation_error. Its details name each field that failed and why.

Errors#

Failures use one envelope on every endpoint, described in Retries, versioning and limits. The codes you are most likely to meet here:

  • validation_error · 422 — The payload was well-formed JSON but failed schema validation.
  • unauthenticated · 401 — The request carried no API key, or one the API could not verify.
  • forbidden · 403 — The key is valid, but it is not allowed to do this — either the scope is missing or the resource belongs to another workspace.
  • rate_limited · 429 — Too many requests in the current window. The limit is per workspace, and some endpoints add a per-agent limit on top.

More Dashboard endpoints#

Something unclear or missing? Tell us and we’ll fix it.