Pydantic schemas used by the REST API and WebSocket protocol. Mirror these in Python integration code to get type-safe request/response handling.
For the user-facing REST documentation see REST API.
cogtrix_core.api.schemas.session
Session CRUD types: create, update, list, delete request/response.
Key types: SessionCreateRequest, SessionPatchRequest, SessionOut, SessionConfig, TokenCounts.
cogtrix_core.api.schemas.message
Message send/list/clear types. The shape used by both POST /sessions/{id}/messages and the WebSocket user_message event.
Key types: SendMessageRequest, MessageOut, ToolCallRecord, SyncTurnOut, ToolConfirmRequest.
cogtrix_core.api.schemas.agent
Named-agent types. Used by the /agents endpoints.
Key type: AgentOut.
cogtrix_core.api.schemas.config
Request/response DTOs for the /config REST endpoints — providers, models, config sections, and the setup wizard. (For the on-disk .cogtrix.yml schema, see the Configuration reference.)
Key types: ProviderOut, ProviderCreateRequest, ModelOut, ModelSwitchRequest, ConfigOut, ConfigPatchRequest.
cogtrix_core.api.schemas.auth
Auth flow types: register, login, refresh, logout, API-key CRUD.
Key types: LoginRequest, TokenPair, UserOut, APIKeyOut.
cogtrix_core.api.schemas.tool
Tool catalogue types — what the /tools endpoints return and accept.
Key types: ToolOut, ToolSummary, ToolParameterSchema, ToolActionRequest.
cogtrix_core.api.schemas.memory
Memory state response types — used by GET /sessions/{id}/memory to expose facts, goals, and recall stats.
cogtrix_core.api.schemas.rag
RAG ingestion and query types.
cogtrix_core.api.schemas.mcp
MCP server connection types.
cogtrix_core.api.schemas.workflow
Workflow definition + binding types — see Workflows for the user-facing guide.