1. Preparation
PixVerse Platform Docs
  • Get Started
    • What Is PixVerse AI?
    • Model Capability Map
    • Billing and Usage
    • Quick Start
    • Contact Us
    • Privacy and Data Protection
  • API
    • Preparation
      • Start Here
      • Concurrency Rules
      • Query Task Status
      • Error Codes
      • FAQ
      • Webhook Callbacks
      • Upload Image
        POST
      • Upload Media (Video and Audio)
        POST
      • Verify Uploaded Audio
        POST
      • Get Effect Template List
        GET
      • Get TTS Speaker List
        GET
      • Get Restyle Effect List
        GET
      • Query Task Status
        GET
      • Get Account Balance
        GET
      • Usage Deduction Query
        POST
      • Create Custom Voice
        POST
      • Delete Custom Voice
        DELETE
    • Core Capabilities
      • Text-to-Video
      • Image-to-Video and Video Templates
      • First and Last Frame Video
      • Reference-to-Video (Fusion)
      • Multi-Transition Video
      • Video Extend
      • Image Template Generation
      • Get Image Generation Result
    • Solutions
      • Video Upscale
      • Video Restyle
      • Lipsync
      • Video Edit (Modify)
      • Image Avatar
      • Select Video Mask
      • Sound Effect
      • Subject Replacement (Swap)
      • Motion Control (Mimic)
      • One-click Real Estate Video
      • One-click VibeMV
  • Pricing
    • PixVerse API Pricing
  • Changelog
    • Changelog
  1. Preparation

Get Effect Template List

GET
/openapi/v2/video/effects/templates/list
Query traditional effect templates and workflow templates to retrieve a list of template details, including input requirements, supported resolutions, and credit configuration.

Request

Query Params

Header Params

Responses

๐ŸŸข200
application/json
Request processed. ErrCode=0 indicates business success; a nonzero ErrCode indicates failure, even with HTTP 200.
Bodyapplication/json

๐ŸŸ 400
๐ŸŸ 401
Request Request Example
Shell
curl --location 'https://app-api.pixverse.ai/openapi/v2/video/effects/templates/list?type=&template_ids=&page=&pageSize=&%20template_mode=undefined' \
--header 'API-KEY: your-api-key' \
--header 'Ai-trace-id: 550e8400-e29b-41d4-a716-446655440000' \
--header 'Accept-Language;'
Response Response Example
200 - Illustrative template metadata, not a fixed catalog
{
    "ErrCode": 0,
    "ErrMsg": "Success",
    "Resp": {
        "effect_items": [
            {
                "template_id": 424590596481004,
                "display_name": "Disco Fever โ€™80s",
                "display_prompt": "Step onto the dance floor, spin to the beat, and light up the night in pure โ€™80s disco style.",
                "thumbnail_video_url": "https://media.pixverse.ai/canvas%2Fasset%2F6b93ceb5-c02b-46b9-89c9-337f19c83566.mp4",
                "qualities": [],
                "effect_type": "1",
                "effect_length": [
                    5
                ],
                "topic_requirements": "1",
                "type": 1,
                "create_at": "2026-09-16 08:04:00",
                "credit_consume": [
                    {
                        "consume_desc_key": "360p",
                        "credit": "115"
                    },
                    {
                        "consume_desc_key": "540p",
                        "credit": "115"
                    },
                    {
                        "consume_desc_key": "720p",
                        "credit": "115"
                    },
                    {
                        "consume_desc_key": "1080p",
                        "credit": "115"
                    }
                ],
                "template_mode": "workflow",
                "template_source": 21,
                "canvas_image_count": 1,
                "input_limit": [
                    {
                        "input_key": "image-98114284-c3b9-46c1-a693-516b96d11357",
                        "content_type": "image",
                        "name": "Generate a European-style half-body portrait of a female, with a simple, sophisticated, and bright background. Style: ๆธ…_GPT Image 2_1080p (7)",
                        "max_size": 31457280
                    }
                ],
                "outputs": [
                    {
                        "content_type": "video"
                    }
                ]
            }
        ]
    }
}
Previous
Verify Uploaded Audio
Next
Get TTS Speaker List