# Table of Contents - [Introduction | Evox API Documentation](#introduction-evox-api-documentation) - [Getting Started | Evox API Documentation](#getting-started-evox-api-documentation) - [Changelog | Evox API Documentation](#changelog-evox-api-documentation) - [Authentication | Evox API Documentation](#authentication-evox-api-documentation) - [Product Catalog - USA | Evox API Documentation](#product-catalog-usa-evox-api-documentation) - [Errors | Evox API Documentation](#errors-evox-api-documentation) - [Vids | Evox API Documentation](#vids-evox-api-documentation) - [Spec Guides | Evox API Documentation](#spec-guides-evox-api-documentation) - [/vids/:vid | Evox API Documentation](#-vids-vid-evox-api-documentation) - [/vids/:vid/products/:productId/:productTypeId | Evox API Documentation](#-vids-vid-products-productid-producttypeid-evox-api-documentation) - [Vehicles | Evox API Documentation](#vehicles-evox-api-documentation) - [/vehicles/:vifnum | Evox API Documentation](#-vehicles-vifnum-evox-api-documentation) - [/vehicles/:vifnum/stills | Evox API Documentation](#-vehicles-vifnum-stills-evox-api-documentation) - [/vehicles/:vifnum/products/:productId/:productTypeId | Evox API Documentation](#-vehicles-vifnum-products-productid-producttypeid-evox-api-documentation) - [/vehicles | Evox API Documentation](#-vehicles-evox-api-documentation) - [/makes | Evox API Documentation](#-makes-evox-api-documentation) - [Products | Evox API Documentation](#products-evox-api-documentation) - [Btllists | Evox API Documentation](#btllists-evox-api-documentation) - [Mappings | Evox API Documentation](#mappings-evox-api-documentation) - [/products | Evox API Documentation](#-products-evox-api-documentation) - [Makes | Evox API Documentation](#makes-evox-api-documentation) - [/mappings | Evox API Documentation](#-mappings-evox-api-documentation) - [/products/:productId | Evox API Documentation](#-products-productid-evox-api-documentation) - [/vehicles/:vifnum/colors | Evox API Documentation](#-vehicles-vifnum-colors-evox-api-documentation) - [/vehicles/:vifnum/hotspots | Evox API Documentation](#-vehicles-vifnum-hotspots-evox-api-documentation) - [/btllists | Evox API Documentation](#-btllists-evox-api-documentation) - [Viflist | Evox API Documentation](#viflist-evox-api-documentation) - [/viflists | Evox API Documentation](#-viflists-evox-api-documentation) - [Contact Us | Evox API Documentation](#contact-us-evox-api-documentation) - [Legal | Evox API Documentation](#legal-evox-api-documentation) - [Spec Guides | Evox API Documentation](#spec-guides-evox-api-documentation) - [Contact Us | Evox API Documentation](#contact-us-evox-api-documentation) --- # Introduction | Evox API Documentation [](https://evoximages.gitbook.io/docs#introduction) Introduction --------------------------------------------------------------------- Welcome to the Evox Images API documentation. You can use our API to access Evox Images automotive image solutions, videos, and data for thousands of vehicles from our asset library. Anyone can use our API. We've tried to make this documentation user-friendly and example-filled, but if you have any questions, you can reach us through our Help Center. The Evox Images Application Programming Interface (API) is a RESTful JSON API. All requests are authenticated by API tokens. [NextGetting Started](https://evoximages.gitbook.io/docs/get-started) Last updated 4 years ago --- # Getting Started | Evox API Documentation [](https://evoximages.gitbook.io/docs/get-started#get-your-api-token) Get your API Token --------------------------------------------------------------------------------------------- 1. An EVOX representative will send you and email with your credentials. 2. If you need assistance, email api-support@evox.com Make sure that your token is never exposed client-side. Anyone with access to your token can accrue charges to your account. [](https://evoximages.gitbook.io/docs/get-started#making-a-request) Making a request ----------------------------------------------------------------------------------------- All URLs start with our domain and host followed by the current API version number. If we change the API in backward-incompatible ways, we'll bump the version marker and maintain stable support for the old URLs. Copy https://api.evoximages.com/api/v1 [](https://evoximages.gitbook.io/docs/get-started#endpoints) Endpoints --------------------------------------------------------------------------- Resource Method Endpoint ​[Vehicles](https://evoximages.gitbook.io/api/~/drafts/-LTxHhZ-Gq2ElLzek85f/primary/resources/endpoints) ​ `GET` ​[/vehicles](https://evoximages.gitbook.io/docs/resources/endpoints/vehicles) [/vehicles/:vifnum](https://evoximages.gitbook.io/docs/resources/endpoints/vehicles-vifnum) [/vehicles/:vifnum/products/:productId/](https://evoximages.gitbook.io/docs/resources/products-1/untitled) [/vehicles/:vifnum/products/:productId/:productTypeId](https://evoximages.gitbook.io/docs/resources/endpoints/vehicles-vifnum-products-productid-producttypeid) [/vehicles/:vifnum/stills](https://evoximages.gitbook.io/docs/resources/endpoints/vehicles-vifnum-stills) [/vehicles/:vifnum/colors](https://evoximages.gitbook.io/docs/resources/endpoints/vehicles-vifnum-colors) ​ ​[Vids](https://evoximages.gitbook.io/docs/resources/vids) `GET` [/vids/:vid](https://evoximages.gitbook.io/docs/resources/vids/vids-vid-1) [/vids/:vid/products/:productId/:productTypeId](https://evoximages.gitbook.io/docs/resources/vids/vids-vid-products-productid-producttypeid) ​[Products](https://evoximages.gitbook.io/api/~/drafts/-LTxHhZ-Gq2ElLzek85f/primary/resources/products-1) ​ `GET` ​[/products](https://evoximages.gitbook.io/api/~/drafts/-LTxHhZ-Gq2ElLzek85f/primary/resources/products-1/untitled-1) ​ ​[/products/:productId](https://evoximages.gitbook.io/api/~/drafts/-LTxHhZ-Gq2ElLzek85f/primary/resources/products-1/untitled) ​ ​[Makes](https://evoximages.gitbook.io/api/~/drafts/-LTxHhZ-Gq2ElLzek85f/primary/resources/makes) ​ `GET` ​[/makes](https://evoximages.gitbook.io/api/~/drafts/-LTxHhZ-Gq2ElLzek85f/primary/resources/makes/untitled) ​ [](https://evoximages.gitbook.io/docs/get-started#api-implementation-details) API implementation details ------------------------------------------------------------------------------------------------------------- * The Evox Images API uses HTTPS response codes to indicate status and errors. * The API uses UTF-8 character encoding for all responses. #### [](https://evoximages.gitbook.io/docs/get-started#documentation-conventions) Documentation Conventions * `:text` Indicates a parameter where _text_ should be replaced by the appropriate data. * `...` Indicates content from a response body that has been edited for brevity. #### [](https://evoximages.gitbook.io/docs/get-started#rate-limiting) Rate Limiting The Evox Images API is rate limited to a certain number per minute per API Token. We reserve the right to adjust the rate limit for given endpoints in order to provide a high quality of service for all customers. You can perform up to 500 requests per second from the same IP address for the same account. The API will respond with a [HTTP 429 Too Many Requests](http://en.wikipedia.org/wiki/List_of_HTTP_status_codes) response code when the limit is reached. [](https://evoximages.gitbook.io/docs/get-started#tracking-usage) Tracking usage ------------------------------------------------------------------------------------- All Evox Images API assets are distributed through Amazon Cloudfront instances. Each user will have a personal Cloudfront base url to track usage. This base url is appended to resource urls on API endpoints that return assets. All accrued charges from accessing assets stored in these instances will be tied back to your account. #### [](https://evoximages.gitbook.io/docs/get-started#example) **Example** Copy https://dgvvcmxxxxt02.cloudfront.net/ [](https://evoximages.gitbook.io/docs/get-started#curl) cURL ----------------------------------------------------------------- Throughout the Evox Images API docs, we include cURL examples. To try the examples in your shell, include your `API key` as a custom header for each request. Copy curl -H "x-api-key:XZsXje95im3Hal6UapnyRQXXXXXXXXXX" "https://api.evoximages.com/..." You should be able to copy/paste any example from the docs. After pasting a cURL example, you can pipe it to a JSON pretty printer to make it more readable. Try [jsonpp](https://jmhodges.github.io/jsonpp/) or `json_pp` on OSX: Copy curl -H "x-api-key:XZsXje95im3Hal6UapnyRQXXXXXXXXXX" "https://api.evoximages.com/..." | json_pp ​ [](https://evoximages.gitbook.io/docs/get-started#sample-request-for-a-vehicles-color) Sample request for a vehicle's color -------------------------------------------------------------------------------------------------------------------------------- Once you have access to an API key and have been assigned a Cloudfront base URI, you may start accessing Evox API endpoints. Below is a sample request for all available `color` options on the 2018 Nissan Sentra: Copy curl -H "x-api-key:XZsXje95im3Hal6UapnyRQXXXXXXXXXX" "https://api.evoximages.com/api/v1/vehicles/12626/colors" Response Body Copy { "status": "success", "data": [\ {\ "vifnum": 12626,\ "code": "A20",\ "title": "Red Alert",\ "simpletitle": "Red",\ "rgb1": "94141C",\ "rgb2": "",\ "shotin": 0,\ "id": 117408\ },\ {\ "vifnum": 12626,\ "code": "K23",\ "title": "Brilliant Silver",\ "simpletitle": "Silver",\ "rgb1": "AAAAAA",\ "rgb2": "",\ "shotin": 0,\ "id": 117409\ },\ ...\ ] } [](https://evoximages.gitbook.io/docs/get-started#glossary) Glossary ------------------------------------------------------------------------- ### [](https://evoximages.gitbook.io/docs/get-started#vifnum) `vifnum` `vifnum` is a unique identifier for a specific set of media for one vehicle's trim. * Some vehicles have multiple trims, thus a vehicle with the same make and model may have multiple `vifnum`(s) associated with it. * `vifnum` is a required parameter for any resource that returns assets for one vehicle. ### [](https://evoximages.gitbook.io/docs/get-started#trim) `trim` `trim` levels are used by manufacturers to identify a vehicle's level of equipment or special features. [PreviousIntroduction](https://evoximages.gitbook.io/docs) [NextAuthentication](https://evoximages.gitbook.io/docs/authentication) Last updated 4 years ago --- # Changelog | Evox API Documentation [](https://evoximages.gitbook.io/docs/changelog#id-1.0.3-tbd) 1.0.3 - tbd ------------------------------------------------------------------------------ **Added** * New endpoint: `/viflists`returns viflist files in various extensions. **Changed** * Strict querying for models that contain a space. * `?model="Corolla Hybrid"` no longer returns vehicles for both "Hybrid"s and "Corolla"s. [](https://evoximages.gitbook.io/docs/changelog#id-1.0.2-2019-11-18) 1.0.2 - 2019-11-18 -------------------------------------------------------------------------------------------- **Added** * /models returns a list of all available vehicle models by vehicle make **Changed** * /makes returns all vehicles makes in a single array instead of key value pairs e.g. { "make" : "Acura" } [](https://evoximages.gitbook.io/docs/changelog#undefined) -------------------------------------------------------------- [PreviousAuthentication](https://evoximages.gitbook.io/docs/authentication) [NextErrors](https://evoximages.gitbook.io/docs/error-codes) Last updated 5 years ago --- # Authentication | Evox API Documentation [](https://evoximages.gitbook.io/docs/authentication#authentication) Authentication ---------------------------------------------------------------------------------------- ### [](https://evoximages.gitbook.io/docs/authentication#api-keys) API keys Once you've completed the sign up process and acknowledged our terms, we'll provide an`API key` . The `API key` is required for every request to the API passed either as a query parameter in the url or in the HTTPS Header. #### [](https://evoximages.gitbook.io/docs/authentication#as-a-query-parameter-in-the-url) As a query parameter in the url Copy https://api.evoximages.com/api/v1/..../?api_key=XZsXje95im3Hal6UapnyRQXXXXXXXXXX #### [](https://evoximages.gitbook.io/docs/authentication#as-a-custom-https-header) As a custom HTTPS Header Copy "x-api-key" : "XZsXje95im3Hal6UapnyRQXXXXXXXXXX" Remember that anyone who has your API key can see everything you have access to. So you want to guard that and keep it private. If you come to fear that it has been compromised, please contact api-support@evox.com to generate a new key. [](https://evoximages.gitbook.io/docs/authentication#authorization) Authorization -------------------------------------------------------------------------------------- ### [](https://evoximages.gitbook.io/docs/authentication#access-to-products) Access to products Evox Images API endpoints that return products or resource URIs can only be accessed if the user has permissions. To see a list of products the user has access to, query the `/products` endpoint using the `API key` that is associated with the account. Copy curl -H "x-api-key:XZsXje95im3Hal6UapnyRQXXXXXXXXXX" "http://api.evoximages.com/api/v1/products" Response Copy HTTP/1.1 200 OK { "status": "success", "data": [\ {\ "id": 78,\ "name": "exterior_vr_gear",\ "product_id": 5\ },\ {\ "id": 134,\ "name": "interior_vr_gear",\ "product_id": 14\ }\ ] } [PreviousGetting Started](https://evoximages.gitbook.io/docs/get-started) [NextChangelog](https://evoximages.gitbook.io/docs/changelog) Last updated 4 years ago --- # Product Catalog - USA | Evox API Documentation This chart is a comprehensive list of products accessible through the Evox Images API. Use this table in conjunction with the [Vehicle Products](https://evoximages.gitbook.io/docs/resources/endpoints/vehicles-vifnum-products-productid-producttypeid#vehicle-products) endpoint to access resources for one vehicle: Copy https://api.evoximages.com/api/v1/vehicles/:vifnum/products/:productId/:productTypeId [](https://evoximages.gitbook.io/docs/product-chart#sample-request-for-3-angle-colors) Sample request for 3-Angle Colors ----------------------------------------------------------------------------------------------------------------------------- Product Category productId productTypeId Color 2 41 Copy https://api.evoximages.com/api/v1/vehicles/12234/products/2/41 ![](https://evoximages.gitbook.io/docs/~gitbook/image?url=https%3A%2F%2F3981408997-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-legacy-files%2Fo%2Fassets%252F-LI7Ux5UuvCq0jrdCJDm%252F-LQ5HVkmQR5dHyUX6DF9%252F-LQ5IVQ-bd3dthk1WczW%252F12234_cc0640_032_0C.png%3Falt%3Dmedia%26token%3D953d0fd4-be7d-4bd4-91a4-0f836af98ce9&width=768&dpr=4&quality=100&sign=3f78316b&sv=2) [](https://evoximages.gitbook.io/docs/product-chart#product-chart) Product chart ------------------------------------------------------------------------------------- Product Id Product Category Product Type ID Product Types 2 Color 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 color\_0320\_001 color\_0320\_014 color\_0320\_032 color\_0480\_001 color\_0480\_014 color\_0480\_032 color\_0640\_001 color\_0640\_001\_png color\_0640\_014 color\_0640\_014\_png color\_0640\_032 color\_0640\_032\_png color\_1280\_001 color\_1280\_014 color\_1280\_032 color\_2400\_001 color\_2400\_001\_png color\_2400\_014 color\_2400\_014\_png color\_2400\_032 color\_2400\_032\_png 27 Front 3/4 (colorized) 210 211 212 213 214 215 216 color\_0320\_032 color\_0480\_032 color\_0640\_032 color\_0640\_032\_png color\_1280\_032 color\_2400\_032 color\_2400\_032\_png 3 Exterior 58 63 64 67 68 69 70 71 exterior\_001\_spinframes\_0080 exterior\_036\_ios\_0480 exterior\_036\_ios\_1024 exterior\_036\_spinframes\_0640 exterior\_036\_spinframes\_0640\_png exterior\_036\_spinframes\_1280 exterior\_036\_spinframes\_2400 exterior\_036\_spinframes\_2400\_png 4 Editorial 56 editorial\_mp4\_0640 4 Editorial 2.0 271 272 273 editorial02\_mp4\_0320 editorial02\_mp4\_0640 editorial02\_mp4\_1920 5 Exterior\_VR\_Gear 78 exterior\_vr\_gear 7 Exterior\_VR\_Relaycars6 81 exterior\_vr\_relaycars6 9 Flyaround 95 96 99 100 103 104 flyaround02\_05s\_mp4\_0320 flyaround02\_05s\_mp4\_0640 flyaround02\_15s\_mp4\_0320 flyaround02\_15s\_mp4\_0640 flyaround02\_30s\_mp4\_0320 flyaround02\_30s\_mp4\_0640 10 HDClips 107 108 hdclips\_mp4\_0320 hdclips\_mp4\_0640 11 HDSpin 111 112 115 116 119 120 hdspin\_05s\_mp4\_0320 hdspin\_05s\_mp4\_0640 hdspin\_15s\_mp4\_0320 hdspin\_15s\_mp4\_0640 hdspin\_mp4\_0320 hdspin\_mp4\_0640 12 Interior 121 122 204 205 interior\_036\_panoframes\_0480 interior\_036\_panoframes\_1280 interior\_eq\_4000 interior\_eq\_8000 14 Interior\_VR\_Gear 134 interior\_vr\_gear 18 SGVideo 151 152 sgvideo\_mp4\_0320 sgvideo\_mp4\_0640 20 Splash\_Standard 157 158 159 160 splash\_standard\_0320 splash\_standard\_0640 splash\_standard\_1280 splash\_standard\_2400\_tif 21 Stills 161 162 163 164 165 166 stills\_0320 stills\_0480 stills\_0640 stills\_0640\_png stills\_1280\_png stills\_2400\_png 22 Stills\_Mini 22 stills\_mini 23 Stills\_White 168 171 172 173 174 stills\_white\_0080 stills\_white\_0640 stills\_white\_1280 stills\_white\_2400 stills\_white\_2400\_tif 28 Stills\_No\_CR 218 219 220 221 222 223 224 225 226 227 228 229 230 231 stills\_0320 stills\_0480 stills\_0640 stills\_0640\_png stills\_1280\_png stills\_2400\_png stills\_mini stills\_white\_0080 stills\_white\_0320 stills\_white\_0480 stills\_white\_0640 stills\_white\_1280 stills\_white\_2400 stills\_white\_2400\_tif 29 Color\_No\_CR 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 color\_0320\_001 color\_0320\_014 color\_0320\_032 color\_0480\_001 color\_0480\_014 color\_0480\_032 color\_0640\_001 color\_0640\_001\_png color\_0640\_014 color\_0640\_014\_png color\_0640\_032 color\_0640\_032\_png color\_1280\_001 color\_1280\_014 color\_1280\_032 color\_2400\_001 color\_2400\_001\_png color\_2400\_014 color\_2400\_014\_png color\_2400\_032 color\_2400\_032\_png 31 Color\_no\_cr (Front 3/4) 256 257 258 259 260 261 262 color\_0320\_032 color\_0480\_032 color\_0640\_032 color\_0640\_032\_png color\_1280\_032 color\_2400\_032 color\_2400\_032\_png Copy https://api.evoximages.com/api/v1/vids/:vid/products/:productId/:productTypeId Copy https://api.evoximages.com/api/v1/vids/42662/products/1/26 Product Id Product Category Product Type ID Product Types **PLEASE NOTE:** BTL, FLL & NRL all use VID's not VIF's for the query structure. **To fetch the list of VID's, use the following endpoint:** [http://api.evoximages.com/api/v1/btllists](http://api.evoximages.com/api/v1/btllists) 1 BTL 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 BTL\_0480\_001 BTL\_0480\_014 BTL\_0480\_032 BTL\_0640\_001 BTL\_0640\_001\_png BTL\_0640\_014 BTL\_0640\_014\_png BTL\_0640\_032 BTL\_0640\_032\_png BTL\_1280\_001 BTL\_1280\_014 BTL\_1280\_032 BTL\_2400\_001 BTL\_2400\_001\_png BTL\_2400\_014 BTL\_2400\_014\_png BTL\_2400\_032 BTL\_2400\_032\_png 8 FLL 83 84 85 86 87 88 FLL\_0640\_001 FLL\_0640\_014 FLL\_0640\_032 FLL\_1920\_001 FLL\_1920\_014 FLL\_1920\_032 17 NRL 139 140 141 142 143 144 NRL\_stills\_0640\_001 NRL\_stills\_0640\_014 NRL\_stills\_0640\_032 NRL\_stills\_1920\_001 NRL\_stills\_1920\_014 NRL\_stills\_1920\_032 35 MDL\_3D 268 269 MDL\_3D\_opensrc\_glb MDL\_3D\_quicklook\_usdz 39 MDL\_360spinframes 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 MDL\_360spin\_0320\_mp4 MDL\_360spin\_0640\_mp4 MDL\_360spin\_1920\_mp4 MDL\_360spinframes\_0480 MDL\_360spinframes\_0480\_nc MDL\_360spinframes\_0480\_nc\_png MDL\_360spinframes\_0480\_png MDL\_360spinframes\_0480HD MDL\_360spinframes\_0480HD\_nc MDL\_360spinframes\_0480HD\_nc\_png MDL\_360spinframes\_0480HD\_png MDL\_360spinframes\_0640 MDL\_360spinframes\_0640\_nc MDL\_360spinframes\_0640\_nc\_png MDL\_360spinframes\_0640\_png MDL\_360spinframes\_0640HD MDL\_360spinframes\_0640HD\_nc MDL\_360spinframes\_0640HD\_nc\_png MDL\_360spinframes\_0640HD\_png MDL\_360spinframes\_1280 MDL\_360spinframes\_1280\_nc MDL\_360spinframes\_1280\_nc\_png MDL\_360spinframes\_1280\_png MDL\_360spinframes\_1280HD MDL\_360spinframes\_1280HD\_nc MDL\_360spinframes\_1280HD\_nc\_png MDL\_360spinframes\_1280HD\_png MDL\_360spinframes\_1920 MDL\_360spinframes\_1920\_nc MDL\_360spinframes\_1920\_nc\_png MDL\_360spinframes\_1920\_png MDL\_360spinframes\_1920HD MDL\_360spinframes\_1920HD\_nc MDL\_360spinframes\_1920HD\_nc\_png MDL\_360spinframes\_1920HD\_png MDL\_360spinframes\_2400 MDL\_360spinframes\_2400\_nc MDL\_360spinframes\_2400\_nc\_png MDL\_360spinframes\_2400\_png MDL\_360spinframes\_2400HD MDL\_360spinframes\_2400HD\_nc MDL\_360spinframes\_2400HD\_nc\_png MDL\_360spinframes\_2400HD\_png 40 MDL\_drivein 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 MDL\_drivein\_0320\_mp4 MDL\_drivein\_0640\_mp4 MDL\_drivein\_1920\_mp4 MDL\_drivein\_frames\_0480HD MDL\_drivein\_frames\_0480HD\_nc MDL\_drivein\_frames\_0480HD\_nc\_png MDL\_drivein\_frames\_0480HD\_png MDL\_drivein\_frames\_0640HD MDL\_drivein\_frames\_0640HD\_nc MDL\_drivein\_frames\_0640HD\_nc\_png MDL\_drivein\_frames\_0640HD\_png MDL\_drivein\_frames\_1920HD MDL\_drivein\_frames\_1920HD\_nc MDL\_drivein\_frames\_1920HD\_nc\_png MDL\_drivein\_frames\_1920HD\_png MDL\_drivein\_frames\_2400HD MDL\_drivein\_frames\_2400HD\_nc MDL\_drivein\_frames\_2400HD\_nc\_png MDL\_drivein\_frames\_2400HD\_png 41 MDL\_drivein360 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 MDL\_drivein360\_0320\_gif MDL\_drivein360\_0320\_mp4 MDL\_drivein360\_0320HD MDL\_drivein360\_0320HD\_nc MDL\_drivein360\_0320HD\_nc\_png MDL\_drivein360\_0320HD\_png MDL\_drivein360\_0480\_gif MDL\_drivein360\_0480HD MDL\_drivein360\_0480HD\_nc MDL\_drivein360\_0480HD\_nc\_png MDL\_drivein360\_0480HD\_png MDL\_drivein360\_0640\_gif MDL\_drivein360\_0640\_mp4 MDL\_drivein360\_0640HD MDL\_drivein360\_0640HD\_nc MDL\_drivein360\_0640HD\_nc\_png MDL\_drivein360\_0640HD\_png MDL\_drivein360\_1920\_mp4 MDL\_drivein360\_1920HD MDL\_drivein360\_1920HD\_nc MDL\_drivein360\_1920HD\_nc\_png MDL\_drivein360\_1920HD\_png MDL\_drivein360\_2400HD MDL\_drivein360\_2400HD\_nc MDL\_drivein360\_2400HD\_nc\_png MDL\_drivein360\_2400HD\_png 42 MDL\_flyaround\_0320 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 MDL\_flyaround\_0320\_mp4 MDL\_flyaround\_0640\_mp4 MDL\_flyaround\_1920\_mp4 MDL\_flyaround\_frames\_0480HD MDL\_flyaround\_frames\_0480HD\_nc MDL\_flyaround\_frames\_0480HD\_nc\_png MDL\_flyaround\_frames\_0480HD\_png MDL\_flyaround\_frames\_0640HD MDL\_flyaround\_frames\_0640HD\_nc MDL\_flyaround\_frames\_0640HD\_nc\_png MDL\_flyaround\_frames\_0640HD\_png MDL\_flyaround\_frames\_1920HD MDL\_flyaround\_frames\_1920HD\_nc MDL\_flyaround\_frames\_1920HD\_nc\_png MDL\_flyaround\_frames\_1920HD\_png MDL\_flyaround\_frames\_2400HD MDL\_flyaround\_frames\_2400HD\_nc MDL\_flyaround\_frames\_2400HD\_nc\_png MDL\_flyaround\_frames\_2400HD\_png 43 BTL\_no\_cr 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 BTL\_no\_cr/BTL\_0320\_001 BTL\_no\_cr/BTL\_0320\_014 BTL\_no\_cr/BTL\_0320\_032 BTL\_no\_cr/BTL\_0480\_001 BTL\_no\_cr/BTL\_0480\_014 BTL\_no\_cr/BTL\_0480\_032 BTL\_no\_cr/BTL\_0640\_001 BTL\_no\_cr/BTL\_0640\_001\_png BTL\_no\_cr/BTL\_0640\_014 BTL\_no\_cr/BTL\_0640\_014\_png BTL\_no\_cr/BTL\_0640\_032 BTL\_no\_cr/BTL\_0640\_032\_png BTL\_no\_cr/BTL\_1280\_001 BTL\_no\_cr/BTL\_1280\_014 BTL\_no\_cr/BTL\_1280\_032 BTL\_no\_cr/BTL\_2400\_001 BTL\_no\_cr/BTL\_2400\_001\_png BTL\_no\_cr/BTL\_2400\_014 BTL\_no\_cr/BTL\_2400\_014\_png BTL\_no\_cr/BTL\_2400\_032 BTL\_no\_cr/BTL\_2400\_032\_png BTL\_no\_cr/BTL\_1280\_001\_png 45 BTL\_no\_cr (Front 3/4) 406 407 408 409 410 411 412 BTL\_no\_cr/BTL\_0320\_032 BTL\_no\_cr/BTL\_0480\_032 BTL\_no\_cr/BTL\_0640\_032 BTL\_no\_cr/BTL\_0640\_032\_png BTL\_no\_cr/BTL\_1280\_032 BTL\_no\_cr/BTL\_2400\_032 BTL\_no\_cr/BTL\_2400\_032\_png [PreviousErrors](https://evoximages.gitbook.io/docs/error-codes) [NextSpec Guides](https://evoximages.gitbook.io/docs/resources/spec-guides) Last updated 4 years ago --- # Errors | Evox API Documentation ### [](https://evoximages.gitbook.io/docs/error-codes#error-messages) Error messages If an error occurs, a response with a proper HTTPS error status code is returned. The response body contains a description of the issue. Error Code Meaning 200 OK – Everything worked as expected. 400 Bad Request – The request was unacceptable, often due to missing a required parameter. 401 Unauthorized – Valid API key not provided. 402 Not enabled – Please contact [sales@evox.com](mailto:sales@scaleapi.com) to gain access to this product. 404 Not Found – The requested resource doesn’t exist. 429 Too Many Requests – Request limit hit. 500 Internal Server Error – We had a problem with our server. Try again later. [PreviousChangelog](https://evoximages.gitbook.io/docs/changelog) [NextProduct Catalog - USA](https://evoximages.gitbook.io/docs/product-chart) Last updated 4 years ago --- # Vids | Evox API Documentation Endpoints Optional Parameters Required Parameters Description /vids/:vid Get one vid /vids/:vid/products/ :productId/:productTypeId `color` Get one product for a vid based on product type ID [PreviousSpec Guides](https://evoximages.gitbook.io/docs/resources/spec-guides) [Next/vids/:vid](https://evoximages.gitbook.io/docs/resources/vids/vids-vid-1) Last updated 4 years ago --- # Spec Guides | Evox API Documentation Endpoints Optional Parameters Description /specguides n/a List of all available product spec guides. [PreviousProduct Catalog - USA](https://evoximages.gitbook.io/docs/product-chart) [NextVids](https://evoximages.gitbook.io/docs/resources/vids) Last updated 4 years ago --- # /vids/:vid | Evox API Documentation [](https://evoximages.gitbook.io/docs/resources/vids/vids-vid-1#vid-one) Vid ( One ) ----------------------------------------------------------------------------------------- `GET` `http://api.evoximages.com/api/v1/vids/:vid` This endpoint allows you to get data for one vid. #### [](https://evoximages.gitbook.io/docs/resources/vids/vids-vid-1#path-parameters) Path Parameters Name Type Description vid string Model ID number #### [](https://evoximages.gitbook.io/docs/resources/vids/vids-vid-1#headers) Headers Name Type Description x-api-key string API key 200 500 Could not find a vid matching this query. Copy HTTP/1.1 200 OK { "data": { "vid": 42590, "cid": null, "vifid": 14685, "btl_vifid": null, "year": 2021, "make": "Nissan", "model": "Frontier", "trim": "SV 4-Cylinder", "doors": 4, "body": "pickup", "cab": "ext", "wheels": "RWD", ... } } Copy { "message": "Bad Request", "details": "Vehicle not found for VID :vid" } [PreviousVids](https://evoximages.gitbook.io/docs/resources/vids) [Next/vids/:vid/products/:productId/:productTypeId](https://evoximages.gitbook.io/docs/resources/vids/vids-vid-products-productid-producttypeid) Last updated 4 years ago --- # /vids/:vid/products/:productId/:productTypeId | Evox API Documentation [](https://evoximages.gitbook.io/docs/resources/vids/vids-vid-products-productid-producttypeid#vid-products) Vid Products ------------------------------------------------------------------------------------------------------------------------------ `GET` `http://api.evoximages.com/api/v1/vehicles/:vid/products/:productId/:productTypeId` This endpoint returns Evox Images assets in the form of resource urls, as well as data for one specific vid. #### [](https://evoximages.gitbook.io/docs/resources/vids/vids-vid-products-productid-producttypeid#path-parameters) Path Parameters Name Type Description vid string Model ID number productId string Product ID. See product chart for details\* productTypeId string Product Type ID. See product chart for details\* #### [](https://evoximages.gitbook.io/docs/resources/vids/vids-vid-products-productid-producttypeid#query-parameters) Query Parameters Name Type Description color string Color code. It is used to return one color folder instead a list. #### [](https://evoximages.gitbook.io/docs/resources/vids/vids-vid-products-productid-producttypeid#headers) Headers Name Type Description x-api-key string API key 200 Without color query param. 500 Could not find a vehicle matching this query. Copy HTTP/1.1 200 OK { "status": "success", "vehicle": { "vid": 42590, "cid": null, "vifid": 14685, "btl_vifid": null, "year": 2021, "make": "Nissan", "model": "Frontier", "trim": "SV 4-Cylinder", "doors": 4, "body": "pickup", "cab": "ext", "wheels": "RWD", ... }, "urls": [\ "Evox01": [\ "https://dbhdyzvm8lm25.cloudfront.net/MDL_360spinframes_0640/MY2021/42590/Evox01/42590_spin_0640_Evox01_001.jpg",\ "https://dbhdyzvm8lm25.cloudfront.net/MDL_360spinframes_0640/MY2021/42590/Evox01/42590_spin_0640_Evox01_002.jpg",\ "https://dbhdyzvm8lm25.cloudfront.net/MDL_360spinframes_0640/MY2021/42590/Evox01/42590_spin_0640_Evox01_003.jpg",\ "https://dbhdyzvm8lm25.cloudfront.net/MDL_360spinframes_0640/MY2021/42590/Evox01/42590_spin_0640_Evox01_004.jpg",\ ...\ ],\ "QAK": [\ "https://dbhdyzvm8lm25.cloudfront.net/MDL_360spinframes_0640/MY2021/42590/QAK/42590_spin_0640_QAK_001.jpg",\ "https://dbhdyzvm8lm25.cloudfront.net/MDL_360spinframes_0640/MY2021/42590/QAK/42590_spin_0640_QAK_002.jpg",\ "https://dbhdyzvm8lm25.cloudfront.net/MDL_360spinframes_0640/MY2021/42590/QAK/42590_spin_0640_QAK_003.jpg",\ "https://dbhdyzvm8lm25.cloudfront.net/MDL_360spinframes_0640/MY2021/42590/QAK/42590_spin_0640_QAK_004.jpg",\ "https://dbhdyzvm8lm25.cloudfront.net/MDL_360spinframes_0640/MY2021/42590/QAK/42590_spin_0640_QAK_005.jpg",\ ...\ ],\ ...\ ] } Copy { "message": "Bad Request", "details": "Vehicle not found for VID 11111" } [Previous/vids/:vid](https://evoximages.gitbook.io/docs/resources/vids/vids-vid-1) [NextVehicles](https://evoximages.gitbook.io/docs/resources/endpoints) Last updated 4 years ago --- # Vehicles | Evox API Documentation [](https://evoximages.gitbook.io/docs/resources/endpoints#overview) Overview --------------------------------------------------------------------------------- **Changelog** **7/1/2020** \- Obtain image assets directly from general vehicle endpoint by adding both `pid` (ProductID)and `ptid` (ProductTypeID). Requires at minimum **2** other parameters. Refer to the Product Catalog for a list of all product assets. Sample endpoint: `.../vehicles?make=Honda&model=Civic&year=2020&pid=2&ptid=30` Endpoints Optional Parameters Required Parameters Description /vehicles `make, model, year, trim, page,` `pid,` `ptid` List all vehicles /vehicles/:vifnum Get one vehicle /vehicles/:vifnum/products/ :productId/:productTypeId `size, eye, color` Get one product for a vehicle based on product type ID /vehicles/:vifnum/stills List all available still frames for a vehicle /vehicles/:vifnum/colors List all colors for one vehicle /vehicles/:vifnum/products/:productId `*typeId` List all subproduct resources by product ID. \*Optional parameters filter the results. \*`typeId`\- Separate multiple queries by adding `+` symbol in between each `productTypeId.` example: `...products/2?typeId=30+31+32` \*`pid`\- Product ID. \*`ptid`\- Product Type ID [Previous/vids/:vid/products/:productId/:productTypeId](https://evoximages.gitbook.io/docs/resources/vids/vids-vid-products-productid-producttypeid) [Next/vehicles](https://evoximages.gitbook.io/docs/resources/endpoints/vehicles) Last updated 5 years ago --- # /vehicles/:vifnum | Evox API Documentation [](https://evoximages.gitbook.io/docs/resources/endpoints/vehicles-vifnum#vehicle-one) Vehicle ( One ) ----------------------------------------------------------------------------------------------------------- `GET` `http://api.evoximages.com/api/v1/vehicles/:vifnum` This endpoint allows you to get data for one vehicle. #### [](https://evoximages.gitbook.io/docs/resources/endpoints/vehicles-vifnum#path-parameters) Path Parameters Name Type Description vifnum string Vehicle ID number #### [](https://evoximages.gitbook.io/docs/resources/endpoints/vehicles-vifnum#headers) Headers Name Type Description x-api-key string API key 200 404 Could not find a vehicle matching this query. Copy HTTP/1.1 200 OK { "statusCode": 200, "data": { "vifnum": 12626, "orgnum": 0, "sendnum": 12626, "year": 2018, "make": "Nissan", "model": "Sentra", "trim": "SV", "doors": 4, "body": "sedan", "cab": "", "wheels": "FWD", "vin": "3N1AB7AP8JL609119", "delivered": "2018-02-13", "color_title": "Gun Metallic", ... } } Copy { "statusCode": 404, "error": { "message": "Vehicle not found" } } [Previous/vehicles](https://evoximages.gitbook.io/docs/resources/endpoints/vehicles) [Next/vehicles/:vifnum/products/:productId/:productTypeId](https://evoximages.gitbook.io/docs/resources/endpoints/vehicles-vifnum-products-productid-producttypeid) Last updated 5 years ago --- # /vehicles/:vifnum/stills | Evox API Documentation [](https://evoximages.gitbook.io/docs/resources/endpoints/vehicles-vifnum-stills#vehicle-stills) Vehicle Stills -------------------------------------------------------------------------------------------------------------------- `GET` `http://api.evoximages.com/api/v1/vehicles/:vifnum/stills` This endpoint allows you to get a list of still shots for one vehicle. #### [](https://evoximages.gitbook.io/docs/resources/endpoints/vehicles-vifnum-stills#path-parameters) Path Parameters Name Type Description vifnum integer Vifnum ID of the vehicle #### [](https://evoximages.gitbook.io/docs/resources/endpoints/vehicles-vifnum-stills#headers) Headers Name Type Description x-api-key string API key 200 Copy HTTP/1.1 200 OK { "statusCode": 200, "data": [\ {\ "frame": "037",\ "title": "Drivers Side View, Door Open"\ },\ {\ "frame": "039",\ "title": "Inside of drivers side open door"\ },\ {\ "frame": "040",\ "title": "Drivers side inside door controls"\ },\ {\ "frame": "042",\ "title": "Drivers Wheel"\ },\ {\ "frame": "043",\ "title": "Headlight"\ },\ {\ "frame": "044",\ "title": "Tail light"\ },\ ...\ ] } [Previous/vehicles/:vifnum/products/:productId/:productTypeId](https://evoximages.gitbook.io/docs/resources/endpoints/vehicles-vifnum-products-productid-producttypeid) [Next/vehicles/:vifnum/colors](https://evoximages.gitbook.io/docs/resources/endpoints/vehicles-vifnum-colors) Last updated 5 years ago --- # /vehicles/:vifnum/products/:productId/:productTypeId | Evox API Documentation [](https://evoximages.gitbook.io/docs/resources/endpoints/vehicles-vifnum-products-productid-producttypeid#vehicle-products) Vehicle Products -------------------------------------------------------------------------------------------------------------------------------------------------- `GET` `http://api.evoximages.com/api/v1/vehicles/:vifnum/products/:productId/:productTypeId` This endpoint returns Evox Images assets in the form of resource urls, as well as data for one specific vehicle. #### [](https://evoximages.gitbook.io/docs/resources/endpoints/vehicles-vifnum-products-productid-producttypeid#path-parameters) Path Parameters Name Type Description vifnum string Vehicle ID number productId string Product ID. See product chart for details\* productTypeId string Product Type ID. See product chart for details\* #### [](https://evoximages.gitbook.io/docs/resources/endpoints/vehicles-vifnum-products-productid-producttypeid#query-parameters) Query Parameters Name Type Description frame string ie. 001, 014, 032 for 3-angle colors eye string show only left or right side images for stereoscopic assets #### [](https://evoximages.gitbook.io/docs/resources/endpoints/vehicles-vifnum-products-productid-producttypeid#headers) Headers Name Type Description x-api-key string API key 200 404 Could not find a vehicle matching this query. Copy HTTP/1.1 200 OK { "status": "success", "vehicle": { "vifnum": 12626, "orgnum": 0, "sendnum": 12626, "year": 2018, "make": "Nissan", "model": "Sentra", "trim": "SV", "doors": 4, "body": "sedan", "cab": "", "wheels": "FWD", "vin": "3N1AB7AP8JL609119", "delivered": "2018-02-13", "color_title": "Gun Metallic", ... }, "product": { "product_id": 14, "product_type_id": 134, "name": "interior_vr_gear" }, "urls": [\ "https://xxxxxx.cloudfront.net/interior_vr_gear/MY2018/AIL12626_2048/Interior/AIL126xxxx",\ "https://xxxxxx.cloudfront.net/interior_vr_gear/MY2018/AIL12626_2048/Interior/AIL126xxxx.png",\ "https://xxxxxx.cloudfront.net/interior_vr_gear/MY2018/AIL12626_2048/Interior/AIL12626_pavr/AIL12xxxx.png",\ "https://xxxxxx.cloudfront.net/interior_vr_gear/MY2018/AIL12626_2048/Interior/AIL12626_pavr/AIL12xxxx.png",\ ...\ ] } Copy { "status": 400, "message": "Vehicle not found, please check Vifnum ID" } [Previous/vehicles/:vifnum](https://evoximages.gitbook.io/docs/resources/endpoints/vehicles-vifnum) [Next/vehicles/:vifnum/stills](https://evoximages.gitbook.io/docs/resources/endpoints/vehicles-vifnum-stills) Last updated 3 years ago --- # /vehicles | Evox API Documentation [](https://evoximages.gitbook.io/docs/resources/endpoints/vehicles#vehicle-list) Vehicle ( List ) ------------------------------------------------------------------------------------------------------ `GET` `http://api.evoximages.com/api/v1/vehicles/` This endpoint allows you to get data for any vehicle in our database. The response is limited to the first `2500` vehicles. Add additional query strings to filter your results ie.`?make=kia&year=2018` #### [](https://evoximages.gitbook.io/docs/resources/endpoints/vehicles#query-parameters) Query Parameters Name Type Description trim string Filter by vehicle trims page string Select page number of paginated results model string Filter by vehicle model types year string Filter by vehicle years make string Filter by vehicle makes #### [](https://evoximages.gitbook.io/docs/resources/endpoints/vehicles#headers) Headers Name Type Description x-api-key string API key 200 Copy HTTP/1.1 200 OK { "statusCode": "success", "data": [\ {\ "vifnum": 12769,\ "orgnum": 0,\ "sendnum": 12769,\ "year": 2018,\ "make": "Kia",\ "model": "Cadenza",\ "trim": "Limited",\ "doors": 4,\ "body": "sedan",\ "cab": "",\ "wheels": "FWD",\ "vin": "KNALC4J18J5101582",\ "delivered": "2018-05-02",\ "color_title": "Aurora Black",\ ...\ },\ {\ "vifnum": 12456,\ "orgnum": 0,\ "sendnum": 12456,\ "year": 2018,\ "make": "Kia",\ "model": "Forte",\ "trim": "LX",\ "doors": 4,\ "body": "sedan",\ "cab": "",\ "wheels": "FWD",\ "vin": "3KPFK4A75JE168975",\ "delivered": "2017-11-30",\ "color_title": "Silky Silver",\ ...\ },\ {\ "vifnum": 12614,\ "orgnum": 0,\ "sendnum": 12614,\ "year": 2018,\ "make": "Kia",\ "model": "Forte",\ "trim": "EX",\ "doors": 4,\ "body": "sedan",\ "cab": "",\ "wheels": "FWD",\ "vin": "3KPFL4A84JE191654",\ "delivered": "2018-02-06",\ "color_title": "Silky Silver",\ ...\ },\ ...\ ] } [PreviousVehicles](https://evoximages.gitbook.io/docs/resources/endpoints) [Next/vehicles/:vifnum](https://evoximages.gitbook.io/docs/resources/endpoints/vehicles-vifnum) Last updated 5 years ago --- # /makes | Evox API Documentation [](https://evoximages.gitbook.io/docs/resources/makes/untitled#makes-list) Makes ( List ) ---------------------------------------------------------------------------------------------- `GET` `http://api.evoximages.com/api/v1/makes/` This endpoint returns all the available makes that have Evox Images assets. #### [](https://evoximages.gitbook.io/docs/resources/makes/untitled#headers) Headers Name Type Description x-api-key string API key 200 Copy HTTP/1.1 200 OK { "status": "success", "data": [ \ "Acura",\ "Alfa Romeo",\ "Aston Martin",\ "Audi"\ ...\ ] } [PreviousMakes](https://evoximages.gitbook.io/docs/resources/makes) [NextMappings](https://evoximages.gitbook.io/docs/resources/mappings) Last updated 5 years ago --- # Products | Evox API Documentation [](https://evoximages.gitbook.io/docs/resources/products-1#overview) Overview ---------------------------------------------------------------------------------- Endpoints Optional Parameters Description /products n/a List all available products for this client /products/:productId n/a List all product types for a product category [Previous/vehicles/:vifnum/hotspots](https://evoximages.gitbook.io/docs/resources/endpoints/vehicles-vifnum-hotspots) [Next/products](https://evoximages.gitbook.io/docs/resources/products-1/untitled-1) Last updated 7 years ago --- # Btllists | Evox API Documentation [](https://evoximages.gitbook.io/docs/resources/btllists#overview) Overview -------------------------------------------------------------------------------- Endpoints Optional Parameters Description /btllists n/a To fetch the list of VID's [Previous/mappings](https://evoximages.gitbook.io/docs/resources/mappings/mappings) [Next/btllists](https://evoximages.gitbook.io/docs/resources/btllists/btllists) Last updated 4 years ago --- # Mappings | Evox API Documentation [](https://evoximages.gitbook.io/docs/resources/mappings#overview) Overview -------------------------------------------------------------------------------- Endpoints Optional Parameters Description /mappings n/a List all available mapping sheets [Previous/makes](https://evoximages.gitbook.io/docs/resources/makes/untitled) [Next/mappings](https://evoximages.gitbook.io/docs/resources/mappings/mappings) Last updated 6 years ago --- # /products | Evox API Documentation [](https://evoximages.gitbook.io/docs/resources/products-1/untitled-1#products-list) Products ( List ) ----------------------------------------------------------------------------------------------------------- `GET` `http://api.evoximages.com/api/v1/products/` This endpoint returns all the available products a client has access to based on their plan. #### [](https://evoximages.gitbook.io/docs/resources/products-1/untitled-1#headers) Headers Name Type Description x-api-key string API key 200 Copy HTTP/1.1 200 OK { "status": "success", "data": [\ {\ "id": 78,\ "name": "exterior_vr_gear",\ "product_id": 5\ },\ {\ "id": 134,\ "name": "interior_vr_gear",\ "product_id": 14\ }\ ] } [PreviousProducts](https://evoximages.gitbook.io/docs/resources/products-1) [Next/products/:productId](https://evoximages.gitbook.io/docs/resources/products-1/untitled) Last updated 6 years ago --- # Makes | Evox API Documentation [](https://evoximages.gitbook.io/docs/resources/makes#overview) Overview ----------------------------------------------------------------------------- Endpoints Optional Parameters Description /makes n/a List all available vehicle makes [Previous/products/:productId](https://evoximages.gitbook.io/docs/resources/products-1/untitled) [Next/makes](https://evoximages.gitbook.io/docs/resources/makes/untitled) Last updated 7 years ago --- # /mappings | Evox API Documentation [](https://evoximages.gitbook.io/docs/resources/mappings/mappings#get-mapping-tables) Get Mapping tables ------------------------------------------------------------------------------------------------------------- `GET` `http://api.evoximages.com/api/v1/mappings` This endpoint allows you to get all Mapping table excel sheets. #### [](https://evoximages.gitbook.io/docs/resources/mappings/mappings#headers) Headers Name Type Description x-api-key string API Key 200 Mappings successfully retrieved. Copy { "status": 200, "mappingFiles": [\ "https://xxxxxx.cloudfront.net/_mapping_vehicle/description_mapping.csv",\ "https://xxxxxx.cloudfront.net/_mapping_vehicle/description_mapping.xlsx",\ "https://xxxxxx.cloudfront.net/_mapping_vehicle/description_mapping_disclaimer.txt"\ ] } [PreviousMappings](https://evoximages.gitbook.io/docs/resources/mappings) [NextBtllists](https://evoximages.gitbook.io/docs/resources/btllists) Last updated 6 years ago --- # /products/:productId | Evox API Documentation [](https://evoximages.gitbook.io/docs/resources/products-1/untitled#product-types-list) Product Types ( List ) ------------------------------------------------------------------------------------------------------------------- `GET` `http://api.evoximages.com/api/v1/products/:productId` This endpoint returns a comprehensive list of product types for a particular product category. For an example, the product category `Color` has several product types in different resolutions, file extensions, and angles. #### [](https://evoximages.gitbook.io/docs/resources/products-1/untitled#path-parameters) Path Parameters Name Type Description :productId string Evox Images Product ID. See Product Table for details\* #### [](https://evoximages.gitbook.io/docs/resources/products-1/untitled#headers) Headers Name Type Description x-api-key string API key 200 Copy HTTP/1.1 200 OK { "status": "success", "data": [\ {\ "product_id": 2,\ "product": "Color",\ "product_type_id": 30,\ "name": "color_0320_001"\ },\ {\ "product_id": 2,\ "product": "Color",\ "product_type_id": 31,\ "name": "color_0320_014"\ },\ {\ "product_id": 2,\ "product": "Color",\ "product_type_id": 32,\ "name": "color_0320_032"\ },\ {\ "product_id": 2,\ "product": "Color",\ "product_type_id": 33,\ "name": "color_0480_001"\ },\ ...\ ] } \*Check out our [Product Table](https://evoximages.gitbook.io/docs/product-chart) page to see a comprehensive list of all Evox Images API products. [Previous/products](https://evoximages.gitbook.io/docs/resources/products-1/untitled-1) [NextMakes](https://evoximages.gitbook.io/docs/resources/makes) Last updated 6 years ago --- # /vehicles/:vifnum/colors | Evox API Documentation [](https://evoximages.gitbook.io/docs/resources/endpoints/vehicles-vifnum-colors#vehicle-colors) Vehicle Colors -------------------------------------------------------------------------------------------------------------------- `GET` `http://api.evoximages.com/api/v1/vehicles/:vifnum/colors` This endpoint allows you to get all color data for one vehicle. #### [](https://evoximages.gitbook.io/docs/resources/endpoints/vehicles-vifnum-colors#path-parameters) Path Parameters Name Type Description vifnum integer Vifnum ID of the vehicle #### [](https://evoximages.gitbook.io/docs/resources/endpoints/vehicles-vifnum-colors#headers) Headers Name Type Description x-api-key string API key 200 Copy HTTP/1.1 200 OK { "statusCode": 200, "data": { "colors": [\ {\ "vifnum": 12626,\ "code": "A20",\ "title": "Red Alert",\ "simpletitle": "Red",\ "rgb1": "94141C",\ "rgb2": "",\ "shotin": 0,\ "id": 117408\ },\ {\ "vifnum": 12626,\ "code": "K23",\ "title": "Brilliant Silver",\ "simpletitle": "Silver",\ "rgb1": "AAAAAA",\ "rgb2": "",\ "shotin": 0,\ "id": 117409\ },\ ...\ ] } } List of colors by `simpletitle` Copy Black Blue Brown Gold Gray Green Orange Purple Red Silver White Yellow [Previous/vehicles/:vifnum/stills](https://evoximages.gitbook.io/docs/resources/endpoints/vehicles-vifnum-stills) [Next/vehicles/:vifnum/hotspots](https://evoximages.gitbook.io/docs/resources/endpoints/vehicles-vifnum-hotspots) Last updated 5 years ago --- # /vehicles/:vifnum/hotspots | Evox API Documentation [](https://evoximages.gitbook.io/docs/resources/endpoints/vehicles-vifnum-hotspots#vehicle-hotspots) Vehicle hotspots -------------------------------------------------------------------------------------------------------------------------- `GET` `http://api.evoximages.com/api/v1/vehicles/:vifnum/hotspots` This endpoint allows you to get all hotspots data for one vehicle. #### [](https://evoximages.gitbook.io/docs/resources/endpoints/vehicles-vifnum-hotspots#path-parameters) Path Parameters Name Type Description vifnum integer Vifnum ID of the vehicle #### [](https://evoximages.gitbook.io/docs/resources/endpoints/vehicles-vifnum-hotspots#headers) Headers Name Type Description x-api-key string API key 200 Copy HTTP/1.1 200 OK { "statusCode": 200, "data": { "panos": [\ {\ "id": 1,\ "hotspot_pan": -0.975495955361175,\ "hotspot_tilt": -65.19089079520687,\ "hotspot_fov": 53.12191390991211,\ "associated_still_frame": 88,\ "hotspot_name": "Front Seats (Ventilated, Heating)",\ "custom_name": null,\ "description": "GT2 bucket seats | 8-way power seats | Seats, power lumbar control | Power seat bolster | Heated and ventilated seats | Two-tone seats"\ },\ ...\ ], "spins": [\ {\ "id": 13,\ "frame": 0,\ "hs_x": 0.8,\ "hs_y": 0.5875,\ "associated_still_frame": 42,\ "hotspot_name": "Wheel/Brake",\ "custom_name": null,\ "description": "19\" front, 20\" rear carbon flash painted aluminum wheels with machined edge | High performance tires, run flat | Z51 performance brakes | Z51 performance suspension | Bright red painted brake calipers"\ },\ ...\ ] } } [Previous/vehicles/:vifnum/colors](https://evoximages.gitbook.io/docs/resources/endpoints/vehicles-vifnum-colors) [NextProducts](https://evoximages.gitbook.io/docs/resources/products-1) Last updated 4 years ago --- # /btllists | Evox API Documentation `GET` `http://api.evoximages.com/api/v1/btllists` #### [](https://evoximages.gitbook.io/docs/resources/btllists/btllists#headers) Headers Name Type Description x-api-key string 200 Mappings successfully retrieved. Copy { "status": 200, "data": [\ "https://dbhdyzvm8lm25.cloudfront.net/_api_btllist/btllist.csv",\ "https://dbhdyzvm8lm25.cloudfront.net/_api_btllist/btllist.xlsx"\ ] } [PreviousBtllists](https://evoximages.gitbook.io/docs/resources/btllists) [NextViflist](https://evoximages.gitbook.io/docs/resources/viflist) Last updated 4 years ago --- # Viflist | Evox API Documentation [](https://evoximages.gitbook.io/docs/resources/viflist#overview) Overview ------------------------------------------------------------------------------- Endpoints Optional Parameters Description /viflists n/a List all available viflist docs [Previous/btllists](https://evoximages.gitbook.io/docs/resources/btllists/btllists) [Next/viflists](https://evoximages.gitbook.io/docs/resources/viflist/viflists) Last updated 4 years ago --- # /viflists | Evox API Documentation [](https://evoximages.gitbook.io/docs/resources/viflist/viflists#get-viflists-documents) Get Viflists documents -------------------------------------------------------------------------------------------------------------------- `GET` `http://api.evoximages.com/api/v1/viflists` This endpoint allows you to get all Viflist excel sheets. #### [](https://evoximages.gitbook.io/docs/resources/viflist/viflists#headers) Headers Name Type Description x-api-key string API Key 200 Mappings successfully retrieved. Copy { "status": 200, "data": [\ "https://xxxxxx.cloudfront.net/_api_viflist/viflist.csv",\ "https://xxxxxx.cloudfront.net/_api_viflist/viflist.xls",\ "https://xxxxxx.cloudfront.net/_api_viflist/viflist.xlsx"\ ] } [PreviousViflist](https://evoximages.gitbook.io/docs/resources/viflist) [NextContact Us](https://evoximages.gitbook.io/docs/getting-help/contact-us) Last updated 5 years ago --- # Contact Us | Evox API Documentation [Previous/viflists](https://evoximages.gitbook.io/docs/resources/viflist/viflists) [NextLegal](https://evoximages.gitbook.io/docs/getting-help/legal) Last updated 6 years ago --- # Legal | Evox API Documentation [](https://evoximages.gitbook.io/docs/getting-help/legal#yui_3_17_2_1_1538436110170_143) TERMS AND CONDITIONS ------------------------------------------------------------------------------------------------------------------ ### [](https://evoximages.gitbook.io/docs/getting-help/legal#evox-images-terms-of-service) EVOX IMAGES TERMS OF SERVICE Welcome to the EVOX images website (referred to herein as the “site”) (we refer to the site and the services provided through the site, collectively, as the “EVOX features”). These terms of service (“terms of service” or “Terms”) set forth an agreement between you and EVOX Productions, LLC (“EVOX”) governing your use of the EVOX features, including the EVOX blog which has additional terms, as set forth below. By accessing this site, you signify your irrevocable acceptance of these terms of service. EVOX has the right to modify or update these terms of service at any time without providing notice. Any additional or different terms in these terms of service shall be effective upon being posted on the site. Your continued use of any of the EVOX features following the posting of any additional or different terms in these terms of service constitutes your irrevocable acceptance of those additional or different terms. _**Proprietary rights**_ All material (“materials”) displayed or transmitted on the site including, but not limited to, text, photographs, images, illustrations, video clips, audio clips, and graphics and all associated patent rights, copyright rights, trademark rights, trade secret rights and other intellectual property and proprietary rights recognized anywhere in the world are owned or licensed by EVOX, and are protected by united states and international intellectual property laws and treaties. EVOX grants you a limited, revocable license to access and use the materials for your personal use, subject to all of the terms and conditions of these terms of service. Except as provided in these terms of service, you may not copy, reproduce, publish, transmit, transfer, sell, rent, modify, edit, create derivative works from, distribute, repost, perform, display, or in any way commercially exploit the materials, nor may you infringe any of the copyrights or other intellectual property rights contained in the materials. You may not remove or alter, nor cause to be removed or altered, any copyright, trademark, or other proprietary rights notices or legends from the materials. You may not archive or retain any of the materials accessed on the site without the express written permission of EVOX. You acquire no rights or license whatsoever in the materials other than the limited right to use the site in accordance with these terms of service. Any of the materials accessed or downloaded from the site must be accessed or downloaded in accordance with these terms of service. EVOX reserves all rights not expressly granted under these terms of service. EVOX Productions, LLC reserves the right to pursue unauthorized users of its materials, including without limitation, any unauthorized use of its individual copyrighted images, video clips and graphics contained therein, each of which have independent economic value. These and other violations of EVOX intellectual property rights may result in your liability for actual damages and loss of income to EVOX and profits you derive from this misappropriation, or alternatively, for statutory damages of up to $150,000 per infringed work, plus all costs and attorneys fees. _**Links to other websites**_ EVOX may provide links to other internet websites and resources and, if it does so, they are provided merely as a convenience and the inclusion of any link does not constitute or imply any affiliation, endorsement or sponsorship by EVOX of such websites or any content contained therein. You acknowledge and agree that EVOX is not responsible or liable in any way for any content, advertising, services or goods on or made available from such websites or resources either via links provided by EVOX or by any user or third party. _**Warranty disclaimers**_ The site and the EVOX features are provided on an “as is” and “as available” basis without any warranty or condition, express or implied. To the full extent permissible under applicable law, EVOX specifically disclaims all warranties including, without limitation, implied warranties of title, quality, performance, merchantability, fitness for a particular purpose and non-infringement. EVOX makes no representation or warranty that (i) the site or the EVOX features will meet your expectations or requirements, (ii) the site or the EVOX features will be available, uninterrupted, timely, secure, accurate, complete or error-free, (iii) any results or information that may be obtained from the use of the site or the EVOX features will be accurate, timely, complete or reliable, (iv) any errors or defects in the site or the EVOX features will be corrected, or (v) the site and the EVOX features and/or the server that makes the site and the EVOX features available are free of viruses, clocks, timers, counters, worms, software locks, trojan horses, trap doors, time bombs or any other harmful codes, instructions, programs or components. Operation of the site and the EVOX features may be interfered with by numerous factors outside of EVOX’s control including, but not limited to, telecommunications network disruptions. EVOX is not responsible and will have no liability for any failures of the internet or any data or telecommunications equipment, system or network used in connection with the site or the EVOX features. You acknowledge that the entire risk arising out of the use or performance of the site or any of the EVOX features remains with you to the maximum extent permitted by law. Some jurisdictions do not allow the disclaimer of implied warranties, so the foregoing disclaimers may not apply to you. You acknowledge and agree that your sole remedy for any problems or dissatisfaction with the site or any of the EVOX features is to discontinue use of the site and the EVOX features. _**Limitation of liability**_ In no event shall EVOX or any of its directors, officers, employees, agents, consultants, parents, affiliates, successors, assigns or content or service providers be liable for any indirect, special, incidental, consequential, exemplary or punitive damages arising from, or directly or indirectly related to, the use of, the inability to use, or reliance on the site including, but not limited to, the EVOX features, or the content, materials and functions related thereto, including, without limitation, loss of revenue, anticipated profits, business, programs or information, even if EVOX or such person or entity has been advised of the possibility of such damages and regardless of the form of action. Except in the case of the gross negligence or intentional misconduct of EVOX, in no event shall the total liability of EVOX to you or any third party for all damages, losses, and causes of action (whether in contract or tort including, but not limited to, negligence or otherwise) exceed one hundred dollars ($100). Some jurisdictions do not allow the exclusion of incidental or consequential damages or limitation of liability, so the above exclusions and limitations may not apply to you. _**Indemnity**_ You agree to defend, indemnify and hold EVOX and its licensors, licensees, affiliated companies, and marketing partners, together with their respective employees, agents, directors and officers, harmless from and against any and all claims, actions, proceedings and suits and all related liabilities, losses, damages, judgments, settlements, penalties, fines, costs and expenses (including, without limitation, reasonable attorneys’ fees and costs) arising out of (i) your use or misuse of the site or any of the EVOX features, (ii) your breach or alleged breach of these terms of service, (iii) your violation of any law, rule, regulation or rights of others in connection with your use of the site or any of the EVOX features, or (iv) the infringement, violation or misappropriation of any copyright, trade secret, or any other intellectual property rights or the violation of any property or privacy right arising from your use of any of the EVOX features. _**Blog Terms of Use**_ The following terms of use apply specifically to the EVOX blog. Here are some basic ground rules you are bound by before going through the detailed legal terms and conditions, though the following are part of, and incorporated into the Terms: 1. You must use either your real name or nickname 2. Absolutely no paid comments are allowed. 3. You must not post any SPAM, links to Spam, Phishing sites, or other harmful content here. 4. No harsh, foul, demeaning or overly critical language is allowed. Your use of this blog is subject to the EVOX terms of use (“Terms”) contained herein. In consideration for accessing, creating or contributing to this blog at [evoximages.com](http://evoximages.com/terms/evoximages.com) , you agree to abide by these Terms. Please read them carefully before posting any comment to this blog. 1\. Rights in the Content You Submit By posting your opinions, views and content (“Content”), you are granting EVOX a non-exclusive, royalty-free, perpetual, and worldwide license to use your Content, including, without limitation, the license rights to copy, distribute, transmit, publicly display, publicly perform, reproduce, edit, translate and reformat your Content, and/or to incorporate it into a collective work. For Content you submit to a blog other than your own, label your submission with a full copyright notice, i.e., your name, the word “copyright” or symbol “©” and the year of first publication. Attribution When publicly displaying, publicly performing, reproducing or distributing copies of your Content, or Content as incorporated into a collective work, EVOX will make best efforts to credit your authorship. You grant EVOX permission to use your name for such attribution purposes. You, likewise, agree to represent yourself accurately. You acknowledge that misrepresentation may lead us, in our sole discretion, to delete any of your Content. 2\. Conduct Posting EVOX reserves the right to remove certain content that you may post. As a general matter, you may post content freely to your blog and to those of others, so long as the content is not illegal, obscene, defamatory, threatening, infringing of intellectual property rights, invasive of privacy or otherwise injurious or objectionable. You may not use the EVOX name to endorse or promote any product, opinion, cause or political candidate. Representation of your personal opinions as institutionally endorsed by EVOX is strictly prohibited. By posting content to any blog, you warrant and represent that you either own or otherwise control all of the rights to that content, including, without limitation, all the rights necessary for you to provide, post, upload, input or submit the content, or that your use of the content is a protected fair use. You agree that you will not knowingly and with intent to defraud provide material and misleading false information. You represent and warrant also that the content you supply does not violate these Terms, and that you will indemnify and hold EVOX harmless for any and all claims resulting from content you supply. You acknowledge that EVOX shall have the right to remove in its sole discretion any content that it considers to violate these Terms or in the discretion of EVOX is inappropriate or against the best interests of EVOX. Accessing You understand that all content posted to [evoximages.com](http://evoximages.com/terms/evoximages.com/) is the sole responsibility of the individual who originally posted the content. You understand, also, that all opinions expressed by users of this site are expressed strictly in their individual capacities, and not as representatives of EVOX. You agree that EVOX will not be liable, under any circumstances and in any way, for any errors or omissions, loss or damage of any kind incurred as a result of use of any content posted on this site. You agree that you must evaluate and bear all risks associated with the use of any content, including any reliance on the accuracy, completeness, or usefulness of such content. Children Collecting personal information from children under the age of 13 is prohibited. No Content should be directed toward such children without the express written permission of EVOX. _**Miscellaneous**_ These terms of service, and any other agreement regarding the EVOX features or the blog between you and EVOX, constitute the entire agreement between you and EVOX with respect to your access and use of the site and the EVOX features and supersede all prior and contemporaneous agreements between you and EVOX. If any of the provisions of these terms of service is found by a court of competent jurisdiction to be invalid or unenforceable, then that provision will be construed in a manner consistent with applicable laws to reflect, as nearly as possible, the original intentions of the parties, and the remaining provisions shall remain in full force and effect. EVOX’s failure to exercise or enforce any right or provision of these terms of service shall not constitute a waiver of such right or provision. These terms of service shall be interpreted, and your performance hereunder shall be governed, by the laws of the state of California, and applicable federal law, without regard to any conflicts of laws provisions. You agree to submit to the personal and exclusive jurisdiction of the state and federal courts located within Los Angeles County. You also agree that, in the event any dispute or claim arises out of or relating to your use of the site or the EVOX features or the blog, that you and EVOX will attempt in good faith to negotiate a written resolution of the matter directly between the parties. You agree that if the matter remains unresolved for forty-five (45) days after notification (via certified mail or personal delivery) that a dispute exists, all parties shall join in mediation services in Los Angeles, California with a mutually agreed mediator in any attempt to resolve the dispute. Should you file any arbitration claims, or any administrative or legal actions without first having attempted to resolve the matter by mediation, then you agree that you will not be entitled to recover attorneys’ fees, even if you would otherwise be entitled to them. ### [](https://evoximages.gitbook.io/docs/getting-help/legal#privacy-policy) **PRIVACY POLICY** Please be sure to read our [Privacy Policy](http://www.evoximages.com/privacy) , which is incorporated herein by reference. _**Contact Us**_ If you have any other questions about these terms of service or your rights or EVOX’s obligations relating to any of the EVOX features or the Blog, please email us at [info@evox.com](mailto:info@evox.com) . EVOX Images Attn: Webmaster 2363 Pacifica Place Rancho Dominguez, CA 90220 (310) 605-1429 [PreviousContact Us](https://evoximages.gitbook.io/docs/getting-help/contact-us) Last updated 7 years ago --- # Spec Guides | Evox API Documentation Endpoints Optional Parameters Description /specguides n/a List of all available product spec guides. [PreviousProduct Catalog - USA](https://evoximages.gitbook.io/docs/product-chart) [NextVids](https://evoximages.gitbook.io/docs/resources/vids) Last updated 4 years ago --- # Contact Us | Evox API Documentation [Previous/viflists](https://evoximages.gitbook.io/docs/resources/viflist/viflists) [NextLegal](https://evoximages.gitbook.io/docs/getting-help/legal) Last updated 6 years ago ---