Rooms

Start recording the room mix to a WAV file

Records the full room mix at 16kHz, 16-bit, mono.

post/rooms/{id}/record

Request body

storage'file' | 's3' | 'gcs' required

"file" (default) — local disk, "s3" — upload to S3 after recording stops, "gcs" — upload to Google Cloud Storage via the native GCS API (Application Default Credentials / Workload Identity)

multi_channelboolean required

When true, record each participant to a separate mono WAV file in addition to the full mix. Only applies to room recordings.

s3_bucketstring required

S3 bucket name. Overrides S3_BUCKET env var. Required if env var is not set.

s3_regionstring required

AWS region. Overrides S3_REGION env var. Default us-east-1.

s3_endpointstring required

Custom S3 endpoint (MinIO, etc.). Overrides S3_ENDPOINT env var.

s3_prefixstring required

Key prefix (e.g. recordings/). Overrides S3_PREFIX env var.

s3_access_keystring required

AWS access key ID. Overrides default credential chain.

s3_secret_keystring required

AWS secret access key. Must be set together with s3_access_key.

gcs_bucketstring required

GCS bucket name. Overrides GCS_BUCKET env var. Required if env var is not set when storage=gcs.

gcs_object_name_prefixstring required

Object name prefix (e.g. recordings or recordings/). Overrides GCS_OBJECT_NAME_PREFIX env var. A trailing slash is added automatically when missing.

filenamestring required

Optional output basename for the WAV file. A .wav suffix is added when missing. Must be a single path segment (no directories). Dots inside the name are preserved (only a trailing .wav is treated as the extension). Rejected with 409 if the file already exists or another recording is using the same name. When omitted, a timestamped name is generated.

Response

Recording started

instance_idstring

Instance identifier

statusstring required

Changes

Changed in 6 of the 67 revisions of this API.11111

Aug 3, 2026955190a7fb6d1See the full diff
- ▲
  added the new required request property filename
  new-required-request-property
Jul 29, 202673b13634e11f21See the full diff
- ▲
  added the new required request property gcs_bucket
  new-required-request-property
- ▲
  added the new required request property gcs_object_name_prefix
  new-required-request-property
- ○
  added the new gcs enum value to the request property storage
  request-property-enum-value-added
Mar 31, 202670d3addada941See the full diff
- ○
  the request property multi_channel with a default value became required
  request-property-became-required-with-default
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 26, 20268d385fec9a6f1See the full diff
- ○
  added the new optional request property multi_channel
  new-optional-request-property
Mar 26, 2026d09c97c6ca8c18See the full diff
- ●
  removed the request property multi_channel
  request-property-removed
- ○
  the request property s3_access_key became optional
  request-property-became-optional
- ○
  the request property s3_bucket became optional
  request-property-became-optional
- ○
  the request property s3_endpoint became optional
  request-property-became-optional
- ○
  the request property s3_prefix became optional
  request-property-became-optional
- ○
  the request property s3_region became optional
  request-property-became-optional
- ○
  the request property s3_secret_key became optional
  request-property-became-optional
- ○
  the request property storage became optional
  request-property-became-optional
- ○
  added the required property file to the response with the 200 status
  response-required-property-added
This revision also has 40 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 26, 2026818619c99a1d8See the full diff
- ▲
  the request property s3_access_key became required
  request-property-became-required
- ▲
  the request property s3_bucket became required
  request-property-became-required
- ▲
  the request property s3_endpoint became required
  request-property-became-required
- ▲
  the request property s3_prefix became required
  request-property-became-required
- ▲
  the request property s3_region became required
  request-property-became-required
- ▲
  the request property s3_secret_key became required
  request-property-became-required
- ▲
  the request property storage became required
  request-property-became-required
- ▲
  removed the required property file from the response with the 200 status
  response-required-property-removed
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history