{
"error": {
"code": "ROOM_INVALID",
"message": "room.type, room.url, and room.token are required; room.type must be livekit or daily",
"details": {}
},
"message": "room.type, room.url, and room.token are required; room.type must be livekit or daily"
}
{
"error": {
"code": "ROOM_INVALID",
"message": "room.type, room.url, and room.token are required; room.type must be livekit or daily",
"details": {}
},
"message": "room.type, room.url, and room.token are required; room.type must be livekit or daily"
}
{
"error": {
"code": "ROOM_INVALID",
"message": "room.type, room.url, and room.token are required; room.type must be livekit or daily",
"details": {}
},
"message": "room.type, room.url, and room.token are required; room.type must be livekit or daily"
}
{
"error": {
"code": "ROOM_INVALID",
"message": "room.type, room.url, and room.token are required; room.type must be livekit or daily",
"details": {}
},
"message": "room.type, room.url, and room.token are required; room.type must be livekit or daily"
}
{
"error": {
"code": "ROOM_INVALID",
"message": "room.type, room.url, and room.token are required; room.type must be livekit or daily",
"details": {}
},
"message": "room.type, room.url, and room.token are required; room.type must be livekit or daily"
}
Returns the avatar record with isOwned. Works for platform defaults and your own uploads; anything else returns AVATAR_NOT_FOUND.
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"FaceMode","description":"FaceMode turns audio into real-time lip-synced talking-head video. Integrate via REST API + WebSocket, or drop a plugin into LiveKit Agents and Pipecat pipelines.","colors":{"primary":"#b25e12","light":"#ffa836","dark":"#ffa836"},"logo":{"light":"https://mintcdn.com/facemode/WsjOTsHfxJ7ZoXG3/logo/facemode-light.svg?fit=max\u0026auto=format\u0026n=WsjOTsHfxJ7ZoXG3\u0026q=85\u0026s=aebadcac7018382241283814a271e202","dark":"https://mintcdn.com/facemode/WsjOTsHfxJ7ZoXG3/logo/facemode-dark.svg?fit=max\u0026auto=format\u0026n=WsjOTsHfxJ7ZoXG3\u0026q=85\u0026s=9ec52e4468d477899d36674e41ef19d0"},"favicon":"https://mintcdn.com/facemode/792sjPb4mjlxR72u/favicon.ico?fit=max\u0026auto=format\u0026n=792sjPb4mjlxR72u\u0026q=85\u0026s=81f1c70d32817459b0a56da947f520b3","api":{"openapi":"openapi/facemode.json","params":{"expanded":"all"},"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["bash","javascript","python"],"prefill":false,"autogenerate":true}},"appearance":{"default":"dark","strict":false},"background":{"decoration":"grid"},"navbar":{"primary":{"type":"button","label":"Go to console","href":"https://console.facemode.io"}},"footer":{"socials":{"x":"https://x.com/facemode_io","github":"https://github.com/facemode-by-infinitylevel","linkedin":"https://linkedin.com/company/infinitylevel"}},"seo":{},"fonts":{"heading":{"family":"Fraunces","weight":500},"body":{"family":"Hanken Grotesk","weight":400}},"icons":{"library":"lucide"},"styling":{"codeblocks":{"theme":{"light":"vitesse-light","dark":"vitesse-dark"}},"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"facemode","hasAudioNarration":false,"actualSubdomain":"facemode","customDomains":["docs.facemode.io"],"gitSource":{"type":"github","owner":"facemode-by-infinitylevel","repo":"facemode-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6ace7b923bfc90d244ae3262","collectionId":"ad231e61-3b36-4344-9360-eaf663d1efa4","liveDeploymentHistoryId":"6ace7b923bfc90d244ae3262","schemaVersion":"v3"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6ace7b923bfc90d244ae3262","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"API Reference","count":27},{"language":"default","tag":"Documentation","count":12},{"language":"default","tag":"Sessions","count":9},{"language":"default","tag":"Avatars","count":7},{"language":"default","tag":"API Keys","count":7},{"language":"default","tag":"Integrations","count":5},{"language":"default","tag":"Concepts","count":4},{"language":"default","tag":"Get Started","count":3}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"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}],"googleFontsInlined":true},"customCss":[{"filePath":"styles.css","content":"@media (min-width:1024px){main#content-container{padding-left:4.5rem;padding-right:4rem}}@media (min-width:1440px){main#content-container{padding-left:6rem;padding-right:6rem}}.edgeLabels .label,g.edgeLabel .label,g.edgeLabel foreignObject div{background-color:#fff!important;border:1px solid #e7e5e4;border-radius:6px;padding:.15rem .55rem}.dark .edgeLabels .label,.dark g.edgeLabel .label,.dark g.edgeLabel foreignObject div{background-color:#3f3f46!important;border-color:#52525b}.edgeLabels foreignObject,g.edgeLabel foreignObject{overflow:visible!important}.edgeLabels p,.edgeLabels span,g.edgeLabel .edgeLabel,g.edgeLabel p,g.edgeLabel span{background:0 0!important;background-color:transparent!important}.edgeLabels rect,g.edgeLabel rect{fill:transparent!important;stroke:none!important}span.absolute.dark\\:hidden.h-\\[64rem\\]{display:none}.mermaid svg,div[class*=mermaid] svg{max-width:100%;height:auto}#topbar-cta-button a,li[id=\"https://console.facemode.io\"] a{display:inline-flex;align-items:center;gap:.45rem}#topbar-cta-button a::before,li[id=\"https://console.facemode.io\"] a::before{content:\"\";width:.9rem;height:.9rem;flex-shrink:0;background-color:currentColor;-webkit-mask-image:url(/icons/layout-dashboard.svg);mask-image:url(/icons/layout-dashboard.svg);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;-webkit-mask-position:center;mask-position:center;-webkit-mask-size:contain;mask-size:contain}"}],"page":{"pagePath":"api-reference/avatars-get","slug":"/api-reference/avatars-get","pageMetadata":{"title":"Get an avatar","description":"GET /api/avatars/{id} - fetch one avatar record visible to your account.","openapi":"openapi/facemode.json GET /avatars/{id}","mode":"wide","href":"/api-reference/avatars-get"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"GET /api/avatars/\", \" - fetch one avatar record visible to your account.\"]\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Returns the avatar record with `,_jsx(_components.code,{children:`isOwned`}),`. Works for platform defaults and your own uploads; anything else returns `,_jsx(_components.code,{children:`AVATAR_NOT_FOUND`}),`.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes vitesse-light vitesse-dark`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#121212`,color:`#393a34`,\"--shiki-dark\":`#dbd7caee`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#59873A`,\"--shiki-dark\":`#80A665`},children:`curl`}),_jsx(_components.span,{style:{color:`#B56959`,\"--shiki-dark\":`#C98A7D`},children:` https://api.facemode.io/api/avatars/6ba7b810-9dad-11d1-80b4-00c04fd430c8`}),_jsx(_components.span,{style:{color:`#A65E2B`,\"--shiki-dark\":`#C99076`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#A65E2B`,\"--shiki-dark\":`#C99076`},children:` -H`}),_jsx(_components.span,{style:{color:`#B5695977`,\"--shiki-dark\":`#C98A7D77`},children:` \"`}),_jsx(_components.span,{style:{color:`#B56959`,\"--shiki-dark\":`#C98A7D`},children:`x-api-key: fm_your_key_here`}),_jsx(_components.span,{style:{color:`#B5695977`,\"--shiki-dark\":`#C98A7D77`},children:`\"`})]}),`\n`]})})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":{"theme":{"light":"vitesse-light","dark":"vitesse-dark"}},"config":{},"pageMetadata":{"title":"Get an avatar","description":"GET /api/avatars/{id} - fetch one avatar record visible to your account.","openapi":"openapi/facemode.json GET /avatars/{id}","mode":"wide","href":"/api-reference/avatars-get"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getAvatar","tags":["Avatars"],"summary":"Get an avatar","description":"GET /api/avatars/{id} - fetch one avatar record visible to your account.","parameters":["3b131682-e1cc-4128-b2ce-ae17be68f98a"],"responses":{"200":"8d6893a0-5bc6-43a5-80c6-ff0785d01661","401":"598531d2-208f-4340-9c62-b948cfa1c761","403":"84e25720-b4e8-40f8-bbc0-eb8c77b7e335","404":"eb2d2b39-0e5b-4602-8038-b78f85b7ec43","429":"f96ee9b6-3b8f-4905-b915-c4f25579d942","500":"020f8b2f-962a-4784-8ecf-5a4c144ee83d"},"method":"get","type":"path","servers":["cdf6bbcb-6a88-4351-9465-58917103889f"],"security":["140cd602-875c-4bfd-8baa-45db5029dd46","a3054b9b-dd84-48f1-ae39-0c9b9598516b"],"path":"/avatars/{id}","baseUrlOptions":["https://api.facemode.io/api"],"title":"Get an avatar","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"3b131682-e1cc-4128-b2ce-ae17be68f98a":{"name":"id","in":"path","required":true,"description":"Avatar ID (UUID).","schema":{"type":"string","format":"uuid","isRequired":true,"description":"Avatar ID (UUID).","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"responses":{"8d6893a0-5bc6-43a5-80c6-ff0785d01661":{"description":"Avatar record.","content":{"application/json":{"schema":{"type":"object","description":"Avatar record with its source image and render readiness.","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"id","typeLabel":"string\u003cuuid>"},"userId":{"oneOf":[{"type":"string","format":"uuid","description":"Owner account ID; null for platform defaults.","uniqueKey":"userId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Owner account ID; null for platform defaults.","uniqueKey":"userId.oneOf.1","typeLabel":"null"}],"uniqueKey":"userId","typeLabel":"string\u003cuuid> | null"},"name":{"type":"string","uniqueKey":"name","typeLabel":"string"},"source":{"type":"string","enum":["DEFAULT","CUSTOM"],"description":"`DEFAULT` for platform avatars, `CUSTOM` for uploads.","uniqueKey":"source","typeLabel":"enum\u003cstring>"},"style":{"oneOf":[{"type":"string","enum":["REALISM","SEMI_REALISM","THREE_D_CARTOON","ANIME_MANGA","FLAT_VECTOR"],"uniqueKey":"style.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["REALISM","SEMI_REALISM","THREE_D_CARTOON","ANIME_MANGA","FLAT_VECTOR"],"uniqueKey":"style.oneOf.1","typeLabel":"null"}],"uniqueKey":"style","typeLabel":"enum\u003cstring> | null"},"image_url":{"oneOf":[{"type":"string","description":"Source image URL used for avatar rendering and downloads.","uniqueKey":"image_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Source image URL used for avatar rendering and downloads.","uniqueKey":"image_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"image_url","typeLabel":"string | null"},"image_version":{"type":"integer","description":"Increments each time the image is replaced.","uniqueKey":"image_version","typeLabel":"integer"},"idle_video_status":{"type":"string","description":"Idle clip render state, for example `PENDING`, `READY`, or `FAILED`.","uniqueKey":"idle_video_status","typeLabel":"string"},"config":{"type":"object","description":"Avatar configuration metadata.","additionalProperties":true,"uniqueKey":"config","typeLabel":"object"},"isActive":{"type":"boolean","description":"Only active avatars can start sessions.","uniqueKey":"isActive","typeLabel":"boolean"},"isOwned":{"type":"boolean","description":"Present on list/get responses: true when the avatar belongs to the caller.","uniqueKey":"isOwned","typeLabel":"boolean"},"createdAt":{"type":"string","format":"date-time","uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","userId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>","source":"DEFAULT","style":"REALISM","image_url":"\u003cstring>","image_version":123,"idle_video_status":"\u003cstring>","config":{},"isActive":true,"isOwned":true,"createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"598531d2-208f-4340-9c62-b948cfa1c761":{"description":"Missing, invalid, or expired API key.","content":{"application/json":{"schema":{"type":"object","description":"Standard error envelope returned for all non-2xx responses.","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code, for example `ROOM_INVALID`.","example":"ROOM_INVALID","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable description.","example":"room.type, room.url, and room.token are required; room.type must be livekit or daily","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"type":"object","description":"Optional structured context. `REQUEST_FIELD_UNKNOWN` includes `details.fields`, a list of rejected field names.","uniqueKey":"error.details.oneOf.0","typeLabel":"object"},{"type":"null","description":"Optional structured context. `REQUEST_FIELD_UNKNOWN` includes `details.fields`, a list of rejected field names.","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"object | null"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"message":{"type":"string","description":"Top-level copy of `error.message`.","example":"room.type, room.url, and room.token are required; room.type must be livekit or daily","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["error","message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"ROOM_INVALID","message":"room.type, room.url, and room.token are required; room.type must be livekit or daily","details":{}},"message":"room.type, room.url, and room.token are required; room.type must be livekit or daily"}}},"exampleType":"generated"}},"exampleType":"generated"},"84e25720-b4e8-40f8-bbc0-eb8c77b7e335":{"description":"Key lacks the `avatars:read` scope.","content":{"application/json":{"schema":{"type":"object","description":"Standard error envelope returned for all non-2xx responses.","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code, for example `ROOM_INVALID`.","example":"ROOM_INVALID","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable description.","example":"room.type, room.url, and room.token are required; room.type must be livekit or daily","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"type":"object","description":"Optional structured context. `REQUEST_FIELD_UNKNOWN` includes `details.fields`, a list of rejected field names.","uniqueKey":"error.details.oneOf.0","typeLabel":"object"},{"type":"null","description":"Optional structured context. `REQUEST_FIELD_UNKNOWN` includes `details.fields`, a list of rejected field names.","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"object | null"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"message":{"type":"string","description":"Top-level copy of `error.message`.","example":"room.type, room.url, and room.token are required; room.type must be livekit or daily","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["error","message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"ROOM_INVALID","message":"room.type, room.url, and room.token are required; room.type must be livekit or daily","details":{}},"message":"room.type, room.url, and room.token are required; room.type must be livekit or daily"}}},"exampleType":"generated"}},"exampleType":"generated"},"eb2d2b39-0e5b-4602-8038-b78f85b7ec43":{"description":"Avatar not found (`AVATAR_NOT_FOUND`).","content":{"application/json":{"schema":{"type":"object","description":"Standard error envelope returned for all non-2xx responses.","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code, for example `ROOM_INVALID`.","example":"ROOM_INVALID","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable description.","example":"room.type, room.url, and room.token are required; room.type must be livekit or daily","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"type":"object","description":"Optional structured context. `REQUEST_FIELD_UNKNOWN` includes `details.fields`, a list of rejected field names.","uniqueKey":"error.details.oneOf.0","typeLabel":"object"},{"type":"null","description":"Optional structured context. `REQUEST_FIELD_UNKNOWN` includes `details.fields`, a list of rejected field names.","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"object | null"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"message":{"type":"string","description":"Top-level copy of `error.message`.","example":"room.type, room.url, and room.token are required; room.type must be livekit or daily","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["error","message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"ROOM_INVALID","message":"room.type, room.url, and room.token are required; room.type must be livekit or daily","details":{}},"message":"room.type, room.url, and room.token are required; room.type must be livekit or daily"}}},"exampleType":"generated"}},"exampleType":"generated"},"f96ee9b6-3b8f-4905-b915-c4f25579d942":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"type":"object","description":"Standard error envelope returned for all non-2xx responses.","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code, for example `ROOM_INVALID`.","example":"ROOM_INVALID","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable description.","example":"room.type, room.url, and room.token are required; room.type must be livekit or daily","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"type":"object","description":"Optional structured context. `REQUEST_FIELD_UNKNOWN` includes `details.fields`, a list of rejected field names.","uniqueKey":"error.details.oneOf.0","typeLabel":"object"},{"type":"null","description":"Optional structured context. `REQUEST_FIELD_UNKNOWN` includes `details.fields`, a list of rejected field names.","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"object | null"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"message":{"type":"string","description":"Top-level copy of `error.message`.","example":"room.type, room.url, and room.token are required; room.type must be livekit or daily","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["error","message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"ROOM_INVALID","message":"room.type, room.url, and room.token are required; room.type must be livekit or daily","details":{}},"message":"room.type, room.url, and room.token are required; room.type must be livekit or daily"}}},"exampleType":"generated"}},"exampleType":"generated"},"020f8b2f-962a-4784-8ecf-5a4c144ee83d":{"description":"Failed to fetch the avatar (`AVATAR_FETCH_FAILED`).","content":{"application/json":{"schema":{"type":"object","description":"Standard error envelope returned for all non-2xx responses.","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code, for example `ROOM_INVALID`.","example":"ROOM_INVALID","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable description.","example":"room.type, room.url, and room.token are required; room.type must be livekit or daily","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"type":"object","description":"Optional structured context. `REQUEST_FIELD_UNKNOWN` includes `details.fields`, a list of rejected field names.","uniqueKey":"error.details.oneOf.0","typeLabel":"object"},{"type":"null","description":"Optional structured context. `REQUEST_FIELD_UNKNOWN` includes `details.fields`, a list of rejected field names.","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"object | null"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"},"message":{"type":"string","description":"Top-level copy of `error.message`.","example":"room.type, room.url, and room.token are required; room.type must be livekit or daily","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["error","message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"ROOM_INVALID","message":"room.type, room.url, and room.token are required; room.type must be livekit or daily","details":{}},"message":"room.type, room.url, and room.token are required; room.type must be livekit or daily"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"140cd602-875c-4bfd-8baa-45db5029dd46":{"ApiKeyHeader":{"type":"apiKey","in":"header","name":"x-api-key","description":"FaceMode API key (`fm_...`).","scopes":[],"schemeName":"ApiKeyHeader"}},"a3054b9b-dd84-48f1-ae39-0c9b9598516b":{"BearerAuth":{"type":"http","scheme":"bearer","description":"FaceMode API key sent as `Authorization: Bearer fm_...` (`ApiKey` and `Api-Key` schemes are also accepted).","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"cdf6bbcb-6a88-4351-9465-58917103889f":{"url":"https://api.facemode.io/api","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","description":"FaceMode API key (`fm_...`).","scopes":[],"schemeName":"ApiKeyHeader"},"schema":{"title":"x-api-key","type":"string","description":"FaceMode API key (`fm_...`).","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyHeader","name":"x-api-key"}],"title":"ApiKeyHeader"},{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"FaceMode API key sent as `Authorization: Bearer fm_...` (`ApiKey` and `Api-Key` schemes are also accepted).","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"FaceMode API key sent as `Authorization: Bearer fm_...` (`ApiKey` and `Api-Key` schemes are also accepted).","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"openapi/facemode.json"},"subdomain":"facemode","siteName":"FaceMode","title":"Get an avatar - FaceMode","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-28T17:41:52.924Z","originalFileLocation":"api-reference/avatars-get.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=\"dark\"}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=\"GET /api/avatars/{id} - fetch one avatar record visible to your account.\">\u003cmeta data-mint-head name=\"application-name\" content=\"FaceMode\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/facemode/RtrBFiouIOwxhLkf/_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/facemode/RtrBFiouIOwxhLkf/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/facemode/RtrBFiouIOwxhLkf/_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/facemode/RtrBFiouIOwxhLkf/_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/facemode/RtrBFiouIOwxhLkf/_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/facemode/RtrBFiouIOwxhLkf/_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/facemode/RtrBFiouIOwxhLkf/_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/facemode/RtrBFiouIOwxhLkf/_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/facemode/RtrBFiouIOwxhLkf/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get an avatar - FaceMode\">\u003cmeta data-mint-head property=\"og:description\" content=\"GET /api/avatars/{id} - fetch one avatar record visible to your account.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"FaceMode\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.facemode.io/api-reference/avatars-get\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://facemode.mintlify.app/_mintlify/api/og/v2?division=Avatars\u0026amp;title=Get+an+avatar\u0026amp;description=GET+%2Fapi%2Favatars%2F%7Bid%7D+-+fetch+one+avatar+record+visible+to+your+account.\u0026amp;theme=9e972256ff824657d65b23ef\u0026amp;signature=a5cdb18804edfad31b1f19133e508deec9e7e925466eed531298ad16504ba5fa\">\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=\"Get an avatar - FaceMode\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"GET /api/avatars/{id} - fetch one avatar record visible to your account.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://facemode.mintlify.app/_mintlify/api/og/v2?division=Avatars\u0026amp;title=Get+an+avatar\u0026amp;description=GET+%2Fapi%2Favatars%2F%7Bid%7D+-+fetch+one+avatar+record+visible+to+your+account.\u0026amp;theme=9e972256ff824657d65b23ef\u0026amp;signature=a5cdb18804edfad31b1f19133e508deec9e7e925466eed531298ad16504ba5fa\">\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/facemode/RtrBFiouIOwxhLkf/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"FaceMode\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#b25e12\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.facemode.io/api-reference/avatars-get\">\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-get.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.facemode.io/#organization\",\"name\":\"FaceMode\",\"url\":\"https://docs.facemode.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/facemode/WsjOTsHfxJ7ZoXG3/logo/facemode-light.svg?fit=max\u0026auto=format\u0026n=WsjOTsHfxJ7ZoXG3\u0026q=85\u0026s=aebadcac7018382241283814a271e202\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.facemode.io#website\",\"name\":\"FaceMode\",\"url\":\"https://docs.facemode.io\",\"publisher\":{\"@id\":\"https://docs.facemode.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.facemode.io/api-reference/avatars-get#webpage\",\"url\":\"https://docs.facemode.io/api-reference/avatars-get\",\"name\":\"Get an avatar\",\"description\":\"GET /api/avatars/{id} - fetch one avatar record visible to your account.\",\"dateModified\":\"2026-09-28T17:41:52.924Z\",\"isPartOf\":{\"@id\":\"https://docs.facemode.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.facemode.io/api-reference/avatars-get#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.facemode.io/api-reference/avatars-get#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Avatars\",\"item\":\"https://docs.facemode.io/api-reference/avatars\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get an avatar\",\"item\":\"https://docs.facemode.io/api-reference/avatars-get\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.facemode.io/api-reference/avatars-get#apireference\",\"headline\":\"Get an avatar\",\"name\":\"Get an avatar\",\"description\":\"GET /api/avatars/{id} - fetch one avatar record visible to your account.\",\"url\":\"https://docs.facemode.io/api-reference/avatars-get\",\"mainEntityOfPage\":{\"@id\":\"https://docs.facemode.io/api-reference/avatars-get#webpage\"},\"dateModified\":\"2026-09-28T17:41:52.924Z\",\"publisher\":{\"@id\":\"https://docs.facemode.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.facemode.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"FaceMode\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"FaceMode","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Reference","pages":[{"title":"API overview","mode":"wide","href":"/api-reference/overview"},{"title":"WebSocket protocol","mode":"wide","href":"/api-reference/websocket-protocol"}]},{"group":"Sessions","pages":[{"title":"Sessions","mode":"wide","href":"/api-reference/sessions"},{"title":"Create a session","openapi":"openapi/facemode.json POST /sessions","mode":"wide","href":"/api-reference/sessions-create"},{"title":"List sessions","openapi":"openapi/facemode.json GET /sessions","mode":"wide","href":"/api-reference/sessions-list"},{"title":"Get session status","openapi":"openapi/facemode.json GET /sessions/{id}","mode":"wide","href":"/api-reference/sessions-get"},{"title":"Reconnect a session","openapi":"openapi/facemode.json POST /sessions/{id}/reconnect","mode":"wide","href":"/api-reference/sessions-reconnect"},{"title":"Heartbeat a session","openapi":"openapi/facemode.json POST /sessions/{id}/heartbeat","mode":"wide","href":"/api-reference/sessions-heartbeat"},{"title":"End a session","openapi":"openapi/facemode.json POST /sessions/{id}/end","mode":"wide","href":"/api-reference/sessions-end"},{"title":"Delete a session","openapi":"openapi/facemode.json DELETE /sessions/{id}","mode":"wide","href":"/api-reference/sessions-delete"},{"title":"Delete all sessions","openapi":"openapi/facemode.json DELETE /sessions","mode":"wide","href":"/api-reference/sessions-delete-all"}]},{"group":"Avatars","pages":[{"title":"Avatars","mode":"wide","href":"/api-reference/avatars"},{"title":"List avatars","openapi":"openapi/facemode.json GET /avatars","mode":"wide","href":"/api-reference/avatars-list"},{"title":"Create an avatar","description":"POST /api/avatars - upload a source image (multipart, max 5 MB) or reference image_url to create a custom avatar.","openapi":"openapi/facemode.json POST /avatars","mode":"wide","href":"/api-reference/avatars-create"},{"title":"Get an avatar","openapi":"openapi/facemode.json GET /avatars/{id}","mode":"wide","href":"/api-reference/avatars-get"},{"title":"Download avatar image","description":"GET /api/avatars/{id}/download - stream the source image of an owned custom avatar as JPEG.","openapi":"openapi/facemode.json GET /avatars/{id}/download","mode":"wide","href":"/api-reference/avatars-download"},{"title":"Update an avatar","openapi":"openapi/facemode.json PUT /avatars/{id}","mode":"wide","href":"/api-reference/avatars-update"},{"title":"Delete an avatar","openapi":"openapi/facemode.json DELETE /avatars/{id}","mode":"wide","href":"/api-reference/avatars-delete"}]},{"group":"API Keys","pages":[{"title":"API keys","mode":"wide","href":"/api-reference/keys"},{"title":"List API keys","openapi":"openapi/facemode.json GET /keys","mode":"wide","href":"/api-reference/keys-list"},{"title":"Create an API key","openapi":"openapi/facemode.json POST /keys","mode":"wide","href":"/api-reference/keys-create"},{"title":"Get an API key","openapi":"openapi/facemode.json GET /keys/{id}","mode":"wide","href":"/api-reference/keys-get"},{"title":"Update an API key","openapi":"openapi/facemode.json PATCH /keys/{id}","mode":"wide","href":"/api-reference/keys-update"},{"title":"Revoke an API key","openapi":"openapi/facemode.json PATCH /keys/{id}/revoke","mode":"wide","href":"/api-reference/keys-revoke"},{"title":"Delete an API key","openapi":"openapi/facemode.json DELETE /keys/{id}","mode":"wide","href":"/api-reference/keys-delete"}]}]}]},"basePath":"","title":"Get an avatar - FaceMode","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-m07pfKpT.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}