Get an avatar
Returns a Telnyx stock avatar or a custom avatar owned by the authenticated organization. A custom avatar belonging to another organization is returned as not found.
GET
/
ai
/
avatars
/
{avatar_id}
JavaScript
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const Avatar = await client.ai.avatars.retrieve('avatar_id');
console.log(Avatar.data);import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
avatar = client.ai.avatars.retrieve(
"avatar_id",
)
print(avatar.data)
package main
import (
"context"
"fmt"
"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)
func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
avatar, err := client.AI.Avatars.Get(
context.TODO(),
"avatar_id",
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", avatar.Data)
}
package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
var response = client.ai().avatars().retrieve("avatar_id");
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
avatar = telnyx.ai.avatars.retrieve("avatar_id")
puts(avatar)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$avatar = $client->ai->avatars->retrieve(
'avatar_id',
);
var_dump($avatar);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx ai:avatars retrieve \
--api-key 'My API Key' \
--avatar-id avatar_idcurl --request GET \
--url https://api.telnyx.com/v2/ai/avatars/{avatar_id} \
--header 'Authorization: Bearer <token>'{
"data": {
"id": "avatar_0123456789abcdef0123456789abcdef",
"name": "Customer portrait",
"provider": "telnyx",
"avatar_type": "custom",
"hosted": true,
"image_url": "https://example.com/avatar.png",
"image_url_expires_at": "2026-10-13T15:00:00Z",
"suggested_voice_id": "",
"content_type": "image/png",
"size_bytes": 248512,
"width_px": 1920,
"height_px": 1080,
"created_at": "2026-10-13T14:00:00Z",
"updated_at": "2026-10-13T14:00:00Z"
}
}{
"errors": [
{
"code": "10015",
"title": "Bad Request",
"detail": "The request contains invalid avatar parameters.",
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10015"
}
}
]
}{
"errors": [
{
"code": "10005",
"title": "Resource not found",
"detail": "Avatar avatar_0123456789abcdef0123456789abcdef does not exist.",
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10005"
}
}
]
}{
"errors": [
{
"code": "10037",
"title": "Service unavailable",
"detail": "Avatar storage is temporarily unavailable. Try again.",
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10037"
}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Stable identifier of a Telnyx stock avatar or an organization-owned custom avatar.
Stable identifier returned by the Avatars API. Discover available stock IDs with GET /v2/ai/avatars and filter[avatar_type]=stock rather than maintaining a fixed list. Custom avatar IDs use the avatar_ prefix and must belong to the authenticated organization. The service validates that the selected avatar is available.
Required string length:
1 - 128Pattern:
^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$Example:
"avatar_0123456789abcdef0123456789abcdef"
Response
The avatar.
Show child attributes
Show child attributes
Was this page helpful?
JavaScript
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const Avatar = await client.ai.avatars.retrieve('avatar_id');
console.log(Avatar.data);import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
avatar = client.ai.avatars.retrieve(
"avatar_id",
)
print(avatar.data)
package main
import (
"context"
"fmt"
"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)
func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
avatar, err := client.AI.Avatars.Get(
context.TODO(),
"avatar_id",
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", avatar.Data)
}
package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
var response = client.ai().avatars().retrieve("avatar_id");
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
avatar = telnyx.ai.avatars.retrieve("avatar_id")
puts(avatar)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$avatar = $client->ai->avatars->retrieve(
'avatar_id',
);
var_dump($avatar);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx ai:avatars retrieve \
--api-key 'My API Key' \
--avatar-id avatar_idcurl --request GET \
--url https://api.telnyx.com/v2/ai/avatars/{avatar_id} \
--header 'Authorization: Bearer <token>'{
"data": {
"id": "avatar_0123456789abcdef0123456789abcdef",
"name": "Customer portrait",
"provider": "telnyx",
"avatar_type": "custom",
"hosted": true,
"image_url": "https://example.com/avatar.png",
"image_url_expires_at": "2026-10-13T15:00:00Z",
"suggested_voice_id": "",
"content_type": "image/png",
"size_bytes": 248512,
"width_px": 1920,
"height_px": 1080,
"created_at": "2026-10-13T14:00:00Z",
"updated_at": "2026-10-13T14:00:00Z"
}
}{
"errors": [
{
"code": "10015",
"title": "Bad Request",
"detail": "The request contains invalid avatar parameters.",
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10015"
}
}
]
}{
"errors": [
{
"code": "10005",
"title": "Resource not found",
"detail": "Avatar avatar_0123456789abcdef0123456789abcdef does not exist.",
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10005"
}
}
]
}{
"errors": [
{
"code": "10037",
"title": "Service unavailable",
"detail": "Avatar storage is temporarily unavailable. Try again.",
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10037"
}
}
]
}