POST
/
index
/
images
/
url

Headers

Authorization
string | null
index-id
string | null

filter by organization

Body

application/json
url
string
required

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

collection_id
string
required

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

asset_update
object | null

Asset update information for existing assets

metadata
object

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

should_save
boolean | null
default: true

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

prevent_duplicate
boolean | null
default: false

Indicates whether to prevent duplicate processing of the same URL.

image_settings
object | null

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

Response

200 - application/json
asset_id
string | null

The unique identifier for the asset

collection_id
string | null

The ID of the collection the asset belongs to

status
string | null

The current status of the asset processing

url
string | null

The URL where the asset can be accessed

metadata
object | null

Additional metadata associated with the asset

error
string | null

The error message if the asset processing failed

modality
string | null

The type of media

task_id
string | null

The task ID

unique_hash
string | null

The unique hash of the asset

updated_at
string | null

The timestamp when the asset was last updated

created_at
string | null

The timestamp when the asset was created

score
number | null

The relevance score of the asset

Was this page helpful?

Index TextIndex Video Url