1. Autobg Enterprise Api's
Autobg
  • Operational Guidelines
    • AI/Collab Processing Webhook Notification Doc
    • Reported Image Review Webhook Notification Doc
  • Autobg Enterprise Api's
    • Create Template
      POST
    • List Templates
      POST
    • List Autobg Library
      GET
    • Upload/Process Images without Template.
      POST
    • Upload/Process Images with Template
      POST
    • Upload/Process Images with Template with Dynamic Branding
      POST
    • (Beta Mode) Upload/Process Images with Default Library Backdrop Templates
      POST
    • Upload/Process S3 Urls without Template.
      POST
    • Upload/Process S3 Urls with Template
      POST
    • Upload/Process S3 Urls with Template with Dynamic Branding
      POST
    • Report Images
      POST
    • Get Image Status
      POST
    • Download Processed Images
      POST
    • User Usage
      POST
    • User Credit Details
      POST
    • Get Raw Image in Base64 Format
      GET
    • Get Raw Image
      GET
  • Autobg Custom APIs
    • replaceNumPlate-v3
      POST
    • replaceNumPlateS3-v3
      POST
    • Send Images For QA
      POST
  1. Autobg Enterprise Api's

Upload/Process Images with Template

POST
https://apis.autobg.ai/public/api/v1/images/uploadWithTemplateCC

Description#

This API processes uploaded images using a custom template that was previously created through the Create Template API or the AutoBG Dashboard. The selected template is applied during image processing, allowing predefined customizations and consistent output generation.
Users can submit up to 20 image files per request, and the system will process them using the specified template.
Processing Types :
1. AI Processing
Use the following process type to receive AI-generated results:
"processType": "ai"
2. QA / Collaboration Processing
Use the following process type for QA or collaboration-based workflows:
"processType": "collab"
For real-time completion updates, refer to the AI/Collab Processing Webhook Notification Doc.
Rate Limits
API Rate Limit: 10 requests per minute per user
Image Processing Limit: 10 images per minute per user
Max Upload Limit: 20 images per request

API Request & Response Guidelines#

🟢 200 OK#

Images Processed Successfully#

Returned when all validations pass and image processing completes successfully.
{
    "status": true,
    "message": "Data Processed",
    "data": {
        "batchID": 1474,
        "images": [
            {
                "fileName": "AHL64S_01.jpg",
                "error": false,
                "errorMsg": ""
            }
        ]
    }
}

🟢 200 OK (Business Validation Errors)#

Mandatory Fields#

Missing numberPlate
{
  "status": false,
  "message": "Number Plate is Required"
}
Missing processType
{
  "status": false,
  "message": "processType field`s accepted values: [`ai`, `collab`]"
}
Invalid Template ID
{
  "status": false,
  "message": "templateCC must be an integer"
}

File Validation Errors#

File Not Allowed
{
  "status": false,
  "message": "File Not Allowed, Replace [image.jpg] with valid image file"
}
File Size Exceeded
{
  "status": false,
  "message": "File Max Size Exceeded! Allowed [image.jpg] Size: 15 MB"
}
File Not Uploaded
{
  "status": false,
  "message": "File Not Uploaded, [image.jpg]"
}
Invalid File Name
{
  "status": false,
  "message": "File Not Allowed, [image.jpg] should only contain English Character Set. Please rename the file and try again."
}

No Active Plan#

No Active Plan History
{
  "status": false,
  "message": "No Active Plan History",
  "data": {}
}
User plan data Missing
{
  "status": false,
  "message": "Insufficient Credits to Process Images.",
  "data": {}
}

Template Errors#

Template Not Found
Returned when template ID is invalid or inaccessible.
{
  "status": false,
  "message": "Template doesn't exists",
  "data": {}
}

🟠 401 Unauthorized#

Missing or Invalid Authorization#

Returned when authentication fails.
Possible reasons:
Authorization header missing
API key invalid
User not found or inactive
{
  "status": false,
  "message": "You are not Authorized"
}

🟠 429 Too Many Requests#

API Request Rate Limit Exceeded#

Returned when the user exceeds the allowed number of API requests within the configured time window.
{
  "status": false,
  "message": "Rate limit exceeded."
}

Image Processing Limit Exceeded#

Returned when the total number of submitted images exceeds the user's image-processing quota for the current 1-minute window.
{
  "status": false,
  "message": "Image creation limit reached (10 images per minute) for this endpoint. Please retry after 1 minute."
}

🔴 500 Internal Server Error#

Returned when an unexpected error occurs during processing.
{
  "status": false,
  "message": "Internal server error"
}
Generic format:
{
  "status": false,
  "message": "<error message>",
  "data": []
}

Important Note#

Consumers of this API should not rely solely on the HTTP status code. Some validation and business-rule failures may return HTTP 200 OK with "status": false in the response body. Always inspect the status field to determine whether the operation succeeded.

Request

Authorization
Add parameter in header
Authorization
Example:
Authorization: ********************
Body Params multipart/form-data

Responses

🟢200OK
application/json
Bodyapplication/json

🟠401Unauthorized
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://apis.autobg.ai/public/api/v1/images/uploadWithTemplateCC' \
--header 'Authorization: <api-key>' \
--form 'cc=@""' \
--form 'numberPlate="AB12CD3456"' \
--form 'templateCC="6"' \
--form 'processType="collab"'
Response Response Example
200 - Example 1
{
    "status": true,
    "message": "Data Processed",
    "data": {
        "batchID": 1474,
        "images": [
            {
                "fileName": "AHL64S_01.jpg",
                "error": false,
                "errorMsg": ""
            },
            {
                "fileName": "AHL64S_03.jpg",
                "error": false,
                "errorMsg": ""
            },
            {
                "fileName": "AHL64S_05.jpg",
                "error": false,
                "errorMsg": ""
            },
            {
                "fileName": "b0d208bf-b52b-4c53-a547-d60fc73a0f6c.jpg",
                "error": false,
                "errorMsg": ""
            }
        ]
    }
}
Modified at 2026-06-15 06:42:03
Previous
Upload/Process Images without Template.
Next
Upload/Process Images with Template with Dynamic Branding
Built with