Skip to main content
POST
/
v1
/
knowledge-bases
/
{knowledge_base_id}
/
document
Add Knowledge Base Document
curl --request POST \
  --url https://api.example.com/v1/knowledge-bases/{knowledge_base_id}/document \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "prefix": "/",
  "doc_metadata": {},
  "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "summary": "<string>",
  "error": {},
  "updated_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "size": 123,
  "short_summary": "<string>",
  "doc_type": "<string>",
  "source_metadata": {},
  "content_type": "<string>",
  "has_conversion": true,
  "doc_metadata": {},
  "name": "<string>",
  "prefix": "<string>",
  "uri": "<string>",
  "file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "dismissed": true,
  "warnings": [
    "<unknown>"
  ],
  "needs_reingestion": true
}

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
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
​
content_type
string | null
​
has_conversion
boolean | null
​
doc_metadata
Doc Metadata · object
​
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