API reference
KnowledgeDocument
The KnowledgeDocument object.
| Field | Type | Description |
|---|---|---|
created_at |
string (date-time) | |
error |
string or null | |
expires_at |
string (date-time) or null | When it stops being used, if it ever does. |
filename |
string | |
id |
string (uuid) | |
items |
integer | How many pieces of it agents can find. |
kind |
string | file for a file sent to it; url for a page of a website it read; topic and faq for what was written in the console. One of: file, faq, topic, url. New words may be added. |
knowledge_base_id |
string (uuid) | |
object |
knowledge_document |
|
size_bytes |
integer | |
source_url |
string or null | The page, for a source a website gave it. |
status |
string | pending until the indexer takes it, processing while it reads it, indexed once agents answer from it, failed when it could not — error says why — and held for a website page waiting for review in the console. One of: pending, processing, indexed, failed, held. New words may be added. |
updated_at |
string (date-time) |