Skip to main content
GET
Returns detailed information about a specific knowledge base, including its current status, metadata, and file information (if applicable).

Headers

string
required
Your API key for authentication.

Path Parameters

string
required
The unique identifier of the knowledge base to retrieve.

Response

object
The knowledge base object.
string
Unique identifier for the knowledge base.
string
Name of the knowledge base.
string
Description of the knowledge base (if provided).
string
Current status: "PROCESSING", "COMPLETED", "FAILED", or "DELETED".
string
Type of knowledge base: "FILE", "WEB_SCRAPE", or "TEXT".
string
Source URLs for web scrape type (comma-separated).
string
Base URL for web scrape type.
string
ISO timestamp of creation.
string
ISO timestamp of last update.
string
Error message if status is "FAILED".
object
File information for file-type knowledge bases.
string
Original filename.
number
File size in bytes.
string
MIME type of the file.
null
Will be null on successful request.

Docs for agents: llms.txt