Video

/api/v1/video/retrieve

Retrieve a video generation result. Returns the video file if completed, or a status if the request is still processing.

Authentication: This endpoint accepts either a Bearer API key or a SIGN-IN-WITH-X header for x402 wallet-based authentication. The legacy X-Sign-In-With-X header is also accepted during migration. When using x402, a 402 Payment Required response indicates insufficient balance and includes top-up instructions.

post/api/v1/video/retrieve

Request

  • Base URL: https://api.venice.ai
  • URL: https://api.venice.ai/api/v1/video/retrieve
  • Auth: one of:
    • HTTP bearer
    • API key in header SIGN-IN-WITH-X

Request body

modelstring required

The ID of the model used for video generation.

queue_idstring required

The ID of the video generation request.

delete_media_on_completionboolean

If true, the video media will be deleted from storage after the request is completed. If false, you can use the complete endpoint to remove the media once you have successfully downloaded the video.

Example request

{
  "model": "video-model-123",
  "queue_id": "123e4567-e89b-12d3-a456-426614174000"
}

Response

Video file if completed, or processing status if still in progress

status'PROCESSING' | 'COMPLETED' required

The status of the video generation request.

average_execution_timenumber required

The estimated execution time of the video generation request in milliseconds (P80).

execution_durationnumber required

The current duration of the video generation request in milliseconds.

Example response

{
  "status": "PROCESSING",
  "average_execution_time": 145000,
  "execution_duration": 53200
}

Changes

No recorded changes to this operation across all 1 revision of this API.