POST
/
index
/
text

Headers

Authorization
string | null
index-id
string | null

filter by organization

Body

application/json
text
string
required

The text to be processed.

collection_id
string
required

Unique identifier for the collection where the processed file will be stored.

file_id
string | null

Unique identifier for the file to be processed. If provided, feature extraction will be performed and the results will be upserted with the existing file_id. If not provided, a random UUID will be generated.

metadata
object

Additional metadata associated with the file. Can include any key-value pairs relevant to the file.

text_settings
object | null

Settings for text processing.

Response

200 - application/json
message
string
required

A message describing the status of the task

task_id
string
required

The unique identifier for the processing task

Was this page helpful?

Index Url