> ## Documentation Index
> Fetch the complete documentation index at: https://docs.amongst.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Join Meeting

> Joins a meeting with a customizable agent.



## OpenAPI

````yaml POST /agent/join
openapi: 3.0.1
info:
  title: Meeting Agent API
  description: >-
    API for managing meeting agents, allowing them to join meetings with
    customizable configurations and fetch meeting data.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://your-hosted-ip/api/v1
security:
  - bearerAuth: []
paths:
  /agent/join:
    post:
      description: Joins a meeting with a customizable agent.
      requestBody:
        description: Details of the meeting agent joining the session.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JoinRequest'
        required: true
      responses:
        '200':
          description: Agent successfully joined the meeting
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JoinResponse'
        '400':
          description: Invalid request or missing required parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized access, invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    JoinRequest:
      type: object
      properties:
        meetingUrl:
          type: string
          description: URL of the meeting the agent will join
        agentName:
          type: string
          description: Name of the meeting agent
          maxLength: 50
        adhoc:
          type: boolean
          description: Indicates if the agent should join as an ad-hoc participant
          default: false
        transcriptionProvider:
          type: object
          properties:
            name:
              type: string
              description: Name of transcription provider
              enum:
                - deepgram
                - rev
                - meeting_captions
              default: meeting_captions
            apiKey:
              type: string
              description: API key for transcription provider
            streaming:
              type: object
              properties:
                websocketUrl:
                  type: string
                  description: WebSocket URL for streaming transcription
              required:
                - websocketUrl
          required:
            - name
        automaticLeave:
          type: object
          properties:
            EveryoneLeftTimeout:
              type: integer
              description: >-
                Time (in seconds) to wait before the agent leaves if everyone
                has left
              default: 60
            NoOneJoinedTimeout:
              type: integer
              description: >-
                Time (in seconds) to wait before the agent leaves if no one has
                joined
              default: 900
            WaitingRoomTimeout:
              type: integer
              description: >-
                Time (in seconds) to wait before the agent leaves if waiting in
                the room
              default: 900
        webhookUrl:
          type: string
          description: Webhook URL to send meeting updates
          maxLength: 200
        metadata:
          type: object
          description: Custom metadata that can be included with the request
          additionalProperties: true
          default:
            additionalKey: value
        agentVideoOutput:
          type: object
          description: Video output configuration for the agent
          properties:
            url:
              type: string
              description: URL of the video source
            base64Data:
              type: string
              description: Base64 encoded video data
          oneOf:
            - required:
                - url
            - required:
                - base64Data
        mediaStreaming:
          type: object
          description: Media streaming configuration
          properties:
            audio:
              type: object
              properties:
                outputFormat:
                  type: string
                  enum:
                    - pcm_16000
                    - pcm_24000
                    - pcm_48000
                  description: Audio output format
                websocketUrl:
                  type: string
                  description: WebSocket URL for audio streaming
              required:
                - websocketUrl
          required:
            - audio
        chat:
          type: object
          description: Chat message configuration
          properties:
            message:
              type: string
              description: Chat message to send
          required:
            - message
        recordingSettings:
          type: object
          description: Recording settings configuration
          properties:
            mode:
              type: string
              enum:
                - fullStream
                - audioOnly
              description: Recording mode
            quality:
              type: string
              enum:
                - high
                - low
              description: Recording quality
          required:
            - mode
      required:
        - meetingUrl
        - agentName
        - adhoc
    JoinResponse:
      type: object
      properties:
        agentId:
          type: string
          description: Unique identifier of the agent that joined the meeting
        statusChanges:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
              createdAt:
                type: string
                format: date-time
              sub_code:
                type: string
                nullable: true
        message:
          type: string
          description: Message from the agent
    Error:
      type: object
      properties:
        error:
          type: integer
          description: Error code
        message:
          type: string
          description: Error message
      required:
        - error
        - message
  securitySchemes:
    bearerAuth:
      type: apiKey
      name: Authorization
      in: header
      description: Use the format 'Token <actual token>' for authentication.

````