Clear message queue
<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>
Removes every queued message and lifts any pause, so the next message you send runs as soon as the AI is free. The turn that's already running isn't affected. Stop it with Stop generation.
A message that was just taken off the queue to run is cancelled too, if its turn hasn't started yet.
A collaborator in the editor can send a queued message into the turn that's running. While that's happening the message can't be changed or removed. Clearing the queue is refused until it finishes.
This is limited to 60 requests per minute per app for each workspace's personal API keys, so every key in a workspace shares one allowance. Every endpoint that changes the queue shares it. Some workspaces have a different limit.
<Note>This endpoint accepts a personal API key belonging to a user with editor access to the app. A read-only key is refused, and workspace API keys are not accepted.</Note>
<Warning>The response includes fields beyond the ones documented here. Don't rely on undocumented response fields, as they can change at any time.</Warning>
Path parameters
ID of the app whose message queue this request acts on.
ID of the app whose message queue this request acts on.
Response
The emptied, unpaused queue.
Example response
{
"items": [
{
"branch_id": "68f1a2b3c4d5e6f708192a3b",
"content": "Add a contact form to the home page",
"created_at": "2026-10-05T14:30:00.123456+00:00",
"id": "3b9d2f6e-8c41-4a7e-9f05-1d2c3b4a5e6f"
}
]
}Changes
Changed in 1 of the 28 revisions of this API.1
- ○
endpoint added
endpoint-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○
Of the 28 revisions, 1 has no diff computed.