Skip to content

Upload one file into a collection

POST
/voice/collections/{collection_id}/files/upload

SPENDS CREDITS. Stores the file in the collection and indexes it for retrieval; the indexing embeds the text against a paid model, which is why this is billable like reindex and paste-text.

Voice extracts text from PDF, DOCX, spreadsheets, HTML and plain text; an unsupported type is voice’s own 4xx, forwarded.

Authorizations

Parameters

Path Parameters

collection_id
required

Collection id.

integer

Collection id.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
file
required

The document. 25 MB maximum.

string format: binary
folder_path

Folder inside the collection. Empty is the root.

string
""

Responses

201

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