Readiness Check

Check if the API is ready to receive traffic.

GET /ready

cURL

curl --request GET \
  --url 'http://localhost:8000/ready' \
  --header "Authorization: Bearer $STATESET_AGENTS_API_KEY"

200

{
  "status": "ready"
}

Check if the API is ready to receive traffic.

Response

object

status · string · required

Status codes

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

cURL

curl --request GET \
  --url 'http://localhost:8000/ready' \
  --header "Authorization: Bearer $STATESET_AGENTS_API_KEY"

200

{
  "status": "ready"
}