Retrieve a plugin task response

Read Responses state and output for a platform plugin task.

200

{
  "id": "resp_example",
  "object": "response",
  "created_at": 1700000000,
  "model": "YOUR_MODEL_ID",
  "status": "queued",
  "background": true,
  "output": [],
  "error": null,
  "usage": null
}

GET /v1/responses/{response_id}

Use a Bearer token and the complete response_id returned by creation, with no request body. GET with an ID returns a JSON snapshot; GET /v1/responses without an ID is a WebSocket upgrade endpoint.

The implementation reads platform task records; it does not proxy GET to ordinary upstreams. Only retrievable plugin tasks belonging to the same user and project are returned. Invalid or inaccessible IDs, discarded results, or unresolved plugins can return 404. Do not automatically resubmit a task in response.

Check status and error even with HTTP 200. queued / in_progress means wait; after completed, validate results according to output type. failed is not success. Rendering a final task result can also fail and return a failed response object.

SSE resumption, input_items, REST cancel, and delete are not provided. See background mode and bounded polling.

阅读中文

Authorizations

Authorization · string · header · required

模型调用 API Key，不是控制台登录凭据 / Model API key, not console login credentials

Path Parameters

response_id · string · required

经过 URL 编码的完整标识 / Complete URL-encoded identifier

Response

200

application/json

成功结构仍需检查业务字段 / Check business fields even on HTTP success

id · string

object · string

Example:

"response"

created_at · number

model · string

status · string

必须检查完成状态，例如 completed、failed、incomplete / Check completion status, for example completed, failed, or incomplete

output · object[]

Show child attributes

error · object | null

incomplete_details · object | null

usage · object | null

Show child attributes