Read a purchased list and its rows

get/v1/agent/lists/{purchase_id}

Request

  • Base URL: https://api.specstream.ai
  • URL: https://api.specstream.ai/v1/agent/lists/{purchase_id}
  • Auth: API key in header Authorization

Path parameters

purchase_idstring required

The purchase_id from the 202.

Response

Where the run stands, and the rows once it ends

purchase_idstring required
statusstring required

running while it works; completed, partial, failed, canceled or expired when it ends.

requeststring
readingobject
requestedinteger
foundinteger
currencystring
paidstring
authorizedstring
chargedstring
refundedstring
paymentobject
notestring
rowsobject[]

The matches, each with its source. Present when the run has ended.

Changes

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