Read a thread

Read an ask/agent thread back as question / answer rounds.

This is both the poll endpoint for a processing answer (GET /ask returns the threadId to poll) and a general way to read a past conversation: it returns every round's question and answer, without the intermediate events. While the run is still working the response is 202 with status: "processing" — poll again after retryAfterSeconds / the Retry-After header.

get/threads/{threadId}

Path parameters

threadIdstring required

The thread id — from a processing response, or any thread of yours.

Response

Ok

threadIdstring required
status'processing' | 'completed' | 'failed' | 'needs-approval' required
titlestring
retryAfterSecondsnumber double

Set while processing — suggested seconds before polling again.

messagestring

Human-readable hint about the current state.

triageUrlstring

needs-approval: where a human reviews the drafted changes.

pendingApprovalCountnumber double

Changes

Changed in 2 of the 5 revisions of this API.3

    • added the optional property rounds/items/sources to the response with the 200 status

      response-optional-property-added

    • added the optional property rounds/items/sources to the response with the 202 status

      response-optional-property-added

    • endpoint added

      endpoint-added