AI Apidocs — API Documentation Portal

  • Area: Intelligence
  • Path: services/ai/apidocs
  • Kind: Aggregated API documentation portal for AI services (rendered specs, code examples, try-it console)
  • Status: v0.0.1 — sector bootstrapping (2026-05-09)

Role in the stack

apidocs is the developer-facing surface for the AI services — what platform.koder.dev is for product browsing, this sector is for API integration. Today external developers consuming gateway, voice, imaging, etc. have nowhere to read request/response shapes, no way to try a call without writing code, no place to copy-paste an idiomatic Python or Go example. This sector pulls each AI sector's OpenAPI spec, renders consistently, generates idiomatic per-language code examples preferring the Koder SDK, embeds a try-it console wired to staging, and surfaces version selector + changelog.

It is the Koder analog of docs.anthropic.com, platform.openai.com/docs, Mintlify, and Redoc — built on a vetted FOSS base with full ownership of the generator (no SaaS lock-in).

Boundary vs neighbors

  • platform.koder.dev is the catalog site (browse-and-discover); apidocs is the integration site.
  • meta/sites/ holds institutional/marketing landings (www.koder.dev); apidocs is developer-facing.
  • Each AI sector backend produces its /openapi.yaml; apidocs aggregates them.
  • infra/net/jet hosts the rendered static site at docs.koder.dev.
  • services/ai/playground integrates: try-it runs can be saved to playground for further iteration.

Features (v1 target)

  • OpenAPI poller with normalization + per-version snapshots (kdb-doc backed)
  • Static-site generator (Astro or Hugo, decision in impl #002) building deterministic bundle
  • Per-sector and stack-wide pages with version selector
  • Code examples in curl + Python + Dart + Go, preferring Koder SDKs
  • Interactive try-it console with staging proxy + short-lived tokens + rate limit
  • Operation-level + sector-level + stack-level changelog with breaking-change classifier
  • RSS feed + opt-in email digest
  • Save-to-playground action from try-it
  • Full-text search (client-side)
  • Light + dark theme + en-US/pt-BR i18n

Primary couplings

Producer Relationship
Each AI sector backend Exposes /openapi.yaml
infra/net/jet Hosts static site at docs.koder.dev
services/ai/gateway (staging) Try-it proxy target
services/ai/translate i18n of spec descriptions (ktrans CLI)
Consumer Relationship
External developers Primary audience
Internal Koder team Cross-service integration reference
Customer-success + sales engineers Demo-ready surface
services/ai/playground Receives saved try-it runs

RFC and bootstrap

  • RFC: apidocs-RFC-001-foundations.kmdaccepted 2026-05-09
  • Bootstrap ticket: services/ai/backlog/done/138-apidocs-bootstrap.md
  • Implementation tickets: services/ai/apidocs/backlog/pending/{001..005}

Self-hosted-first analysis (5 gates)

Gate Status Notes
G1 Feature parity pending Spec rendering + try-it + code examples covers Mintlify baseline
G2 Performance pending Build target < 60s for 20 sectors × 5 versions; site latency dominated by Jet CDN
G3 Stability pending Pre-MVP
G4 Capability pending Long-form tutorials deferred to separate docs surface
G5 Critical-path readiness pending Unblocks external API adoption + internal cross-service integration