> ## Documentation Index > Fetch the complete documentation index at: https://docs.orbit.devotel.io/llms.txt > Use this file to discover all available pages before exploring further. # Register an avatar-agent persona > Register a new AI video-avatar-agent persona for the calling tenant, binding an existing conversational agent to a rendered-avatar provider and display config. Owner/admin/developer only; scoped on video:write. Persona names must be unique within the tenant (case-insensitive) and the registry is capped per tenant. ## OpenAPI ````yaml /openapi.yaml post /api/v1/video/avatar-agents openapi: 3.1.0 info: title: Devotel CPaaS API description: Orbit by Devotel — Communications Platform as a Service API version: 1.0.0 contact: name: Devotel url: https://devotel.io email: support@devotel.io license: name: Proprietary servers: - url: https://api.orbit.devotel.io description: Production security: - Bearer: [] - ApiKey: [] tags: - name: Messages description: >- Send and manage messages across all channels (SMS, WhatsApp, RCS, Email, Viber, etc.) - name: Fax description: >- List and track fax (MMS/T.38) transmissions on Telnyx-backed fax numbers (sending flows through the Messaging API) - name: Agents description: AI agent creation, configuration, and execution - name: Voice description: Voice calls, IVR, conferencing, and SIP trunking - name: OnCall description: On-call rotations and escalation policy planning for incident alerting - name: Webhooks description: Webhook endpoint management and delivery logs - name: Numbers description: Phone number search, provisioning, and configuration - name: Brand Identity description: >- Unified cross-channel brand trust posture (10DLC, toll-free, WhatsApp, RCS, branded calling, number KYC) - name: Contacts description: Contact management, segmentation, and lifecycle tracking - name: Campaigns description: Marketing campaign orchestration and analytics - name: Flows description: Automation flow builder and execution engine - name: Templates description: Message template management and approval workflows - name: Settings description: Organization, channel, and user preference settings - name: Verify description: OTP generation and verification across channels - name: Push description: Push notification delivery via FCM and APNs - name: Integrations description: Third-party service connections and OAuth management - name: CDP description: >- Customer Data Platform — activation surface (CRM object sync, streaming destinations, ad-audience activation) - name: Files description: >- Server-to-server media upload, listing, retrieval, and deletion (signed-URL backed) - name: Commerce description: >- Omnichannel conversational-commerce — persistent cart + checkout state machine, channel-agnostic hosted pay-by-link, native WhatsApp checkout, and AP2-style agent payment mandates. - name: Sync description: >- Real-time shared-state primitive (Twilio Sync parity) — Documents, Maps, Lists, and ephemeral Streams, with change events relayed over the /api/v1/ws/sync WebSocket gateway paths: /api/v1/video/avatar-agents: post: tags: - Video summary: Register an avatar-agent persona description: >- Register a new AI video-avatar-agent persona for the calling tenant, binding an existing conversational agent to a rendered-avatar provider and display config. Owner/admin/developer only; scoped on video:write. Persona names must be unique within the tenant (case-insensitive) and the registry is capped per tenant. requestBody: required: true content: application/json: schema: type: object required: - name - agent_id - provider - provider_persona_ref properties: name: type: string minLength: 1 maxLength: 80 description: >- Tenant-supplied label rendered in the picker. Unique within the tenant (case-insensitive). agent_id: type: string minLength: 1 maxLength: 64 description: >- The conversational agent that drives the dialog (agt_-prefixed). provider: type: string enum: - tavus - heygen - did description: Rendered-avatar provider this persona uses. provider_persona_ref: type: string minLength: 1 maxLength: 200 description: >- The tenant's own opaque persona/replica reference id at that provider. greeting: type: - string - 'null' maxLength: 500 description: Optional opening line the avatar speaks on join. locale: type: - string - 'null' maxLength: 35 description: Optional BCP-47-ish locale hint for TTS (e.g. en-US). enabled: type: boolean description: >- Whether the persona is dispatchable to rooms. Defaults to true. responses: '201': description: The registered avatar persona. content: application/json: schema: type: object properties: data: type: object properties: avatar_agent: $ref: '#/components/schemas/VideoAvatarAgentPersona' meta: $ref: '#/components/schemas/ResponseMeta' '400': description: >- Invalid field, a duplicate persona name, or the per-tenant persona cap was reached. components: schemas: VideoAvatarAgentPersona: type: object description: >- A registered AI video-avatar-agent ('digital human') persona binding one of the tenant's existing conversational agents (the dialog brain) to a rendered-avatar provider and a display config, so the avatar-runtime can join a self-hosted WebRTC room as a talking-head participant. Stored per tenant; no provider credentials are persisted, only a non-secret provider persona reference. required: - id - name - agent_id - provider - provider_persona_ref - greeting - locale - enabled - created_at - updated_at - created_by additionalProperties: false properties: id: type: string description: The vaa_-prefixed persona id minted on registration. name: type: string maxLength: 80 description: Tenant-supplied label rendered in the persona picker. agent_id: type: string description: >- The bound conversational agent (agt_-prefixed) that supplies dialog turns. provider: type: string enum: - tavus - heygen - did description: Rendered-avatar provider this persona uses. provider_persona_ref: type: string maxLength: 200 description: >- The tenant's own opaque persona/replica reference id at that provider. greeting: type: - string - 'null' maxLength: 500 description: Opening line the avatar speaks on join; null when unset. locale: type: - string - 'null' maxLength: 35 description: BCP-47-ish locale hint for TTS (e.g. en-US); null when unset. enabled: type: boolean description: When false the persona is retained but excluded from room dispatch. created_at: type: string format: date-time description: ISO 8601 creation timestamp. updated_at: type: string format: date-time description: ISO 8601 last-update timestamp. created_by: type: - string - 'null' description: Platform user id of the creating operator; null for API-key callers. ResponseMeta: type: object required: - request_id - timestamp additionalProperties: false properties: request_id: type: string description: Unique request identifier (also returned as X-Request-Id header) timestamp: type: string format: date-time docs_url: type: string format: uri nullable: true securitySchemes: Bearer: type: http scheme: bearer bearerFormat: JWT description: Dashboard JWT token from Clerk ApiKey: type: apiKey name: X-API-Key in: header description: Server-to-server API key (dv_live_sk_*) ````