> ## 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.

# Get Instance Status

> Check the current status of an instance.

A lightweight endpoint for checking whether an instance is ready. Useful for polling during provisioning or verifying the gateway is reachable before sending messages.

<Note>
  Accepts an **organization key** (`chd_org_*`) or a **scoped key** (`chd_sk_*`) with `read` permission on this instance.
</Note>

## Path Parameters

<ParamField path="instance_id" type="string" required>
  The ID of the instance to check.
</ParamField>

## Response

Returns `200 OK` with a minimal status object.

<ResponseField name="id" type="string">The instance ID.</ResponseField>

<ResponseField name="status" type="string">
  Current instance status: `"provisioning"`, `"running"`, `"stopped"`, `"error"`, or `"terminated"`.
</ResponseField>

<ResponseField name="gateway_url" type="string | null">
  The public gateway URL if the instance has been provisioned. `null` while provisioning or if the instance errored.
</ResponseField>

<RequestExample>
  ```bash cURL theme={"theme":{"light":"github-light","dark":"github-dark-dimmed"}}
  curl https://api.chowder.dev/v1/instances/f47ac10b-58cc-4372-a567-0e02b2c3d479/status \
    -H "Authorization: Bearer chd_org_abc123..."
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={"theme":{"light":"github-light","dark":"github-dark-dimmed"}}
  {
    "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "status": "running",
    "gateway_url": "https://sb-abc123-18789.preview.sandbox.app"
  }
  ```
</ResponseExample>