Create Template
POST
https://apis.autobg.ai/public/api/v1/templates/create
Description
This API supports up to 100 requests per minute per user.
API Request & Response Guidelines
🟢 200 OK
Template Created
{
"status": true,
"message": "",
"data": {
"templateID": 123
}
}🟢 200 OK (Business Validation Errors)
Validation / Processing Errors
Missing Brand Logo
{
"status": false,
"message": "Missing Brand Logo Image File",
"data": []
}Missing Brand Alignment
{
"status": false,
"message": "Missing Brand Alignment (bAlignment value)",
"data": []
}Invalid File Type
{
"status": false,
"message": "File Not Allowed: Replace Background [background.png] with valid image file",
"data": []
}File Not Allowed: Replace {FieldName} [{FileName}] with valid image fileFile Size Exceeded
{
"status": false,
"message": "File Max Size Exceeded! Allowed Background [background.jpg] Size: 15 MB",
"data": []
}File Max Size Exceeded! Allowed {FieldName} [{FileName}] Size: 15 MBInvalid Filename
{
"status": false,
"message": "File Not Allowed, Background [背景.jpg] should only contain English Character Set. Please rename the file and try again."
}Pattern:
File Not Allowed, {FieldName} [{FileName}] should only contain English Character Set. Please rename the file and try again.Background Format Error
{
"status": false,
"message": "Background Suported Formats: [jpg, jpeg]",
"data": []
}Side Backdrop Format Error
{
"status": false,
"message": "Side Backdrop Suported Formats: [jpg, jpeg]",
"data": []
}Front/Rear Backdrop Format Error
{
"status": false,
"message": "Front/Rear Backdrop Suported Formats: [jpg, jpeg]",
"data": []
}Invalid Number Plate Background Color
{
"status": false,
"message": "Enter a valid background hex code for a transparent number plate.",
"data": []
}Invalid Input
{
"status": false,
"message": "Something is missing or incorrect. Please recheck all inputs.",
"data": []
}namenamenumPlatebAlignmentTemplate Save Failure
{
"status": false,
"message": "Error saving template.",
"data": []
}Internal Processing Errors
{
"status": false,
"message": "Unique constraint failed"
}🟠400 Bad Request
Invalid File Combination
libraryBackdropIDbackgroundbackground + side + frontRear{
"status": false,
"message": "Valid combinations are: only libraryBackdropID, only background, or background + side + frontRear."
}🟠401 Unauthorized
Missing or Invalid Authorization
{
"status": false,
"message": "You are not Authorized"
}🟠404 Not Found
{
"status": false,
"message": "Not Found"
}🟠429 Too Many Requests
100 requests per minute per user/API key{
"status": false,
"message": "Rate limit exceeded."
}🔴 500 Internal Server Error
Unexpected Server Error
{
"status": false,
"message": "Service unavailable"
}{
"status": false,
"message": "<error message>"
}Important Note
"status": false in the response body. Always inspect the status field to determine whether the operation succeeded.Request
Body Params multipart/form-data
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://apis.autobg.ai/public/api/v1/templates/create' \
--header 'Authorization: <api-key>' \
--form 'name="API-Template-1"' \
--form 'libraryBackdropID="1"' \
--form 'background=@""' \
--form 'side=@""' \
--form 'frontRear=@""' \
--form 'numPlate=""' \
--form 'numberPlate=@""' \
--form 'numPlateBgHexCode="\#FFFFFF"' \
--form 'brandLogo=@""' \
--form 'bAlignment=""'Response Response Example
200 - Example 1
{
"status": true,
"message": "",
"data": {
"templateID": 367
}
}Modified at 2026-06-15 10:20:23