Skip to main content
POST
meetings.bot.record

Authorizations

Authorization
string
header
required

API key: sk_live_…. The approvals routes and GET /v1/members/me also take a member token: an OAuth access token an app gets when its member signs in to Pramaan and allows pramaan:approve (see the approvals guide).

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
meetingUrl
string
required

The join link of a live or about-to-start meeting on Zoom, Google Meet or Microsoft Teams.

Required string length: 1 - 2048
botName
string
default:Meeting Notetaker

The name the recording bot shows to everyone in the meeting. Default: Meeting Notetaker. Keep it clear that the meeting is being recorded.

Required string length: 1 - 100

Response

Job started; poll GET /v1/jobs/{id}

job_id
string
required
status
enum<string>
required
Available options:
running
held_micro
integer
required

The credit set aside for the job (its estimate), micro-USD; 0 when it takes none. Not a price: what the job is charged reads on GET /v1/jobs/{id} once it is settled.