AI

Get a quest

Polls the outcome of a turn started by POST /api/chat or an async generation route. status done and stopped are terminal; pending and running are not. A finished turn that failed has type: "error" and, where classified, an errorCode; a stopped turn is also a failure even without type: "error", and its reply is an explanation rather than an answer. A 404 covers a quest that does not exist, one whose session was deleted, and one the caller cannot see, so polling after deleting the session returns 404. Safe (GET) requests are exempt from the per-day API-key quota: a poll consumes no daily slot, and only the per-minute burst limit applies.

get/api/v1/quests/{id}

Request

  • Base URL: https://your-deployment.example.com
  • URL: https://your-deployment.example.com/api/v1/quests/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Path parameters

idstring required

The quest id returned by POST /api/chat or another async start.

Response

The quest and its outcome so far.

idstring required
status'pending' | 'running' | 'done' | 'stopped'
type'message' | 'oob' | 'error' | 'system' | 'voice_transcript'
errorCode'insufficient_credits' | 'spend_cap_exceeded'
replystring nullable
repliesstring[]
sessionIdstring required
imagesstring[] required
videosstring[] required
createdAtstring date-time nullable
updatedAtstring date-time nullable
promptMetaobject
attachmentNoticesstring[]
attachmentDeliveryobject
executionTrackingunknown

Changes

No recorded changes to this operation across all 1 revision of this API.