For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
DashboardAPI PricingGet an API key
  • Guides
    • Introduction
    • Getting started
    • Use with AI agents
    • Examples
    • Authentication
    • Handling async tasks
    • File uploads
    • File hydration
    • Embedding videos
    • Errors
    • Rate limits
    • Libraries & SDKs
  • REST API Reference
    • Overview
    • Workflows
        • POSTGenerate image
        • POSTGenerate video clip
        • POSTText to speech
        • POSTGenerate sound effect
        • POSTGenerate avatar clip
        • POSTVectorize image
        • POSTRemove background from an image
        • POSTRemove background from a video
        • POSTUpscale an image
        • POSTUpscale a video
        • POSTCancel tool execution
        • GETGet tool execution info
        • GETList files
        • POSTSearch files
        • GETGet file
        • POSTCreate file upload
        • POSTHydrate file
        • POSTArchive file
        • POSTEnable public preview
        • POSTDisable public preview
        • GETList avatar presenters
        • GETList TTS voices
        • GETList webhooks
        • POSTCreate webhook
        • DELDelete webhook
  • Webhook events
    • Overview
    • Changelog
LogoLogo
DashboardAPI PricingGet an API key
REST API ReferenceEndpointsFiles

List files

GET
https://api.videogen.io/v1/files
GET
/v1/files
1import { VideoGenClient } from "@videogen/sdk";
2
3const client = new VideoGenClient({ token: "YOUR_TOKEN" });
4await client.files.getFiles();
200Retrieved
1{
2  "files": [
3    {
4      "fileId": "string",
5      "scope": "GLOBAL",
6      "type": "IMAGE",
7      "displayName": "string",
8      "description": "string",
9      "durationSeconds": 1.1,
10      "transcript": "string",
11      "thumbnailSource": {
12        "status": "pending",
13        "url": "string",
14        "expiresAt": 1.1,
15        "width": 1,
16        "height": 1,
17        "fileBytes": 1
18      },
19      "previewSource": {
20        "status": "pending",
21        "url": "string",
22        "expiresAt": 1.1,
23        "width": 1,
24        "height": 1,
25        "fileBytes": 1
26      },
27      "downloadSource": {
28        "status": "pending",
29        "url": "string",
30        "expiresAt": 1.1,
31        "width": 1,
32        "height": 1,
33        "fileBytes": 1
34      },
35      "hlsSource": {
36        "status": "pending",
37        "url": "string",
38        "expiresAt": 1.1,
39        "width": 1,
40        "height": 1,
41        "fileBytes": 1
42      },
43      "isPublicPreviewEnabled": true,
44      "publicHlsUrl": "string",
45      "publicPlaybackId": "string",
46      "sourceToolType": "string",
47      "sourceToolExecutionId": "string"
48    }
49  ]
50}
List all files in your account, including generated assets and uploads.
Was this page helpful?
Previous

Search files

Next
Built with

Authentication

AuthorizationBearer

API key from app.videogen.io/developers. The full key is only shown once when you create it.

Response

File list
fileslist of objects