Retrieve the list of videos currently running via the API along with the available account capacity

December 6, 2024

Table of contents

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

This endpoint retrieves the list of videos currently running via the API along with the available account capacity.

If you want to get all videos currently being executed including you manually initiated from PixVerse.ai website use GET /videos.

https://api.useapi.net/v2/pixverse/scheduler/available

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

  • 200 OK

    {
    "executing": [
        {
            "video_id": "user:user_id-pixverse:email-video:id1",
            "started": "2024-09-25T01:55:16.128Z",
            "elapsed": "03:57",
            "replyUrl": "<optional callback URL>",
            "replyRef": "<optional reference>"
        },
        {
            "video_id": "user:user_id-pixverse:email-video:inN",
            "started": "2024-09-25T01:58:18.555Z",
            "elapsed": "00:35",
            "replyUrl": "<optional callback URL>",
            "replyRef": "<optional reference>"
        }
    ],
    "available": [
        {
            "email": "<email_1>",
            "maxJobs": 5,
            "executing": 0,
            "available": 5
        },
        {
            "email": "<email_2>",
            "maxJobs": 8,
            "executing": 3,
            "available": 2
        },
        {
            "email": "<email_N>",
            "maxJobs": 3,
            "executing": 2,
            "available": 1
        }
    ]
}

  • 401 Unauthorized

    {
  "error": "Unauthorized",
  "code": 401
}
Model 
{ // TypeScript, all fields are optional
    executing: {
        video_id: string
        started: string 
        elapsed: string 
        replyUrl: string
        replyRef: string
    }[]
    available: {
        email: string
        maxJobs: number
        executing: number
        available: number
    }[]
    error: string
    code: number
}
Examples 
  • curl "https://api.useapi.net/v2/pixverse/scheduler/available" \
   -H "Accept: application/json" \
   -H "Authorization: Bearer …" 

  • const token = "API token";
const apiUrl = `https://api.useapi.net/v2/pixverse/scheduler/available`; 
const response = await fetch(apiUrl, {
  headers: {
    "Authorization": `Bearer ${token}`,
  },
});
const result = await response.json();
console.log("response", {response, result});

  • import requests
token = "API token"
apiUrl = f"https://api.useapi.net/v2/pixverse/scheduler/available"
headers = {
    "Content-Type": "application/json", 
    "Authorization" : f"Bearer {token}"
}
response = requests.get(apiUrl, headers=headers)
print(response, response.json())
Try It