Knowledge Base API

Search manufacturer technical documentation programmatically. Use these endpoints to build LLM-powered integrations that reference Biamp, Crestron, and other manufacturer knowledge bases.

GET /api/v1/knowledge-base/manufacturers

List all available manufacturer knowledge bases with article counts. Use this to discover which manufacturers have documentation before searching.

Response (200 - Success)

{
    "success": true,
    "data": [
        {
            "slug": "biamp",
            "displayName": "Biamp",
            "description": "Tesira, Devio, Parle, Vocia product families",
            "articleCount": 1298,
            "lastImportedAt": "2026-04-19T15:30:00Z",
            "isActive": true
        },
        {
            "slug": "crestron",
            "displayName": "Crestron",
            "description": "Control systems, SIMPL programming, hardware",
            "articleCount": 3533,
            "lastImportedAt": "2026-04-19T15:30:00Z",
            "isActive": true
        }
    ],
    "timestamp": "2026-04-20T12:00:00Z"
}

GET /api/v1/knowledge-base/manufacturers/{slug}

Get details for a single manufacturer knowledge base.

Path Parameters

Parameter	Type	Description
`slug`	string	Manufacturer slug (e.g. `biamp`, `crestron`)

Response (200 - Success)

{
    "success": true,
    "data": {
        "slug": "biamp",
        "displayName": "Biamp",
        "description": "Tesira, Devio, Parle, Vocia product families",
        "articleCount": 1298,
        "lastImportedAt": "2026-04-19T15:30:00Z",
        "isActive": true
    },
    "timestamp": "2026-04-20T12:00:00Z"
}

POST /api/v1/knowledge-base/search

Semantic search across manufacturer documentation. Returns articles ranked by relevance to your query. This is the primary endpoint for LLM integrations — search for wiring rules, port specs, configuration steps, or troubleshooting guidance.

Request Body

Field	Type	Required	Description
`query`	string	Yes	Natural language search query
`manufacturer`	string	No	Filter by manufacturer slug (e.g. `biamp`)
`category`	string	No	Filter by category (e.g. `hardware`, `network`, `control`)
`limit`	integer	No	Max results (default 10)
`threshold`	number	No	Minimum similarity score 0-1 (default 0.5)

Example Request

POST /api/v1/knowledge-base/search
Content-Type: application/json
Authorization: Bearer YOUR_TOKEN

{
    "query": "Dante port wiring requirements for TesiraFORTE",
    "manufacturer": "biamp",
    "limit": 5
}

Response (200 - Success)

{
    "success": true,
    "query": "Dante port wiring requirements for TesiraFORTE",
    "results": [
        {
            "id": 42,
            "title": "TesiraFORTE Network Configuration",
            "summary": "Step-by-step guide for configuring network...",
            "contentSnippet": "The TesiraFORTE connects via Dante...",
            "similarity": 0.92,
            "sourceUrl": "https://support.biamp.com/...",
            "category": "network",
            "productLine": "tesira",
            "manufacturerSlug": "biamp",
            "manufacturerName": "Biamp"
        }
    ],
    "totalResults": 1,
    "timestamp": "2026-04-20T12:00:00Z"
}

GET /api/v1/knowledge-base/entries/{id}

Get the full content of a knowledge base article, including structured fields for configuration steps, troubleshooting procedures, and critical rules. Use this after searching to retrieve detailed documentation.

Path Parameters

Parameter	Type	Description
`id`	integer	Article ID from search results

Response (200 - Success)

{
    "success": true,
    "data": {
        "id": 42,
        "title": "TesiraFORTE Network Configuration",
        "summary": "Step-by-step guide for configuring network settings...",
        "content": "Full article text...",
        "configurationSteps": "[\"Connect Dante primary port...\", ...]",
        "troubleshooting": "[\"If device not discovered, check...\", ...]",
        "criticalRules": "[\"Never hot-swap Dante connections...\", ...]",
        "sourceUrl": "https://support.biamp.com/...",
        "category": "network",
        "subcategory": "dante",
        "productLine": "tesira",
        "tags": ["dante", "networking", "configuration"],
        "sourceFolder": "tesira",
        "manufacturer": "Biamp",
        "manufacturerSlug": "biamp"
    },
    "timestamp": "2026-04-20T12:00:00Z"
}

LLM Integration Pattern

To use these endpoints as tools for an external LLM agent:

Discover available manufacturers with GET /manufacturers
Search for relevant articles with POST /search using the device manufacturer and a natural language query
Retrieve full article detail with GET /entries/{id} when you need configuration steps, troubleshooting, or critical rules

The search endpoint uses vector similarity (cosine distance on OpenAI embeddings) — natural language queries work best. For example, "How do I wire IR ports on an HD-CTL-101" will find relevant Crestron IR documentation.