Stock Photos

AutoGrab can provide a range of stock photos for usage in your applications.

Get stock photos from a Vehicle ID

get

Get stock photos from a Vehicle ID

Authorizations

ApiKeyAuth

ApiKeystringRequired

Path parameters

vehicle_idstringRequired

ID of the vehicle that you want to view stock photos of

Query parameters

colorstringOptional

The color of the vehicle that you want to return. Defaults to white if not specified or if there are no photos available for the color you requested

regionenum · enumOptional

The region to perform this request in

Example: {"value":"au"}Possible values:

reference_idstringOptional

An optional reference id which will be stored against usage records if supplied

Responses

200

Success

application/json

successbooleanOptionalDefault: true

400

Bad Request

application/json

401

Unauthorized

application/json

get

/v2/vehicles/{vehicle_id}/photos

HTTPcURLJavaScriptPython

GET /v2/vehicles/{vehicle_id}/photos HTTP/1.1
ApiKey: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "images": [
    {
      "type": "stock",
      "color": null,
      "url": "text",
      "match_confidence": "high"
    }
  ]
}

Example usage

For photos you already have the AGID For (from facets, VIN or Rego search in your context) you can now send that ID to the photos service to resolve to the most relevant image.

curl --location 'https://api.autograb.com.au/v2/vehicles/5674527417696256/photos?region=au' \
--header 'ApiKey: YOURKEY'

You can also specify the colour you're after with "&color=Black" or the like.

curl --location 'https://api.autograb.com.au/v2/vehicles/5674527417696256/photos?region=au&color=Black' \
--header 'ApiKey: YOURKEY'

Colour

A colour value is always returned, regardless of whether one is requested. If no colour is specified in the request, white is returned by default. Where white is unavailable, the next available colour is returned.

Match Confidence

Match confidence reflects the accuracy of the mapping between the supplied AutoGrab ID and the descriptors present on the image. This value is not always high.

A medium confidence score typically indicates variation in attributes such as drive type or fuel type — factors that do not necessarily affect the vehicle's visual presentation. A low confidence score suggests the mapping between the supplied ID and the vehicle is likely inaccurate.

        {
            "type": "generated",
            "color": "White",
            "url": "https://storage.googleapis.com/ag-vehicle-stock-images/9981807149433772/generic-hero-white-354313d0-5041-49e5-a024-5781852d6e9d.png",
            "match_confidence": "medium"
        },