Updates the customer-facing name of a custom avatar owned by the authenticated organization. Stock avatars cannot be modified. To replace the image, create a new custom avatar so existing references keep their original content.
PATCH
/
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.update('avatar_id', { name: 'Updated portrait',});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.update(
avatar_id="avatar_id",
name="Updated portrait",
)
print(avatar.data)
{
"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": "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"
}
}
]
}
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.
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.update('avatar_id', { name: 'Updated portrait',});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.update(
avatar_id="avatar_id",
name="Updated portrait",
)
print(avatar.data)
{
"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": "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"
}
}
]
}
{"docsConfig":{"theme":"sequoia","$schema":"https://mintlify.com/docs.json","name":"Telnyx","description":"Infrastructure for real-time agents. Voice, AI, Edge Compute","colors":{"primary":"#00B688","light":"#00B688","dark":"#00B688"},"logo":{"light":"https://mintcdn.com/telnyx/v2FpkbJg6PQ53qHU/assets/images/site/logo.svg?fit=max\u0026auto=format\u0026n=v2FpkbJg6PQ53qHU\u0026q=85\u0026s=5ee3f61d11ba90a197dd9a1e3499fab6","dark":"https://mintcdn.com/telnyx/v2FpkbJg6PQ53qHU/assets/images/site/logo-dark.svg?fit=max\u0026auto=format\u0026n=v2FpkbJg6PQ53qHU\u0026q=85\u0026s=d65aaa12ec708c79e5833cbdea958055"},"favicon":"https://mintcdn.com/telnyx/t-qaBUa_gCxdRz_m/favicon.ico?fit=max\u0026auto=format\u0026n=t-qaBUa_gCxdRz_m\u0026q=85\u0026s=8291283238ab8c0e2a7a985e69f38c2f","background":{"decoration":"gradient"},"navbar":{"links":[{"icon":"triangle-exclamation","href":"/docs/development/api-fundamentals/api-errors","label":"Error codes"},{"icon":"headset","href":"https://telnyx.com/contact-us","label":"Contact us"},{"icon":"user","href":"https://portal.telnyx.com/#/login/sign-in","label":"Login"}],"primary":{"type":"button","label":"Sign Up","href":"https://telnyx.com/sign-up"}},"footer":{"socials":{"github":"https://github.com/team-telnyx","linkedin":"https://www.linkedin.com/company/telnyx","slack":"https://joinslack.telnyx.com","x":"https://x.com/telnyx"},"links":[{"header":"Resources","items":[{"label":"Pricing","href":"https://developers.telnyx.com/internal/pages/pricing"},{"label":"Compare Telnyx","href":"https://developers.telnyx.com/internal/pages/compare"},{"label":"Support center","href":"https://support.telnyx.com/en"},{"label":"SETI","href":"https://seti.telnyx.com"},{"label":"Agent platform configs","href":"https://github.com/team-telnyx/ai"},{"label":"About Telnyx","href":"https://developers.telnyx.com/internal/pages/about"},{"label":"Service status","href":"https://status.telnyx.com"}]},{"header":"Updates","items":[{"label":"Release notes","href":"https://telnyx.com/release-notes"}]},{"header":"Community","items":[{"label":"Low Latency Club","href":"https://lowlatencyclub.ai/"}]},{"header":"Legal","items":[{"label":"Privacy policy","href":"https://telnyx.com/privacy-policy"},{"label":"Terms and conditions","href":"https://telnyx.com/terms-and-conditions"}]}]},"seo":{"metatags":{"og:description":"Infrastructure for real-time agents. Voice, AI, Edge Compute","description":"Infrastructure for real-time agents. Voice, AI, Edge Compute"},"organization":{"name":"Telnyx","url":"https://telnyx.com","logo":"https://telnyx.com/favicon.ico","sameAs":["https://x.com/telnyx","https://www.linkedin.com/company/telnyx/","https://github.com/team-telnyx"]}},"fonts":{"heading":{"family":"PP Formula","weight":800,"source":"assets/fonts/PPFormula-Extrabold.woff2","format":"woff2"},"body":{"family":"Inter","weight":400,"source":"assets/fonts/Inter-Regular.woff2","format":"woff2"}},"styling":{"eyebrows":"breadcrumbs","latex":true},"integrations":{"gtm":{"tagId":"GTM-NRRX236"}},"banner":{"content":"Check out our upcoming events and meetups! [View events →](https://lowlatencyclub.ai/)","dismissible":true},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"navigation":{"global":{"anchors":[{"anchor":"Home","icon":"house","href":"/docs/overview"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"telnyx","hasAudioNarration":false,"actualSubdomain":"telnyx","customDomains":["developers.telnyx.com"],"gitSource":{"type":"github","owner":"team-telnyx","repo":"developer-docs-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aea286477df7a8c9a9eff7a","collectionId":"9f3b5d7e-768f-4324-a47a-77f6ac373df3","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aea286477df7a8c9a9eff7a"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aea2b3300d9bd74e0860642","clientVersion":"0.0.4054","searchFilterCounts":[{"language":"default","tag":"Calling","count":592},{"language":"default","tag":"API Reference","count":552},{"language":"default","tag":"Other APIs","count":406},{"language":"default","tag":"AI","count":382},{"language":"default","tag":"Messaging","count":353},{"language":"default","tag":"Numbers","count":287},{"language":"default","tag":"Agent Platform","count":218},{"language":"default","tag":"Assistants","count":202},{"language":"default","tag":"Voice API","count":178},{"language":"default","tag":"SMS \u0026 MMS","count":149}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":"[class*=sidebar] [class*=badge],[class*=sidebar] [class*=tag],nav [class*=badge],nav [class*=tag]{font-size:.8rem!important}#ot-sdk-btn-floating{left:auto!important;right:10px!important}body:has([aria-label=\"Preview Widget\"]) #ot-sdk-btn-floating{bottom:88px!important}#navbar .nav-tabs-item:has(>div>svg[style*=\"/book-open.svg\"]),#navbar div:has(>div>.nav-tabs>a.nav-tabs-item:first-child:last-child){display:none}.nav-tabs a.nav-tabs-item:not([aria-current=location]){display:none}#mobile-nav #navigation-items>div:has(>div>button[aria-haspopup=menu]),#mobile-nav [data-component-part=products-selector-trigger],#mobile-nav.tx-has-directory #navigation-items{display:none!important}#mobile-nav .tx-mobile-directory{padding:0;margin-bottom:1.5rem}#mobile-nav .tx-mobile-directory .tx-dir-suite-head,#mobile-nav .tx-mobile-directory a{min-height:2.75rem}#mobile-nav .tx-mobile-directory :is(a, .tx-dir-suite-head):focus-visible{outline:2px solid currentColor;outline-offset:-2px}.txd-shell{display:flex;gap:0;max-width:none;margin:0;padding:3rem 2rem 6rem 0}.txd-side{width:18rem;flex-shrink:0}.txd-main{flex:1;min-width:0;max-width:56rem;margin-left:11.75rem}@media (max-width:80rem){.txd-main{margin-left:4rem}}:is(#tx-directory, .tx-mobile-directory){margin:0 0 .5rem;padding:0 .5rem 0 1rem}:is(#tx-directory, .tx-mobile-directory) .tx-dir-label{font-size:.72rem;font-weight:600;letter-spacing:.06em;text-transform:uppercase;opacity:.55;margin:0 0 .4rem}:is(#tx-directory, .tx-mobile-directory) .tx-dir-label-gap{margin-top:1.5rem}:is(#tx-directory, .tx-mobile-directory) .tx-dir-link,:is(#tx-directory, .tx-mobile-directory) summary{display:flex;align-items:center;cursor:pointer;font-size:.875rem;line-height:1.25rem;padding:.35rem .5rem;border-radius:.375rem;color:rgb(55 65 81);text-decoration:none}html.dark :is(#tx-directory, .tx-mobile-directory) .tx-dir-link,html.dark :is(#tx-directory, .tx-mobile-directory) summary{color:rgb(156 163 175)}:is(#tx-directory, .tx-mobile-directory) .tx-dir-link:hover,:is(#tx-directory, .tx-mobile-directory) summary:hover{color:rgb(17 24 39);background:rgb(0 0 0/.04)}:is(#tx-directory, .tx-mobile-directory) .tx-dir-link[aria-current=page]{color:#00b688;background:0 0;box-shadow:none;font-weight:400;text-shadow:-.2px 0 0 currentColor,.2px 0 0 currentColor}html.dark :is(#tx-directory, .tx-mobile-directory) .tx-dir-link:hover,html.dark :is(#tx-directory, .tx-mobile-directory) summary:hover{color:rgb(229 231 235);background:rgb(255 255 255/.06)}html.dark :is(#tx-directory, .tx-mobile-directory) .tx-dir-link[aria-current=page]{color:#5eead4;background:0 0;box-shadow:none}:is(#tx-directory, .tx-mobile-directory) .tx-dir-soon,:is(#tx-directory, .tx-mobile-directory) .tx-dir-soon:hover,html.dark :is(#tx-directory, .tx-mobile-directory) .tx-dir-soon,html.dark :is(#tx-directory, .tx-mobile-directory) .tx-dir-soon:hover{cursor:default;opacity:.45;background:0 0;color:inherit}:is(#tx-directory, .tx-mobile-directory) .tx-dir-soon sup{font-size:.6rem;line-height:1;letter-spacing:.05em;text-transform:uppercase;margin-left:.4rem;vertical-align:super}:is(#tx-directory, .tx-mobile-directory) .tx-dir-suite{margin-bottom:.15rem}:is(#tx-directory, .tx-mobile-directory) .tx-dir-suite-head{display:flex;align-items:center;cursor:pointer;user-select:none;font-size:.875rem;line-height:1.25rem;font-weight:500;padding:.35rem .5rem;border-radius:.375rem;color:rgb(55 65 81)}html.dark :is(#tx-directory, .tx-mobile-directory) .tx-dir-suite-head,html.dark :is(#tx-directory, .tx-mobile-directory) li a{color:rgb(156 163 175)}:is(#tx-directory, .tx-mobile-directory) .tx-dir-suite-head:hover,:is(#tx-directory, .tx-mobile-directory) li a:hover{color:rgb(17 24 39);background:rgb(0 0 0/.04)}html.dark :is(#tx-directory, .tx-mobile-directory) .tx-dir-suite-head:hover,html.dark :is(#tx-directory, .tx-mobile-directory) .tx-dir-suite.open>.tx-dir-suite-head,html.dark :is(#tx-directory, .tx-mobile-directory) li a:hover{color:rgb(229 231 235);background:rgb(255 255 255/.06)}:is(#tx-directory, .tx-mobile-directory) .tx-dir-suite-head::after{content:'';width:.42rem;height:.42rem;margin-left:auto;border-right:1.5px solid currentColor;border-bottom:1.5px solid currentColor;transform:rotate(-45deg);transition:transform .15s;flex-shrink:0;opacity:.7}:is(#tx-directory, .tx-mobile-directory) .tx-dir-suite.open>.tx-dir-suite-head::after{transform:rotate(45deg)}:is(#tx-directory, .tx-mobile-directory) .tx-dir-suite.open>.tx-dir-suite-head{color:rgb(17 24 39);background:rgb(0 0 0/.04);font-weight:600}:is(#tx-directory, .tx-mobile-directory) .tx-dir-suite>ul{display:none}:is(#tx-directory, .tx-mobile-directory) .tx-dir-suite.open>ul{display:block}:is(#tx-directory, .tx-mobile-directory) ul{margin:.15rem 0 .5rem;padding:0}:is(#tx-directory, .tx-mobile-directory) li{list-style:none}:is(#tx-directory, .tx-mobile-directory) li a{display:flex;align-items:center;font-size:.875rem;line-height:1.25rem;padding:.3rem .5rem .3rem 1.6rem;border-radius:.375rem;color:rgb(107 114 128);text-decoration:none}:is(#tx-directory, .tx-mobile-directory) .tx-dir-section-item{font-weight:500}:is(#tx-directory, .tx-mobile-directory) .tx-dir-icon{display:inline-block;width:1rem;height:1rem;flex-shrink:0;margin-right:.5rem;background-color:currentColor;-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;-webkit-mask-position:center;mask-position:center;-webkit-mask-size:contain;mask-size:contain}.txi-arrows-left-right-to-line{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/arrows-left-right-to-line.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/arrows-left-right-to-line.svg)}.txi-bolt{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/bolt.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/bolt.svg)}.txi-brain{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/brain.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/brain.svg)}.txi-brain-circuit{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/brain-circuit.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/brain-circuit.svg)}.txi-brands-whatsapp{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/brands/whatsapp.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/brands/whatsapp.svg)}.txi-broadcast-tower{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/broadcast-tower.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/broadcast-tower.svg)}.txi-browser{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/browser.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/browser.svg)}.txi-circle-nodes{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/circle-nodes.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/circle-nodes.svg)}.txi-clone{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/clone.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/clone.svg)}.txi-cloud{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/cloud.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/cloud.svg)}.txi-code{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/code.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/code.svg)}.txi-comment-sms{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/comment-sms.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/comment-sms.svg)}.txi-cubes{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/cubes.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/cubes.svg)}.txi-database{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/database.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/database.svg)}.txi-envelope{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/envelope.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/envelope.svg)}.txi-eye{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/eye.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/eye.svg)}.txi-file-certificate{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/file-certificate.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/file-certificate.svg)}.txi-fingerprint{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/fingerprint.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/fingerprint.svg)}.txi-folder-tree{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/folder-tree.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/folder-tree.svg)}.txi-globe{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/globe.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/globe.svg)}.txi-hard-drive{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/hard-drive.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/hard-drive.svg)}.txi-hashtag{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/hashtag.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/hashtag.svg)}.txi-headset{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/headset.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/headset.svg)}.txi-key{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/key.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/key.svg)}.txi-layer-group{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/layer-group.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/layer-group.svg)}.txi-magnifying-glass{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/magnifying-glass.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/magnifying-glass.svg)}.txi-message{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/message.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/message.svg)}.txi-message-dots{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/message-dots.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/message-dots.svg)}.txi-microchip-ai{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/microchip-ai.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/microchip-ai.svg)}.txi-microphone{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/microphone.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/microphone.svg)}.txi-network-wired{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/network-wired.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/network-wired.svg)}.txi-phone{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/phone.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/phone.svg)}.txi-phone-volume{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/phone-volume.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/phone-volume.svg)}.txi-plug{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/plug.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/plug.svg)}.txi-right-left{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/right-left.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/right-left.svg)}.txi-robot{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/robot.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/robot.svg)}.txi-server{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/server.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/server.svg)}.txi-share-nodes{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/share-nodes.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/share-nodes.svg)}.txi-shield{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/shield.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/shield.svg)}.txi-shield-check{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/shield-check.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/shield-check.svg)}.txi-signal{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/signal.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/signal.svg)}.txi-sim-card{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/sim-card.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/sim-card.svg)}.txi-split{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/split.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/split.svg)}.txi-table{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/table.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/table.svg)}.txi-tower-control{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/tower-control.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/tower-control.svg)}.txi-train-tunnel{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/train-tunnel.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/train-tunnel.svg)}.txi-video{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/video.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/video.svg)}.txi-wand-magic-sparkles{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/wand-magic-sparkles.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/wand-magic-sparkles.svg)}.txi-waveform{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/waveform.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/waveform.svg)}.txi-waveform-lines{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/waveform-lines.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/waveform-lines.svg)}.txd-main .txd-h1{font-family:var(--font-family-headings-custom, \"PP Formula\"),-apple-system,BlinkMacSystemFont,\"Segoe UI\",system-ui,sans-serif;font-size:2.1rem;font-weight:500;letter-spacing:-.01em;margin:1.2rem 0 .4rem;color:rgb(22 28 26)}html.dark .txd-main .txd-h1{color:rgb(229 231 235)}.txd-main .txd-lead{font-size:1.3rem;line-height:1.55;font-weight:500;margin:.9rem 0 1.3rem;color:rgb(31 41 55)}html.dark .txd-main .txd-lead{color:rgb(209 213 219)}.txd-main .txd-h2{font-family:var(--font-family-headings-custom, \"PP Formula\"),-apple-system,BlinkMacSystemFont,\"Segoe UI\",system-ui,sans-serif;font-size:1.45rem;font-weight:500;margin:2.4rem 0 .4rem;color:rgb(22 28 26)}html.dark .txd-main .txd-h2{color:rgb(229 231 235)}.txd-main .txd-section-h{font-size:1.05rem;font-weight:600;margin:1.8rem 0 .2rem;opacity:.85}.txd-main .txd-p{margin:.7rem 0 1rem;line-height:1.65;color:rgb(75 85 99)}html.dark .txd-main .txd-p{color:rgb(156 163 175)}.txd-main .txd-follow-up a:hover,.txd-main .txd-p a{text-decoration:underline}.txd-main .txd-h1{max-width:46rem;line-height:1.12}.txd-main .txd-hero-copy{max-width:45rem}.txd-main .txd-follow-up{margin-top:1rem}.txd-main .txd-follow-up a{color:#00b688;font-weight:600;text-decoration:none}.txd-main a:focus-visible{outline:2px solid #00b688;outline-offset:3px}@media (max-width:48rem){.txd-main .txd-h1{font-size:1.9rem}}@media (min-width:64.01rem) and (max-width:90rem){.txd-main{margin-right:4rem}}.rm-explorer{--rm-border:rgb(15 23 42 / 14%);--rm-muted:#5f6b68;--rm-soft:#f6f8f7}.dark .rm-explorer{--rm-border:rgb(255 255 255 / 14%);--rm-muted:#a2aaa8;--rm-soft:#151a19}#resource-map-toolbar{position:sticky;top:5rem;z-index:20;margin:1.25rem 0 1.75rem;padding:.75rem 0;background:var(--rm-surface, #fff);border-bottom:1px solid var(--rm-border)}.dark #resource-map-toolbar{background:#0b0e0d}.rm-controls{display:grid;grid-template-columns:minmax(15rem,1fr) minmax(10rem,auto) auto;gap:.625rem;align-items:center}.rm-search{position:relative;min-width:0}.rm-search svg{position:absolute;top:50%;left:.75rem;width:1rem;height:1rem;color:var(--rm-muted);fill:none;stroke:currentColor;stroke-width:1.8;transform:translateY(-50%);pointer-events:none}.rm-area-select,.rm-collapse,.rm-search input{min-height:2.5rem;font-size:.875rem}.rm-area-select,.rm-clear,.rm-collapse,.rm-empty button,.rm-search input{color:inherit;background:0 0;border:1px solid var(--rm-border);border-radius:.5rem;font:inherit}.rm-empty button{font-size:.875rem}.rm-search input{width:100%;padding:.58rem 2.6rem .58rem 2.35rem}.rm-search input::placeholder{color:var(--rm-muted);opacity:1}.rm-shortcut{position:absolute;top:50%;right:.65rem;display:grid;width:1.5rem;height:1.5rem;place-items:center;color:var(--rm-muted);background:var(--rm-soft);border:1px solid var(--rm-border);border-radius:.35rem;font:inherit;font-size:.72rem;transform:translateY(-50%);pointer-events:none}.rm-area-wrap{position:relative;max-width:13rem}.rm-area-select{width:100%;max-width:13rem;padding:.55rem 2.25rem .55rem .75rem;appearance:none;cursor:pointer}.rm-area-caret{position:absolute;top:50%;right:.85rem;width:.45rem;height:.45rem;border-right:1.5px solid currentColor;border-bottom:1.5px solid currentColor;transform:translateY(-70%) rotate(45deg);pointer-events:none}.rm-collapse{padding:.5rem .75rem}.rm-clear,.rm-collapse,.rm-empty button{font-weight:650;cursor:pointer}.rm-empty button{padding:.5rem .75rem}.rm-area-select:focus-visible,.rm-clear:focus-visible,.rm-collapse:focus-visible,.rm-empty button:focus-visible,.rm-search input:focus-visible{outline:2px solid #00b688;outline-offset:2px;border-color:#00b688;box-shadow:none!important}.rm-clear:hover,.rm-collapse:hover,.rm-empty button:hover{color:#08785d;background:var(--rm-soft)}.dark .rm-clear:hover,.dark .rm-collapse:hover,.dark .rm-empty button:hover{color:#5eead4}.rm-meta{display:flex;min-height:1.65rem;align-items:center;justify-content:space-between;gap:.75rem;padding:.45rem .15rem 0}.rm-status{color:var(--rm-muted);font-size:.78rem;line-height:1.35}.rm-clear{min-height:1.8rem;padding:.2rem .55rem;border-color:transparent;font-size:.78rem}.rm-empty{display:grid;justify-items:start;gap:.35rem;margin:-.5rem 0 1.75rem;padding:1.1rem 1.2rem;color:var(--rm-muted);background:var(--rm-soft);border:1px solid var(--rm-border);border-radius:.75rem;font-size:.875rem}.rm-empty strong{color:inherit;font-size:.95rem}.rm-empty button{min-height:2.2rem;margin-top:.35rem}.rm-resource-list{display:block!important;margin:0 0 .75rem!important;border-color:var(--rm-border)!important;border-top:0!important;border-radius:0 0 .75rem .75rem!important}.rm-resource-list>details.accordion{margin:0!important;border:0!important;border-radius:0!important}.rm-resource-list>details.accordion+details.accordion{border-top:1px solid var(--rm-border)!important}.rm-resource-list>details.accordion>summary{min-height:3rem;padding:.7rem .9rem!important;border-radius:0!important}.rm-resource-list>details.accordion:first-child>summary{border-radius:0!important}.rm-resource-list>details.accordion:last-child:not([open])>summary{border-radius:0 0 .75rem .75rem!important}.rm-resource-list [data-component-part=accordion-title]{display:flex;min-width:0;align-items:baseline;justify-content:space-between;gap:1rem}.rm-resource-name{min-width:0;overflow-wrap:anywhere;font-weight:650}.rm-method-count{flex:0 0 auto;color:var(--rm-muted);font-size:.75rem;font-weight:500;white-space:nowrap}.rm-resource-list details[open]>summary{background:var(--rm-soft)}.rm-resource-list details[open] [data-component-part=accordion-content]{margin-right:1rem;margin-left:1rem}.rm-resource-list tbody tr.rm-row-match{background:rgb(0 182 136/8%)}.rm-resource-list td:first-child code{white-space:nowrap}.rm-clear[hidden],.rm-collapse[hidden],.rm-empty[hidden],.rm-explorer h2[hidden],.rm-resource-list tbody tr[hidden],.rm-resource-list[hidden]{display:none!important}.rm-explorer h2{position:relative;min-height:3rem;margin:.45rem 0 0!important;scroll-margin-top:10rem;border:1px solid var(--rm-border);border-radius:.75rem}.rm-explorer h2.rm-section-open{border-radius:.75rem .75rem 0 0}.rm-section-toggle{display:grid;width:100%;min-height:3rem;grid-template-columns:minmax(0,1fr) auto auto;align-items:center;gap:.75rem;padding:.6rem .9rem;color:inherit;text-align:left;background:0 0;border:0;cursor:pointer}.rm-section-toggle:focus-visible,.rm-section-toggle:hover{background:var(--rm-soft)}.rm-section-toggle:focus-visible{outline:2px solid #00b688;outline-offset:2px;border-radius:.7rem}.rm-section-name{font-size:1rem;font-weight:700}.rm-section-count{display:grid;min-width:1.65rem;min-height:1.4rem;place-items:center;padding:3px 6px;color:#08785d;background:rgb(0 182 136/10%);border-radius:.35rem;font-size:12px;font-weight:700;line-height:16px;white-space:nowrap}.dark .rm-section-count{color:#5eead4;background:#12302b}.rm-section-caret{width:.5rem;height:.5rem;border-right:1.5px solid currentColor;border-bottom:1.5px solid currentColor;transform:rotate(45deg) translateY(-.15rem)}.rm-section-toggle[aria-expanded=true] .rm-section-caret{transform:rotate(225deg) translate(-.1rem,-.05rem)}@media (max-width:767px){#resource-map-toolbar{position:static;top:auto;z-index:auto;margin-top:1rem;padding-top:.6rem}.rm-controls{grid-template-columns:minmax(0,1fr) auto}.rm-search{grid-column:1/-1}.rm-search input{padding-right:.75rem}.rm-resource-list thead,.rm-shortcut{display:none}.rm-area-select,.rm-area-wrap{width:100%;max-width:none}.rm-resource-list [data-component-part=accordion-title]{gap:.65rem}.rm-method-count{font-size:.7rem}.rm-resource-list table,.rm-resource-list tbody{display:block;width:100%;min-width:0!important}.rm-resource-list tbody tr{display:grid;width:100%;grid-template-columns:minmax(0,1fr);gap:.45rem;padding:.75rem 0}.rm-resource-list tbody tr+tr{border-top:1px solid var(--rm-border)}.rm-resource-list tbody td{display:grid;width:100%;min-width:0!important;grid-template-columns:4.5rem minmax(0,1fr);align-items:start;gap:.5rem;padding:0!important;border:0!important}.rm-resource-list tbody td::before{color:var(--rm-muted);font-size:.68rem;font-weight:700;letter-spacing:.04em;text-transform:uppercase}.rm-resource-list tbody td:first-child::before{content:\"Method\"}.rm-resource-list tbody td:last-child::before{content:\"Endpoint\"}.rm-resource-list tbody td a,.rm-resource-list tbody td code{min-width:0;white-space:normal!important;overflow-wrap:anywhere}}@media (prefers-reduced-motion:reduce){.rm-explorer *,.rm-explorer ::after,.rm-explorer ::before{scroll-behavior:auto!important;transition-duration:.01ms!important}}.sdk-launchpad{--sdk-border:#d8e1de;--sdk-panel:#ffffff;margin:1rem 0 1.5rem;padding:1rem;overflow:hidden;color:inherit;background:var(--sdk-panel);border:1px solid var(--sdk-border);border-radius:12px}.dark .sdk-launchpad{--sdk-border:#293431;--sdk-panel:#101513}.sdk-launchpad-kicker{margin:0 0 .25rem!important;color:#08785d;font-size:.68rem;font-weight:800;letter-spacing:.1em}.dark .sdk-launchpad-kicker{color:#5eead4}.sdk-launchpad>h2{margin-top:.25rem}.sdk-launchpad [role=tablist]{display:flex;flex-wrap:wrap;gap:.25rem}.sdk-launchpad [role=tab]{min-width:56px;min-height:44px}.sdk-launchpad [role=tab][aria-selected=true]{color:#08785d!important}.dark .sdk-launchpad [role=tab][aria-selected=true]{color:#5eead4!important}.sdk-launchpad [role=tab]:focus-visible,.sdk-launchpad a:focus-visible,.sdk-launchpad-code:focus-visible{outline:2px solid #08785d;outline-offset:2px}.dark .sdk-launchpad [role=tab]:focus-visible,.dark .sdk-launchpad a:focus-visible,.dark .sdk-launchpad-code:focus-visible{outline-color:#5eead4}.sdk-launchpad-code{max-width:100%;overflow-x:auto;border-radius:.5rem}.sdk-launchpad-code pre{max-width:none;overflow-x:visible!important}.sdk-launchpad-code button{min-width:44px;min-height:44px}#content-area:has(#sdk-launchpad) .chat-assistant-floating-input{display:none}@media (max-width:640px){.sdk-launchpad{margin-top:.75rem;padding:.75rem}.sdk-launchpad-kicker{display:none}.sdk-launchpad [role=tablist]{display:grid;grid-template-columns:repeat(6,minmax(0,1fr));gap:.2rem;overflow:visible}.sdk-launchpad [role=tab]{min-width:0;min-height:44px;padding-inline:.2rem;font-size:.75rem;line-height:1.15;white-space:nowrap}}.sdk-directory li{margin-block:.5rem}.mdx-content table td{min-width:0!important}.mdx-content table td :is(code, a){overflow-wrap:anywhere}.mdx-content table :is(th, td):first-child code{white-space:nowrap;word-break:normal;overflow-wrap:normal}@media (min-width:768px){.tx-table-grid table{table-layout:fixed}.tx-table-grid table :is(th, td):first-child{width:40%}}.tx-retirement-banner{margin-bottom:1.5rem}.tx-retirement-banner>div{margin:0}@media (min-width:1024px){.tx-retirement-banner{position:sticky;top:calc(6rem + var(--banner-height, 0px));z-index:20;padding-top:.5rem;background:rgb(var(--background-light, 255 255 255))}.dark .tx-retirement-banner{background:rgb(var(--background-dark, 9 12 14))}}#content>.callout:first-child{margin-top:0}#content strong{font-weight:600}"}],"page":{"pagePath":"api-reference/avatars/update-a-custom-avatar","slug":"/api-reference/avatars/update-a-custom-avatar","pageMetadata":{"title":"Update a custom avatar","description":"Updates the customer-facing name of a custom avatar owned by the authenticated organization. Stock avatars cannot be modified. To replace the image, create a new custom avatar so existing references keep their original content.","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json patch /ai/avatars/{avatar_id}","href":"/api-reference/avatars/update-a-custom-avatar","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Updates the customer-facing name of a custom avatar owned by the authenticated organization. Stock avatars cannot be modified. To replace the image, create a new custom avatar so existing references keep their original content.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Update a custom avatar","description":"Updates the customer-facing name of a custom avatar owned by the authenticated organization. Stock avatars cannot be modified. To replace the image, create a new custom avatar so existing references keep their original content.","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json patch /ai/avatars/{avatar_id}","href":"/api-reference/avatars/update-a-custom-avatar","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/telnyx/a2dd5aaa2ff5831a/reading-progress.js","/_mintlify/custom/telnyx/7b77ce9cedb163fd/webmcp-init.js","/_mintlify/custom/telnyx/7fbfee588ac7ad38/structured-data.js","/_mintlify/custom/telnyx/41d9633b1a2dd405/scripts/tests/generate-llms-txt.test.js","/_mintlify/custom/telnyx/8851ad5fd6e9b5c7/scripts/tests/direct-source-workflows.test.js","/_mintlify/custom/telnyx/7ad13bb6588be22f/scripts/tests/redirects.test.js","/_mintlify/custom/telnyx/f981035eb45fcbdb/scripts/tests/generate-error-catalog.test.js","/_mintlify/custom/telnyx/132bc205f55282a5/scripts/tests/sync-llms-automerge.test.js","/_mintlify/custom/telnyx/05e787f15f45952b/scripts/tests/webhook-catalog-lifecycle.test.js","/_mintlify/custom/telnyx/01b840b27496e6c8/scripts/tests/repository-structure.test.js","/_mintlify/custom/telnyx/5ebc7d6e18012563/scripts/tests/legacy-content-usage.test.js","/_mintlify/custom/telnyx/ac1f21e68bf4050a/scripts/docs/check-llms-links.js","/_mintlify/custom/telnyx/5f7d2f1ae375b9ad/scripts/docs/check-llms-native-routes.js","/_mintlify/custom/telnyx/b8d13287c2dcc5b9/scripts/docs/fetch-coverage.js","/_mintlify/custom/telnyx/e0a29f76f2645359/scripts/docs/generate-error-catalog.js","/_mintlify/custom/telnyx/3d8fe29c5f30f1bc/scripts/docs/generate-llms-txt.js","/_mintlify/custom/telnyx/f1f111fe784c3ede/scripts/docs/update-tts-voices.js","/_mintlify/custom/telnyx/c48ad0189f7f1c57/scripts/docs/build-sdk-doc-pages.js","/_mintlify/custom/telnyx/f840117777d76f9e/scripts/tests/sdk-doc-pages.test.js","/_mintlify/custom/telnyx/414c53c50b0e1968/resource-map-filter.js","/_mintlify/custom/telnyx/80af622b3010a712/scripts/tests/sdk-language-switcher.test.js","/_mintlify/custom/telnyx/52fa0fbcb966f8b6/sdk-language-switcher.js","/_mintlify/custom/telnyx/3de33ceedb29f568/home-directory.js","/_mintlify/custom/telnyx/da7a630a1adf8a7a/scripts/generate-home-directory.js","/_mintlify/custom/telnyx/137e3eb8e1d1d85a/scripts/tests/api-fundamentals.test.js","/_mintlify/custom/telnyx/24a8eed3a5010d4c/scripts/tests/agent-sdk-workflow.test.js","/_mintlify/custom/telnyx/abc2169efcd5115c/scripts/tests/homepage-overview.test.js","/_mintlify/custom/telnyx/8edf49ac62deef02/scripts/tests/batch-detail-records-navigation.test.js","/_mintlify/custom/telnyx/e005178572336f01/scripts/tests/api-discoverability.test.js","/_mintlify/custom/telnyx/78cb83896fbea5cf/scripts/tests/home-directory.test.js","/_mintlify/custom/telnyx/11ae45253e6b7be6/scripts/tests/agent-readiness.test.js","/_mintlify/custom/telnyx/82396d5a75077c2a/scripts/tests/sample-workflow-regressions.test.js","/_mintlify/custom/telnyx/5f6625c0420c9328/scripts/tests/openapi-mintlify-parsing.test.js","/_mintlify/custom/telnyx/c7dca602ca9641ec/scripts/tests/llms-markdown-assets.test.js","/_mintlify/custom/telnyx/02d6acd7c86b79f9/scripts/tests/agent-browser-quickstart.test.js"],"openApiReferenceData":{"operation":{"tags":["Avatars"],"summary":"Update a custom avatar","description":"Updates the customer-facing name of a custom avatar owned by the authenticated organization. Stock avatars cannot be modified. To replace the image, create a new custom avatar so existing references keep their original content.","operationId":"update_avatar_public_avatars__avatar_id__patch","parameters":["d425609f-6071-406d-998a-a0c0cd7bbea0"],"requestBody":"f67d5208-9323-4c71-ae4b-3a8eba7ed262","responses":{"200":"c06b04c2-c393-4692-8351-1983b2885f25","400":"427087a0-7c4c-408d-ba33-58412926d804","404":"aa51e4d3-2c54-4c4f-9bf5-d1e5972b904b","422":"86a70be8-8a03-4480-aab9-5b27fd9bff96","503":"3307b16d-3057-48eb-8351-554963ef90c7"},"x-codeSamples":[{"lang":"JavaScript","source":"import Telnyx from 'telnyx';\n\nconst client = new Telnyx({\n apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted\n});\n\nconst Avatar = await client.ai.avatars.update('avatar_id', {\n name: 'Updated portrait',\n});\n\nconsole.log(Avatar.data);"},{"lang":"Python","source":"import os\nfrom telnyx import Telnyx\n\nclient = Telnyx(\n api_key=os.environ.get(\"TELNYX_API_KEY\"), # This is the default and can be omitted\n)\navatar = client.ai.avatars.update(\n avatar_id=\"avatar_id\",\n name=\"Updated portrait\",\n)\nprint(avatar.data)\n"},{"lang":"Go","source":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/team-telnyx/telnyx-go\"\n\t\"github.com/team-telnyx/telnyx-go/option\"\n)\n\nfunc main() {\n\tclient := telnyx.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tavatar, err := client.AI.Avatars.Update(\n\t\tcontext.TODO(),\n\t\t\"avatar_id\",\n\t\ttelnyx.AIAvatarUpdateParams{\n\t\t\tName: \"Updated portrait\",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", avatar.Data)\n}\n"},{"lang":"Java","source":"package com.telnyx.sdk.example;\n\nimport com.telnyx.sdk.client.TelnyxClient;\nimport com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;\nimport com.telnyx.sdk.models.ai.avatars.AvatarUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n TelnyxClient client = TelnyxOkHttpClient.fromEnv();\n\n AvatarUpdateParams params = AvatarUpdateParams.builder()\n .name(\"Updated portrait\")\n .build();\n var response = client.ai().avatars().update(\"avatar_id\", params);\n }\n}"},{"lang":"Ruby","source":"require \"telnyx\"\n\ntelnyx = Telnyx::Client.new(api_key: \"My API Key\")\n\navatar = telnyx.ai.avatars.update(\"avatar_id\", name: \"Updated portrait\")\n\nputs(avatar)"},{"lang":"PHP","source":"\u003c?php\n\nrequire_once dirname(__DIR__) . '/vendor/autoload.php';\n\nuse Telnyx\\Client;\nuse Telnyx\\Core\\Exceptions\\APIException;\n\n$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');\n\ntry {\n $avatar = $client->ai->avatars->update(\n 'avatar_id',\n name: 'Updated portrait',\n );\n\n var_dump($avatar);\n} catch (APIException $e) {\n echo $e->getMessage();\n}"},{"lang":"CLI","source":"telnyx ai:avatars update \\\n --api-key 'My API Key' \\\n --avatar-id avatar_id \\\n --name 'Updated portrait'"}],"method":"patch","type":"path","servers":["e1077638-f2c5-4868-8a50-25633dbe3f9b"],"security":["56a3d1db-c9c9-42dd-99ba-415f5aad88ec"],"path":"/ai/avatars/{avatar_id}","baseUrlOptions":["https://api.telnyx.com/v2"],"title":"Update a custom avatar","codeSamples":[{"lang":"JavaScript","source":"import Telnyx from 'telnyx';\n\nconst client = new Telnyx({\n apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted\n});\n\nconst Avatar = await client.ai.avatars.update('avatar_id', {\n name: 'Updated portrait',\n});\n\nconsole.log(Avatar.data);"},{"lang":"Python","source":"import os\nfrom telnyx import Telnyx\n\nclient = Telnyx(\n api_key=os.environ.get(\"TELNYX_API_KEY\"), # This is the default and can be omitted\n)\navatar = client.ai.avatars.update(\n avatar_id=\"avatar_id\",\n name=\"Updated portrait\",\n)\nprint(avatar.data)\n"},{"lang":"Go","source":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/team-telnyx/telnyx-go\"\n\t\"github.com/team-telnyx/telnyx-go/option\"\n)\n\nfunc main() {\n\tclient := telnyx.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tavatar, err := client.AI.Avatars.Update(\n\t\tcontext.TODO(),\n\t\t\"avatar_id\",\n\t\ttelnyx.AIAvatarUpdateParams{\n\t\t\tName: \"Updated portrait\",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", avatar.Data)\n}\n"},{"lang":"Java","source":"package com.telnyx.sdk.example;\n\nimport com.telnyx.sdk.client.TelnyxClient;\nimport com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;\nimport com.telnyx.sdk.models.ai.avatars.AvatarUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n TelnyxClient client = TelnyxOkHttpClient.fromEnv();\n\n AvatarUpdateParams params = AvatarUpdateParams.builder()\n .name(\"Updated portrait\")\n .build();\n var response = client.ai().avatars().update(\"avatar_id\", params);\n }\n}"},{"lang":"Ruby","source":"require \"telnyx\"\n\ntelnyx = Telnyx::Client.new(api_key: \"My API Key\")\n\navatar = telnyx.ai.avatars.update(\"avatar_id\", name: \"Updated portrait\")\n\nputs(avatar)"},{"lang":"PHP","source":"\u003c?php\n\nrequire_once dirname(__DIR__) . '/vendor/autoload.php';\n\nuse Telnyx\\Client;\nuse Telnyx\\Core\\Exceptions\\APIException;\n\n$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');\n\ntry {\n $avatar = $client->ai->avatars->update(\n 'avatar_id',\n name: 'Updated portrait',\n );\n\n var_dump($avatar);\n} catch (APIException $e) {\n echo $e->getMessage();\n}"},{"lang":"CLI","source":"telnyx ai:avatars update \\\n --api-key 'My API Key' \\\n --avatar-id avatar_id \\\n --name 'Updated portrait'"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"d425609f-6071-406d-998a-a0c0cd7bbea0":{"name":"avatar_id","in":"path","required":true,"description":"Stable identifier of a Telnyx stock avatar or an organization-owned custom avatar.","schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$","description":"Stable identifier of a Telnyx stock avatar or an organization-owned custom avatar.\nStable 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.","example":"avatar_0123456789abcdef0123456789abcdef","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["name"],"properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"New customer-facing name of the custom avatar.","example":"Updated portrait","isRequired":true,"uniqueKey":"name","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"name":"Updated portrait"},"examples":{"Example":{"title":"Example","value":{"name":"Updated portrait"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"c06b04c2-c393-4692-8351-1983b2885f25":{"description":"The custom avatar was updated.","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["id","name","provider","avatar_type","hosted","image_url"],"properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$","description":"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.","example":"avatar_0123456789abcdef0123456789abcdef","isRequired":true,"uniqueKey":"data.id","typeLabel":"string"},"name":{"type":"string","minLength":1,"maxLength":255,"description":"Customer-facing avatar name.","example":"Customer portrait","isRequired":true,"uniqueKey":"data.name","typeLabel":"string"},"provider":{"type":"string","const":"telnyx","description":"Avatar provider. The first release supports Telnyx avatars.","example":"telnyx","isRequired":true,"uniqueKey":"data.provider","typeLabel":"string"},"avatar_type":{"type":"string","enum":["stock","custom"],"description":"Whether the avatar is provided by Telnyx or was uploaded by the authenticated organization.","isRequired":true,"uniqueKey":"data.avatar_type","typeLabel":"enum\u003cstring>"},"hosted":{"type":"boolean","const":true,"description":"Indicates that avatar rendering runs on Telnyx-operated infrastructure.","example":true,"isRequired":true,"uniqueKey":"data.hosted","typeLabel":"boolean"},"image_url":{"type":"string","format":"uri","pattern":"^https://","description":"HTTPS image URL suitable for an avatar selection thumbnail. If the URL expires, list or retrieve the avatar again to refresh it.","example":"https://example.com/avatar.png","isRequired":true,"uniqueKey":"data.image_url","typeLabel":"string\u003curi>"},"image_url_expires_at":{"type":"string","format":"date-time","description":"Expiration time of `image_url`. Omitted when the URL does not expire.","example":"2026-10-13T15:00:00Z","uniqueKey":"data.image_url_expires_at","typeLabel":"string\u003cdate-time>"},"suggested_voice_id":{"type":"string","minLength":0,"maxLength":255,"readOnly":true,"description":"Optional recommended Telnyx text-to-speech voice for this avatar. An omitted field or empty string means no recommendation is available. Custom avatars have no suggested voice. It is informational and selecting the avatar does not automatically change the AI Assistant's configured voice.","example":"Telnyx.Ultra.db6b0ed5-d5d3-463d-ae85-518a07d3c2b4","uniqueKey":"data.suggested_voice_id","typeLabel":"string"},"content_type":{"type":"string","enum":["image/jpeg","image/png","image/webp"],"description":"MIME type of a custom avatar image.","uniqueKey":"data.content_type","typeLabel":"enum\u003cstring>"},"size_bytes":{"type":"integer","minimum":1,"maximum":10485760,"description":"Size of a custom avatar image in bytes.","example":248512,"uniqueKey":"data.size_bytes","typeLabel":"integer"},"width_px":{"type":"integer","minimum":256,"maximum":8192,"description":"Decoded width of a custom avatar image.","example":1920,"uniqueKey":"data.width_px","typeLabel":"integer"},"height_px":{"type":"integer","minimum":256,"maximum":8192,"description":"Decoded height of a custom avatar image.","example":1080,"uniqueKey":"data.height_px","typeLabel":"integer"},"created_at":{"type":"string","format":"date-time","description":"Time when the custom avatar was created.","example":"2026-10-13T14:00:00Z","uniqueKey":"data.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"Time when the custom avatar was last updated.","example":"2026-10-13T14:00:00Z","uniqueKey":"data.updated_at","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"id":"avatar_0123456789abcdef0123456789abcdef","name":"Customer portrait","provider":"telnyx","avatar_type":"stock","hosted":true,"image_url":"https://example.com/avatar.png","image_url_expires_at":"2026-10-13T15:00:00Z","suggested_voice_id":"Telnyx.Ultra.db6b0ed5-d5d3-463d-ae85-518a07d3c2b4","content_type":"image/jpeg","size_bytes":248512,"width_px":1920,"height_px":1080,"created_at":"2026-10-13T14:00:00Z","updated_at":"2026-10-13T14:00:00Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"427087a0-7c4c-408d-ba33-58412926d804":{"description":"The avatar identifier is malformed, or the operation targets a Telnyx stock avatar, which is read-only.","content":{"application/json":{"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","minItems":1,"items":{"type":"object","additionalProperties":true,"required":["code","title","detail","meta"],"properties":{"code":{"type":"string","description":"Telnyx error code.","example":"10015","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"title":{"type":"string","description":"Short description of the error.","example":"Bad Request","isRequired":true,"uniqueKey":"errors.items.[INDEX].title","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable details about the error.","example":"The request failed because it was not well-formed.","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"meta":{"type":"object","additionalProperties":true,"required":["url"],"properties":{"url":{"type":"string","format":"uri","description":"Link to the Telnyx error-code documentation.","example":"https://developers.telnyx.com/docs/overview/errors/10027","isRequired":true,"uniqueKey":"errors.items.[INDEX].meta.url","typeLabel":"string\u003curi>"}},"isRequired":true,"uniqueKey":"errors.items.[INDEX].meta","typeLabel":"object"},"source":{"type":"object","additionalProperties":true,"properties":{"pointer":{"type":"string","description":"Location of the invalid request value.","example":"/image_file","uniqueKey":"errors.items.[INDEX].source.pointer","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].source","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"code":"10015","title":"Bad Request","detail":"Telnyx stock avatars cannot be modified.","meta":{"url":"https://developers.telnyx.com/docs/overview/errors/10015"}}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"code":"10015","title":"Bad Request","detail":"Telnyx stock avatars cannot be modified.","meta":{"url":"https://developers.telnyx.com/docs/overview/errors/10015"}}]}}},"exampleType":"examples"}},"exampleType":"examples"},"aa51e4d3-2c54-4c4f-9bf5-d1e5972b904b":{"description":"The avatar does not exist or is not available to the authenticated organization.","content":{"application/json":{"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","minItems":1,"items":{"type":"object","additionalProperties":true,"required":["code","title","detail","meta"],"properties":{"code":{"type":"string","description":"Telnyx error code.","example":"10015","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"title":{"type":"string","description":"Short description of the error.","example":"Bad Request","isRequired":true,"uniqueKey":"errors.items.[INDEX].title","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable details about the error.","example":"The request failed because it was not well-formed.","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"meta":{"type":"object","additionalProperties":true,"required":["url"],"properties":{"url":{"type":"string","format":"uri","description":"Link to the Telnyx error-code documentation.","example":"https://developers.telnyx.com/docs/overview/errors/10027","isRequired":true,"uniqueKey":"errors.items.[INDEX].meta.url","typeLabel":"string\u003curi>"}},"isRequired":true,"uniqueKey":"errors.items.[INDEX].meta","typeLabel":"object"},"source":{"type":"object","additionalProperties":true,"properties":{"pointer":{"type":"string","description":"Location of the invalid request value.","example":"/image_file","uniqueKey":"errors.items.[INDEX].source.pointer","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].source","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"code":"10005","title":"Resource not found","detail":"Avatar avatar_0123456789abcdef0123456789abcdef does not exist.","meta":{"url":"https://developers.telnyx.com/docs/overview/errors/10005"}}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"code":"10005","title":"Resource not found","detail":"Avatar avatar_0123456789abcdef0123456789abcdef does not exist.","meta":{"url":"https://developers.telnyx.com/docs/overview/errors/10005"}}]}}},"exampleType":"examples"}},"exampleType":"examples"},"86a70be8-8a03-4480-aab9-5b27fd9bff96":{"description":"The request, uploaded image, or organization quota failed validation. Uploaded images must not exceed 10 MiB.","content":{"application/json":{"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","minItems":1,"items":{"type":"object","additionalProperties":true,"required":["code","title","detail","meta"],"properties":{"code":{"type":"string","description":"Telnyx error code.","example":"10015","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"title":{"type":"string","description":"Short description of the error.","example":"Bad Request","isRequired":true,"uniqueKey":"errors.items.[INDEX].title","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable details about the error.","example":"The request failed because it was not well-formed.","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"meta":{"type":"object","additionalProperties":true,"required":["url"],"properties":{"url":{"type":"string","format":"uri","description":"Link to the Telnyx error-code documentation.","example":"https://developers.telnyx.com/docs/overview/errors/10027","isRequired":true,"uniqueKey":"errors.items.[INDEX].meta.url","typeLabel":"string\u003curi>"}},"isRequired":true,"uniqueKey":"errors.items.[INDEX].meta","typeLabel":"object"},"source":{"type":"object","additionalProperties":true,"properties":{"pointer":{"type":"string","description":"Location of the invalid request value.","example":"/image_file","uniqueKey":"errors.items.[INDEX].source.pointer","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].source","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"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"}}]},"examples":{"Example":{"title":"Example","value":{"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"}}]}}},"exampleType":"examples"}},"exampleType":"examples"},"3307b16d-3057-48eb-8351-554963ef90c7":{"description":"Avatar storage is temporarily unavailable. Retry the operation.","content":{"application/json":{"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","minItems":1,"items":{"type":"object","additionalProperties":true,"required":["code","title","detail","meta"],"properties":{"code":{"type":"string","description":"Telnyx error code.","example":"10015","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"title":{"type":"string","description":"Short description of the error.","example":"Bad Request","isRequired":true,"uniqueKey":"errors.items.[INDEX].title","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable details about the error.","example":"The request failed because it was not well-formed.","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"meta":{"type":"object","additionalProperties":true,"required":["url"],"properties":{"url":{"type":"string","format":"uri","description":"Link to the Telnyx error-code documentation.","example":"https://developers.telnyx.com/docs/overview/errors/10027","isRequired":true,"uniqueKey":"errors.items.[INDEX].meta.url","typeLabel":"string\u003curi>"}},"isRequired":true,"uniqueKey":"errors.items.[INDEX].meta","typeLabel":"object"},"source":{"type":"object","additionalProperties":true,"properties":{"pointer":{"type":"string","description":"Location of the invalid request value.","example":"/image_file","uniqueKey":"errors.items.[INDEX].source.pointer","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].source","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"code":"10037","title":"Service unavailable","detail":"Avatar storage is temporarily unavailable. Try again.","meta":{"url":"https://developers.telnyx.com/docs/overview/errors/10037"}}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"code":"10037","title":"Service unavailable","detail":"Avatar storage is temporarily unavailable. Try again.","meta":{"url":"https://developers.telnyx.com/docs/overview/errors/10037"}}]}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"56a3d1db-c9c9-42dd-99ba-415f5aad88ec":{"bearerAuth":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"e1077638-f2c5-4868-8a50-25633dbe3f9b":{"url":"https://api.telnyx.com/v2","description":"Version 2.0.0 of the Telnyx API"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi/source/external/inference/inference-embedding.json"},"subdomain":"telnyx","siteName":"Telnyx","title":"Update a custom avatar - Telnyx","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-03T15:19:37.449Z","originalFileLocation":"api-reference/avatars/update-a-custom-avatar.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Updates the customer-facing name of a custom avatar owned by the authenticated organization. Stock avatars cannot be modified. To replace the image, create a new custom avatar so existing references keep their original content.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Telnyx\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/telnyx/MhCJ9JWG11MInbt6/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/telnyx/MhCJ9JWG11MInbt6/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/telnyx/MhCJ9JWG11MInbt6/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/telnyx/MhCJ9JWG11MInbt6/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/telnyx/MhCJ9JWG11MInbt6/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/telnyx/MhCJ9JWG11MInbt6/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/telnyx/MhCJ9JWG11MInbt6/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/telnyx/MhCJ9JWG11MInbt6/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/telnyx/MhCJ9JWG11MInbt6/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update a custom avatar - Telnyx\">\u003cmeta data-mint-head property=\"og:description\" content=\"Infrastructure for real-time agents. Voice, AI, Edge Compute\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Telnyx\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.telnyx.com/api-reference/avatars/update-a-custom-avatar\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://telnyx.mintlify.app/_mintlify/api/og/v2?division=Avatars+API\u0026amp;title=Update+a+custom+avatar\u0026amp;description=Updates+the+customer-facing+name+of+a+custom+avatar+owned+by+the+authenticated+organization.+Stock+avatars+cannot+be+modified.+To+replace+the+image%2C+create+a+ne\u0026amp;theme=0dd46d2166d1a00e34819206\u0026amp;signature=ceab58faa852e0ce30009b58e38f18f59d28d54d3f713e2de54e4757a8e518f6\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Update a custom avatar - Telnyx\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Infrastructure for real-time agents. Voice, AI, Edge Compute\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://telnyx.mintlify.app/_mintlify/api/og/v2?division=Avatars+API\u0026amp;title=Update+a+custom+avatar\u0026amp;description=Updates+the+customer-facing+name+of+a+custom+avatar+owned+by+the+authenticated+organization.+Stock+avatars+cannot+be+modified.+To+replace+the+image%2C+create+a+ne\u0026amp;theme=0dd46d2166d1a00e34819206\u0026amp;signature=ceab58faa852e0ce30009b58e38f18f59d28d54d3f713e2de54e4757a8e518f6\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/telnyx/MhCJ9JWG11MInbt6/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Telnyx\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#00B688\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.telnyx.com/api-reference/avatars/update-a-custom-avatar\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/avatars/update-a-custom-avatar.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://telnyx.com/#organization\",\"name\":\"Telnyx\",\"url\":\"https://telnyx.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://telnyx.com/favicon.ico\"},\"sameAs\":[\"https://x.com/telnyx\",\"https://www.linkedin.com/company/telnyx/\",\"https://github.com/team-telnyx\"]},{\"@type\":\"WebSite\",\"@id\":\"https://developers.telnyx.com#website\",\"name\":\"Telnyx\",\"url\":\"https://developers.telnyx.com\",\"publisher\":{\"@id\":\"https://telnyx.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.telnyx.com/api-reference/avatars/update-a-custom-avatar#webpage\",\"url\":\"https://developers.telnyx.com/api-reference/avatars/update-a-custom-avatar\",\"name\":\"Update a custom avatar\",\"description\":\"Updates the customer-facing name of a custom avatar owned by the authenticated organization. Stock avatars cannot be modified. To replace the image, create a new custom avatar so existing references keep their original content.\",\"dateModified\":\"2026-11-03T15:19:37.449Z\",\"isPartOf\":{\"@id\":\"https://developers.telnyx.com#website\"},\"breadcrumb\":{\"@id\":\"https://developers.telnyx.com/api-reference/avatars/update-a-custom-avatar#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.telnyx.com/api-reference/avatars/update-a-custom-avatar#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Assistants API\",\"item\":\"https://developers.telnyx.com/api-reference/assistants/list-assistants\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Avatars API\",\"item\":\"https://developers.telnyx.com/api-reference/avatars/create-a-custom-avatar\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Update a custom avatar\",\"item\":\"https://developers.telnyx.com/api-reference/avatars/update-a-custom-avatar\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.telnyx.com/api-reference/avatars/update-a-custom-avatar#apireference\",\"headline\":\"Update a custom avatar\",\"name\":\"Update a custom avatar\",\"description\":\"Updates the customer-facing name of a custom avatar owned by the authenticated organization. Stock avatars cannot be modified. To replace the image, create a new custom avatar so existing references keep their original content.\",\"url\":\"https://developers.telnyx.com/api-reference/avatars/update-a-custom-avatar\",\"mainEntityOfPage\":{\"@id\":\"https://developers.telnyx.com/api-reference/avatars/update-a-custom-avatar#webpage\"},\"dateModified\":\"2026-11-03T15:19:37.449Z\",\"publisher\":{\"@id\":\"https://telnyx.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.telnyx.com#website\"}}]}\u003c/script>","siteName":"Telnyx","nav":{"global":{"anchors":[{"anchor":"Home","icon":"house","href":"/docs/overview"}]},"products":[{"product":"Home","icon":"house","pages":[{"title":"Home","href":"/docs/overview"}]},{"product":"Other APIs","icon":"ellipsis","pages":[{"title":"Other APIs","href":"/docs/other-apis"}]},{"product":"Agent Platform","icon":"circle-nodes","pages":[{"title":"Agent Platform","href":"/docs/agent-platform"}]},{"product":"AI","icon":"microchip-ai","tabs":[{"tab":"Inference","icon":"brain-circuit","pages":[{"title":"Inference","href":"/docs/inference/models"}]},{"tab":"AI Gateway","icon":"key","pages":[{"title":"AI Gateway","href":"/docs/inference/ai-gateway"}]},{"tab":"Embedding","icon":"database","pages":[{"title":"Embedding","href":"/docs/inference/embedding-rag"}]},{"tab":"Assistants","icon":"robot","groups":[{"group":"Guides","pages":[{"group":"Getting Started","pages":[{"title":"Voice Assistant Quickstart","sidebarTitle":"Voice Assistant","href":"/docs/inference/ai-assistants/no-code-voice-assistant"},{"title":"Web Chat Without Voice","sidebarTitle":"Web Chat Without Voice","href":"/docs/inference/ai-assistants/web-chat/index"},{"title":"Importing Assistants from another Provider","sidebarTitle":"Importing Assistants","href":"/docs/inference/ai-assistants/importing/index"},{"title":"Realtime voice conversations over WebSocket","sidebarTitle":"Realtime Conversations","href":"/docs/inference/ai-assistants/realtime-conversations/index"},{"title":"Realtime voice and avatar conversations over WebRTC","sidebarTitle":"WebRTC Conversations","tag":"Beta","href":"/docs/inference/ai-assistants/webrtc-conversations/index"},{"title":"Assistant Deletion and Restore","sidebarTitle":"Deletion and Restore","href":"/docs/inference/ai-assistants/assistant-deletion/index"}]},{"group":"Models \u0026 Voice","pages":[{"title":"Speech-to-speech models","sidebarTitle":"Speech-to-speech models","href":"/docs/inference/ai-assistants/speech-to-speech/index"},{"title":"GPT Live voice assistants","sidebarTitle":"GPT Live","href":"/docs/inference/ai-assistants/gpt-live/index"},{"title":"Configure custom LLM providers for AI assistants","sidebarTitle":"Custom LLMs for Assistants","href":"/docs/inference/ai-assistants/custom-llm/index"},{"title":"Transcription Settings","sidebarTitle":"Transcription Settings","href":"/docs/inference/ai-assistants/transcription-settings/index"},{"title":"Avatars","sidebarTitle":"Avatars","tag":"Beta","href":"/docs/inference/ai-assistants/avatars/index"},{"title":"Interruption Settings","sidebarTitle":"Interruption Settings","href":"/docs/inference/ai-assistants/interruption-settings/index"}]},{"group":"Context \u0026 Memory","pages":[{"title":"Dynamic Variables","sidebarTitle":"Dynamic Variables","href":"/docs/inference/ai-assistants/dynamic-variables/index"},{"title":"How conversations are keyed across channels","sidebarTitle":"Conversation Keying","href":"/docs/inference/ai-assistants/conversation-keying/index"},{"title":"Memory","sidebarTitle":"Memory","href":"/docs/inference/ai-assistants/memory/index"}]},{"group":"Tools \u0026 Integrations","pages":[{"title":"Tools Library","sidebarTitle":"Tools Library","href":"/docs/inference/ai-assistants/tools-library/index"},{"title":"AI assistant integrations","sidebarTitle":"Integrations","href":"/docs/inference/ai-assistants/integrations/index"},{"title":"Add MCP servers to an AI assistant","href":"/docs/development/mcp/assistant-mcp-servers/index"},{"title":"Per-Caller Credentials","sidebarTitle":"Per-Caller Credentials","href":"/docs/inference/ai-assistants/per-caller-credentials/index"},{"title":"Preset Webhook Parameters","sidebarTitle":"Preset Webhook Parameters","href":"/docs/inference/ai-assistants/preset-webhook-parameters/index"},{"title":"Async Tools \u0026 Deferred Context","sidebarTitle":"Async Tools","href":"/docs/inference/ai-assistants/async-tools/index"},{"title":"Webhook Tool Filler Messages","sidebarTitle":"Filler Messages","href":"/docs/inference/ai-assistants/filler-messages/index"},{"title":"Client-Side Tools","sidebarTitle":"Client-Side Tools","href":"/docs/inference/ai-assistants/client-side-tools/index"},{"title":"Vision","sidebarTitle":"Vision","tag":"BETA","href":"/docs/inference/ai-assistants/vision/index"},{"title":"Power AI Assistants with Edge Compute","sidebarTitle":"AI Assistants and Edge Compute","href":"/docs/edge-compute/guides/ai-assistant-backend/index"}]},{"group":"Workflows \u0026 Agents","pages":[{"title":"Conversation Workflows","sidebarTitle":"Conversation Workflows","href":"/docs/inference/ai-assistants/workflows/index"},{"title":"Delegation","sidebarTitle":"Delegation","href":"/docs/inference/ai-assistants/delegation/index"},{"title":"A2A Agents","sidebarTitle":"A2A Agents","tag":"Beta","href":"/docs/inference/ai-assistants/a2a-agents/index"},{"title":"Agent Handoff","sidebarTitle":"Agent Handoff","href":"/docs/inference/ai-assistants/agent-handoff/index"}]},{"group":"Calls \u0026 Transfers","pages":[{"title":"Multi-Participant Voice AI Calls","sidebarTitle":"Multi-Participant Calls","href":"/docs/inference/ai-assistants/multi-participant-calls/index"},{"title":"Warm Transfer Acceptance","sidebarTitle":"Warm Transfer Acceptance","href":"/docs/inference/ai-assistants/warm-transfer-acceptance/index"},{"title":"Voicemail Detection on Transfer","sidebarTitle":"Voicemail Detection on Transfer","href":"/docs/inference/ai-assistants/voicemail-detection-on-transfer/index"},{"title":"Scheduled Events","sidebarTitle":"Scheduled Events","href":"/docs/inference/ai-assistants/scheduled-events/index"}]},{"group":"Testing \u0026 Monitoring","pages":[{"title":"Testing and Traffic Distribution for AI Assistants","sidebarTitle":"Testing, Versions \u0026 Traffic Distribution","href":"/docs/inference/ai-assistants/version-testing-traffic-distribution/index"},{"title":"Stream conversation events to your WebSocket","sidebarTitle":"Conversation Event Stream","href":"/docs/inference/ai-assistants/conversation-event-stream/index"},{"title":"Observability","sidebarTitle":"Observability","href":"/docs/inference/ai-assistants/agent-observability/index"},{"title":"Post-Conversation Processing","sidebarTitle":"Post-Conversation Processing","href":"/docs/inference/ai-assistants/post-conversation-processing/index"}]}]},{"group":"Missions","pages":[{"title":"Voice Outreach with AI Missions","sidebarTitle":"Voice Outreach","href":"/docs/inference/missions/index"}]},{"group":"AI Insights","pages":[{"title":"Creating Insights","sidebarTitle":"Creating insights","href":"/docs/inference/ai-insights/creating-insights/index"},{"title":"AI insights use cases","sidebarTitle":"Use cases","href":"/docs/inference/ai-insights/use-cases/index"},{"title":"Structured data insights","sidebarTitle":"Structured insights","href":"/docs/inference/ai-insights/structured-insights/index"},{"title":"Insight Groups","sidebarTitle":"Insight groups","href":"/docs/inference/ai-insights/insight-groups/index"},{"title":"Telnyx-Managed Insights","sidebarTitle":"Telnyx-managed insights","href":"/docs/inference/ai-insights/telnyx-managed-insights/index"}]},{"group":"Assistants API","pages":[{"group":"Assistants API","pages":[{"title":"List assistants","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/assistants","href":"/api-reference/assistants/list-assistants"},{"title":"Create an assistant","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/assistants","href":"/api-reference/assistants/create-an-assistant"},{"title":"Delete an assistant","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json delete /ai/assistants/{assistant_id}","href":"/api-reference/assistants/delete-an-assistant"},{"title":"List deleted assistants","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/assistants/deleted","href":"/api-reference/assistants/list-deleted-assistants"},{"title":"Get a deleted assistant","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/assistants/{assistant_id}/deleted","href":"/api-reference/assistants/get-a-deleted-assistant"},{"title":"Restore an assistant","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/assistants/{assistant_id}/restore","href":"/api-reference/assistants/restore-an-assistant"},{"title":"Get an assistant","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/assistants/{assistant_id}","href":"/api-reference/assistants/get-an-assistant"},{"title":"Update an assistant","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/assistants/{assistant_id}","href":"/api-reference/assistants/update-an-assistant"},{"title":"Assistant Chat","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/assistants/{assistant_id}/chat","href":"/api-reference/assistants/assistant-chat"},{"title":"Assistant Sms Chat","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/assistants/{assistant_id}/chat/sms","href":"/api-reference/assistants/assistant-sms-chat"},{"title":"Assistant WhatsApp Chat","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/assistants/{assistant_id}/chat/whatsapp","href":"/api-reference/assistants/assistant-whatsapp-chat"},{"title":"Clone Assistant","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/assistants/{assistant_id}/clone","href":"/api-reference/assistants/clone-assistant"},{"title":"Enhance Assistant Instructions","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/assistants/{assistant_id}/instructions/enhance","href":"/api-reference/assistants/enhance-assistant-instructions"},{"title":"Import assistants from external provider","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/assistants/import","href":"/api-reference/assistants/import-assistants-from-external-provider"},{"title":"List scheduled events","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/assistants/{assistant_id}/scheduled_events","href":"/api-reference/assistants/list-scheduled-events"},{"title":"Create a scheduled event","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/assistants/{assistant_id}/scheduled_events","href":"/api-reference/assistants/create-a-scheduled-event"},{"title":"Delete a scheduled event","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json delete /ai/assistants/{assistant_id}/scheduled_events/{event_id}","href":"/api-reference/assistants/delete-a-scheduled-event"},{"title":"Get a scheduled event","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/assistants/{assistant_id}/scheduled_events/{event_id}","href":"/api-reference/assistants/get-a-scheduled-event"},{"title":"List assistant tests with pagination","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/assistants/tests","href":"/api-reference/assistants/list-assistant-tests-with-pagination"},{"title":"Create a new assistant test","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/assistants/tests","href":"/api-reference/assistants/create-a-new-assistant-test"},{"title":"Get all test suite names","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/assistants/tests/test-suites","href":"/api-reference/assistants/get-all-test-suite-names"},{"title":"Get test suite run history","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/assistants/tests/test-suites/{suite_name}/runs","href":"/api-reference/assistants/get-test-suite-run-history"},{"title":"Trigger test suite execution","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/assistants/tests/test-suites/{suite_name}/runs","href":"/api-reference/assistants/trigger-test-suite-execution"},{"title":"Delete an assistant test","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json delete /ai/assistants/tests/{test_id}","href":"/api-reference/assistants/delete-an-assistant-test"},{"title":"Get assistant test by ID","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/assistants/tests/{test_id}","href":"/api-reference/assistants/get-assistant-test-by-id"},{"title":"Update an assistant test","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json put /ai/assistants/tests/{test_id}","href":"/api-reference/assistants/update-an-assistant-test"},{"title":"Get test run history for a specific test","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/assistants/tests/{test_id}/runs","href":"/api-reference/assistants/get-test-run-history-for-a-specific-test"},{"title":"Trigger a manual test run","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/assistants/tests/{test_id}/runs","href":"/api-reference/assistants/trigger-a-manual-test-run"},{"title":"Get specific test run details","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/assistants/tests/{test_id}/runs/{run_id}","href":"/api-reference/assistants/get-specific-test-run-details"},{"title":"Get all versions of an assistant","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/assistants/{assistant_id}/versions","href":"/api-reference/assistants/get-all-versions-of-an-assistant"},{"title":"Delete a specific assistant version","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json delete /ai/assistants/{assistant_id}/versions/{version_id}","href":"/api-reference/assistants/delete-a-specific-assistant-version"},{"title":"Get a specific assistant version","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/assistants/{assistant_id}/versions/{version_id}","href":"/api-reference/assistants/get-a-specific-assistant-version"},{"title":"Update a specific assistant version","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/assistants/{assistant_id}/versions/{version_id}","href":"/api-reference/assistants/update-a-specific-assistant-version"},{"title":"Promote an assistant version to main","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/assistants/{assistant_id}/versions/{version_id}/promote","href":"/api-reference/assistants/promote-an-assistant-version-to-main"},{"title":"Delete Canary Deploy","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json delete /ai/assistants/{assistant_id}/canary-deploys","href":"/api-reference/assistants/delete-canary-deploy"},{"title":"Get Canary Deploy","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/assistants/{assistant_id}/canary-deploys","href":"/api-reference/assistants/get-canary-deploy"},{"title":"Create Canary Deploy","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/assistants/{assistant_id}/canary-deploys","href":"/api-reference/assistants/create-canary-deploy"},{"title":"Update Canary Deploy","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json put /ai/assistants/{assistant_id}/canary-deploys","href":"/api-reference/assistants/update-canary-deploy"},{"title":"Get assistant texml","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/assistants/{assistant_id}/texml","href":"/api-reference/assistants/get-assistant-texml"},{"title":"Test Assistant Tool","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/assistants/{assistant_id}/tools/{tool_id}/test","href":"/api-reference/assistants/test-assistant-tool"},{"title":"Get All Tags","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/assistants/tags","href":"/api-reference/assistants/get-all-tags"},{"title":"Add Assistant Tag","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/assistants/{assistant_id}/tags","href":"/api-reference/assistants/add-assistant-tag"},{"title":"Remove Assistant Tag","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json delete /ai/assistants/{assistant_id}/tags/{tag}","href":"/api-reference/assistants/remove-assistant-tag"},{"title":"Remove Assistant Tool","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json delete /ai/assistants/{assistant_id}/tools/{tool_id}","href":"/api-reference/assistants/remove-assistant-tool"},{"title":"Add Assistant Tool","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json put /ai/assistants/{assistant_id}/tools/{tool_id}","href":"/api-reference/assistants/add-assistant-tool"}]},{"group":"Avatars API","pages":[{"title":"Create a custom avatar","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/avatars","href":"/api-reference/avatars/create-a-custom-avatar"},{"title":"List avatars","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/avatars","href":"/api-reference/avatars/list-avatars"},{"title":"Get an avatar","description":"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.","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/avatars/{avatar_id}","href":"/api-reference/avatars/get-an-avatar"},{"title":"Update a custom avatar","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json patch /ai/avatars/{avatar_id}","href":"/api-reference/avatars/update-a-custom-avatar"}]},{"group":"Conversation WebSocket","pages":[{"group":"Websockets","pages":[{"asyncapi":"openapi/asyncapi/assistant-conversation/assistant-conversation.yml assistant-conversation-websocket","href":"/api-reference/websockets/talk-to-an-ai-assistant-over-websocket","title":"Talk to an AI Assistant over WebSocket","description":"Real-time voice conversation with a Telnyx AI Assistant. The client streams PCM16 audio to Telnyx and receives lifecycle, transcription, and assistant-audio frames in return.\n\n## Authentication\nRequires authentication via a Bearer token (Telnyx API v2 key), in the `Authorization` header or, from a browser, as the WebSocket subprotocols `telnyx-auth-ws` and `base64url.bearer.telnyx.\u003cbase64url credential>`.\n\n## WebRTC transport\nWith `transport=webrtc`, the socket signals a WebRTC call instead of carrying audio: Telnyx sends `webrtc.config` with the ICE servers, the client sends `webrtc.offer`, and Telnyx answers `webrtc.answer`. Audio (and the optional avatar or camera video) then travels on the WebRTC media tracks; every other frame on this socket works as described here, except `input_audio_buffer.append`, `response.output_audio.delta` and `session.update`, which are not used. See the WebRTC conversations guide.\n","version":null}]}]},{"group":"Assistant Event Stream","pages":[{"group":"Websockets","pages":[{"asyncapi":"openapi/asyncapi/assistant-events/assistant-events.yml assistant-events-websocket","href":"/api-reference/websockets/assistant-event-stream-websocket-channel","title":"Assistant event stream WebSocket channel","version":null}]}]},{"group":"Integrations API","pages":[{"title":"List Integrations","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/integrations","href":"/api-reference/integrations/list-integrations"},{"title":"List User Integrations","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/integrations/connections","href":"/api-reference/integrations/list-user-integrations"},{"title":"Delete Integration Connection","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json delete /ai/integrations/connections/{user_connection_id}","href":"/api-reference/integrations/delete-integration-connection"},{"title":"Get User Integration connection By Id","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/integrations/connections/{user_connection_id}","href":"/api-reference/integrations/get-user-integration-connection-by-id"},{"title":"List Integration By Id","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/integrations/{integration_id}","href":"/api-reference/integrations/list-integration-by-id"}]},{"group":"MCP Servers API","pages":[{"title":"List MCP Servers","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/mcp_servers","href":"/api-reference/mcp-servers/list-mcp-servers"},{"title":"Create MCP Server","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/mcp_servers","href":"/api-reference/mcp-servers/create-mcp-server"},{"title":"Delete MCP Server","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json delete /ai/mcp_servers/{mcp_server_id}","href":"/api-reference/mcp-servers/delete-mcp-server"},{"title":"Get MCP Server","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/mcp_servers/{mcp_server_id}","href":"/api-reference/mcp-servers/get-mcp-server"},{"title":"Update MCP Server","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json put /ai/mcp_servers/{mcp_server_id}","href":"/api-reference/mcp-servers/update-mcp-server"}]}]},{"group":"Missions API","pages":[{"title":"List missions","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json get /ai/missions","href":"/api-reference/missions/list-missions"},{"title":"Create mission","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json post /ai/missions","href":"/api-reference/missions/create-mission"},{"title":"List recent events","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json get /ai/missions/events","href":"/api-reference/missions/list-recent-events"},{"title":"List recent runs","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json get /ai/missions/runs","href":"/api-reference/missions/list-recent-runs"},{"title":"Delete mission","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json delete /ai/missions/{mission_id}","href":"/api-reference/missions/delete-mission"},{"title":"Get mission","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json get /ai/missions/{mission_id}","href":"/api-reference/missions/get-mission"},{"title":"Update mission","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json put /ai/missions/{mission_id}","href":"/api-reference/missions/update-mission"},{"title":"Clone mission","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json post /ai/missions/{mission_id}/clone","href":"/api-reference/missions/clone-mission"},{"title":"List runs for mission","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json get /ai/missions/{mission_id}/runs","href":"/api-reference/missions/list-runs-for-mission"},{"title":"Start a run","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json post /ai/missions/{mission_id}/runs","href":"/api-reference/missions/start-a-run"},{"title":"Get run details","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json get /ai/missions/{mission_id}/runs/{run_id}","href":"/api-reference/missions/get-run-details"},{"title":"Update run","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json patch /ai/missions/{mission_id}/runs/{run_id}","href":"/api-reference/missions/update-run"},{"title":"Cancel run","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json post /ai/missions/{mission_id}/runs/{run_id}/cancel","href":"/api-reference/missions/cancel-run"},{"title":"List events","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json get /ai/missions/{mission_id}/runs/{run_id}/events","href":"/api-reference/missions/list-events"},{"title":"Log event","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json post /ai/missions/{mission_id}/runs/{run_id}/events","href":"/api-reference/missions/log-event"},{"title":"Get event details","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json get /ai/missions/{mission_id}/runs/{run_id}/events/{event_id}","href":"/api-reference/missions/get-event-details"},{"title":"Pause run","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json post /ai/missions/{mission_id}/runs/{run_id}/pause","href":"/api-reference/missions/pause-run"},{"title":"Get plan","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json get /ai/missions/{mission_id}/runs/{run_id}/plan","href":"/api-reference/missions/get-plan"},{"title":"Create initial plan","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json post /ai/missions/{mission_id}/runs/{run_id}/plan","href":"/api-reference/missions/create-initial-plan"},{"title":"Add step(s) to plan","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json post /ai/missions/{mission_id}/runs/{run_id}/plan/steps","href":"/api-reference/missions/add-steps-to-plan"},{"title":"Get step details","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json get /ai/missions/{mission_id}/runs/{run_id}/plan/steps/{step_id}","href":"/api-reference/missions/get-step-details"},{"title":"Update step status","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json patch /ai/missions/{mission_id}/runs/{run_id}/plan/steps/{step_id}","href":"/api-reference/missions/update-step-status"},{"title":"Resume run","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json post /ai/missions/{mission_id}/runs/{run_id}/resume","href":"/api-reference/missions/resume-run"},{"title":"List linked Telnyx agents","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json get /ai/missions/{mission_id}/runs/{run_id}/telnyx-agents","href":"/api-reference/missions/list-linked-telnyx-agents"},{"title":"Link Telnyx agent to run","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json post /ai/missions/{mission_id}/runs/{run_id}/telnyx-agents","href":"/api-reference/missions/link-telnyx-agent-to-run"},{"title":"Unlink Telnyx agent","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json delete /ai/missions/{mission_id}/runs/{run_id}/telnyx-agents/{telnyx_agent_id}","href":"/api-reference/missions/unlink-telnyx-agent"},{"title":"List knowledge bases","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json get /ai/missions/{mission_id}/knowledge-bases","href":"/api-reference/missions/list-knowledge-bases"},{"title":"Create knowledge base","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json post /ai/missions/{mission_id}/knowledge-bases","href":"/api-reference/missions/create-knowledge-base"},{"title":"Delete knowledge base","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json delete /ai/missions/{mission_id}/knowledge-bases/{knowledge_base_id}","href":"/api-reference/missions/delete-knowledge-base"},{"title":"Get knowledge base","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json get /ai/missions/{mission_id}/knowledge-bases/{knowledge_base_id}","href":"/api-reference/missions/get-knowledge-base"},{"title":"Update knowledge base","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json put /ai/missions/{mission_id}/knowledge-bases/{knowledge_base_id}","href":"/api-reference/missions/update-knowledge-base"},{"title":"List MCP servers","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json get /ai/missions/{mission_id}/mcp-servers","href":"/api-reference/missions/list-mcp-servers"},{"title":"Create MCP server","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json post /ai/missions/{mission_id}/mcp-servers","href":"/api-reference/missions/create-mcp-server"},{"title":"Delete MCP server","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json delete /ai/missions/{mission_id}/mcp-servers/{mcp_server_id}","href":"/api-reference/missions/delete-mcp-server"},{"title":"Get MCP server","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json get /ai/missions/{mission_id}/mcp-servers/{mcp_server_id}","href":"/api-reference/missions/get-mcp-server"},{"title":"Update MCP server","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json put /ai/missions/{mission_id}/mcp-servers/{mcp_server_id}","href":"/api-reference/missions/update-mcp-server"},{"title":"List tools","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json get /ai/missions/{mission_id}/tools","href":"/api-reference/missions/list-tools"},{"title":"Create tool","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json post /ai/missions/{mission_id}/tools","href":"/api-reference/missions/create-tool"},{"title":"Delete tool","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json delete /ai/missions/{mission_id}/tools/{tool_id}","href":"/api-reference/missions/delete-tool"},{"title":"Get tool","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json get /ai/missions/{mission_id}/tools/{tool_id}","href":"/api-reference/missions/get-tool"},{"title":"Update tool","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json put /ai/missions/{mission_id}/tools/{tool_id}","href":"/api-reference/missions/update-tool"}]},{"group":"AI Tests API","pages":[{"title":"List test agents","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json get /ai/tests/test_framework/v1/aiagents","href":"/api-reference/ai-tests/list-test-agents"},{"title":"Create a test agent","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json post /ai/tests/test_framework/v1/aiagents","href":"/api-reference/ai-tests/create-a-test-agent"},{"title":"Delete a test agent","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json delete /ai/tests/test_framework/v1/aiagents/{id}","href":"/api-reference/ai-tests/delete-a-test-agent"},{"title":"Retrieve a test agent","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json get /ai/tests/test_framework/v1/aiagents/{id}","href":"/api-reference/ai-tests/retrieve-a-test-agent"},{"title":"Update a test agent","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json put /ai/tests/test_framework/v1/aiagents/{id}","href":"/api-reference/ai-tests/update-a-test-agent"},{"title":"List test personalities","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json get /ai/tests/test_framework/v1/personalities","href":"/api-reference/ai-tests/list-test-personalities"},{"title":"List test metrics","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json get /ai/tests/test_framework/v1/metrics","href":"/api-reference/ai-tests/list-test-metrics"},{"title":"Create a test metric","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json post /ai/tests/test_framework/v1/metrics","href":"/api-reference/ai-tests/create-a-test-metric"},{"title":"Bulk create test metrics","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json post /ai/tests/test_framework/v1/metrics/bulk_create","href":"/api-reference/ai-tests/bulk-create-test-metrics"},{"title":"Generate test metrics","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json post /ai/tests/test_framework/v1/metrics/generate_metrics","href":"/api-reference/ai-tests/generate-test-metrics"},{"title":"Get test metric generation progress","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json get /ai/tests/test_framework/v1/metrics/generate_metrics_progress","href":"/api-reference/ai-tests/get-test-metric-generation-progress"},{"title":"Delete a test metric","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json delete /ai/tests/test_framework/v1/metrics/{id}","href":"/api-reference/ai-tests/delete-a-test-metric"},{"title":"Retrieve a test metric","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json get /ai/tests/test_framework/v1/metrics/{id}","href":"/api-reference/ai-tests/retrieve-a-test-metric"},{"title":"Update a test metric","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json patch /ai/tests/test_framework/v1/metrics/{id}","href":"/api-reference/ai-tests/update-a-test-metric"},{"title":"List evaluator scenarios","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json get /ai/tests/test_framework/v1/scenarios","href":"/api-reference/ai-tests/list-evaluator-scenarios"},{"title":"Create an evaluator scenario","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json post /ai/tests/test_framework/v1/scenarios","href":"/api-reference/ai-tests/create-an-evaluator-scenario"},{"title":"Delete an evaluator scenario","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json delete /ai/tests/test_framework/v1/scenarios/{id}","href":"/api-reference/ai-tests/delete-an-evaluator-scenario"},{"title":"Retrieve an evaluator scenario","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json get /ai/tests/test_framework/v1/scenarios/{id}","href":"/api-reference/ai-tests/retrieve-an-evaluator-scenario"},{"title":"Update an evaluator scenario","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json patch /ai/tests/test_framework/v1/scenarios/{id}","href":"/api-reference/ai-tests/update-an-evaluator-scenario"},{"title":"Generate evaluator scenarios","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json post /ai/tests/test_framework/v1/scenarios/generate-bg","href":"/api-reference/ai-tests/generate-evaluator-scenarios"},{"title":"Get scenario generation progress","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json get /ai/tests/test_framework/v1/scenarios/generate-progress","href":"/api-reference/ai-tests/get-scenario-generation-progress"},{"title":"Run evaluator scenarios","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json post /ai/tests/test_framework/v1/scenarios/run_scenarios","href":"/api-reference/ai-tests/run-evaluator-scenarios"},{"title":"Get improve-scenarios progress","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json get /ai/tests/test_framework/v1/scenarios/scenario-agent-progress","href":"/api-reference/ai-tests/get-improve-scenarios-progress"},{"title":"Improve evaluator scenarios","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json post /ai/tests/test_framework/v1/scenarios/scenario-agent","href":"/api-reference/ai-tests/improve-evaluator-scenarios"},{"title":"Export evaluator scenarios","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json get /ai/tests/test_framework/v1/scenarios/export_scenarios","href":"/api-reference/ai-tests/export-evaluator-scenarios"},{"title":"List test run results","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json get /ai/tests/test_framework/v1/results","href":"/api-reference/ai-tests/list-test-run-results"},{"title":"Delete a test run result","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json delete /ai/tests/test_framework/v1/results/{id}","href":"/api-reference/ai-tests/delete-a-test-run-result"},{"title":"Retrieve a test run result","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json get /ai/tests/test_framework/v1/results/{id}","href":"/api-reference/ai-tests/retrieve-a-test-run-result"},{"title":"Rerun a test run result","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json post /ai/tests/test_framework/v1/results/{id}/rerun","href":"/api-reference/ai-tests/rerun-a-test-run-result"},{"title":"List scheduled test jobs","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json get /ai/tests/schedules/v1/cron-jobs","href":"/api-reference/ai-tests/list-scheduled-test-jobs"},{"title":"Create a scheduled test job","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json post /ai/tests/schedules/v1/cron-jobs","href":"/api-reference/ai-tests/create-a-scheduled-test-job"},{"title":"Delete a scheduled test job","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json delete /ai/tests/schedules/v1/cron-jobs/{id}","href":"/api-reference/ai-tests/delete-a-scheduled-test-job"},{"title":"Retrieve a scheduled test job","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json get /ai/tests/schedules/v1/cron-jobs/{id}","href":"/api-reference/ai-tests/retrieve-a-scheduled-test-job"},{"title":"Update a scheduled test job","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json patch /ai/tests/schedules/v1/cron-jobs/{id}","href":"/api-reference/ai-tests/update-a-scheduled-test-job"}]},{"group":"Conversations API","pages":[{"title":"List conversations","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/conversations","href":"/api-reference/conversations/list-conversations"},{"title":"Create a conversation","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/conversations","href":"/api-reference/conversations/create-a-conversation"},{"title":"Aggregate Conversation Insights","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/conversations/conversation-insights/aggregates","href":"/api-reference/conversations/aggregate-conversation-insights"},{"title":"Get Insight Template Groups","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/conversations/insight-groups","href":"/api-reference/conversations/get-insight-template-groups"},{"title":"Create Insight Template Group","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/conversations/insight-groups","href":"/api-reference/conversations/create-insight-template-group"},{"title":"Delete Insight Template Group","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json delete /ai/conversations/insight-groups/{group_id}","href":"/api-reference/conversations/delete-insight-template-group"},{"title":"Get Insight Template Group","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/conversations/insight-groups/{group_id}","href":"/api-reference/conversations/get-insight-template-group"},{"title":"Update Insight Template Group","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json put /ai/conversations/insight-groups/{group_id}","href":"/api-reference/conversations/update-insight-template-group"},{"title":"Assign Insight Template To Group","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/conversations/insight-groups/{group_id}/insights/{insight_id}/assign","href":"/api-reference/conversations/assign-insight-template-to-group"},{"title":"Unassign Insight Template From Group","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json delete /ai/conversations/insight-groups/{group_id}/insights/{insight_id}/unassign","href":"/api-reference/conversations/unassign-insight-template-from-group"},{"title":"Get Insight Templates","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/conversations/insights","href":"/api-reference/conversations/get-insight-templates"},{"title":"Create Insight Template","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/conversations/insights","href":"/api-reference/conversations/create-insight-template"},{"title":"Delete Insight Template","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json delete /ai/conversations/insights/{insight_id}","href":"/api-reference/conversations/delete-insight-template"},{"title":"Get Insight Template","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/conversations/insights/{insight_id}","href":"/api-reference/conversations/get-insight-template"},{"title":"Update Insight Template","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json put /ai/conversations/insights/{insight_id}","href":"/api-reference/conversations/update-insight-template"},{"title":"Delete a conversation","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json delete /ai/conversations/{conversation_id}","href":"/api-reference/conversations/delete-a-conversation"},{"title":"Get a conversation","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/conversations/{conversation_id}","href":"/api-reference/conversations/get-a-conversation"},{"title":"Update conversation metadata","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json put /ai/conversations/{conversation_id}","href":"/api-reference/conversations/update-conversation-metadata"},{"title":"Get insights for a conversation","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/conversations/{conversation_id}/conversations-insights","href":"/api-reference/conversations/get-insights-for-a-conversation"},{"title":"Delete a conversation's insight generation results","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json delete /ai/conversations/{conversation_id}/conversations-insights/{insight_id}","href":"/api-reference/conversations/delete-a-conversations-insight-generation-results"},{"title":"Create Message","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/conversations/{conversation_id}/message","href":"/api-reference/conversations/create-message"},{"title":"Get conversation messages","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/conversations/{conversation_id}/messages","href":"/api-reference/conversations/get-conversation-messages"}]},{"group":"For AI Agents","pages":[{"title":"Assistants llms.txt","sidebarTitle":"Assistants llms txt","href":"/docs/development/llms/ai-assistants-llms-txt/index"},{"title":"Assistants llms-full.txt","sidebarTitle":"Assistants llms full txt","href":"/docs/development/llms/ai-assistants-llms-full-txt/index"}]}]},{"tab":"LiveKit on Telnyx (Beta)","icon":"waveform-lines","pages":[{"title":"LiveKit on Telnyx (Beta)","href":"/docs/livekit"}]},{"tab":"Web Search","icon":"globe","pages":[{"title":"Web Search","href":"/docs/web-search"}]},{"tab":"AI Search","icon":"magnifying-glass","pages":[{"title":"AI Search","href":"/docs/ai-search"}]},{"tab":"Meeting","icon":"video","pages":[{"title":"Meeting","href":"/docs/meeting"}]}]},{"product":"Voice","icon":"waveform","pages":[{"title":"Voice","href":"/docs/voice/overview"}]},{"product":"Compute","icon":"server","pages":[{"title":"Compute","href":"/docs/edge-compute/platform-overview"}]},{"product":"Storage","icon":"hard-drive","pages":[{"title":"Storage","href":"/docs/cloud-storage/overview"}]},{"product":"Virtual Private Cloud","icon":"cloud","pages":[{"title":"Virtual Private Cloud","href":"/docs/virtual-private-cloud"}]},{"product":"Calling","icon":"phone","pages":[{"title":"Calling","href":"/docs/voice/programmable-voice/voice-api-fundamentals"}]},{"product":"Messaging","icon":"message","pages":[{"title":"Messaging","href":"/docs/messaging/messages/send-message"}]},{"product":"Numbers","icon":"hashtag","pages":[{"title":"Numbers","href":"/docs/numbers/phone-numbers/getting-started"}]},{"product":"Wireless","icon":"broadcast-tower","pages":[{"title":"Wireless","href":"/docs/iot-sim/wireless-overview"}]}]},"basePath":"","title":"Update a custom avatar - Telnyx","buildId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","deploymentId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","dynamics":["10e4515597","c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["BannerMarkdown-DIeMibn4.js","dist-DJnKvr0g.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","clsx-B2v50t8t.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-C8RPHPxo.js","utils-0BK-9q6z.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DfjzsUJT.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B4v9psJ4.js","snippetPresets-CpTQv-Ez.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-Buji1S4J.js","ApiExamples-BNP-Fvr0.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BSgu6h1D.js","shallow-Biv1i9Gs.js","getApiPlaygroundDisplay-BoGOXhtF.js","CodeSnippet-DvQoT18_.js","CodeSnippets-Dnpa15xT.js","getPastedJson-xAIyhUFE.js","icon-S6FBih11.js","MethodPill-SaYeUZyk.js","DuplicateIcon-Cs-p3v2Q.js","createIcon-DjCFEoHq.js","DynamicMarkdown-BcnBltEQ.js","SectionHeading-BUBl0eEF.js","axios-vUo_bRtp.js","Markdown-h4cOoD8d.js","AssistantPageLink-BHrrjR1K.js"]}