redocly logoAPI docs by Redocly

Car-Cutter API (2.60.10)

Download OpenAPI specification:Download

E-mail: support@car-cutter.com License: Proprietary Terms of Service

Global #1 visual AI editing and optimisation solution for the automotive industry

Find out more about Car-Cutter

Asynchronous API

All non-mandatory parameters should be left our from the request.

Retrieve Cut Result

Authorizations:
api_key
query Parameters
image_url
required
string

URL of the image to be retrieved.

Responses

Response samples

Content type
application/json
{
  • "code": 400,
  • "message": "string"
}

Get current status of images

Authorizations:
api_key
query Parameters
image_url
required
string

URL of the image. May be repeated multiple times to retrieve the status for multiple images.

Responses

Response samples

Content type
application/json
{}

Submit an image for asynchronous processing

Authorizations:
api_key
Request Body schema: multipart/form-data
image_url
required
Array of strings

URL to the image that you want to process. You can repeat this parameter up to 60 times to submit multiple images.

vehicle_id
required
string

The ID of the vehicle to which the image belongs (e.g. VIN). It is recommend that you specify this parameter, otherwise all images will be assigned to the same vehicle.

cut_type
string
Enum: "complete" "normal" "blur" "none"

The cut type to perform on all images in this request. If this parameter is not supplied, the cut type will be read from the user configuration.

location_id
string

The ID of the location (e.g. store) from which this request is sent.

webhook_url
string

If your account has a webhook target enabled, this parameter can be used to define a custom webhook to use with the images submitted in this request.

webhook_response_auth_key
string

will POST to webhoook_url with "Authorization: Bearer "

custom_json
string

Provide a custom JSON document, which is stored in our system alongside the image. This is not used to determine any processing steps, it's solely used to exchange additional identifiers between CarCutter and customers for human discussions.

license_plate
string <byte>

Provide a custom license plate inlay PNG image with RGBA channels.

background
string <byte>

Provide a background image with RGBA channels.

overlay
string <byte>

Provide a custom overlay PNG image with RGBA channels.

scene_id
string

Provide a custom scene identification. A Complete list of available scene_ids can be provided on request.

Responses

Response samples

Content type
application/json
{}

Submit an image for asynchronous processing using guideline_id

Authorizations:
api_key
Request Body schema: multipart/form-data
image_url
required
Array of strings

URL to the image that you want to process. You can repeat this parameter up to 60 times to submit multiple images.

vehicle_id
required
string

The ID of the vehicle to which the image belongs (e.g. VIN). It is recommend that you specify this parameter, otherwise all images will be assigned to the same vehicle.

guideline_id
required
string

The guideline that you want to select for processing. By using guideline_id's provided by the CarCutter team, you can omit following parameters: 'cut_type', 'scene_id'

location_id
string

The ID of the location (e.g. store) from which this request is sent.

cut_type
string
Enum: "complete" "normal" "blur" "none"

The cut type to perform on all images in this request. If this parameter is not supplied, the cut type will be read from the user configuration.

webhook_url
string

If your account has a webhook target enabled, this parameter can be used to define a custom webhook to use with the images submitted in this request.

webhook_response_auth_key
string

will POST to webhoook_url with "Authorization: Bearer "

custom_json
string

Provide a custom JSON document, which is stored in our system alongside the image. This is not used to determine any processing steps, it's solely used to exchange additional identifiers between CarCutter and customers for human discussions.

license_plate
string <byte>

Provide a custom license plate inlay PNG image with RGBA channels.

background
string <byte>

Provide a background image with RGBA channels.

overlay
string <byte>

Provide a custom overlay PNG image with RGBA channels.

scene_id
string

Provide a custom scene identification. A Complete list of available scene_ids can be provided on request.

Responses

Response samples

Content type
application/json
{}

vehicle

Delete Vehicle

Sets the status of a vehicle to DELETED.

Authorizations:
api_key
query Parameters
vehicle_id
required
string

Responses

Response samples

Content type
application/json
{
  • "vehicle": {
    }
}

List Vehicles

Authorizations:
api_key
Request Body schema: application/json
customer
required
string

The user id

Array of objects

Only retrieve vehicles which have a match on all specified (column, values) pairs.

limit
integer >= 1

Return up to n results

offset
integer >= 0

Skip the first n results

sort_by
string
Value: "last_update"

Field to sort values on

sort_direction
string
Enum: "ASC" "DESC"

Responses

Request samples

Content type
application/json
{
  • "customer": "string",
  • "filters": [
    ],
  • "limit": 1,
  • "offset": 0,
  • "sort_by": "last_update",
  • "sort_direction": "ASC"
}

Response samples

Content type
application/json
[
  • {
    }
]

List Vehicles to Shoot

Return all vehicles with status new

Authorizations:
api_key

Responses

Response samples

Content type
application/json
{
  • "vehicles": [
    ]
}

Get Vehicle

The status can be new, active or deleted.

Authorizations:
api_key
query Parameters
vehicle_id
required
string

Responses

Response samples

Content type
application/json
{
  • "vehicle": {
    }
}

Add or Update a Vehicle

If a vehicle with that id already exists, it is updated and its status is set to new.

Authorizations:
api_key
Request Body schema: multipart/form-data
custom_reference
string
location
string
lot
string
vehicle_color
string
vehicle_id
required
string

Use the VIN if possible

vehicle_manufacturer
string
vehicle_model
string
vehicle_model_ext
string

Responses

Response samples

Content type
application/json
{
  • "vehicle": {
    }
}

feature

Get a feature of a vehicle

Authorizations:
api_key
Request Body schema: multipart/form-data
feature_id
required
string

ID of the feature.

Responses

Response samples

Content type
application/json
{
  • "features": [
    ]
}

Delete a feature of a vehicle

Authorizations:
api_key
Request Body schema: multipart/form-data
feature_id
required
string

ID of the feature.

Responses

Response samples

Content type
application/json
{
  • "deleted_features": [
    ]
}

Submit a feature for a vehicle

Authorizations:
api_key
Request Body schema: multipart/form-data
annotation_id
string

Public ID of an annotation.

description
string

Additional information about the feature.

detail_image_id
string

Public ID of an image. This is used for linking the feature to the specified image (click of it opens this detail image).

feature_rule_name
string

Feature rule name that is used for assigning features to hotspots.

icon
required
string

The icon that should be displayed in the webplayer.

title
required
string

The title text of the feature (hover text).

type
required
string

This field describes what the type of the feature it is, e.g. text, doc, href, ...

vehicle_id
required
string

ID of the vehicle (usually the vin).

Responses

Response samples

Content type
application/json
{
  • "feature_id": "string"
}

Get all features of a vehicle

Authorizations:
api_key
Request Body schema: multipart/form-data
vehicle_id
required
string

ID of the vehicle (usually the vin).

Responses

Response samples

Content type
application/json
{
  • "features": [
    ]
}

Delete all features of a vehicle

Authorizations:
api_key
Request Body schema: multipart/form-data
vehicle_id
required
string

ID of the vehicle (usually the vin).

Responses

Response samples

Content type
application/json
{
  • "deleted_features": [
    ]
}