Skip to main content
GET
Get chat conversation

Path Parameters

chatConversationShortId
string
required
Pattern: ^chat(-.+_.+|_.+)$

Query Parameters

query
object
required

Response

200 - application/json

The request has succeeded.

Conversation data with recent messages (newest first).

shortId
string
required
Pattern: ^chat(-.+_.+|_.+)$
url
string
required

Dashboard URL for the conversation.

createdAt
string<date-time>
required
updatedAt
string<date-time>
required
status
enum<string>
required

Overall conversation lifecycle. in_progress while the assistant is working or a background test run / research task is still going. Assistant message COMPLETED is not enough — starting a run ends the current turn. Poll until this is completed, failed, or cancelled.

Available options:
in_progress,
completed,
failed,
cancelled
runs
object[]
required

Test runs started from this conversation, newest first. Empty until a run is created. Use shortId with get_run (testCases = all) or nested test-case short IDs from that call with get_run_test_case.

title
string
source
enum<string>

Where the conversation originated. api for conversations created via this API, ui for the dashboard, github/gitlab for VCS-triggered chats, and system for everything else.

Available options:
api,
ui,
github,
gitlab,
system
messages
object[]

Recent messages, newest first. Empty on creation; poll get_chat_conversation to retrieve. Internal wake messages are omitted.