Skip to main content
GET
Query ByteDance AI effect template list

Overview

Use this endpoint to query the available ByteDance AI effect templates exposed by Crun. This endpoint is designed for developers who want to integrate all ByteDance templates with a single API connection. It returns template metadata, cover assets, preview videos, input image requirements, supported aspect ratios, supported resolutions, and Crun-normalized credit costs.
Developers can use this endpoint as the source of truth for ByteDance template IDs and per-template capabilities, then pass the selected TemplateId directly into bytedance/template for one-click integration of all supported templates.

Use Cases

  1. Build a ByteDance template marketplace or template picker UI
  2. Synchronize the latest template list on a scheduled basis
  3. Query a single template by passing the optional template_id parameter
  4. Drive dynamic form rendering based on InputNum, InputRequirement, TemplateType, and ConsumeItems
You can also open the official ByteDance template gallery, choose a template, and copy its template ID:

ByteDance Template Video

Submit a ByteDance template video generation task with the selected template and image inputs.

Get Task Info

Query generation status and retrieve final results after task submission.

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

Query Parameters

page
integer
default:1

Page number. Ignored when template_id is provided.

Required range: x >= 1
page_size
integer
default:20

Number of templates per page. Maximum value is 50. Ignored when template_id is provided.

Required range: x <= 50
template_id
string
default:""

Optional template ID. When provided, the API returns only the matching template.

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