Skip to content

Rename or move a file within a collection

PUT
/voice/collections/{collection_id}/files/rename

Rename a file, move it between folders, or both in one call.

The vector rows follow the file - this is a rename, not a re-index, so retrieval keeps working and nothing is re-embedded.

Authorizations

Parameters

Path Parameters

collection_id
required

Collection id.

integer

Collection id.

Query Parameters

old_filename
required

Current file name.

string

Current file name.

new_filename
required

New file name.

string

New file name.

old_folder_path

Current folder. Empty is the root.

string
""

Current folder. Empty is the root.

new_folder_path

Target folder. Empty is the root.

string
""

Target folder. Empty is the root.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

One voice object - a collection, an agent, a route, a chat.

Open-shaped: voice adds fields to these bodies on its own release cadence and a dropped-or-added key must not be a 500 in this service.

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