REST API

OpenAPI 3.1 spec served at /openapi.json by the API.

Base URL

Default http://localhost:8000. The Next.js dashboard proxies /api/* through to the API so cookies stay first-party.

Authentication

Two flows — see the auth page for details. TL;DR: cookie sessions for browsers, bearer tokens (API keys) for servers.

Endpoints

filed under · endpoints.bash

POST   /api/auth/register
POST   /api/auth/login
POST   /api/auth/logout
GET    /api/auth/me

GET    /api/jobs                      list
POST   /api/jobs                      create
GET    /api/jobs/{id}                 detail
DELETE /api/jobs/{id}
POST   /api/jobs/{id}/cancel
GET    /api/jobs/{id}/events          server-sent events
GET    /api/jobs/{id}/fetches
GET    /api/jobs/{id}/extracted
GET    /api/jobs/{id}/export.json
GET    /api/jobs/{id}/export.csv

Interactive docs

FastAPI ships Swagger UI at /docs and ReDoc at /redoc. Both are live against your local API instance.

← PREVIOUS

CLI

Authentication