Skip to main content
POST
Start change review chat

Body

application/json

Request body for starting a change review chat

mode
enum<string>
required
Available options:
pr
prUrl
string<uri>
required
vcsProviderId
enum<string>
required

Supported VCS providers for pull request URL review mode

Available options:
github,
gitlab
applicationOverrides
object[]
required
context
string
forceNewConversation
boolean
default:false

Force a brand-new chat instead of reusing the pull request's existing review conversation. Defaults to false, so repeated reviews of the same PR share one chat.

projectShortId
string

Target a specific project by its prefixed short ID (proj-slug_shortId or proj_shortId), as returned by the projects API. Required for organization-scoped API keys; project-scoped keys may only pass their own project's short ID.

Pattern: ^proj(-.+_.+|_.+)$

Response

202 - application/json

The request has been accepted for processing, but processing has not yet completed.

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.