GET
/
images
Returns a list of images hits for query
curl --request GET \
  --url https://image-search.ydc-index.io/images \
  --header 'X-API-Key: <api-key>'
{
  "images": {
    "results": [
      {
        "title": "8 Test Day Tips for Success",
        "page_url": "https://www.c2educate.com/8-test-day-tips-success/",
        "image_url": "https://s26378.pcdn.co/wp-content/uploads/sat-or-act-test-1030x519.jpg"
      }
    ]
  },
  "metadata": {
    "query": "test",
    "search_uuid": "c6c8f8cf-b6fc-4248-9828-24fc0dcf7be5"
  }
}
The You.com Image Search is currently available to exclusive early access partnersTo express interest in early access, please reach out via email to api@you.com
The correct cURL code to use in your API call is in the playground. Click on Try it in the bar above to open the playground.

​
Description

This endpoint returns the URLs of images associated to the user query.

​
Errors

The endpoint returns as a structured JSON object with status, code, title, and detail fields:
HTTPCodeWhen it happens
401bad_requestThis can happen for a missing API key: {"detail": "API key is required"}, an invalid/expired API key: {"detail": "Invalid or expired API key"} or for other auth parsing errors: {"detail": "<error message>"}
403forbiddenAPI key lacks scope for the path (e.g., /images): {"detail": "Missing required scopes"}
500Internal Server Error (auth/authorization middleware)This can happen in the case of authentication failure: {"detail": "Internal authentication error"} or authorization failure: {"detail": "Internal authorization error"}

Authorizations

​
X-API-Key
string
header
required

A unique API Key required to authorize API access. Ensure it is kept confidential. Get a free API Key at you.com/platform.

Query Parameters

​
q
string
default:The image you are searching for
required

Search query used to retrieve relevant results from index

Response

A JSON object containing an array of image search results

​
images
object
​
metadata
object