---
title: "Knowledge Sources — AVCodex Docs"
description: "Knowledge Sources — AVCodex documentation for AV integrators, programmers, and ops teams."
lang: en
json-ld:
---

[](/)

Solutions

[Pricing](/pricing)[The Signal](/blog)[Resources](/resources)

Learn

[Free AI Assessment](/scorecard)[Get Started →](/pricing)

[Documentation Home](/docs)

Guides 

Custom Actions 

Pro Actions 

API 

Builder API 

-   [Overview](/docs/builder-api/overview)
-   [Sessions](/docs/builder-api/sessions)
-   [Consumers](/docs/builder-api/consumers)
-   [Feedback](/docs/builder-api/feedback)
-   [Tags](/docs/builder-api/tags)
-   [Knowledge Sources](/docs/builder-api/knowledge-sources)
-   [Memories](/docs/builder-api/memories)
-   [Analytics](/docs/builder-api/analytics)

Agentic Commerce (ACP) 

Integrations 

[Docs](/docs)/ Builder API / Builder API 

# Knowledge Sources

Last updated · MAR 2026 · [Read as Markdown](/docs/builder-api/knowledge-sources.md)

Knowledge sources are the documents, URLs, and files you've loaded to train your agent. Programming guides, AS-built drawings, manufacturer spec sheets, commissioning checklists, internal SOPs. This endpoint lets you check their processing status and metadata.

> **Note:** Internal file paths (storage locations) are never exposed through this endpoint. Only public-facing metadata is returned.

## [List knowledge sources# ](#list-knowledge-sources)

code 

```
GET /api/v1/apps/{appId}/knowledge-sources
```

Returns a paginated list of knowledge sources. Uses offset-based pagination.

### [Query parameters# ](#query-parameters)

Parameter

Type

Default

Description

`limit`

integer

25

Results per page (1-100).

`offset`

integer

0

Number of results to skip.

`status`

string

\-

Filter by processing status.

`type`

string

\-

Filter by source type.

**Status values:** `pending`, `processing`, `completed`, `failed`, `deleting`.

**Type values:** `file`, `url`, `google_drive`, `notion`, `text`, `qa`, `sitemap`, `youtube`, `confluence`.

### [Example# ](#example)

bash 

```
curl "https://app.avcodex.com/api/v1/apps/YOUR_APP_ID/knowledge-sources?status=completed" \
  -H "Authorization: Bearer avcodex_YOUR_API_KEY"
```

### [Response# ](#response)

json 

```
{
  "data": [
    {
      "id": "ks-001",
      "name": "Crestron 4-Series Programming Guide",
      "type": "file",
      "status": "completed",
      "url": null,
      "error_message": null,
      "chunk_count": 1,
      "file_size_bytes": 24576,
      "refresh_interval_hours": null,
      "last_refreshed_at": null,
      "created_at": "2025-05-10T08:00:00Z",
      "updated_at": "2025-05-10T08:02:30Z"
    },
    {
      "id": "ks-002",
      "name": "Manufacturer Firmware Notes",
      "type": "url",
      "status": "completed",
      "url": "https://example.com/firmware",
      "error_message": null,
      "chunk_count": 24,
      "file_size_bytes": null,
      "refresh_interval_hours": 168,
      "last_refreshed_at": "2025-06-01T06:00:00Z",
      "created_at": "2025-05-12T14:00:00Z",
      "updated_at": "2025-06-01T06:00:00Z"
    },
    {
      "id": "ks-003",
      "name": "Q-SYS Lua Module Library Docs",
      "type": "url",
      "status": "processing",
      "url": "https://docs.example.com",
      "error_message": null,
      "chunk_count": 0,
      "file_size_bytes": null,
      "refresh_interval_hours": null,
      "last_refreshed_at": null,
      "created_at": "2025-06-15T12:00:00Z",
      "updated_at": "2025-06-15T12:00:05Z"
    }
  ],
  "pagination": {
    "has_more": false,
    "total": 3,
    "limit": 25,
    "offset": 0
  }
}
```

### [Response fields# ](#response-fields)

Field

Type

Description

`id`

string

Unique knowledge source identifier.

`name`

string

Display name.

`type`

string

Source type: `file`, `url`, `google_drive`, `notion`, `text`, `qa`, `sitemap`, `youtube`, `confluence`.

`status`

string

Processing status: `pending`, `processing`, `completed`, `failed`, or `deleting`.

`url`

string or null

Source URL, if applicable.

`error_message`

string or null

Error details if the source failed processing.

`chunk_count`

integer

Number of chunks extracted.

`file_size_bytes`

integer or null

File size in bytes.

`refresh_interval_hours`

integer or null

Auto-refresh interval in hours.

`last_refreshed_at`

ISO 8601 or null

When the source was last refreshed.

`created_at`

ISO 8601

When the source was added.

`updated_at`

ISO 8601

When the source was last updated.

### [Checking for failed sources# ](#checking-for-failed-sources)

bash 

```
curl "https://app.avcodex.com/api/v1/apps/YOUR_APP_ID/knowledge-sources?status=failed" \
  -H "Authorization: Bearer avcodex_YOUR_API_KEY"
```

\*AVCodex · Your AV expertise. Amplified by AI.\*

Was this helpful? 

[Edit this page →](#)

[

Previous

Tags

](/docs/builder-api/tags)[

Next

Memories

](/docs/builder-api/memories)

On this page

-   [List knowledge sources](#list-knowledge-sources)
-   [Query parameters](#query-parameters)
-   [Example](#example)
-   [Response](#response)
-   [Response fields](#response-fields)
-   [Checking for failed sources](#checking-for-failed-sources)

[](/)

The AI platform built exclusively for professional AV. Build, deploy, and sell AI tools that understand your industry.

### Platform

-   What You Can Build
-   Templates
-   [Pricing](/pricing)

### Services

-   [Done-For-You](/pricing)
-   [Academy](/academy)
-   [Contact](/contact)

### Company

-   About
-   [The Signal](/blog)
-   [Docs](/docs)
-   [LinkedIn](#)

© 2026 AVCodex. A Future Ready Holdings Inc. product. SOC 2 Type II Certified · HIPAA Compliant