Skip to main content
PATCH
/
user
/
document
/
{knowledge_id}
Update Document
curl --request PATCH \
  --url https://api.example.com/user/document/{knowledge_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "folder_path": "<string>",
  "status": "<string>",
  "chunk_count": 123,
  "progress": 123,
  "error_message": "<string>"
}
'
{
  "knowledge_id": 123,
  "owner_id": 123,
  "name": "<string>",
  "file_format": "<string>",
  "file_size_bytes": 123,
  "status": "<string>",
  "chunk_count": 123,
  "progress": 123,
  "uploaded_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "folder_path": "<string>",
  "error_message": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
knowledge_id
integer
required
Required range: x >= 1

Body

application/json
​
name
string | null
​
folder_path
string | null
​
status
string | null
​
chunk_count
integer | null
​
progress
integer | null
​
error_message
string | null

Response

Successful Response

​
knowledge_id
integer
required
​
owner_id
integer
required
​
name
string
required
​
file_format
string
required
​
file_size_bytes
integer
required
​
status
string
required
​
chunk_count
integer
required
​
progress
integer
required
​
uploaded_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
folder_path
string | null
​
error_message
string | null