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
        • POSTtool_execution.succeeded
        • POSTtool_execution.failed
        • POSTtool_execution.cancelled
        • POSTfile.upload.completed
        • POSTfile.upload.failed
        • POSTfile.playback_ready
        • POSTfile.download_ready
        • POSTfile.analysis_completed
        • POSTfile.analysis_failed
    • Changelog
LogoLogo
DashboardAPI PricingGet an API key
Webhook eventsWebhook Events

file.upload.failed

Payload
1{
2  "event": "file.upload.completed",
3  "fileId": "string",
4  "occurredAt": 1.1,
5  "file": {
6    "fileId": "string",
7    "scope": "GLOBAL"
8  }
9}
Delivered when a file upload fails. Only fired for files uploaded via the API.
Was this page helpful?
Previous

file.playback_ready

Next
Built with

Payload

The payload of this webhook request is an object.
eventenumRequired

Webhook event types for file upload lifecycle. Only fired for files uploaded via the API (not the VideoGen UI).

fileIdstringRequired

File id (e.g. vg_file_...).

occurredAtdoubleRequired

Seconds since epoch (Unix timestamp) when the event occurred.

fileobjectRequired
Hydrated file object with the latest state at the time of the event.
errorobject or nullOptional

Error details. Present only on file.upload.failed and file.analysis_failed.

Response

200
Acknowledge receipt