API reference · v1
Quickstart
Configure your environment, send a health request, and inspect the response.
1. Set the base URL
Use the origin provided by your environment operator, without a trailing slash or /v1 suffix. The placeholder below is not a live service. For local development, use the origin printed by the API development server.
bash
export BIRDOR_API_BASE_URL="https://birdor.com"2. Make the first request
Start with GET /v1/health. This read-only route needs no API key at the application layer.
bash
curl --request GET "$BIRDOR_API_BASE_URL/v1/health" \
--header "Accept: application/json"3. Inspect the result
A successful request returns HTTP 200 with ok: true. Inspect the service version and environment. A healthy response is not a guarantee that all other services are configured.
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"
}4. Explore the catalog
Read tool metadata or palette values next. Browser tools are not remote compute endpoints; listing a tool does not execute it.