Index image url
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
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'
Optional namespace for data isolation. Example: 'netflix_prod' or 'spotify_recs_dev'. To create a namespace, use the /namespaces endpoint.
The URL of the asset to be processed. Must be a valid HTTP or HTTPS URL.
Unique identifier for the collection where the processed asset will be stored.
Asset update information for existing assets
Unique identifier for the asset to be updated
Update mode: 'replace' or 'append'
Additional metadata associated with the asset. Can include any key-value pairs relevant to the asset.
Settings for percolating the asset against stored queries.
Whether to enable percolator matching for this request
Minimum similarity score (0-1) required for a match. Higher values mean stricter matching.
Maximum number of matching percolators to return in the response
Skips processing when a duplicate hash is found and stores an error by the task_id with the existing asset_id
Settings for image processing. Only applicable if the URL points to an image file.
Settings for reading and analyzing image content.
Enable image reading
Prompt for reading on-screen text
JSON format for the response
Name of the vector model to use for embedding the text output. If vector_index is duplicated, the vector will be overwritten.
List of embedding settings for generating multiple embeddings. For now, if url is provided, value must be None.
Settings for generating image descriptions.
Prompt for image description
Enable image description
Maximum length of the description
JSON format for the response
Name of the vector model to use for embedding the text output. If vector_index is duplicated, the vector will be overwritten.
Settings for object detection in images.
Settings for face detection
Enable face detection
Minimum confidence threshold for detected objects
Settings for logo detection
Enable logo detection
Minimum confidence threshold for detected logos
Settings for structured JSON output of image analysis.
Headers
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'
Optional namespace for data isolation. Example: 'netflix_prod' or 'spotify_recs_dev'. To create a namespace, use the /namespaces endpoint.
Body
The URL of the asset to be processed. Must be a valid HTTP or HTTPS URL.
Unique identifier for the collection where the processed asset will be stored.
Additional metadata associated with the asset. Can include any key-value pairs relevant to the asset.
Settings for percolating the asset against stored queries.
Whether to enable percolator matching for this request
Minimum similarity score (0-1) required for a match. Higher values mean stricter matching.
Maximum number of matching percolators to return in the response
Skips processing when a duplicate hash is found and stores an error by the task_id with the existing asset_id
Settings for image processing. Only applicable if the URL points to an image file.
Settings for reading and analyzing image content.
Enable image reading
Prompt for reading on-screen text
JSON format for the response
Name of the vector model to use for embedding the text output. If vector_index is duplicated, the vector will be overwritten.
image, multimodal, text, keyword List of embedding settings for generating multiple embeddings. For now, if url is provided, value must be None.
Type of input to embed
url, text, file, base64 The input content to embed. Could be a URL, text content, file path, or base64 encoded string
Name of the vector index to use for embedding
image, multimodal, text, keyword Field name to insert into the database, if not provided, the embedding will be inserted into the default field
Settings for generating image descriptions.
Prompt for image description
Enable image description
Maximum length of the description
JSON format for the response
Name of the vector model to use for embedding the text output. If vector_index is duplicated, the vector will be overwritten.
image, multimodal, text, keyword Settings for object detection in images.
Was this page helpful?