API reference

API reference · API

A stored response

GET/v1/responses/{id}API key

The response kept with store: true, as it was answered. The read or chat scope, on a key of the account, organization and agent that stored it; another's id, a lapsed one and one never kept are the same 404 (code response_not_found). A response is kept 30 days unless the operator sets ANTIMATTER_STORED_RESPONSES_RETENTION_DAYS. Every method is the unknown endpoint 404 while the operator has not turned stored responses on (ANTIMATTER_STORED_RESPONSES=1).

Parameters

Path and query parameters
FieldTypeWhat it is
id (path)requiredstringThe response's id, as the answer to POST /v1/responses carried it.

Answer 200

The response object.

The answer's fields are not named in the document.

Errors

  • 401OpenAI shaped error.
  • 403OpenAI shaped error.
  • 404OpenAI shaped error.
  • 429Rate limited, or a spent budget or spend cap. The type distinguishes rate_limit_error, policy_exceeded, and spend_cap_exceeded.

Every error answers in one shape, with its type, code and the field it names. The whole list is in the docs' Errors section.

Antimatter