--- title: "Get a response by ID" method: GET path: "/responses/{id}" tags: ["Response"] --- # Get a response by ID `GET /responses/{id}` ## Request - Base URL: `https://api.cloudglue.dev/v1` - URL: `https://api.cloudglue.dev/v1/responses/{id}` - Auth: HTTP bearer Retrieve a specific response by its ID. ## Path parameters - `id` string, uuid, required ## Response `200` Response details - Response - `id` string, uuid: Unique identifier for the response - `object` 'response': Object type identifier - `status` 'in_progress' | 'completed' | 'failed' | 'cancelled': Current status of the response - `created_at` integer: Unix timestamp of when the response was created - `model` string: The model used for the response - `instructions` string, nullable: The system instructions used - `output` union[], nullable: The generated output items: assistant message(s), any echoed function_call items, and one cloudglue_query_call per read-only SQL query the agent ran over structured data. Clients should tolerate unknown output-item types. - union - ResponseOutputMessage - `type` 'message': The type of output - `role` 'assistant': The role (always assistant for outputs) - `content` ResponseOutputContent[]: The content items in the output - `type` 'output_text': The type of content - `text` string: The generated text - `annotations` ResponseAnnotation[]: Citations and references in the output - `type` 'cloudglue_citation', required: The type of annotation - `collection_id` string, uuid: The collection containing the cited content. Present when using `collections` source; omitted for `files` and `default` sources. - `file_id` string, uuid, required: The file containing the cited content - `segment_id` string, uuid: The specific segment cited. Present when a matching segment is found. - `start_time` number, required: Start time of the cited content in seconds - `end_time` number: End time of the cited segment in seconds. Present when a matching segment is found. - `context` string: The text context of the citation - `relevant_sources` string[]: Relevant source descriptions (included when 'cloudglue_citations.media_descriptions' is requested) - `visual_scene_description` string[]: Visual descriptions (included when 'cloudglue_citations.media_descriptions' is requested) - `scene_text` string[]: On-screen text (included when 'cloudglue_citations.media_descriptions' is requested) - `speech` string[]: Speech transcripts (included when 'cloudglue_citations.media_descriptions' is requested) - `audio_description` string[]: Audio descriptions (included when 'cloudglue_citations.media_descriptions' is requested) - ResponseFunctionCall: A function/tool call the model emitted (echoed back in output for client-executed tools). - `type` 'function_call': The type of output item - `id` string: Identifier for this output item - `call_id` string: Correlates the call with its function_call_output - `name` string: The name of the called function - `arguments` string: JSON-encoded arguments to the function - ResponseQueryCall: A read-only SQL query the nimbus-002 agent ran over the structured (extracted) data. Result rows are not included in v1. - `type` 'cloudglue_query_call': The type of output item - `id` string: Identifier for this query call (query_) - `status` 'completed' | 'failed': Whether the query executed successfully - `sql` string: The SQL SELECT that was executed - `row_count` integer: Rows returned to the model after truncation - `total_rows` integer, nullable: True total when the engine saw the whole result; null when truncated - `truncated` boolean: Whether the result was truncated (row or byte cap) before reaching the model - `error` string, nullable: Error message when status is failed; null otherwise - `usage` ResponseUsage: Token usage statistics for the response - `input_tokens` integer: Number of input tokens used - `output_tokens` integer: Number of output tokens generated - `total_tokens` integer: Total tokens used - `error` ResponseError, nullable: Error details when the response status is 'failed' - `message` string: Error message - `type` string: Error type - `code` string: Error code ## Other responses - `404`: Response not found - `500`: An unexpected error occurred on the server ## Changes - **2026-10-30** `23d3f240819f`: 2 info - added the optional property `code` to the response with the `404` status - added the optional property `code` to the response with the `500` status - **2026-08-02** `a7a390d80571`: 2 breaking, 3 warning - added `#/components/schemas/ResponseOutputMessage, #/components/schemas/ResponseFunctionCall, #/components/schemas/ResponseQueryCall` to the `output/items/` response property `oneOf` list for the response status `200` - the `output/items/` response's property type changed from `object` to no type for status `200` - removed the optional property `output/items/content` from the response with the `200` status - removed the optional property `output/items/role` from the response with the `200` status - …1 more - **2026-03-16** `9dc639e1d66c`: 1 breaking - the response property `output/items/content/items/annotations/items/collection_id` became optional for the status `200` - **2026-02-13** `3e8a842138ee`: 4 info - the response property `output/items/content/items/annotations/items/collection_id` became required for the status `200` - the response property `output/items/content/items/annotations/items/file_id` became required for the status `200` - the response property `output/items/content/items/annotations/items/start_time` became required for the status `200` - the response property `output/items/content/items/annotations/items/type` became required for the status `200` - …earlier changes not shown [Operation history](https://skmtc.dev/cloudglue/apis/cloudglue-api/changes/responses/:id/get.md) --- [API](https://skmtc.dev/cloudglue/apis/cloudglue-api.md) - [All operations](https://skmtc.dev/cloudglue/apis/cloudglue-api/llms.txt) - [OpenAPI document](https://skmtc.dev/cloudglue/apis/cloudglue-api/revisions/23d3f240819f?raw)