Image Search

Searches the web for images.

post/v1/images/search

Request

  • Base URL
    https://api.parallel.ai
  • Auth
    API key in header x-api-key

Request body

objectivestring nullable

Natural-language description of the images wanted. Used together with search_queries to focus results on the most relevant images. At most 5000 characters.

search_queriesstring[] required

Concise keyword image search queries. At least one query is required, and at most 5, each at most 200 characters.

mode'fast' | 'advanced' nullable

fast: lowest latency and cost. advanced (default): slower, with higher-quality results.

session_idstring nullable

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.

client_modelstring nullable

The model generating this request and consuming the results.

Example request

{
  "client_model": "claude-opus-4-7",
  "advanced_settings": {
    "location": "us"
  }
}

Response

Successful Response

search_idstring required

Search ID. Example: search_cad0a6d2dec046bd95ae900527d880e7

session_idstring required

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.

Example response

{
  "session_id": "session_8a911eb27c7a4afaa20d0d9dc98d07c0",
  "warnings": [
    {
      "type": "spec_validation_warning"
    }
  ],
  "usage": [
    {
      "name": "sku_search",
      "count": 1
    }
  ]
}

Changes