Skip to main content
GET
/
v1
/
projects
/
{projectId}
/
warm-pool
/
instances
List warm pool instances
curl --request GET \
  --url https://capy.ai/api/v1/projects/{projectId}/warm-pool/instances \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "<string>",
      "instanceId": "<string>",
      "status": "<string>",
      "isTest": true,
      "failureReason": "<string>",
      "provisionedAt": "<string>",
      "createdAt": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.capy.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
projectId
string
required

Project ID.

Query Parameters

​
limit
integer
default:20
Required range: 1 <= x <= 50
​
status
enum<string>
Available options:
ready,
provisioning,
failed,
claimed

Response

Success

​
items
object[]
required