API reference / Space guide

Operations

Space is in development. These guides describe the current development version and the intended workflow. Public sign-ups and hosted agent connections are not available yet.

Service liveness.

Send every request to your API URL with your key, as described in the reference overview. Read API concepts for paging, safe retries, revisions and errors.

GET /health/ready

Check readiness

Returns ready once the database answers, otherwise 503.

This route needs no API key.

Responses

200Success

  • statusstringRequired

    Always ready

Example response
{
  "status": "ready"
}

Errors

  • 503Temporarily unavailable or busy. Retry with backoff, honouring Retry-After. Error

Example request

curl "https://<api-host>/health/ready"

GET /health/live

Check liveness

Process liveness. It does not check storage; use /health/ready for that.

This route needs no API key.

Responses

200Success

  • statusstringRequired

    Always ok

  • servicestringRequired
  • versionstringRequired
Example response
{
  "service": "space",
  "status": "ok",
  "version": "0.3.0"
}

Example request

curl "https://<api-host>/health/live"