Information
- OpenAPI version:
3.1.0
The API may change between versions while TTX-Zone is 0.x.
Overview
TTX-Zone API 0.1.0
Section titled “TTX-Zone API 0.1.0”The HTTP API behind TTX-Zone’s web application. Every path is under /api/v1.
It may change between versions while TTX-Zone is 0.x: there is no compatibility promise yet.
Authentication
The API uses the web application’s session: POST /auth/login sets a session cookie and a
CSRF cookie. Requests that change something must repeat the CSRF cookie’s value in the
X-CSRF-Token header. Sessions expire, and sensitive operations need a recent authentication
(POST /auth/step-up), answering 403 REAUTHENTICATION_REQUIRED otherwise.
The AI assistant’s /mcp endpoint is the exception: it takes a personal access token as a
bearer token.
Context
Requests name their organization or exercise in the path or the body. The server never infers them.
Operations
Section titled “Operations”DELETE
/api/v1/auth/avatarDELETE
/api/v1/auth/meDELETE
/api/v1/auth/mfa/emailDELETE
/api/v1/auth/oidc/linkDELETE
/api/v1/auth/sessionsGET
/api/v1/ttxPOST
/api/v1/ttxDELETE
/api/v1/ttx/{ttx_id}PATCH
/api/v1/ttx/{ttx_id}POST
/api/v1/mcpDELETE
/api/v1/instance/emailDELETE
/api/v1/instance/oidcAuthentication
Section titled “Authentication”accessToken
Section titled “accessToken”A personal access token, for the AI assistant’s /mcp endpoint.
Security scheme type: http
csrfToken
Section titled “csrfToken”The value of the CSRF cookie, on requests that change something.
Security scheme type: apiKey
Header parameter name: X-CSRF-Token
sessionCookie
Section titled “sessionCookie”The session cookie POST /auth/login sets.
Security scheme type: apiKey
Cookie parameter name: ttx_access_token