Create Template

POST

https://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

Add parameter in header

Authorization

Example:

Authorization: ********************

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

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://apis.autobg.ai/public/api/v1/templates/create' \
--header 'Authorization;' \
--form 'background=@""' \
--form 'side=@""' \
--form 'frontRear=@""' \
--form 'numberPlate=@""' \
--form 'brandLogo=@""' \
--form 'numPlate=""' \
--form 'bAlignment=""' \
--form 'name=""' \
--form 'numPlateBgHexCode="#FFFFFF"'

Responses

🟢200OK

application/json

Body

status

boolean

required

message

string

required

data

object

required

templateID

integer

required

Example

{
  "status": true,
  "message": "string",
  "data": {
    "templateID": 0
  }
}

🟠401Unauthorized

Modified at 2024-05-24 12:16:43

List Templates