API Reference
API Reference
Complete REST API documentation for Org in a Box.
Base URL
| Environment | URL |
|---|---|
| Local | http://localhost:8787 |
| Docker Compose | http://orginabox-api:8787 (internal) |
| Production | https://oiab-prod-api.<region>.azurecontainerapps.io |
Authentication
All endpoints except /v1/auth/* and /v1/healthz require authentication.
JWT (recommended):
Authorization: Bearer <access-token>
Legacy API key (single-operator mode):
Authorization: Bearer <ORGINABOX_API_KEY>
Response Format
All responses are JSON. Errors follow:
{
"error": "not_found",
"message": "Session abc123 not found"
}
Endpoints
| Category | Base Path |
|---|---|
| Auth | /v1/auth/ |
| Sessions | /v1/sessions/ |
| Memories | /v1/memories/ |
| Templates | /v1/templates/ |
| Orchestrator | /v1/orchestrate/ |
| Skills | /v1/skills/ |
| Admin | /v1/admin/ |
| Gateways | /v1/gateways/ |
Health Check
GET /v1/healthz
Returns { "ok": true, "ts": "2026-04-18T..." } or 503 if the database is unreachable. No authentication required.
