Skip to API content
Birdor API v1

API reference · v1

Service health

Read service name, version, environment and uptime. This probe does not verify all downstream dependencies.

GET/v1/health

Access requirements

Health, metadata, changelog and waitlist routes are public. Catalog reads (GET /v1/tools, /v1/tools/{id}, /v1/colors/*) and POST /v1/tools/query require a tools.read credential; POST /v1/run/* requires tools.run. There is no anonymous access to these routes: send an API key (Bearer OR X-API-Key) from your server, or use the HttpOnly main-site session plus workspace selection and same-origin Origin. Never combine credentials. Every admitted call is metered. Ingress and workspace/actor minute/month limits are separate; waitlist has its own policy.

Implemented interfaces and development screens do not imply public production availability, paid access or a completed payment integration. Confirm access with Birdor before connecting an application. No paid Pro service, activation or cross-device sync is currently delivered. We are validating one repeatable task before building a paid offer.

Parameters

No path or query parameters.

Request example

1. Set the base URL

Request example
curl --request GET "$BIRDOR_API_BASE_URL/v1/health" \
  --header "Accept: application/json"

Examples are copied only; this page does not send API requests.

Responses

Illustrative response. Values vary by environment and time.

200Success
HTTP 200
{
  "ok": true,
  "data": {
    "service": "birdor-api",
    "version": "v1",
    "ok": true,
    "timestamp": "2026-09-26T00:00:00.000Z",
    "uptimeSeconds": 123.45,
    "env": "development"
  },
  "request_id": "req_example",
  "timestamp": "2026-09-26T00:00:00.000Z"
}
414Query string exceeds4096 characters before admission
HTTP 414
{
  "ok": false,
  "code": "QUERY_TOO_LONG",
  "message": "Query string too long",
  "request_id": "req_example",
  "timestamp": "2026-09-26T00:00:00.000Z"
}
Error handling

Example response fields

Fields shown in this example; optional fields can be omitted. Array rows describe the first example element.

okboolean
Application success flag.
dataobject
Endpoint-specific result.
data.servicestring
Service name.
data.versionstring
Version string.
data.okboolean
Application success flag.
data.timestampstring
Response creation timestamp.
data.uptimeSecondsnumber
Runtime uptime in seconds.
data.envstring
Runtime environment.
request_idstring
Origin-response identifier matching X-Request-ID; a shared HTTP cache may replay the original trace.
timestampstring
Response creation timestamp.