Reference

Rate Limiting

We currently rate limit requests to 60 per minute or 1 per second. If you need more, please contact us.

Token Information

You can use this endpoint to retrieve information about your user account.

Request

GET

https://portal.autocartel.com/v1/user

Response

{
    "id": 1,
    "name": "Test",
    "email": "test@test.com",
    "revoked": 0,
    "created_at": "2023-09-10T18:26:12.000000Z",
    "updated_at": "2023-09-10T18:32:32.000000Z"
}

AI Background

This is our main endpoint used for processing vehicle photos.

We currently only support exterior photos of vehicles using this model.

Request

POST

https://portal.autocartel.com/v1/background

{
    "vertical_position": 0,
    "horizontal_position": 50,
    "scale": 85,
    "vertical_scale": 99,
    "background_url": "{LINK TO BACKGROUND IMAGE URL}",
    "original_url": "{LINK TO ORIGINAL VEHICLE PHOTO}",
    "note": "This is an optional note for the request",
    "preview": true
}

Response

{
    "status": "enqueued",
    "data": "{REQUEST_ID}",
    "note": "This is an optional note for the request",
    "preview": true
}

Request Status

Since our API requests are queued, you can use this endpoint to check the status of your request.

Request

GET

https://portal.autocartel.com/v1/status/{REQUEST_ID}

Response

200

{
    "status": "success",
    "data": "https://cdn.autocartel.com/results/39-39-6c0195003f6343e74856b47b89c6523836564f4c.jpg",
    "note": "This is an optional note for the request",
    "preview": true
}

200

We will also respond with a 200 if the request has failed.

{
    "status": "failure",
    "data": "{ERROR MESSAGE}"
}

Possible Error Messages

Required payload errors
The background URL is not a valid URL.
The original URL is not a valid URL.
The background image could not be retrieved.
The original image could not be retrieved.
The background image failed to download.