Skip to main content
POST
Submit Effect Template Creation Task

Authorizations

Authorization
string
header
required

Authenticate using Bearer token. Get your API Key from the WeryAI Console.

Example: Authorization: Bearer sk-xxxxxxxxxxxxxxxx

Body

application/json
template_config_id
integer<int64>
required

Template configuration ID (obtained from the effect template list endpoint)

Example:

2001

image_url
string<uri>[]
required

Image URL list (supports jpg, jpeg, png, webp). The number of images should match the image_input value from the template config.

Minimum array length: 1
Example:
bgm
boolean
default:false

Whether to add background music (only applicable when the template config supports bgm)

aspect_ratio
string

Aspect ratio (must be one of the supported ratios from the template config)

Example:

"1:1"

prompt_inputs
object

Prompt placeholder inputs as key-value pairs. Keys should match the key field from prompt_variables in the template config.

Example:
webhook_url
string<uri>

Callback URL where results will be sent when task completes

Example:

"https://your-server.com/webhook"

caller_id
integer<int64>

Caller ID (for business association)

Response

Task submitted successfully

status
integer

Business status code (0 indicates success)

Example:

0

desc
string

Status description

Example:

"success"

message
string

Multi-language message

Example:

"success"

data
object