Skip to main content

​
1. Send a agent to the meeting

You can dispatch an agent to a meeting either:
  1. Immediately, provided there are available agents in your pool.
  2. With a reservation, scheduling an agent to join 5 minutes before a meeting.
To send an agent to a meeting, use the following example POST request to http://your-hosted-ip/api/v1/agent/join
Note: The response will include an Agent ID. Be sure to save this ID for use in further steps.
  • Bash
  • JavaScript
  • Python
curl --location 'http://your-hosted-ip/api/v1/agent/join' \
--header 'Authorization: Token YOUR-API-KEY' \
--header 'Content-Type: application/json' \
--data '{
  "meetingUrl": "YOUR-MEETING-URL",
  "agentName": "Agent X",
  "adhoc": false,
  "automaticLeave": {
      "EveryoneLeftTimeout": 2,
      "NoOneJoinedTimeout": 900,
      "WaitingRoomTimeout": 900
  },
  "webhookUrl": "YOUR-WEBHOOK-URL",
  "agentVideoOutput": {
      "base64Data": "/9j/4AAQSkZJRgABAQAAAQABAAD...."
  },
  "transcriptionProvider": {
      "name": "meeting_captions"
  }
}'

​
Breaking It Down:

​
meetingUrl
string
required
Description: The URL of the meeting the agent should join.
Supported Platforms: Google Meet, Microsoft Teams, Zoom.
​
agentName
string
required
Description: The display name for the agent in the meeting. Max Length: 50 characters
​
adhoc
boolean
required
Description: Determines whether to dispatch an agent immediately or reserve it in advance.
  • true: Dispatches an agent immediately from the pool of always-ready agents.
    Note: During high demand, there may be a delay.
  • false: Reserves an agent in advance, ensuring it joins exactly 5 minutes before a scheduled meeting.
    Ideal for planned calendar events to guarantee agent availability.
​
transcriptionProvider
object
Description: Configuration for meeting transcription services.
Optional: YesProperties:
  • name:
    • "meeting_captions": Standard transcription (default, no API key needed)
  • streaming: Object with:
    • websocketUrl: Required WebSocket URL for real-time transcription streaming
​
automaticLeave
object
Description: Controls the agent’s automatic leaving behavior.
Optional: YesProperties:
  • EveryoneLeftTimeout: Time (seconds) to wait after everyone leaves (default: 60)
  • NoOneJoinedTimeout: Time (seconds) to wait if no one joins (default: 900)
  • WaitingRoomTimeout: Time (seconds) in waiting room (default: 900)
  • CallEndTimeout: Time (seconds) to stay in the call before leaving automatically (default: 10800 - 3 hours)
​
webhookUrl
string
Description: URL to receive meeting events and updates.
Optional: Yes Max Length: 200 characters
​
metadata
object
Description: Custom key-value pairs attached to the agent.
Optional: Yes Default: {"additionalKey": "value"}Usage: Useful for custom logic or tracking, as this data can be retrieved later.
​
agentVideoOutput
object
Description: Customize the agent’s video feed during the meeting.
Optional: Yes Requirements:
  • Must provide either url OR base64Data (but not both)
  • The image should be in jpeg format.
  • The image should have a 16:9 aspect ratio
  • Most platforms support resolutions up to 1020x720. Higher-resolution images are automatically scaled down.
Properties:
  • url: URL of the video source
  • base64Data: Base64 encoded image data
​
mediaStreaming
object
Description: Configuration for streaming meeting audio.
Optional: YesProperties:
  • audio: Required object with:
    • outputFormat: One of pcm_16000, pcm_24000, or pcm_48000
    • websocketUrl: Required WebSocket URL for audio streaming
​
chat
object
Description: Configure chat messages the agent will send (Only supported for Zoom & Teams).
Optional: YesProperties:
  • message: Required chat message content
​
recordingSettings
object
Description: Configure meeting recording options.
Optional: YesProperties:
  • mode: Required - "audioOnly" or "fullStream"
  • quality: Optional - "high" or "low"
​
deduplicationKey
string
Description: A unique identifier to prevent duplicate agents from joining the same meeting.
Optional: Yes
Max Length: 50 characters
Default Behavior: Rejects multiple agents in the same meeting to avoid spamming.

​
4. Interact During the Meeting

While the agent is in the meeting, ensure there is meaningful interaction, such as turning on your video or speaking. This ensures the recording contains relevant content.

​
5. End the Meeting

Once you have sufficient content, end the meeting. The agent will leave automatically.