Image Search
The Image Search API allows you to search through your indexed images using natural language queries. Images must be uploaded with index: true to be searchable.
Prerequisites
Before using Image Search, ensure your images have been successfully indexed:
- Upload images with index=trueusing the/images/uploadendpoint
- Wait for indexing to complete
Search Images
Search through indexed images using natural language descriptions.
Endpoint
- POST /images/search
Request
Bash
Python
Parameters
- query(required): Natural language search query describing the image content you’re looking for
- max_results(optional): Maximum number of results to return (default: 10)
- threshold(optional): Minimum similarity threshold for results (0-1 scale)
Response
Returns an array of images matching the search query, ranked by relevance. Each result includes:
- image_id: Unique identifier for the image
- image_url: URL to access the image
- score: Relevance score (0-1 scale)
Use Cases
Image search is useful for:
- Content discovery: Find specific images in large collections
- Visual cataloging: Search product images by description
- Media management: Locate images based on visual content
- Quality control: Find images matching specific criteria