Retrieve the list of effects

December 6, 2024

Table of contents

  1. Request Headers
  2. Query Parameters
  3. Responses
  4. Model
  5. Examples
  6. Try It

https://api.useapi.net/v2/pixverse/videos/effects?…

Request Headers 
Authorization: Bearer {API token}
Content-Type: application/json
Query Parameters

  • email is optional when only one account configured. However, if you have multiple accounts configured, this parameter becomes required.

  • limit is optional, specify the number of videos to return. Default 100.

  • offset is optional, specify the offset from where to start.

Responses

  • 200 OK

    {
    "items": [
        {
            "display_name": "We Are Venom!",
            "workflow_tag": "venom_241030",
            "template_id": 303624537709312,
            "thumbnail_path": "https://media.pixverse.ai/1.png",
            "thumbnail_video_path": "https://media.pixverse.ai/1.mp4",
            "marker": "hot",
            "created_at": "2024-10-31T12:08:42Z",
            "updated_at": "2024-12-05T05:59:55Z",
            "display_prompt": "Transform into a [BLACK] Venom",
            "i18n_json": "{...}",
            "example_list": "[...]"
        },
        {
            "display_name": "Hot Harley Quinn",
            "workflow_tag": "harley_quinn_241121",
            "template_id": 307489434436288,
            "thumbnail_path": "https://media.pixverse.ai/2.png",
            "thumbnail_video_path": "https://media.pixverse.ai/2.mp4",
            "marker": "new",
            "created_at": "2024-11-22T08:21:19Z",
            "updated_at": "2024-12-04T17:40:30Z",
            "display_prompt": "Transform into Harley Quinn, mastering allure and chaos",
            "i18n_json": "{...}",
            "example_list": "[...]"
        }
    ]
}

  • 400 Bad Request

    {
    "error": "<Error message>",
    "code": 400
}

  • 401 Unauthorized

    {
  "error": "Unauthorized",
  "code": 401
}
Model 
{   // TypeScript, all fields are optional
    items: {
        template_id: number
        display_name: string
        workflow_tag: string
        thumbnail_path: string
        thumbnail_video_path: string
        marker: string
        created_at: string
        updated_at: string
        display_prompt: string
        i18n_json: {
            "zh-CN": {
                display_name: string
                display_prompt: string
            }
        } | string
        example_list: {
            img_id: number
            img_url: string
        }[] | 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())
Try It