API Platform
Use pre-built Context8 skills
Pick Cloud or Docker mode and copy the matching skill directly.
Cloud Server Skill
For hosted service via https://api.context8.org
Docker Self-hosted Skill
For local/team deployment with Docker and compose

Docker architecture

Read the runtime design first, then use the API interface table as your integration contract.

Docker design (what runs and why)

Context8 Docker is designed for predictability: Postgres is source of truth, Elasticsearch is the only search source, and writes are synchronous (DB then ES index in one request path).

Core services
  • frontend: Vite + Nginx dashboard UI
  • api: FastAPI auth, keys, solutions, quotas, search routing
  • postgres: durable source-of-truth data store
  • elasticsearch: only search backend for /search
Optional capabilities
  • embedding service (semantic profile) for ES kNN
  • Federated search via REMOTE_CONTEXT8_*
  • Visibility model: private and team (no public in Docker edition)
  • Stable contracts: /v2/solutions, /solutions, /mcp/solutions

Docker interfaces (API you will actually use)

These are the endpoints you need for bootstrap, search, and MCP compatibility.

Method
Path
Auth
Purpose
GET
/status/summary
None
Health summary for readiness checks and monitoring.
GET
/auth/status
None
Check whether admin setup is already completed.
POST
/auth/setup
None (first run)
Create the first admin account.
POST
/auth/login
None
Login and receive JWT for admin operations.
POST
/apikeys
Bearer JWT
Create root API key for team/services.
POST
/search
X-API-Key
Search solutions (ES-only, optional remote source).
GET
/v2/solutions
X-API-Key or JWT
Primary paginated contract: {items,total,limit,offset}.
GET
/mcp/solutions
X-API-Key
Array response for MCP clients.