Skip to main content
POST
Stop generation

Authorizations

api_key
string
header
required

Personal API key.

Path Parameters

app_id
string
required

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

Response

The app after the running turn was stopped, or unchanged if nothing was running.

The app document the chat endpoints return once a turn settles.

The real payload is the whole app document, so this is a strict subset: the fields a caller needs to see what the turn did and whether it succeeded.

id
string | null

ID of the app.

Example:

"6820f3a4e7b91d003c45a1f2"

name
string | null

Display name of the app.

Example:

"My CRM"

status
AppStatusResponse · 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.