> ## 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. # Compose an avatar-agent join plan > Compose the deterministic dispatch descriptor the avatar-runtime consumes to join the given room as this persona. Read-only: it resolves the persona and composes the join contract; it does not mint the SFU token or call the avatar provider (the runtime does that with its own credentials). A disabled persona returns 409. Scoped on video:read (or video:write as a superset). ## OpenAPI ````yaml /openapi.yaml get /api/v1/video/avatar-agents/{id}/join-plan 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/{id}/join-plan: get: tags: - Video summary: Compose an avatar-agent join plan description: >- Compose the deterministic dispatch descriptor the avatar-runtime consumes to join the given room as this persona. Read-only: it resolves the persona and composes the join contract; it does not mint the SFU token or call the avatar provider (the runtime does that with its own credentials). A disabled persona returns 409. Scoped on video:read (or video:write as a superset). parameters: - schema: type: string in: path name: id required: true description: The vaa_-prefixed persona id. - schema: type: string minLength: 1 maxLength: 256 in: query name: room required: true description: Name of the WebRTC room the avatar will join. responses: '200': description: The composed join plan. content: application/json: schema: type: object properties: data: type: object properties: join_plan: $ref: '#/components/schemas/VideoAvatarJoinPlan' meta: $ref: '#/components/schemas/ResponseMeta' '400': description: The room query parameter is missing or exceeds 256 characters. '404': description: No avatar persona with that id exists in this tenant. '409': description: The persona is disabled and cannot be dispatched to a room. components: schemas: VideoAvatarJoinPlan: type: object description: >- The deterministic dispatch descriptor the avatar-runtime consumes to join a WebRTC room as a persona. Read-only: composing it does not mint an SFU token or call the provider (the runtime does that with its own credentials). required: - persona_id - agent_id - provider - provider_persona_ref - room - bot_identity - bot_display_name - greeting - locale additionalProperties: false properties: persona_id: type: string description: The vaa_-prefixed id of the persona being dispatched. agent_id: type: string description: The conversational agent that supplies dialog turns. provider: type: string enum: - tavus - heygen - did provider_persona_ref: type: string room: type: string description: Room name the avatar participant will join. bot_identity: type: string description: Deterministic, SFU-safe participant identity for the avatar bot. bot_display_name: type: string description: Display name shown on the avatar's video tile. greeting: type: - string - 'null' locale: type: - string - 'null' 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_*) ````