Skip to main content
POST
Stop generation

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>. Each operation lists the permission it needs: read_only or full_access. A full-access token can call every operation. A read-only token can call only the operations that list read_only; anything else returns 403 read_only_credential_route_not_allowed.

Path Parameters

app_id
string
required

ID of the app whose AI chat this request acts on.

Response

Successful Response

An app, with its conversation and build status.

id
string | null

ID of the app.

Example:

"6820f3a4e7b91d003c45a1f2"

name
string | null

Display name of the app.

Example:

"My CRM"

status
StatusObject · object | null

The app's build status once the request returned. Read state to tell a finished turn from one that is still processing or that failed.

conversation
ChatTurnConversation · object | null

The app's conversation, including the messages this request produced.