Get warm pool instance

Get status and provisioning logs for a warm pool instance. Use this to poll test boot results. The response includes a summary with the failed step and error message.

GET /v1/projects/{projectId}/warm-pool/instances/{id}

Get warm pool instance

cURL

curl --request GET \
  --url https://capy.ai/api/v1/projects/{projectId}/warm-pool/instances/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "<string>",
  "instanceId": "<string>",
  "status": "<string>",
  "isTest": true,
  "summary": {
    "success": true,
    "totalDurationMs": 123,
    "failedStep": "<string>",
    "error": "<string>",
    "completedSteps": 123,
    "totalSteps": 123
  },
  "failureReason": "<string>",
  "steps": [
    {
      "name": "<string>",
      "status": "success",
      "timestamp": "<string>",
      "error": "<string>",
      "output": "<string>",
      "durationMs": 123,
      "metadata": {}
    }
  ],
  "createdAt": "<string>"
}

Authorizations

Authorization · string · header · required

API token (capy_xxxx). Generate at capy.ai/settings/tokens

Path Parameters

projectId · string · required

Project ID.

id · string · required

Warm pool instance ID (returned by test boot).

Response

200

application/json

Success

id · string · required

instanceId · string · required

status · string · required

isTest · boolean · required

summary · object · required

Show child attributes

failureReason · string | null · required

steps · object[] · required

Show child attributes

createdAt · string · required