API Reference¶
The Kairos API is documented using OpenAPI 3 with interactive Scalar UI.
Accessing the API Docs¶
Start the API server first:
Then open: http://localhost:8880/docs
Base URL¶
All endpoints are under /api/v1:
Endpoints Overview¶
| Method | Path | Description |
|---|---|---|
GET |
/health |
Health check |
POST |
/jobs/search |
Search jobs across platforms |
GET |
/jobs |
List saved jobs (cursor pagination) |
GET |
/jobs/{id} |
Get job details |
POST |
/jobs/{id}/fetch-details |
Re-scrape full description |
DELETE |
/jobs/{id} |
Delete a job |
GET |
/config |
View current configuration |
PATCH |
/config |
Update configuration |
OpenAPI Spec¶
Raw spec available at: http://localhost:8880/openapi.json