API Reference

Get conversation with messages

View Markdown

GET /api/ai/conversations/{id}

Operation IDgetAiConversation

Authentication

BearerAuth·http bearer·API key token (envoy_<hex>). Create keys from Settings → API Keys — see Using the API.

Path parameters

idintegerrequired

Resource ID

Success response body

200Conversation and messages. Message `role` may be `user`, `assistant`, or `summary` (auto-compaction divider). Summary rows include `summarized_through_seq`. Conversation may include `last_context_tokens`.

Conversation and messages. Message role may be user, assistant, or summary (auto-compaction divider). Summary rows include summarized_through_seq. Conversation may include last_context_tokens.

No response content schema is documented.

Error responses

404Not found

Not found

No response content schema is documented.

Code examples

curl --request GET \
  --url 'https://your-envoy.example.com/api/ai/conversations/YOUR_ID' \
  --header 'Authorization: Bearer $API_KEY'

const response = await fetch("https://your-envoy.example.com/api/ai/conversations/YOUR_ID", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
  },
});

if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = response.status === 204 ? null : await response.json();
console.log(data);