Skip to main content
PUT
Updates the metadata (name and description) of an existing knowledge base. This endpoint does not modify the content of the knowledge base, only its descriptive information.

Headers

string
required
Your API key for authentication.
string
required
Must be application/json.

Path Parameters

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

Body Parameters

string
New name for the knowledge base. If not provided, the current name is retained.
string
New description for the knowledge base. Pass null to remove the description entirely.

Response

object
The updated knowledge base object.
string
Unique identifier for the knowledge base.
string
Updated name of the knowledge base.
string
Updated description of the knowledge base.
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 update.

Docs for agents: llms.txt