get avatar video

Get an avatar video

curl --request GET \
  --url https://api.anam.ai/v1/avatar-videos/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.anam.ai/v1/avatar-videos/{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://api.anam.ai/v1/avatar-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.anam.ai/v1/avatar-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.anam.ai/v1/avatar-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": "avv_123",
  "status": "pending",
  "truncated": true,
  "effectiveMaxDurationSeconds": 123,
  "region": "eu",
  "zeroDataRetention": true,
  "content": {
    "available": true,
    "deleteAt": "2023-11-07T05:31:56Z",
    "url": "<string>",
    "expiresAt": "2023-11-07T05:31:56Z"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "metadata": {},
  "completionReason": "script_completed",
  "durationSeconds": 123,
  "sessionId": "<string>",
  "failure": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true
  },
  "retryOf": "<string>",
  "startedAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "retryable": true,
  "details": {}
}

{
  "code": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "retryable": true,
  "details": {}
}

{
  "code": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "retryable": true,
  "details": {}
}

GET

avatar-videos

{id}

Get an avatar video

curl --request GET \
  --url https://api.anam.ai/v1/avatar-videos/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.anam.ai/v1/avatar-videos/{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://api.anam.ai/v1/avatar-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.anam.ai/v1/avatar-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.anam.ai/v1/avatar-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": "avv_123",
  "status": "pending",
  "truncated": true,
  "effectiveMaxDurationSeconds": 123,
  "region": "eu",
  "zeroDataRetention": true,
  "content": {
    "available": true,
    "deleteAt": "2023-11-07T05:31:56Z",
    "url": "<string>",
    "expiresAt": "2023-11-07T05:31:56Z"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "metadata": {},
  "completionReason": "script_completed",
  "durationSeconds": 123,
  "sessionId": "<string>",
  "failure": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true
  },
  "retryOf": "<string>",
  "startedAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "retryable": true,
  "details": {}
}

{
  "code": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "retryable": true,
  "details": {}
}

{
  "code": "<string>",
  "message": "<string>",
  "requestId": "<string>",
  "retryable": true,
  "details": {}
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

Response

Avatar video resource

string

required

Example:

"avv_123"

status

enum<string>

required

Available options:

pending,

running,

finalizing,

completed,

failed,

cancelled

truncated

boolean

required

effectiveMaxDurationSeconds

integer

required

region

enum<string> | null

required

Region the job is pinned to: eu when created on api.eu.anam.ai, us when created on api.us.anam.ai. Its session, recording and retries stay in that region. Null when created on api.anam.ai.

Available options:

eu,

us,

null

zeroDataRetention

boolean

required

Whether the job runs with Zero Data Retention, which keeps its script, and a direct request's style prompts, out of Lab's database. A persona-sourced job's director notes stay in its stored persona. Always true for a job created on a regional host.

content

object

required

Show child attributes

createdAt

string<date-time>

required

metadata

object

required

completionReason

enum<string> | null

Available options:

script_completed,

max_duration_reached,

cancelled,

null

durationSeconds

number | null

sessionId

string | null

Underlying normal EngineSession ID. Use its recording deletion endpoint for deletion.

failure

object | null

Show child attributes

retryOf

string | null

startedAt

string<date-time> | null

completedAt

string<date-time> | null

Use the API

Sessions

Meetings

Avatar Videos

Personas

Avatars

Voices

Pronunciation Dictionaries

LLMs

Knowledge

Tools

Share Links

Engine

get avatar video

Authorizations

Path Parameters

Response