DocsAPI reference

Export archive

Downloads recent conversations as a portable, verifiable bundle.

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

The file is self-describing JSON with a checksum and a signature, so it can be kept, mailed to somebody, and brought back later to be looked at - including by a customer who has cancelled, which is a promise worth making and cheap to keep.

redact=true strips names, emails, phone numbers and the visitor id while keeping every transcript and every number derived from them. It exists because the most common reason to export chats is to send them to somebody, and the second most common regret is having sent personal data with them.

Path parameters#

  • agent_idstringrequired

Query parameters#

  • daysinteger

    Default: 7·≥ 1 and ≤ 31

  • redactboolean

    Default: false

Responses#

  • 200OKapplication/json

    any

    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 Insights endpoints#

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