/recordings

Get recordings

get

Returns the recordings.

Query parameters

roomNamestringoptional

The name of the room

cursorstringoptional

The cursor for paginating through the results. To fetch the next page, set the cursor to the cursor returned by the previous request.

Example: 8f4031bfc7640c5f267b11b6fe0c2507

limitinteger · min: 1 · max: 100 · default: 50optional

The limit for the pagination - the maximum number of results that will be returned within a single API response.

sortByanyoptional

Sort results by a field. Accepted fields are: roomName, startDate, duration and sizeInMegaBytes. Accepted sort values are 'asc' and 'desc'.

Example: roomName:asc

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.whereby.dev/v1/recordings'

200

401

404

429

200

{
  "results": [
    {
      "recordingId": "a56f6ad7-37fe-4a37-9319-3174630ba57a",
      "roomSessionId": "e2f29530-46ec-4cee-8b27-e565cb5bb2e9",
      "filename": "recording.mp4",
      "startDate": "2025-01-01T00:00:00.000Z",
      "endDate": "2025-01-01T00:00:00.000Z",
      "sizeInMegaBytes": 100
    }
  ],
  "cursor": "text"
}

A JSON object with the page containing the array with the recordings results.

Get recording

get

Returns the specified recording metadata.

Path parameters

recordingIdstringrequired

Recording ID.

Example: a56f6ad7-37fe-4a37-9319-3174630ba57a

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.whereby.dev/v1/recordings/{recordingId}'

200

401

404

429

200

{
  "recordingId": "a56f6ad7-37fe-4a37-9319-3174630ba57a",
  "roomSessionId": "e2f29530-46ec-4cee-8b27-e565cb5bb2e9",
  "filename": "recording.mp4",
  "startDate": "2025-01-01T00:00:00.000Z",
  "endDate": "2025-01-01T00:00:00.000Z",
  "sizeInMegaBytes": 100
}

A JSON object representing the recording.

Get recording access link

get

Returns the access link for the specified recording. Available for Whereby-hosted recordings only

Path parameters

recordingIdstringrequired

Recording ID.

Example: a56f6ad7-37fe-4a37-9319-3174630ba57a

Query parameters

validForSecondsinteger · min: 1 · max: 43200 · default: 3600optional

The number of seconds the access link is valid for.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.whereby.dev/v1/recordings/{recordingId}/access-link'

200

401

403

404

429

200

{
  "accessLink": "https://s3.eu-central-1.amazonaws.com/recordings/1.mp4?AWSAccessKeyId=AKIAJ...",
  "expires": 1740819600000
}

A JSON object representing the access link.

Bulk delete recordings

post

Deletes multiple recordings at once. This is an asynchronous operation. The endpoint returns immediately, and schedules a background job to delete the recordings. The endpoint is idempotent, meaning it will return the same response even if the recordings have already been deleted, or the recordings doesn't exist.

Body

recordingIdsstring[]required

The recording ID to delete.

Example: a56f6ad7-37fe-4a37-9319-3174630ba57a

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.whereby.dev/v1/recordings/bulk-delete' \
  --header 'Content-Type: application/json' \
  --data '{
    "recordingIds": [
      "a56f6ad7-37fe-4a37-9319-3174630ba57a"
    ]
  }'

204

401

429

204

No body

The resources are scheduled for deletion.

Delete recording

delete

Deletes the specified recording. The endpoint is idempotent, meaning it will return the same response even if the recording has already been deleted.

Path parameters

recordingIdstringrequired

Recording ID.

Example: a56f6ad7-37fe-4a37-9319-3174630ba57a

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.whereby.dev/v1/recordings/{recordingId}'

204

401

429

204

No body

The resource was deleted successfully.