Get Instance Status

GET

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"
}

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

string

required

The ID of the instance to check.

Response

Returns 200 OK with a minimal status object.

string

The instance ID.

string

Current instance status: "provisioning", "running", "stopped", "error", or "terminated".

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"
}

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"
}

Overview

Organization

Instances

Channels

Skills

Files

API Keys

Subscription

Get Instance Status

Path Parameters

Response

​Path Parameters

​Response

Path Parameters

Response