Templates/API Documentation
Free Template

API Documentation
Knowledge Base Template

A complete template to make your API documentation searchable with AI. Includes OpenAPI specs, code examples, and implementation guide.

What's Included

1. OpenAPI Structure

{
  "project": "api-documentation",
  "sources": [
    {
      "type": "openapi",
      "name": "API Spec",
      "spec_url": "https://api.example.com/openapi.json",
      "sync_frequency": "daily"
    },
    {
      "type": "github",
      "name": "SDK Repository",
      "repo": "company/sdks",
      "include_code": true
    },
    {
      "type": "url",
      "name": "Changelog",
      "urls": ["https://docs.example.com/changelog"]
    }
  ]
}

2. Memory Categories

factual
API endpoints, parameters, auth methods
procedural
Implementation steps, error handling
episodic
Common issues, workarounds
semantic
Concepts, relationships between APIs

3. Common Queries

  • 1
    "How do I authenticate with the API?"
  • 2
    "What's the rate limit for /users endpoint?"
  • 3
    "How do I handle pagination?"
  • 4
    "What's the difference between v1 and v2?"
  • 5
    "Show me an example in Python"

Implementation Steps

1

Connect Sources

Link your OpenAPI spec, docs, and repos

2

Initial Sync

Import all API documentation

3

Test Queries

Verify developers can find answers

4

Deploy

Add search widget to your portal

Get Started With This Template