Get a response handler

Required scope: read

GET /v1/responses/{response_id}

cURL

curl --request GET \
  --url 'https://api.nsr.stateset.com/v1/responses/{response_id}' \
  --header "X-API-Key: $STATESET_NSR_API_KEY"

200

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "object": "string",
  "created_at": 1,
  "status": "pending",
  "model": "string",
  "output": [
    {
      "type": "standard",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "status": "pending",
      "role": "string",
      "content": [],
      "call_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Two-Person Tent",
      "arguments": "string"
    }
  ],
  "output_text": "string",
  "usage": {
    "input_tokens": 1,
    "output_tokens": 1,
    "total_tokens": 1
  },
  "metadata": {},
  "previous_response_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "x_nsr": {}
}

Required scope: read

Path parameters

response_id · string · required

Response ID

Response

object

id · string · required

object · string · required

created_at · integer · required

Unix timestamp (seconds).

status · string · required

model · string · required

output · object[] · required

Show output

type · string · required

id · string · required

status · string · required

role · string

Present on message items.

content · object[]

Present on message items.

Show content

type · string

text · string

annotations · object[]

call_id · string

Present on function_call items.

name · string

Present on function_call items.

arguments · string

JSON-encoded arguments string. Present on function_call items.

output_text · string

Convenience concatenation of the output text. Omitted when there is none.

usage · object · required

Show usage

input_tokens · integer · required

output_tokens · integer · required

total_tokens · integer · required

metadata · object

Echoed request metadata. Omitted when absent.

previous_response_id · string

Omitted when absent.

x_nsr · object

Full recursive NSR payload. Present only when the response was created with include_nsr_metadata.

Status codes

Code	Meaning
200	The stored response object, exactly as returned by POST /v1/responses.
401	Unauthorized — missing or invalid credentials
403	Forbidden — the key/token lacks the required scope
404	Unknown response_id (or a response owned by another org). OpenAI-shaped error envelope: {'error': {'message', 'type', 'param', 'code'}}.
429	Rate limited — see Retry-After / X-RateLimit-Reset

cURL

curl --request GET \
  --url 'https://api.nsr.stateset.com/v1/responses/{response_id}' \
  --header "X-API-Key: $STATESET_NSR_API_KEY"

200

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "object": "string",
  "created_at": 1,
  "status": "pending",
  "model": "string",
  "output": [
    {
      "type": "standard",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "status": "pending",
      "role": "string",
      "content": [],
      "call_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Two-Person Tent",
      "arguments": "string"
    }
  ],
  "output_text": "string",
  "usage": {
    "input_tokens": 1,
    "output_tokens": 1,
    "total_tokens": 1
  },
  "metadata": {},
  "previous_response_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "x_nsr": {}
}