Create a custom avatar

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.create();

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.create()
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.New(
		context.TODO(),
		telnyx.AIAvatarNewParams{
		},
	)
	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;
import com.telnyx.sdk.models.ai.avatars.AvatarCreateParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        AvatarCreateParams params = AvatarCreateParams.builder()
            .build();
        var response = client.ai().avatars().create(params);
    }
}

require "telnyx"

telnyx = Telnyx::Client.new(api_key: "My API Key")

avatar = telnyx.ai.avatars.create

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->create();

  var_dump($avatar);
} catch (APIException $e) {
  echo $e->getMessage();
}

telnyx ai:avatars create \
  --api-key 'My API Key'

curl --request POST \
  --url https://api.telnyx.com/v2/ai/avatars \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form image_file=@example-file \
  --form 'name=Customer portrait'

{
  "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": "10027",
      "title": "Unprocessable Entity",
      "detail": "The image must be between 256 and 8192 pixels on each side.",
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10027"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10037",
      "title": "Service unavailable",
      "detail": "Avatar storage is temporarily unavailable. Try again.",
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10037"
      }
    }
  ]
}