PUT
/
api
/
v0
/
documents
/
{document_id}
{
  "id": 123,
  "name": "<string>",
  "folder_id": 123,
  "file_path": "<string>",
  "file_type": "<string>",
  "file_url": "<string>",
  "summary": "<string>",
  "version": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Headers

​
authorization
string

Path Parameters

​
document_id
integer
required

Body

application/json
​
name
string | null
required

The name of the document

​
folder_id
integer | null
required

The ID of the folder containing the document

​
summary
string | null
required

The summary of the document

Response

200
application/json
Successful Response
​
id
integer
required

The ID of the document.

​
name
string
required

The name of the document.

​
folder_id
integer | null
required

The ID of the folder that contains the document.

​
file_path
string | null
required

The path to the document file.

​
file_type
string
required

The type of the document file. Options: pdf, docx, txt, html, md.

​
file_url
string | null
required

The URL of the document file.

​
summary
string
required

A summary of the document content.

​
version
integer
required

The version of the document.

​
created_at
string
required

The date and time the document was created.

​
updated_at
string
required

The date and time the document was last updated.