Skip to main content
GET
/
videos
/
{id}
# Docs for v2 can be found by changing the above selector ^
from together import Together
import os

client = Together(
    api_key=os.environ.get("TOGETHER_API_KEY"),
)

response = client.videos.retrieve(video_id)

print(response.id)
{
  "id": "<string>",
  "model": "<string>",
  "status": "in_progress",
  "created_at": 123,
  "size": "<string>",
  "seconds": "<string>",
  "object": "video",
  "completed_at": 123,
  "error": {
    "message": "<string>",
    "code": "<string>"
  },
  "outputs": {
    "cost": 123,
    "video_url": "<string>"
  }
}

Authorizations

​
Authorization
string
header
default:default
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Identifier of video from create response.

Response

Success

Structured information describing a generated video job.

​
id
string
required

Unique identifier for the video job.

​
model
string
required

The video generation model that produced the job.

​
status
enum<string>
required

Current lifecycle status of the video job.

Available options:
in_progress,
completed,
failed
​
created_at
number
required

Unix timestamp (seconds) for when the job was created.

​
size
string
required

The resolution of the generated video.

​
seconds
string
required

Duration of the generated clip in seconds.

​
object
enum<string>

The object type, which is always video.

Available options:
video
​
completed_at
number

Unix timestamp (seconds) for when the job completed, if finished.

​
error
object

Error payload that explains why generation failed, if applicable.

​
outputs
object

Available upon completion, the outputs provides the cost charged and the hosted url to access the video