Retrieve the list of effects
December 6, 2024 (August 8, 2025)
Table of contents
The returned effect_type
field indicates the number of images required for a given effect.
https://api.useapi.net/v2/pixverse/videos/effects?…
Request Headers
Authorization: Bearer {API token}
Content-Type: application/json
API token
is required, see Setup useapi.net for details.
Query Parameters
email
is optional when only one account configured. However, if you have multiple accounts configured, this parameter becomes required.
Responses
-
{ "items": [ { "display_name": "Let's Dance!", "workflow_tag": "babydance_250227", "template_id": 324641581197696, "thumbnail_path": "https://media.pixverse.ai/…png", "thumbnail_video_path": "https://media.pixverse.ai/…mp4", "thumbnail_gif_path": "https://media.pixverse.ai/…gif", "marker": "hot", "created_at": "2025-02-27T06:45:51Z", "updated_at": "2025-03-28T03:45:08Z", "display_prompt": "Everyone, join the Disco Party Jam!", "i18n_json": "…", "example_list": "…", "qualities": [ "360p", "540p", "720p", "1080p" ], "audio_path": "asset/template/324641581197696.MP3", "effect_type": "1" }, { "display_name": "Forever Us", "workflow_tag": "couple_250311", "template_id": 326733946317888, "thumbnail_path": "https://media.pixverse.ai/…png", "thumbnail_video_path": "https://media.pixverse.ai/…mp4", "thumbnail_gif_path": "https://media.pixverse.ai/…gif", "marker": "new", "created_at": "2025-03-11T02:33:33Z", "updated_at": "2025-03-25T06:53:36Z", "i18n_json": "…", "example_list": "…", "qualities": [ "360p", "540p", "720p", "1080p" ], "audio_path": "asset/template/326733946317888.MP3", "effect_type": "2" }, ] }
-
{ "error": "<Error message>", "code": 400 }
-
{ "error": "Unauthorized", "code": 401 }
Model
{ // TypeScript, all fields are optional
items: {
display_name: string
workflow_tag: string
template_id: number
thumbnail_path: string
thumbnail_video_path: string
thumbnail_gif_path: string
marker: string
created_at: string
updated_at: string
display_prompt: string
i18n_json: string
example_list: string
qualities: string[]
audio_path: string
effect_type: string
}[]
total: number
next_offset: number
}
Examples
-
curl "https://api.useapi.net/v2/pixverse/videos/effects?email=email" \ -H "Accept: application/json" \ -H "Authorization: Bearer …"
-
const token = "API token"; const email= "Previously configured account email"; const apiUrl = `https://api.useapi.net/v2/pixverse/videos/effects?email=${email}`; const response = await fetch(apiUrl, { headers: { "Authorization": `Bearer ${token}`, }, }); const result = await response.json(); console.log("response", {response, result});
-
import requests token = "API token" email= "Previously configured account email" apiUrl = f"https://api.useapi.net/v2/pixverse/videos/effects?email={email}" headers = { "Content-Type": "application/json", "Authorization" : f"Bearer {token}" } response = requests.get(apiUrl, headers=headers) print(response, response.json())