Skip to main content
POST
/
agent
/
join
cURL
curl --request POST \
  --url https://your-hosted-ip/api/v1/agent/join \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "meetingUrl": "<string>",
  "agentName": "<string>",
  "adhoc": false,
  "transcriptionProvider": {
    "name": "meeting_captions",
    "apiKey": "<string>",
    "streaming": {
      "websocketUrl": "<string>"
    }
  },
  "automaticLeave": {
    "EveryoneLeftTimeout": 60,
    "NoOneJoinedTimeout": 900,
    "WaitingRoomTimeout": 900
  },
  "webhookUrl": "<string>",
  "metadata": {
    "additionalKey": "value"
  },
  "agentVideoOutput": {
    "url": "<string>",
    "base64Data": "<string>"
  },
  "mediaStreaming": {
    "audio": {
      "websocketUrl": "<string>",
      "outputFormat": "pcm_16000"
    }
  },
  "chat": {
    "message": "<string>"
  },
  "recordingSettings": {
    "mode": "fullStream",
    "quality": "high"
  }
}
'
{
  "agentId": "<string>",
  "statusChanges": [
    {
      "code": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "sub_code": "<string>"
    }
  ],
  "message": "<string>"
}

Authorizations

Authorization
string
header
required

Use the format 'Token ' for authentication.

Body

application/json

Details of the meeting agent joining the session.

meetingUrl
string
required

URL of the meeting the agent will join

agentName
string
required

Name of the meeting agent

Maximum string length: 50
adhoc
boolean
default:false
required

Indicates if the agent should join as an ad-hoc participant

transcriptionProvider
object
automaticLeave
object
webhookUrl
string

Webhook URL to send meeting updates

Maximum string length: 200
metadata
object

Custom metadata that can be included with the request

agentVideoOutput
object

Video output configuration for the agent

mediaStreaming
object

Media streaming configuration

chat
object

Chat message configuration

recordingSettings
object

Recording settings configuration

Response

Agent successfully joined the meeting

agentId
string

Unique identifier of the agent that joined the meeting

statusChanges
object[]
message
string

Message from the agent