Autobg
  • Autobg Enterprise Api's
    • Create TemplatePOST
    • List TemplatesPOST
    • Upload/Process Images without Template.POST
    • Upload/Process Images with TemplatePOST
    • Get Image StatusPOST
    • Get Images in Base64 FormatGET
    • Get Images RawGET
    • User Credit DetailsPOST
  • Autobg Custom APIs
logoPowered by Apidog
  1. Autobg Enterprise Api's

Create Template

POSThttps://apis.autobg.ai/public/api/v1/templates/create

Use our template creation api to create a template in a blink of an eye to start
generating eye-catching automotive images.

Request

Authorization: API Key
Add parameter in header
Authorization
Example
Authorization: 2f68dbbf-519d-4f01-9636-e2421b68f379
Body Params multipart/form-data
background
file 
required

Mandatory parameter representing the background image to be substituted in your image. This file is required for the operation

side
file 
optional

An optional parameter (mandatory for multi-backdrops) representing the background image to be substituted in your side-angled image. This file is required for the operation

frontRear
file 
optional

An optional parameter (mandatory for multi-backdrops) representing the background image to be substituted in your front/rear-angled image. This file is required for the operation

numberPlate
file 
optional

An optional parameter allowing the replacement of the existing number plate in your image. If you wish to update the number plate, provide the corresponding image file; otherwise, this parameter can be left blank.

brandLogo
file 
optional

Optional parameter for incorporating your brand logo into the image. If you desire to include your logo, kindly provide the corresponding image/file; otherwise, this parameter can be left blank

numPlate
boolean 
required

Boolean parameter indicating whether to include a number plate in the image. If set to true, provide the corresponding image/file for the number plate; otherwise, leave this parameter blank..

bAlignment
string 
optional

Brand alignment(TL: Top Left, TR: Top Right)

name
string 
required

This parameter specifies the name of the template you intend to use. It serves as a unique identifier for the created template.

numPlateBgHexCode
string 
optional

This parameter is mandatory when a transparent number plate (PNG file) is provided; otherwise, it is optional.

Example:
#FFFFFF

Request samples

Responses

OK(200)
Unauthorized(401)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
status
boolean 
required
message
string 
required
data
object 
required
templateID
integer 
required
Example
Not configured
Last modified: 7 months ago