Answer a clarification question

Answers a clarifying question the agent raised mid-turn

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

When a turn emits a user_question or agent_form event, the agent has stopped and is waiting on you. This endpoint delivers the answer.

It is a side-channel signal, not a new stream: it returns immediately, and the turn resumes on the /v2/stream/agent_ask stream you already have open.

{threadResponseId} is the id from that turn's init frame.

Basic Usage

The stream pauses on a question:

event: user_question
data: {"question_id":"q-abc-123","question":"Do you want this by order date or by delivery date?","options":["Order date","Delivery date"]}

Answer it, passing question_id back verbatim:

{
  "projectId": 1,
  "questionId": "q-abc-123",
  "answers": ["Order date"],
  "freeText": "Use the order timestamp, not delivery."
}
{
  "success": true
}

The original stream then continues from where it paused:

event: thinking
data: {"block_id":6,"content":"Order date it is — filtering on order_purchase_timestamp."}

Request Parameters

ParameterTypeRequiredDescription
projectIdnumberYesThe project that owns the turn.
questionIdstringYesThe question_id from the user_question event, verbatim.
answersstring[]YesThe selected options.
freeTextstringNoAnything extra the user typed.

question_id is accepted too. The event spells the id in snake case and this endpoint takes it either way, so copying the field straight across from the frame works. Prefer questionId; if you send both, questionId wins.

Error handling

StatusWhen
400questionId is missing, or the agent is not waiting on it — unknown, already answered, or belonging to another turn. Use the id from the most recent user_question event.
401Missing or invalid API key.
404The turn does not exist.

If you would rather stop than answer, cancel the turn instead.

🔗

Learn more


Path Params
integer
required

The turn id produced by the originating agent_ask.

Body Params
integer
required
string

The question_id from the user_question event. Required — a request without it is rejected with 400.

string

Accepted as an alias for questionId, because this is the spelling the user_question event uses — passing the id straight back from the frame it came out of works. Prefer questionId; if both are sent, questionId wins.

answers
array of strings
answers
string
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json