Download OpenAPI specification:Download
Global #1 visual AI editing and optimisation solution for the automotive industry
| 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. |
| 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. |
| guideline_id | string The guideline that you want to select for processing. |
| location_id | string The ID of the location (e.g. store) from which this request is sent. |
| processing_speed | string Default: "normal" Enum: "normal" "lazy" The processing speed defines how fast the image will be cut and retouched. |
| vehicle_id | 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. |
| 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. |
| retouching_accuracy | string Default: "normal" Enum: "normal" "precise" The retouching accuracy defines the level of detail that we take for retouching. |
| 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 | bytes Provide a custom license plate inlay PNG image with RGBA channels. |
| overlay | bytes Provide a custom overlay PNG image with RGBA channels. |
| scene_id | string Provide a custom scene identification. |
{- "data": {
- "images": [
- {
- "angle": [
- "exterior",
- "side-left"
], - "status": "processing",
- "phase": "unknown",
- "quality": "ok"
}
]
}
}| image_url required | string URL of the image. May be repeated multiple times to retrieve the status for multiple images. |
{- "data": {
- "images": [
- {
- "angle": [
- "exterior",
- "side-left"
], - "status": "processing",
- "phase": "unknown",
- "quality": "ok"
}
]
}
}| image required | string <binary> Upload the image that you want to process. Either this or |
| image_url required | string URL to the image that you want to process. Either this or |
| cut_type required | string Enum: "complete" "normal" "blur" "none" The cut type to perform on the submitted image. |
| location | string The location of the store at which this image is taken. |
| guideline | string The guideline to use to process this image, different guidelines can specify different processing behaviours. |
| processing_speed | string Enum: "normal" "lazy" The processing speed defines how fast the image will be cut and retouched |
| resolution | string The pixel resolution for the output image, width and height separated by |
| scene_id | string The ID of the 3D scene that you want to use as the background for the image. |
| padding_id | string The padding ID defines how big the border around your car should be on each side. Padding IDs refer to predefined paddings which are available on the server. If you want to use custom paddings, use the other padding parameters. |
| padding_x | string How much border there should be around the car on the left and right side (relative number between 0 and 1). |
| padding_y | string How much border there should be around the car on the top and bottom of the image (relative number between 0 and 1). |
| padding_add_bottom | string Make the border at the bottom of the image wider (relative number between 0 and 1). |
| padding_add_top | string Make the border at the top of the image wider (relative number between 0 and 1). |
| padding_add_left | string Make the border at the left side of the image wider (relative number between 0 and 1). |
| padding_add_right | string Make the border at the right side of the image wider (relative number between 0 and 1). |
| offset_background | string Set this to |
| blurring_license_plate | bool Whether license plates should be detected and blurred. |
| underground_3d | bool Enables or disables the 3D underground. We recommend that you use 3D scenes insteads. If you don't use 3D scenes, 3D underground is the next best option. Only disable 3D undergrounds if you want to submit your own underground as a JPG image. |
| upload_only | bool Deprecated Whether this image should only be uploaded and put into a queue without immediate response. This attribute is deprecated, use the asynchronous API instead. |
| from_manual_retouching | bool Deprecated Only used internally. Specifies whether an image comes from manual retouching. This attribute is deprecated. |
| retouching_accuracy | string Enum: "normal" "precise" The retouching accuracy defines the level of detail that we take for retouching |
| 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. |
| background | bytes Provide a custom background JPG image with RGB channels. |
| license_plate | bytes Provide a custom license plate inlay PNG image with RGBA channels. |
| overlay | bytes Provide a custom overlay PNG image with RGBA channels. |
| vehicle_id required | string ID of the vehicle (usually the vin). |
| title required | string The title text of the feature (hover text). |
| description | string Additional information about the feature. |
| icon required | string The icon that should be displayed in the webplayer. |
| type required | string This field describes what the type of the feature it is, e.g. text, doc, href, ... |
| feature_rule_name | string Feature rule name that is used for assigning features to hotspots. |
| annotation_id | string Public ID of an annotation. |
| 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_id": "string"
}| image_id required | string ID of the image. |
| position_x required | integer The x-coordinate (pixel coordinate) where the hotspot should be shown. |
| position_y required | integer The y-coordinate (pixel coordinate) where the hotspot should be shown. |
| location | string This parameter can be used for annotating a location (car-part). |
{- "annotation_id": "string"
}