import requests
url = "https://api.parallel.ai/v1/images/search"
payload = { "search_queries": ["<string>"] }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({search_queries: ['<string>']})
};
fetch('https://api.parallel.ai/v1/images/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api.parallel.ai/v1/images/search")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"search_queries\": [\n \"<string>\"\n ]\n}")
.asString();curl --request POST \
--url https://api.parallel.ai/v1/images/search \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"search_queries": [
"<string>"
]
}
'{
"search_id": "search_fcb2b4f3c75e418687bccaa1a8381331",
"session_id": "session_fcb2b4f3c75e418687bccaa1a8381331",
"results": [
{
"title": "Golden Gate Bridge at sunset",
"image_url": "https://www.example.com/images/golden-gate.jpg",
"source_page_url": "https://www.example.com/golden-gate-bridge",
"width": 1920,
"height": 1080
}
]
}{
"type": "error",
"error": {
"ref_id": "search_fcb2b4f3c75e418687bccaa1a8381331",
"message": "Request validation error"
}
}Image search
Searches the web for images.
import requests
url = "https://api.parallel.ai/v1/images/search"
payload = { "search_queries": ["<string>"] }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({search_queries: ['<string>']})
};
fetch('https://api.parallel.ai/v1/images/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api.parallel.ai/v1/images/search")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"search_queries\": [\n \"<string>\"\n ]\n}")
.asString();curl --request POST \
--url https://api.parallel.ai/v1/images/search \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"search_queries": [
"<string>"
]
}
'{
"search_id": "search_fcb2b4f3c75e418687bccaa1a8381331",
"session_id": "session_fcb2b4f3c75e418687bccaa1a8381331",
"results": [
{
"title": "Golden Gate Bridge at sunset",
"image_url": "https://www.example.com/images/golden-gate.jpg",
"source_page_url": "https://www.example.com/golden-gate-bridge",
"width": 1920,
"height": 1080
}
]
}{
"type": "error",
"error": {
"ref_id": "search_fcb2b4f3c75e418687bccaa1a8381331",
"message": "Request validation error"
}
}Authorizations
Body
Image search request.
Concise keyword image search queries. At least one query is required, and at most 5, each at most 200 characters.
5200Natural-language description of the images wanted. Used together with search_queries to focus results on the most relevant images. At most 5000 characters.
fast: lowest latency and cost. advanced (default): slower, with higher-quality results.
fast, advanced Session identifier that groups related calls made as part of a larger task. Echoed back in the response when nonempty; generated by the server if omitted, null, or empty.
1000The model generating this request and consuming the results.
"claude-opus-4-7"
Advanced configuration for location and result count.
Show child attributes
Show child attributes
Response
Successful Response
Image search response.
Search ID. Example: search_cad0a6d2dec046bd95ae900527d880e7
Session identifier, echoed back from the request when nonempty; otherwise generated by the server. Pass it to later calls made as part of the same task.
"session_8a911eb27c7a4afaa20d0d9dc98d07c0"
A list of image results, ordered by decreasing relevance.
Show child attributes
Show child attributes
Warnings for the search request, if any.
Show child attributes
Show child attributes
Usage metrics for the search request.
Show child attributes
Show child attributes