POST
/
index
/
upload

The Index by File Upload endpoint allows you to upload and index a file directly. This is useful for processing and indexing local files or documents.

Request

file
file
required

The file to be uploaded and indexed

collection_id
string
required

The ID of the collection to index the content into

metadata
object

Additional metadata to associate with the indexed content

settings
object

Optional settings for processing the content (e.g., image caption model)

Response

message
string

A message indicating the status of the indexing process

task_id
string

A unique identifier for the indexing task

The indexing process is asynchronous. You can use the returned task_id to check the status of the indexing task if needed.

Was this page helpful?