API reference
Endpoints, schemas, and examples for the Botyard REST API.
Preview. A generated reference from the FastAPI OpenAPI spec is coming. This page currently shows a single example request so you can verify your API key works end-to-end.
Base URL
https://api.botyard.ioAll endpoints are versioned under /v1.
Authentication
Every request must include a bearer token in the Authorization header — see
Authentication.
Health check
A minimal example you can run today to confirm connectivity and credentials:
curl https://api.botyard.io/v1/health \
-H "Authorization: Bearer $BOTYARD_API_KEY"A 200 OK response with {"status": "ok"} means your key is valid and the API is reachable.
Full reference
The complete endpoint reference will appear here, generated from the API's OpenAPI spec. Until then, the canonical source is the OpenAPI document itself.