POST
/
ingest
/
images
/
url

Headers

​
Authorization
string | null

Bearer token authentication using your API key. Format: 'Bearer your_api_key'. To get an API key, create an account at mixpeek.com/start and generate a key in your account settings. Example: 'Bearer sk_1234567890abcdef'

​
X-Namespace
string | null

Optional namespace for data isolation. This can be a namespace name or namespace ID. Example: 'netflix_prod' or 'ns_1234567890'. To create a namespace, use the /namespaces endpoint.

Body

application/json
​
url
string
required

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

​
collection
string
required

Unique identifier for the collection where the processed asset will be stored, can be the collection name or collection ID. If neither exist, the collection will be created.

​
asset_update
object | null

Controls how processing results are stored - either creating a new asset or updating an existing one.

​
metadata
object

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

​
percolate
object | null

Settings for percolating the asset against stored queries.

​
skip_duplicate
boolean | null
default: true

Makes feature extraction idempotent. When True and a duplicate file hash is found, copies features from the existing asset instead of reprocessing. This allows the same file to be used multiple times with different metadata while avoiding redundant processing.

​
feature_extractors
object | null

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

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?

Ingest Video UrlGet Feature