Bebshai API

Public HTTP API of the Bebshai platform.

Requests use REST over HTTP and return JSON. Errors share one envelope, { "error": { "code", "message" } }, where code is a stable machine-readable string and message is safe to show to people.

1 published endpoint · API v1.0.0

Base URL

https://apibebshai.stackrover.com

Authentication

Every published endpoint is currently anonymous: send requests without credentials. Endpoints that need credentials will state their scheme here and on the endpoint itself.

Never put credentials in query strings or client-side code you ship to browsers.

Errors

Failed requests return a non-2xx status and one JSON envelope. code is stable and machine-readable — branch on it; message is safe to show to people but may change.

Error response

{
  "error": {
    "code": "not_found",
    "message": "resource not found"
  }
}

Versioning

This reference describes API v1.0.0. Additive changes (new endpoints, new optional fields) ship without notice; breaking changes get a new major version. Download the contract as OpenAPI 3.1 JSON.

System

Service status for uptime monitors and load balancers.

Check service health

GET/healthz

Reports whether the API is up and can reach its database. Anonymous and cheap: suitable for uptime monitors and load-balancer health checks. Do not call it more than once every few seconds.

Anonymous — no credentials required

Responses

200The API is serving and the database is reachable.
- status"ok"required
  Always ok when the response status is 200.
503The API is running but cannot reach its database. Retry with backoff.
- errorobjectrequired
  - codestringrequired
    Stable machine-readable error code, e.g. not_found, unavailable.
  - messagestringrequired
    Human-readable explanation, safe to display.

Request

curl "https://apibebshai.stackrover.com/healthz"

200 response

{
  "status": "ok"
}

503 response

{
  "error": {
    "code": "unavailable",
    "message": "database unreachable"
  }
}