Get Knowledge Base Document

curl https://api.speechify.ai/v1/agents/knowledge-bases/id/documents/docId \
     -H "Authorization: Bearer <token>"

{
  "id": "doc_01knthz1d4v2bn8y9wz5ewjagk",
  "kb_id": "string",
  "source_kind": "file",
  "folder_id": "string",
  "filename": "string",
  "content_type": "string",
  "byte_size": 1,
  "char_count": 1,
  "chunk_count": 1,
  "status": "fetching",
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z",
  "content_preview": "string",
  "preview_truncated": true,
  "dependent_agents": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "source_url": "string",
  "error": "string",
  "refresh": {
    "enabled": true,
    "interval_days": 1,
    "auto_remove_enabled": true,
    "last_refreshed_at": "2024-01-15T09:30:00Z",
    "consecutive_fetch_failures": 1
  }
}

Retrieve a document by ID.

Authentication

AuthorizationBearer

Enter your API key with the Bearer prefix, e.g. ‘Bearer sk_…’.

Path parameters

idstringRequired

docIdstringRequired

Response

The document record.

idstring

kb_idstring

Prefixed wire identifier (kb_<26 char Crockford base32>) of the knowledge base the document belongs to. ADR 0015 FK consistency.

source_kindenum

How the document entered the KB. file is the upload path, text is inline pasted content, url is fetched via Firecrawl. Sitemap and crawl imports also produce url rows.

folder_idstring or null

Folder this document lives in. Null for root-level (unfiled) documents. Mutated via the move endpoint.

filenamestring

content_typestring

byte_sizelong

char_countinteger

chunk_countinteger

statusenum

Document lifecycle. fetching is the pre-scrape state used only by url-sourced rows; file and text docs skip straight to embedding because their content is available synchronously. Terminal states are ready and failed.

created_atdatetime

updated_atdatetime

content_previewstring

preview_truncatedboolean

dependent_agentslist of objects

source_urlstring

Source URL for url-sourced documents (and the sitemap / crawl imports that produce them). Empty string for file and text rows.

errorstring

Populated when status is failed.

refreshobject

Per-document auto-refresh state (AIS-2656). Only populated for url-sourced documents; file and text rows omit this and the console’s auto-refresh panel hides accordingly.

Errors

401

Unauthorized Error

404

Not Found Error