Retrieve a Dream's status, results, and usage by ID.
GET /api/v1/forward/dreams/{id}
After creating a Dream, poll this endpoint until status reaches a terminal state: completed, failed, or canceled.
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT or admin SAT>. |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Dream ID with the drm_ prefix. |
Example request
Example response
HTTP 200 OK
Response fields
| Field | Type | Description |
|---|---|---|
| Return value | object | The Dream object in its current state. |
Errors
| HTTP | Type | Trigger |
|---|---|---|
400 | invalid_request_error | id is not a valid Dream ID. error.code is invalid_dream_id. |
401 | authentication_error | Authentication is missing, invalid, or expired. |
403 | permission_error | The token cannot query Dreams. Identity SAT is not supported by this endpoint. |
404 | not_found_error | The Dream does not exist or is not visible to the caller. error.code is dream_not_found. |
500/502/503 | api_error | The service or an internal dependency is temporarily unavailable. |

