requestRead a request by putting its id in the URL path. The response includes the current status, result, metadata, and complete conversation.
COMPLETED means the request has reached a terminal state, not necessarily that its objective was achieved. Inspect result and the conversation before treating the work as successful. CANCELLED requests include the reason in metadata.cancellation_reason when one is available.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The request id that you want to retrieve |
curl -XGET https://console.api.getmagic.com/api/v1/request/REQUEST_ID \
-H "x-api-key: <API_KEY>"{
"id": "12345-67890-12345-67890",
"status": "PENDING",
"result": "Request Result",
"completed_at": "2025-01-01T00:00:00.000Z",
"internal_id": "123456-7890-123456-7890",
"project_id": "123456-7890-123456-7890",
"title": "Request Title",
"instructions": "Request Instructions",
"objective": "Request Objective",
"relaxed": true,
"max_minutes": 60,
"metadata": null,
"created_at": "2025-01-01T00:00:00.000Z",
"updated_at": "2025-01-01T00:00:00.000Z",
"conversation": []
}