{"openapi":"3.1.0","info":{"title":"Images","version":"1.0.0"},"paths":{"/v1/images":{"get":{"operationId":"returnsAListOfImagesHitsForQuery","summary":"Returns a list of images hits for query","description":"<Warning>\n  **Beta and unmaintained.** This endpoint works, but it is not under active development. The response shape and its availability can change without notice, so do not build a production dependency on it.\n</Warning>\n\nReturns the URLs of images associated to the user query.\n\nQuery operators such as `site:`, `filetype:` (for example, `filetype:png`), and `OR` are supported in `q`.\n\nAccess is limited to early access partners. To request access, email [api@you.com](mailto:api@you.com).","parameters":[{"name":"q","in":"query","description":"The search query used to retrieve relevant image results from the web. There is no server-side default: a missing or empty `q` returns `422`. A whitespace-only `q` is accepted and returns `200` with zero results, so do not treat it as an error.","required":true,"schema":{"type":"string"}},{"name":"count","in":"query","description":"The maximum number of image results to return. The supported range is 1–100, and the default is 10.","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":10}}],"responses":{"200":{"description":"A JSON object containing an array of image search results.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/returnsAListOfImagesHitsForQuery_Response_200"}}}},"401":{"description":"Unauthorized. Problems with API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnsAListOfImagesHitsForQueryRequestUnauthorizedError"}}}},"403":{"description":"Forbidden. API key lacks scope for this path.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnsAListOfImagesHitsForQueryRequestForbiddenError"}}}},"405":{"description":"Method Not Allowed. This endpoint accepts `GET` requests only.","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"Unprocessable Entity. The request is missing `q`, or `q` is empty.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnsAListOfImagesHitsForQueryRequestUnprocessableEntityError"}}}},"500":{"description":"Internal Server Error during authentication/authorization middleware. Also returned for a malformed `count` (a non-integer value) instead of `422`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnsAListOfImagesHitsForQueryRequestInternalServerError"}}}}},"security":[{"ApiKeyAuth":[]}]}}},"servers":[{"url":"https://api.you.com","description":"Production"}],"components":{"schemas":{"V1ImagesGetResponsesContentApplicationJsonSchemaImagesResultsItems":{"type":"object","properties":{"title":{"type":"string","description":"The title of the image result."},"page_url":{"type":"string","description":"The URL of the webpage containing the image."},"image_url":{"type":"string","description":"The direct URL to the image."},"thumbnail":{"type":"string","description":"The URL of a proxy-hosted thumbnail, usually served through `https://you.com/proxy?url=…`."},"large_thumbnail":{"type":"string","description":"The URL of a larger, transformer-resized image, usually served through `https://you.com/image-transformer?image=…`. The transformer can fail to fetch the origin image and return `403` (`ERROR 9408: Could not fetch…`). Fall back to `thumbnail` or `image_url` when that happens."}},"title":"V1ImagesGetResponsesContentApplicationJsonSchemaImagesResultsItems"},"V1ImagesGetResponsesContentApplicationJsonSchemaImages":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/V1ImagesGetResponsesContentApplicationJsonSchemaImagesResultsItems"}}},"title":"V1ImagesGetResponsesContentApplicationJsonSchemaImages"},"V1ImagesGetResponsesContentApplicationJsonSchemaMetadata":{"type":"object","properties":{"query":{"type":"string","description":"Returns the original query submitted."},"search_uuid":{"type":"string","description":"The unique identifier for the search request."}},"title":"V1ImagesGetResponsesContentApplicationJsonSchemaMetadata"},"returnsAListOfImagesHitsForQuery_Response_200":{"type":"object","properties":{"images":{"$ref":"#/components/schemas/V1ImagesGetResponsesContentApplicationJsonSchemaImages"},"metadata":{"$ref":"#/components/schemas/V1ImagesGetResponsesContentApplicationJsonSchemaMetadata"}},"title":"returnsAListOfImagesHitsForQuery_Response_200"},"ReturnsAListOfImagesHitsForQueryRequestUnauthorizedError":{"type":"object","properties":{"detail":{"type":"string","description":"Error detail message."}},"title":"ReturnsAListOfImagesHitsForQueryRequestUnauthorizedError"},"ReturnsAListOfImagesHitsForQueryRequestForbiddenError":{"type":"object","properties":{"detail":{"type":"string"}},"title":"ReturnsAListOfImagesHitsForQueryRequestForbiddenError"},"ReturnsAListOfImagesHitsForQueryRequestUnprocessableEntityError":{"type":"object","properties":{"error":{"type":"string"}},"title":"ReturnsAListOfImagesHitsForQueryRequestUnprocessableEntityError"},"ReturnsAListOfImagesHitsForQueryRequestInternalServerError":{"type":"object","properties":{"detail":{"type":"string"}},"title":"ReturnsAListOfImagesHitsForQueryRequestInternalServerError"}},"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"A unique API Key is required to authorize API access. For details, see how to [get your API Key](/quickstart#get-your-api-key)."}}}}