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

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

Search one manufacturer's documentation for a question. The response holds the passages of that documentation that match the question, best match first. Each passage names the article it belongs to, with the article's id, title and source URL. This is the endpoint to give an LLM as a tool when it needs wiring rules, port specifications, configuration steps or troubleshooting guidance.

Each article's text is divided into passages of at most 400 words, and the search ranks each passage on its own. A short article is a single passage, so the search returns its whole text.

Request Body

The passages of one response hold at most 3,000 words in total, so a response can hold fewer passages than limit.

Changed on 9 October 2026

Before this date the endpoint returned one row per article. It now returns one row per passage, and the request, the rows in results and the error body changed with it. An integration written for the article search needs these changes:

A removed field is absent from the response, so code that still reads id or contentSnippet gets no value and no error.

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",
    "manufacturer": "biamp",
    "results": [
        {
            "articleId": 42,
            "title": "TesiraFORTE Network Configuration",
            "manufacturerName": "Biamp",
            "manufacturerSlug": "biamp",
            "productLine": "tesira",
            "sourceUrl": "https://support.biamp.com/...",
            "text": "The TesiraFORTE connects via Dante...",
            "score": 0.912,
            "match": "hybrid"
        }
    ],
    "totalResults": 1,
    "creditsCharged": 1,
    "timestamp": "2026-10-09T12:00:00Z"
}

Response Fields

Passage Fields

Every passage in results carries the same nine fields. A field with no value is null.

A search that finds no passage also answers 200, with an empty results array, "totalResults": 0 and "creditsCharged": 0.

Credits

A search costs 1 credit. A search is charged whenever passages come back, and it has no relevance cut-off, so a search of a manufacturer that has documentation returns passages and is charged nearly every time. A search that returns no passage, names an unknown manufacturer or fails is not charged.

The credit balance is checked before the search runs. An organization without the credit gets INSUFFICIENT_CREDITS and no search is made. A key or user with read-only access gets READ_ONLY_ACCESS, and nothing is searched or charged.

Error Responses

Two answers come before this endpoint runs and are not in the table: 401 for a request without a valid token or API key, and 403 SUBSCRIPTION_REQUIRED for an organization without a subscription that is active, trialing or past due. See Error Handling.

An error carries its code, its message and, for some errors, a hint in details:

{
    "success": false,
    "error": {
        "code": "MANUFACTURER_NOT_FOUND",
        "message": "Unknown manufacturer 'nosuch'",
        "details": "GET /api/v1/knowledge-base/manufacturers lists the slugs."
    },
    "timestamp": "2026-10-09T12:00:00Z"
}

LLM Integration Pattern

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

1. Discover available manufacturers and their slugs with GET /manufacturers
2. Search one manufacturer's documentation with POST /search, using the manufacturer's slug and a natural language question. The passages in the response are the documentation text to hand to the LLM

The search matches passages by meaning and by matching words, and a reranker then puts the matches in order. A query written as a full question works best. For example, "How do I wire IR ports on an HD-CTL-101" with the manufacturer crestron searches the Crestron documentation for the passages about IR port wiring.