Skip to main content
PATCH
Update a document

Authorizations

Authorization
string
header
required

A Bearer token. Create keys in the portal under Settings > API keys (https://app.ryvo.so/developers). The token has the form ryvo_live_<64 hex characters> and is shown once.

Header: Authorization: Bearer ryvo_live_...

Path Parameters

id
string<uuid>
required

The document uuid.

Body

application/json
title
string
Required string length: 1 - 200
folder_id
string<uuid> | null

null moves the document to the root.

auto_refresh
boolean

Only accepted on url documents.

Response

The document after the update.

id
string<uuid>
required
Example:

"9b1c2d3e-4f50-4a6b-8c7d-0e1f2a3b4c5d"

title
string
required
Example:

"Price list 2026.pdf"

source
enum<string>
required
Available options:
upload,
url
Example:

"upload"

source_url
string | null
required
Example:

null

mime
string | null
required
Example:

"application/pdf"

bytes
integer
required
Example:

184320

status
enum<string>
required
Available options:
processing,
ready,
error
Example:

"ready"

folder_id
string<uuid> | null
required
auto_refresh
boolean
required

Only meaningful on url documents.

last_refreshed_at
string<date-time> | null
required
last_refresh_error
string | null
required
chunks
integer
required

Indexed fragments. The visible proof that the document is searchable.

Example:

37

agents
object[]
required

The agents whose published version consults this document, directly or through its folder.

created_at
string<date-time>
required
updated_at
string<date-time>
required