Get Face
curl --request GET \
--url https://tavusapi.com/v2/faces/{face_id} \
--header 'x-api-key: <api-key>'import requests
url = "https://tavusapi.com/v2/faces/{face_id}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://tavusapi.com/v2/faces/{face_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://tavusapi.com/v2/faces/{face_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 => [
"x-api-key: <api-key>"
],
]);
$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://tavusapi.com/v2/faces/{face_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://tavusapi.com/v2/faces/{face_id}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://tavusapi.com/v2/faces/{face_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"face_id": "rc9cff32ceba",
"face_name": "My Face",
"default_voice_id": "v0a1b2c3d4e5f",
"original_voice_id": "v0a1b2c3d4e5f",
"thumbnail_video_url": "<string>",
"training_progress": "100/100",
"status": "completed",
"finetune_status": "training",
"created_at": "2024-01-24T07:14:03.327Z",
"updated_at": "2024-01-24T07:14:03.327Z",
"error_message": "<string>",
"face_type": "user'",
"model_name": "phoenix-4.5"
}{
"error": "Invalid face_id"
}{
"message": "Invalid access token"
}Face
Get Face
This endpoint returns a single Face by its unique identifier.
GET
/
v2
/
faces
/
{face_id}
Get Face
curl --request GET \
--url https://tavusapi.com/v2/faces/{face_id} \
--header 'x-api-key: <api-key>'import requests
url = "https://tavusapi.com/v2/faces/{face_id}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://tavusapi.com/v2/faces/{face_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://tavusapi.com/v2/faces/{face_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 => [
"x-api-key: <api-key>"
],
]);
$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://tavusapi.com/v2/faces/{face_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://tavusapi.com/v2/faces/{face_id}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://tavusapi.com/v2/faces/{face_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"face_id": "rc9cff32ceba",
"face_name": "My Face",
"default_voice_id": "v0a1b2c3d4e5f",
"original_voice_id": "v0a1b2c3d4e5f",
"thumbnail_video_url": "<string>",
"training_progress": "100/100",
"status": "completed",
"finetune_status": "training",
"created_at": "2024-01-24T07:14:03.327Z",
"updated_at": "2024-01-24T07:14:03.327Z",
"error_message": "<string>",
"face_type": "user'",
"model_name": "phoenix-4.5"
}{
"error": "Invalid face_id"
}{
"message": "Invalid access token"
}For AI agents, use
https://docs.tavus.io/openapi.yaml for the full HTTP API contract.Query Parameters
Response
The Voice this face speaks with when a PAL sets no voice of its own. Null if the face has none.
Example:
"v0a1b2c3d4e5f"
Whether the face is usable: started, completed, or error. On failure, this is error and error_message is populated. On Phoenix-4.5, completed means the zero-shot preview is ready, not that tuning is done. See Phoenix-4.5 Preview and Status.
Example:
"completed"
Phoenix-4.5 background tuning: null until fine-tuning starts, then training, completed, or error. Unused on Phoenix-4 and Phoenix-3. See Phoenix-4.5 Preview and Status.
Example:
"training"

