Skip to main content
GET
/
api
/
v1
/
client
/
job
/
vidu-templates
Query Vidu template list
curl --request GET \
  --url https://api.crun.ai/api/v1/client/job/vidu-templates \
  --header 'x-api-key: <api-key>'
{
  "code": 200,
  "message": "success",
  "data": {
    "total": 120,
    "templates": [
      {
        "template": "Vintage_Moment_of_Mom",
        "resolution": [
          "1080p"
        ],
        "duration": [
          0
        ],
        "aspect_ratio": [
          "9:16"
        ],
        "output_type": "unspecified",
        "name": "Vintage Moment of Mom",
        "cover": "https://scene.cf.vidu.studio/media-asset/083048-QXAxiKtJUEYIy8ti.png",
        "video": "https://scene.cf.vidu.studio/media-asset/083048-QXAxiKtJUEYIy8ti.png",
        "credits": 9,
        "person_count": "Only single female person photos are supported",
        "input_instruction": "{\"image_count\":\"Only one image can be uploaded\",\"image_url\":[\"https://scene.cf.vidu.studio/media-asset/083031-h9r9GH4Ll5AYpoF1.png\"],\"person_count\":\"Only single female person photos are supported\",\"attention\":\"Single person half-body or full-body photos yield the best results\",\"prompt_instruction\":\"No prompt required for this mode\",\"effect_boundary\":\"There is a low probability of issues such as subtle changes in facial features\"}",
        "category_name": "Festival",
        "category_id": 11,
        "is_hot": true,
        "is_new": false
      }
    ]
  }
}

Overview

Use this endpoint to query the available Vidu effect templates exposed by Crun. This endpoint is designed for developers who want to integrate all Vidu templates with a single API connection. It returns the paginated template catalog, supported options, preview resources, input instructions, official Vidu category metadata, hot/new flags, and credits after Crun-side normalization.
Developers can use this endpoint as the source of truth for template IDs and per-template capabilities, then pass the selected template configuration directly into vidu/template for one-click integration of all supported templates.

Use Cases

  1. Build a 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 parameter
  4. Drive dynamic form rendering based on returned template metadata
  5. Use page and page_size to paginate large template catalogs

Official References

  • Official Vidu template gallery examples: Templates
  • Official Vidu template generation API: Template

Vidu Template Video

Submit a Vidu template video generation task with the selected template and template-specific 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 for paginated template list queries. Ignored when template is provided.

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

Number of templates per page. The maximum value is 50. Ignored when template is provided.

Required range: x <= 50
template
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