Skip to main content
POST
/
v1
/
generation
/
effect-template
Submit Effect Template Creation Task
curl --request POST \
  --url https://api.weryai.com/v1/generation/effect-template \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "template_config_id": 2001,
  "image_url": [
    "https://example.com/photo.jpg"
  ],
  "bgm": false,
  "aspect_ratio": "1:1",
  "prompt_inputs": {
    "style": "cyberpunk"
  },
  "webhook_url": "https://your-server.com/webhook"
}
'
{
  "status": 0,
  "desc": "success",
  "message": "success",
  "data": {
    "batch_id": 123456789,
    "task_ids": [
      "task_abc123"
    ]
  }
}

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:
["https://example.com/photo.jpg"]
​
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:
{ "style": "cyberpunk" }
​
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