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
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.