> ## 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 probe (503 until stores are initialised)

> Ready

### Response

`Readiness`

**ready** `boolean` *required*

**store** `StoreKind` *required*

Thread store backend. Allowed values: `'memory'`, `'redis'`.

### Status codes

| Code | Meaning |
| - | - |
| `200` | Ready |
| `503` | Not ready |

### Using this contract

Read the [source OpenAPI document](https://docs.stateset.com/spec/chat-widget.json) for declared schemas and alternatives.
This page also includes documented corrections from the [spec overlays](https://github.com/stateset/docs/tree/main/spec/overlays).
Example IDs and values are illustrative; replace them with records from your workspace.

```bash cURL theme={null}
curl --silent --show-error --fail-with-body --request GET \
  --url 'https://api.example.com/api/ready'
```

```json 200 theme={null}
{
  "ready": true,
  "store": "memory"
}
```


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