Skip to content

Update Library Document

PUT
/library/documents/{doc_id}

Update a document’s name, folder, metadata or text. FREE. New text is re-embedded.

Authorizations

Parameters

Path Parameters

doc_id
required

Library document id.

string

Library document id.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Partial update. New content is re-embedded.

object
content
Any of:
string
display_name
Any of:
string
folder_path
Any of:
string
meta_data
Any of:
object
key
additional properties
any

Responses

200

Successful Response

object
data
required

One Studio object, open-shaped. See the module docstring.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string