Codex API | YAADMIN

Application boundary#

These paths belong to your YAADMIN installation. They are not callable product-website APIs. Authenticated mutations require a session-matched X-CSRF-Token unless the route is public. Handler-local error codes are not exhaustive downstream schemas.

Verified routes#

Find a route in this category

5 routes

GET/api/codex/status

Codex status.

Authentication: session
Permission: codex.use (special default-allow fallback for assigned role; see §6)
Request body: none
Query parameters: none explicitly read
Headers: none beyond shared session/CSRF
Response structure: {available, allowed, enabled, active, account}; {available, allowed, enabled, active, auth_mode, model, reasoning, account}; status
Important errors: none literal; shared/helper errors apply
Approval behavior: no standalone approval behavior in this handler.

Verified route registration · handler api_codex_status. Some definitions may be partially redacted; no missing fields are inferred.

PUT/api/codex/preferences

Codex preferences.

Authentication: session
Permission: codex.use (special default-allow fallback for assigned role; see §6)
Request body: CodexPreferencePayload [enabled, auth_mode, model, reasoning]
Query parameters: none explicitly read
Headers: none beyond shared session/CSRF
Response structure: {ok, enabled, auth_mode, model, reasoning}
Important errors: 400, 403, 500
Approval behavior: no standalone approval behavior in this handler.

Request fields

Field	Verified definition
`enabled`	`bool`
`auth_mode`	`str = Field(default="chatgpt", min_length=1, max_length=32)`
`model`	`str \| None = Field(default=None, max_length=200)`
`reasoning`	`str = Field(default="maximum", min_length=1, max_length=32)`

Verified route registration · handler api_codex_preferences. Some definitions may be partially redacted; no missing fields are inferred.

POST/api/codex/login

Codex login.

Authentication: session
Permission: codex.use (special default-allow fallback for assigned role; see §6)
Request body: CodexLoginPayload [mode, api_key]
Query parameters: none explicitly read
Headers: none beyond shared session/CSRF
Response structure: {ok, **result}
Important errors: 403, 502
Approval behavior: no standalone approval behavior in this handler.

Request fields

Field	Verified definition
`mode`	`str = Field(min_length=1, max_length=32)`
`api_key`	`type/default redacted; field name verified`

Verified route registration · handler api_codex_login. Some definitions may be partially redacted; no missing fields are inferred.

POST/api/codex/logout

Codex logout.

Authentication: session
Permission: codex.use (special default-allow fallback for assigned role; see §6)
Request body: none
Query parameters: none explicitly read
Headers: none beyond shared session/CSRF
Response structure: {ok}
Important errors: 403, 502
Approval behavior: no standalone approval behavior in this handler.

Verified route registration · handler api_codex_logout. Some definitions may be partially redacted; no missing fields are inferred.

GET/api/codex/models

Codex models.

Authentication: session
Permission: codex.use (special default-allow fallback for assigned role; see §6)
Request body: none
Query parameters: none explicitly read
Headers: none beyond shared session/CSRF
Response structure: {ok, models}
Important errors: 403, 502
Approval behavior: no standalone approval behavior in this handler.

Verified route registration · handler api_codex_models. Some definitions may be partially redacted; no missing fields are inferred.

Implementation reference: 2026-10-02. Labels distinguish verified behavior, partial implementation and architectural intent.