Desktop
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
GET | |
POST | |
GET | |
PATCH | |
DELETE | |
POST |
List all environments desktop recordings
Required API key scopes
desktop_recording:readPath parameters
- project_idstring
Query parameters
- limitinteger
- offsetinteger
Response
Example request
GET /api /environments /:project_id /desktop_recordingsExample response
Status 200
RESPONSE
Create environments desktop recordings
Create a new recording and get Recall.ai upload token for the desktop SDK
Required API key scopes
desktop_recording:writePath parameters
- project_idstring
Request parameters
- platformDefault:
desktop_audio
Response
Example request
POST /api /environments /:project_id /desktop_recordingsExample response
Status 201
RESPONSE
Retrieve environments desktop recordings
Required API key scopes
desktop_recording:readPath parameters
- idstring
- project_idstring
Response
Example request
GET /api /environments /:project_id /desktop_recordings /:idExample response
Status 200
RESPONSE
Update environments desktop recordings
Required API key scopes
desktop_recording:writePath parameters
- idstring
- project_idstring
Request parameters
- recall_recording_idstring
- platform
- meeting_titlestring
- meeting_urlstring
- duration_secondsinteger
- status
- notesstring
- error_messagestring
- video_urlstring
- video_size_bytesinteger
- participantsarray
- transcript_segmentsarray
- summarystring
- extracted_tasksarray
- tasks_generated_atstring
- summary_generated_atstring
- started_atstring
- completed_atstring
Response
Example request
PATCH /api /environments /:project_id /desktop_recordings /:idExample response
Status 200
RESPONSE
Delete environments desktop recordings
Required API key scopes
desktop_recording:writePath parameters
- idstring
- project_idstring
Example request
DELETE /api /environments /:project_id /desktop_recordings /:idExample response
Status 204 No response body
Create environments desktop recordings append segments
Append transcript segments (supports batched real-time streaming)
Required API key scopes
desktop_recording:writePath parameters
- idstring
- project_idstring
Request parameters
- segmentsarray
Response
Example request
POST /api /environments /:project_id /desktop_recordings /:id /append_segmentsExample response
Status 200
RESPONSE