Skip to navigation

Answer the question a prompt paused on

Resumes a prompt whose status is paused_for_question, exactly as if the key’s creator answered in the app. Send answer as text, or as a list of option labels when the question allows several. Quote the question’s id as questionId so an answer meant for one question is never applied to a later one. The run continues in its place in the queue; poll or wait for the callback as before.

Authentication

X-API-Keystring

Create one in the app under Settings → API keys. It is shown once and stored only as a hash, so it cannot be recovered — losing it means issuing a new one.

A key reads the endpoints below and nothing else. It is not a session: it cannot create or delete projects, change settings, or issue another API key. It sees exactly what its owner sees, re-checked on every request, so removing someone’s access to a project removes it from their key on the very next call.

OR
AuthorizationBearer

The same key, sent as Authorization: Bearer <key>.

Path parameters

projectIdintegerRequired
promptIdintegerRequired

Request

This endpoint expects an object.
answerstring or list of stringsRequired

Free text, or the chosen option label(s).

questionIdstringOptional

The question.id from the prompt’s view.

Response

Resumed.
createdAtstringOptional
errorstring or nullOptional
finishedAtstring or nullOptional
idintegerOptional
positionintegerOptional
Prompts ahead of this one, while queued.
promptstringOptional
questionobject or nullOptional

Present while status is paused_for_question.

responsestringOptional
The reply, once it has started.
startedAtstring or nullOptional
statusenumOptional
summarystringOptional
urlstringOptional

Returned on POST: where to poll.

Errors

400
Bad Request Error
404
Not Found Error
409
Conflict Error
410
Gone Error