Skip to main content

​
Endpoint

GET /api/v1/bots/{object_id}

​
Authentication

Requires API key authentication via the Authorization header.
​
Authorization
string
required
Your API key in the format: Token YOUR_API_KEY_HERE
​
Content-Type
string
required
Must be application/json

​
Path Parameters

​
object_id
string
required
The unique identifier for the bot.Example: bot_xxxxxxxxxxx

​
Response

Returns the bot object.
​
id
string
Unique identifier for the bot (e.g., bot_weIAju4OXNZkDTpZ)
​
meeting_url
string
The URL of the meeting the bot joined or will join.
​
state
string
Current state of the bot.Possible values: ready, joining, joined_not_recording, joined_recording, leaving, post_processing, fatal_error, waiting_room, ended, data_deleted, scheduled, staged, joined_recording_paused, joining_breakout_room, leaving_breakout_room, joined_recording_permission_denied
​
events
array
Array of events that have occurred for this bot.
​
type
string
Event type (e.g., join_requested, joined_meeting, leave_requested)
​
sub_type
string | null
Event sub-type with additional context.
​
created_at
string
ISO 8601 timestamp when the event occurred.
​
transcription_state
string
Current transcription state.Possible values: not_started, in_progress, complete
​
recording_state
string
Current recording state.Possible values: not_started, in_progress, complete, paused
​
join_at
string
ISO 8601 timestamp when the bot joined or will join the meeting.
​
deduplication_key
string
Optional deduplication key for the bot.
​
metadata
object
Custom metadata associated with the bot.

​
Example Request

curl -X GET 'https://api.attendee.dev/api/v1/bots/bot_weIAju4OXNZkDTpZ' \
  -H 'Authorization: Token YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json'

​
Example Response

{
  "id": "bot_weIAju4OXNZkDTpZ",
  "meeting_url": "https://zoom.us/j/123?pwd=456",
  "state": "joined_recording",
  "events": [
    {
      "type": "join_requested",
      "sub_type": null,
      "created_at": "2024-01-18T12:34:56Z"
    },
    {
      "type": "joined_meeting",
      "sub_type": null,
      "created_at": "2024-01-18T12:35:00Z"
    }
  ],
  "transcription_state": "in_progress",
  "recording_state": "in_progress",
  "join_at": "2024-01-18T12:34:56Z",
  "deduplication_key": "my-unique-bot-key",
  "metadata": {
    "customer_id": "abc123",
    "user": "john_doe"
  }
}

​
Error Codes

  • 200 - Success
  • 401 - Invalid or missing API key
  • 404 - Bot not found

Build docs developers (and LLMs) love

Get started for freeTalk to us