POST
/
index
/
url

Headers

Authorization
string | null
index-id
string | null

filter by organization

Body

application/json
url
string
required

The URL of the file to be processed. Must be a valid HTTP or HTTPS URL.

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.

should_save
boolean | null
default: true

Indicates whether the processed file should be uploaded to S3 storage.

prevent_duplicate
boolean | null
default: false

Indicates whether to prevent duplicate processing of the same URL.

video_settings
object[] | null

Settings for video processing. Only applicable if the URL points to a video file.

image_settings
object | null

Settings for image processing. Only applicable if the URL points to an image file.

Response

200 - application/json
file_id
string
required

The unique identifier for the file

collection_id
string
required

The ID of the collection the file belongs to

status
string
required

The current status of the file processing

url
string | null

The URL where the file can be accessed

metadata
object | null

Additional metadata associated with the file

created_at
string | null
required

The timestamp when the file was created

error
string | null

The error message if the file processing failed

media_type
string | null

The type of media

task_id
string | null

The task ID

unique_hash
string | null

The unique hash of the file

updated_at
string | null

The timestamp when the file was last updated

Was this page helpful?

Index TextIndex Upload