API Reference

The SeaMind API is a REST API built on FastAPI. All endpoints are under /api/v1/ and return JSON responses.

Base URL

https://api.seamind.xyz

Most endpoints require a Bearer token. Include it in the Authorization header:

Authorization: Bearer <your-token>

Tokens are issued through SSO authentication via WorkOS.

The API is organized around these core resources:

Resource	Description
Ships	Manage vessels in your fleet
Courses	Training modules with slides and quizzes
Programs	Groups of courses (called “curriculums” in the API)
Assignments	Crew-ship placements with roles and dates
Registrations	Training progress — one person, one course
Users	Crew members and their profiles
Analytics	Learner performance and insights
Admin	Dashboard stats and aggregations

Pagination — List endpoints accept page and page_size query parameters.
Search — Most list endpoints accept a search query parameter for filtering by name or title.
IDs — All resource IDs are UUIDs.
Dates — ISO 8601 format (2025-06-15T00:00:00Z).
Errors — Standard HTTP status codes with JSON error bodies.

The API playground on each endpoint page lets you try requests directly. You’ll need a valid Bearer token to authenticate.

⌘I