API

This section contains the Xylolabs HTTP API reference.

The API is documented in two languages, with identical surface and semantics:

• API Reference (English) — full surface, request/response shapes, authentication, error codes.
• API Reference (Korean) / API 레퍼런스 (한국어) — 동일한 API의 한국어 레퍼런스.

Health endpoints

• GET /api/health — liveness probe.
• GET /api/health/ready — readiness probe (checks DB / S3 connectivity).

Authentication

The API supports two authentication mechanisms:

1. Session cookie — issued by the admin dashboard POST /api/auth/login flow.
2. API key — issued via /api-keys in the admin dashboard. Sent as Authorization: Bearer <key>.

See the language-specific reference for the full authentication, role, and rate-limit details.