Image Management
The Vision API provides endpoints for managing images in your account. You can upload images for indexing, retrieve image details, list images with filters, and delete images when no longer needed. While video search is ideal for more complex use cases that require video context and understanding, for the majority of simple use cases, image upload and search has similiar accuracy to video search but with significantly faster processing and lower costs.
Upload Images
Upload one or more images to your account with optional indexing.
Endpoint
- POST /images/upload
Request
Bash
Python
Parameters
- images(required): Image file(s) to upload
- metadata(optional): JSON object containing configuration for each image:- indexing_config: Configuration for indexing- index: Boolean indicating whether to index the image
 
- metadata: Custom metadata for the image
 
Response
Returns an array of image upload results with:
- image_id: Unique identifier for the uploaded image
- image_url: URL to access the uploaded image
- indexing_status: Indexing status (1 = indexing in progress, 2 = indexed)
- image_metadata: Custom metadata fields for the image
- upload_timestamp: Unix timestamp of when the image was uploaded
Get Images
Retrieve details for specific images by their IDs.
Endpoint
- POST /images/get
Request
Bash
Python
Parameters
- image_ids(required): Array of image IDs to retrieve
Response
Returns an array of image objects with the same structure as the upload response.
List Images
List images in your account with optional filtering and pagination.
Endpoint
- POST /images/list
Request
Bash
Python
Parameters
- limit(optional): Maximum number of images to return
- offset(optional): Number of images to skip for pagination
- filters(optional): Filter criteria for images:- recorded_timestamp_utc: Filter by timestamp- operator: Filter operator (e.g., “range”)
- value: Filter values- _from: Start timestamp
- _to: End timestamp
 
 
 
Response
Returns a paginated array of images matching the filter criteria, with the same structure as the upload and get responses.
Delete Images
Delete one or more images from your account.
Endpoint
- POST /images/delete
Request
Bash
Python
Parameters
- image_ids(required): Array of image IDs to delete
Response
Returns a confirmation message indicating the images were deleted successfully.