Responses

Retrieve a response

A stored response, as it was returned (status queued or in_progress while a background response runs). With stream=true (background responses only), its stream events from the start, or after starting_after, then each new one as it happens.

get/responses/{response_id}

Request

  • Base URL
    https://api.openscale.so/v1
  • URL
    https://api.openscale.so/v1/responses/{response_id}
  • Auth
    HTTP bearer

Query parameters

streamboolean

Stream a background response as SSE events.

starting_afterinteger

With stream: the sequence number to resume after.

Response

The response, or its events when stream is true.

idstring required
object'response' required
created_atinteger required
status'completed' | 'incomplete' | 'failed' | 'in_progress' | 'queued' | 'cancelled' required
model'deepseek/deepseek-v4.1-flash' | 'z-ai/glm-5.3-flash' | 'deepseek/deepseek-v4.1-flash-1017' | 'deepseek/deepseek-v4.1-flash-0910' | 'z-ai/glm-5.3-flash-0828' | 'deepseek/deepseek-v4.1-flash:fast' | 'deepseek/deepseek-v4.1-flash-1017:fast' | 'deepseek/deepseek-v4.1-flash-0910:fast' required
service_tier'default' | 'priority'

The tier that served the response: priority in fast mode.

Example response

{
  "id": "resp_example",
  "output": [
    {
      "id": "msg_example"
    }
  ]
}

Changes

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