Fetch video metadata

GET

videos

{id}

Together AI SDK (Python)

from together import Together
import os

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

response = client.videos.retrieve("<VIDEO_ID>")

print(response.status)

import Together from "together-ai";

const client = new Together({
  apiKey: process.env.TOGETHER_API_KEY,
});

const response = await client.videos.retrieve("<VIDEO_ID>");

console.log(response.status);

import Together from "together-ai";

const client = new Together({
  apiKey: process.env.TOGETHER_API_KEY,
});

const response = await client.videos.retrieve("<VIDEO_ID>");

console.log(response.status);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.together.ai/v2/videos/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.together.ai/v2/videos/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.together.ai/v2/videos/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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

string

required

Identifier of video from create response.

Response

Success

Structured information describing a generated video job.

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

any

The object type, which is always 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.

Show child attributes

outputs

object

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

Show child attributes

⌘I

Together AI SDK (Python)

from together import Together
import os

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

response = client.videos.retrieve("<VIDEO_ID>")

print(response.status)

import Together from "together-ai";

const client = new Together({
  apiKey: process.env.TOGETHER_API_KEY,
});

const response = await client.videos.retrieve("<VIDEO_ID>");

console.log(response.status);

import Together from "together-ai";

const client = new Together({
  apiKey: process.env.TOGETHER_API_KEY,
});

const response = await client.videos.retrieve("<VIDEO_ID>");

console.log(response.status);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.together.ai/v2/videos/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.together.ai/v2/videos/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.together.ai/v2/videos/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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>"
  }
}

TOGETHER APIS

SDK LIBRARIES

ERROR CODES

Authorizations

Path Parameters

Response