Skip to navigation

One prompt's status, and its reply once finished

status is queued, running, completed, error, cancelled or paused_for_question (then question says what it needs; answer it with the /answer call, or /cancel to give up and free the queue).

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

Response

OK
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

404
Not Found Error