Send chat message
Sends a message to the app’s AI builder and runs the turn it starts. This is how you build an app after creating it.
The request stays open until the builder finishes the whole turn, so it can take several minutes on a large change. The response is the app once the turn settles, with the messages it produced under conversation.messages. Read the newest assistant message for the builder’s reply, and status.state to see how the turn ended. Each turn consumes credits.
{"queued": true} with the queue’s state, and it carries none of the fields below. Check for queued before reading the app.Authorizations
Personal API key.
Path Parameters
ID of the app whose builder chat this request acts on.
Body
Response
The app once the turn finished, or the queue state if the message was queued.
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.