Skip to main content
POST
Generate video with a ByteDance AI effect template

Overview

Use this endpoint to generate a video from a ByteDance AI effect template through Crun’s unified task creation API. The outer request uses model: "bytedance/template". The input object contains the selected template ID, one or more input image URLs, and the target output resolution:
To integrate all ByteDance AI effect templates at once, call /api/v1/client/job/bytedance-templates first, render the returned template catalog in your app, then submit the selected TemplateId as template_id to this generation endpoint.

Template Discovery

Before creating a task, query the Crun ByteDance template list endpoint:

ByteDance Template List

Query available ByteDance AI effect templates, preview assets, input requirements, supported resolutions, and credits.
The list endpoint is designed for one-click integration of all templates:
  1. Query /api/v1/client/job/bytedance-templates
  2. Display templates, covers, preview videos, supported resolutions, and credit costs
  3. Use the selected TemplateId, image count requirement, and resolution options to call bytedance/template
You can also open the official ByteDance template gallery, choose a template, and copy its template ID:

Query Task Status

After submitting a task, use the unified query endpoint to check progress and retrieve results:

Get Task Info

Learn how to query task status and retrieve generation results
For production use, we recommend using the callback_url parameter to receive automatic notifications when generation completes, rather than polling the status endpoint.

ByteDance Template List

Query all available ByteDance AI effect templates and support one-click template integration.

Models Overview

Explore all available generation models on Crun.

Authorizations

x-api-key
string
header
required

All APIs require authentication via API Key.

Get API Key:

  1. Visit API Key Management Page to get your API Key

Usage: Add to request header:

x-api-key: YOUR_API_KEY

Note:

  • Keep your API Key secure and do not share it with others
  • If you suspect your API Key has been compromised, reset it immediately in the management page

Body

application/json
model
enum<string>
required

The model name to use for generation. Required field.

  • Must be bytedance/template for this endpoint
Available options:
bytedance/template
input
object
required

Input parameters for ByteDance AI effect template video generation.

callback_url
string<uri>

Optional. Callback URL for receiving task completion notifications.

  • System will POST task status and results to this URL when generation completes
  • Callback payloads structure is consistent with the data object returned by the task status query
  • Your callback endpoint should accept POST requests with JSON payload containing results
  • It returns an HTTP 200 status code upon successful receipt
Example:

"https://your-domain.com/api/callback"

Response

Request successful

code
enum<integer>

Response status code

  • 200: Success - Request has been processed successfully
  • 401: Unauthorized - Authentication credentials are missing or invalid
  • 402: Insufficient Credits - Account does not have enough credits to perform the operation
  • 404: Not Found - The requested resource or endpoint does not exist
  • 422: Validation Error - The request parameters failed validation checks
  • 429: Rate Limited - Request limit has been exceeded for this resource
  • 455: Service Unavailable - System is currently undergoing maintenance
  • 500: Server Error - An unexpected error occurred while processing the request
  • 501: Generation Failed - Content generation task failed
  • 505: Feature Disabled - The requested feature is currently disabled
Available options:
200,
401,
402,
404,
422,
429,
455,
500,
501,
505
message
string

Response message, error description when failed

Example:

"success"

data
object