Skip to main content
POST
Add Knowledge Base Document

Authorizations

X-API-Key
string
header
required

Path Parameters

knowledge_base_id
string
required

Body

application/json
status
enum<string>
required
Available options:
trained,
training,
error,
uploaded,
folder
name
string
required
prefix
string
default:/
doc_metadata
Doc Metadata · object
run_id
string<uuid> | null

Response

Successful Response

id
string<uuid>
required
summary
string | null
required
status
enum<string>
required
Available options:
trained,
training,
error,
uploaded,
folder
error
Error · object | null
required
updated_at
string<date-time>
required
created_at
string<date-time>
required
size
integer
required
short_summary
string | null
doc_type
string | null
source_type
enum<string> | null
Available options:
Document,
Google Drive,
Notion,
Website,
OneDrive,
Slack,
Linear,
Github,
Teams,
Sharepoint,
ServiceNow,
Custom
source_metadata
Source Metadata · object | null
content_type
string | null
has_conversion
boolean | null
doc_metadata
Doc Metadata · object | null
name
string | null
prefix
string | null
uri
string | null
file_id
string<uuid> | null
run_id
string<uuid> | null
dismissed
boolean | null
warnings
any[] | null
needs_reingestion
boolean | null