API REFERENCE
Database readiness
GET
/readyRuns SELECT 1 against PostgreSQL; SMTP worker health is not checked.
Authentication
No bearer token required. This does not remove validation or rate limits.
Parameters
No path or query parameters.
Request
No JSON request body is required.
Example request
Replace synthetic identifiers and credentials. Example dates, coordinates, revisions, and IDs are not production defaults. Read the workflow guide before making a write.
curl --request GET 'https://route-api.okok.space/ready'Responses
Examples illustrate the documented shape; optional fields and current state can differ. JSON extraction/body-limit errors may be plain text.
200 · Successful response.
application/json
| Field | Type | Description & constraints |
|---|---|---|
statusRequired | ready | Current execution or operation state. Planned/unplanned is separate from execution. |
Illustrative response
{
"status": "ready"
}Response schema
{
"$ref": "#/components/schemas/Ready"
}503 · Required persistence or credential operation unavailable.
application/json
| Field | Type | Description & constraints |
|---|---|---|
errorRequired | object | Resource-specific value; see the related workflow and schema. |
error fields
| Field | Type | Description & constraints |
|---|---|---|
error.codeRequired | validation | unauthorized | not_found | conflict | unavailable | rate_limited | Private activation or recovery code supplied to the driver. |
error.messageRequired | string | Resource-specific value; see the related workflow and schema. |
Illustrative response
{
"error": {
"code": "unavailable",
"message": "Required persistence or credential operation unavailable."
}
}Response schema
{
"$ref": "#/components/schemas/Error"
}