Skip to main content
GET
/
v1
/
instances
/
{instance_id}
/
status
curl https://api.chowder.dev/v1/instances/f47ac10b-58cc-4372-a567-0e02b2c3d479/status \
  -H "Authorization: Bearer chd_org_abc123..."

{
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "status": "running",
  "gateway_url": "https://sb-abc123-18789.preview.sandbox.app"
}

Documentation Index

Fetch the complete documentation index at: https://docs.chowder.dev/llms.txt

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

A lightweight endpoint for checking whether an instance is ready. Useful for polling during provisioning or verifying the gateway is reachable before sending messages.
Accepts an organization key (chd_org_*) or a scoped key (chd_sk_*) with read permission on this instance.

​
Path Parameters

​
instance_id
string
required
The ID of the instance to check.

​
Response

Returns 200 OK with a minimal status object.
​
id
string
The instance ID.
​
status
string
Current instance status: "provisioning", "running", "stopped", "error", or "terminated".
​
gateway_url
string | null
The public gateway URL if the instance has been provisioned. null while provisioning or if the instance errored.
curl https://api.chowder.dev/v1/instances/f47ac10b-58cc-4372-a567-0e02b2c3d479/status \
  -H "Authorization: Bearer chd_org_abc123..."

{
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "status": "running",
  "gateway_url": "https://sb-abc123-18789.preview.sandbox.app"
}