Skip to main content
GET
Get a composer session
The agent a session is currently holding, plus the conversation that shaped it. Use it to pick up a session your integration started earlier — after a page reload, in another process, or when a human comes back to a preview a day later — and to render the thread of how the agent was designed.
agent is the current preview — the same body POST /agents accepts verbatim, reflecting every refinement so far.

Paging the conversation

messages is newest first. When there is an older page, nextCursor is present; pass it back as cursor to continue.
No nextCursor means you have reached the beginning of the conversation.
The cursor is opaque. Do not construct or parse one — pass back what you were given. An unreadable cursor is treated as no cursor, so you get the newest page rather than an error.

Scope and lifetime

Requires the agents read scope. An unknown session, an expired one, and one belonging to another company are all a 404. Sessions live 30 days; expiresAt says when this one goes. Once you create the agent, the conversation moves with it and is no longer read here — it is part of the agent.

Authorizations

Authorization
string
header
required

API key for authentication using Bearer scheme

Path Parameters

sessionId
string<uuid>
required

The composer session id returned by POST /agents/composer.

Query Parameters

cursor
string

Opaque cursor from a previous page's nextCursor.

companyId
string

Required for ATS API keys to specify which company to access. Ignored for standard company API keys.

Response

The session, its current preview and a page of the conversation.

sessionId
string<uuid>
required
agent
object
required

The agent the composer would build. There is no id: this agent does not exist yet. Post this object to POST /agents to create it — it is accepted verbatim, with no ids or schemaVersion to strip first.

messages
object[]
required

The conversation so far, newest first.

expiresAt
string<date-time>
required
nextCursor
string

Pass as cursor to fetch the next (older) page. Absent at the start of the conversation.