Odock.ai
Reference

API And Data Reference

Quick reference for routes, resources, and core data models.

API And Data Reference

Gateway Routes

RoutePurpose
GET /v1/healthBasic health
GET /v1/healthzReadiness with Postgres and Redis
GET /metricsPrometheus metrics when enabled
POST /v1/keys/validateValidate an API key
POST /v1/internal/cache/invalidateCache invalidation, enabled only with secret
/v1/mcp/:identifierUnified MCP gateway
POST /v1/llm/chatOdock-native LLM chat
POST /v1/chat/completionsOpenAI-compatible chat
POST /v1/responsesOpenAI responses
POST /v1/embeddingsOpenAI embeddings
POST /v1/images/generationsOpenAI image generation
POST /v1/images/editsOpenAI image edits
POST /v1/images/variationsOpenAI image variations
POST /v1/messagesAnthropic messages
/v1beta/models/*Gemini generate content
/v1/vllm/*vLLM-compatible routes

UI Route Families

Admin pages:

/admin/dashboard
/admin/organisations
/admin/teams
/admin/users
/admin/providers
/admin/models
/admin/mcp-servers
/admin/apikeys
/admin/budgets
/admin/quotas
/admin/usage
/admin/invoices
/admin/playground
/admin/settings

Organisation pages:

/:organisation/dashboard
/:organisation/providers
/:organisation/models
/:organisation/mcp-servers
/:organisation/teams
/:organisation/users
/:organisation/apikeys
/:organisation/budgets
/:organisation/quotas
/:organisation/usage
/:organisation/invoices
/:organisation/playground
/:organisation/settings

API route prefixes:

/api/admin/*
/api/organisations/:organisationId/*
/api/auth/*
/api/invitations/*

Core Data Models

ModelDescription
UserAuth user with role, status, organisation
OrganisationTenant boundary
OrganisationInvitationInvite workflow
TeamGroup inside an organisation
TeamMemberUser-to-team membership and team role
ApiKeyOdock runtime credential
ProviderUpstream provider config
ProviderApiKeyUpstream secret envelope and preview
ModelOrganisation-facing model catalog row
ApiKeyModelAccessAPI key to model grant
McpServerMCP server config
ApiKeyMcpAccessAPI key to MCP server grant
UsageAggregate usage rollup
UsageRecordPer-request LLM usage and billing
McpUsageRecordPer-request MCP sidecar usage
BudgetSpend cap
BudgetWindowBudget accounting window
QuotaUsage cap
QuotaWindowQuota accounting window
BudgetRequestRequest-level reservation state
BudgetReservationBudget reservation row
QuotaReservationQuota reservation row

Important Enums

Roles:

  • SUPER_ADMIN
  • ORG_ADMIN
  • MANAGER
  • USER

API key types:

  • ORGANISATION
  • TEAM
  • USER

Provider types:

  • OPENAI
  • ANTHROPIC
  • GOOGLE
  • AZURE_OPENAI
  • VLLM
  • CUSTOM

Model types:

  • chat
  • reasoning
  • image
  • embeddings
  • audio
  • moderation
  • transcription
  • tts

MCP transports:

  • STREAMABLE_HTTP
  • SSE
  • STDIO

Budget periods:

  • DAILY
  • WEEKLY
  • MONTHLY
  • QUARTERLY

Quota metrics:

  • REQUESTS
  • TOKENS
  • TOKENS_IN
  • TOKENS_OUT
  • ERRORS
  • COST
  • LATENCY_MS

Dashboards, Alerts, And Logs

Use Grafana dashboards, Prometheus alerts, and structured logs.

Deployment Checklists

Production-oriented checklists for rolling out Odock.

On this page

API And Data ReferenceGateway RoutesUI Route FamiliesCore Data ModelsImportant Enums