Stop generation
Stops the turn the AI builder is currently running on this app and returns the app once it has settled.
The builder keeps whatever it finished before you stopped, so the app is left in a usable state and the conversation keeps the partial turn. Send a new message with Send chat message to carry on from there.
Stopping an app that is not running anything is not an error. You get the app back unchanged, which makes this safe to call whenever you are unsure whether a turn is still going.
Authorizations
Personal API key.
Path Parameters
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 of the app.
"6820f3a4e7b91d003c45a1f2"
Display name of the app.
"My CRM"
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.
The app's conversation, including the messages this request produced.