List videos | Sample

3 parameters

limitintegeroptional

Number of items to retrieve

orderstringoptional

Sort order of results by timestamp. Use `asc` for ascending order or `desc` for descending order.

Allowed:ascdesc

afterstringoptional

Identifier for the last item from the previous pagination request

1 status code

200Success

objectstringrequired

The type of object returned, must be `list`.

Allowed:listDefault:list

dataarray<VideoJob>required

A list of items

first_idstringrequired

The ID of the first item in the list.

last_idstringrequired

The ID of the last item in the list.

has_morebooleanrequired

Whether there are more items available.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.videos.list({
  limit: 20,
  order: "example",
  after: "example",
});

{
  "object": "list",
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "object": "video",
      "model": "example_value",
      "status": "queued",
      "progress": 1,
      "created_at": 1,
      "completed_at": 1,
      "expires_at": 1,
      "prompt": "example_value",
      "size": "720x1280",
      "seconds": "example_value",
      "remixed_from_video_id": "550e8400-e29b-41d4-a716-446655440000",
      "error": {
        "code": "123456",
        "message": "This is an example message.",
        "misalignment": {
          "error_type": null,
          "detailed_explanation": "example_value",
          "steer": {
            "message": null
          }
        }
      }
    }
  ],
  "first_id": "550e8400-e29b-41d4-a716-446655440000",
  "last_id": "550e8400-e29b-41d4-a716-446655440000",
  "has_more": true
}

Request

Response