> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stateset.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Readiness Check

> Check if the API is ready to receive traffic.

Check if the API is ready to receive traffic.

### Response

`object`

<ResponseField name="status" type="string" required />

### Status codes

| Code | Meaning |
| - | - |
| `200` | Successful response |
| `401` | Authentication required |
| `422` | Validation error |
| `429` | Rate limit exceeded |
| `503` | Not ready |

<RequestExample>
  ```bash cURL theme={null}
  curl --request GET \
    --url 'http://localhost:8000/ready' \
    --header "Authorization: Bearer $STATESET_AGENTS_API_KEY"
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "status": "ready"
  }
  ```
</ResponseExample>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.