curl --request POST \
--url https://api.octen.ai/image-search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"inputs": [
{
"type": "text",
"data": "Preview deployments card with dark theme"
}
],
"topic": "design",
"count": 3,
"include_domains": [
"unkey.dev",
"stripe.com",
"linear.app"
],
"html_snippet": {
"enable": true,
"max_tokens": 5000
}
}
'{
"code": 0,
"msg": "success",
"request_id": "req_9d1c4f7a2e6b0853",
"data": {
"results": [
{
"title": "Scandinavian Minimalist Living Room",
"url": "https://images.unsplash.com/photo-scandi-living-room.jpg",
"source_page": "https://unsplash.com/photos/scandi-living-room",
"description": "A Scandinavian minimalist living room with light wood flooring, an off-white sofa, and greenery; the composition is very close to the uploaded image.",
"width": 1920,
"height": 1280,
"thumbnail": "https://images.unsplash.com/photo-scandi-living-room.jpg?w=200"
},
{
"title": "Minimalist Interior Inspiration",
"url": "https://i.pinimg.com/originals/minimal-interior.jpg",
"source_page": "https://www.pinterest.com/pin/minimal-interior-inspiration",
"description": "Minimalist interior design inspiration; the palette and layout are close to the uploaded image.",
"width": 736,
"height": 981,
"thumbnail": "https://i.pinimg.com/236x/minimal-interior.jpg"
}
]
},
"meta": {
"usage": {
"num_search_queries": 1
},
"latency": 642
}
}Image Search
Searches the web for images. Setting topic to design searches design assets and returns a structured summary and a reusable html_snippet. Contact us to request beta access.
curl --request POST \
--url https://api.octen.ai/image-search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"inputs": [
{
"type": "text",
"data": "Preview deployments card with dark theme"
}
],
"topic": "design",
"count": 3,
"include_domains": [
"unkey.dev",
"stripe.com",
"linear.app"
],
"html_snippet": {
"enable": true,
"max_tokens": 5000
}
}
'{
"code": 0,
"msg": "success",
"request_id": "req_9d1c4f7a2e6b0853",
"data": {
"results": [
{
"title": "Scandinavian Minimalist Living Room",
"url": "https://images.unsplash.com/photo-scandi-living-room.jpg",
"source_page": "https://unsplash.com/photos/scandi-living-room",
"description": "A Scandinavian minimalist living room with light wood flooring, an off-white sofa, and greenery; the composition is very close to the uploaded image.",
"width": 1920,
"height": 1280,
"thumbnail": "https://images.unsplash.com/photo-scandi-living-room.jpg?w=200"
},
{
"title": "Minimalist Interior Inspiration",
"url": "https://i.pinimg.com/originals/minimal-interior.jpg",
"source_page": "https://www.pinterest.com/pin/minimal-interior-inspiration",
"description": "Minimalist interior design inspiration; the palette and layout are close to the uploaded image.",
"width": 736,
"height": 981,
"thumbnail": "https://i.pinimg.com/236x/minimal-interior.jpg"
}
]
},
"meta": {
"usage": {
"num_search_queries": 1
},
"latency": 642
}
}Authorizations
Bearer token used for request authentication. Alternatively, you can send the API key in the x-api-key header. Note: A payment method is required to use the API.
Body
Request body for the Image Search API.
Multimodal input array. Currently only a single input is supported: either one text input or one image input.
1 elementShow child attributes
Show child attributes
Use general for general image search, or design for design reference.
general, design Number of results to return.
1 <= x <= 10Domains to include, matched against each result's source_page URL.
Domains to exclude, matched against each result's source_page URL.
Controls filtering of explicit/adult content. off disables filtering; strict drops all adult content.
off, strict Only effective when topic=design; controls whether an html_snippet is returned for each result.
Show child attributes
Show child attributes
Response
Successful image search response
Was this page helpful?