Recorder/Survey

Update Recorder Settings

Update a recorder details.

name - Name of the recorder

All the other fields are optional. Your recorder will be updated automatically.

Duration of the recorder:

  • minDuration - 15 seconds (min) & 5 min (max)
  • Pass the duration in seconds
  • maxDuration - 10 seconds (min) & 3 hours (max)
  • Pass the duration in seconds

Source Language:

  • You can pass the sourceLanguage as a code.
  • Other language codes available at the top of the page.

Recorder options:

  • We allow to support creating recorder with the multiple options such as:
  • audio - Audio recorder
  • video - Video recorder
  • screeShare - Allow to screen share on browser (Mobile not supported)
  • uploadFile - Allow to upload various file formats
  • allowMultiple - Supporting multiple file uploads

Notifications:

upload - Recieve an email notification when anyone uploads a recording on the recorder

client - When your user submits a recording (have the email address in a form) - they will receive an submittion email

Not found:

The lookup is scoped to your own workspace. If no recorder with that recorderId belongs to it, the call returns 404 and nothing is updated.

put/recorder/settings/{recorderId}

Request

  • Base URL: https://api.speakai.co/v1
  • URL: https://api.speakai.co/v1/recorder/settings/{recorderId}
  • Auth: API key in header x-speakai-key and API key in header x-access-token

Path parameters

recorderIdstring required

Request body

namestring required

Set the recorder name. Required on every call, even when you only mean to change something else. An empty or whitespace-only value is rejected. Sending the current name back is how you make a partial update.

descriptionstring

Describe the recorder for your own reference. Optional, empty string allowed. The handler writes this only when the value is truthy, so an empty string leaves the stored description as it was.

isAutoAnalyzeboolean

Analyze each recording automatically as soon as it is submitted. Optional. Leaving it out leaves the stored setting alone. Send false to turn automatic analysis off.

sourceLanguagestring

Set the spoken language Speak transcribes recordings in. Optional. Leaving it out or sending an empty string leaves the stored language alone. Must be one of the transcription language codes the server compiles at start up from the static list (137 entries, including auto and multi). An unrecognized code returns 400 with 'sourceLanguage must be a valid transcription language code'.

folderIdstring

Move new recordings from this recorder into the folder you name here. Optional, empty string allowed. The handler writes the folder only when the value is truthy, so an empty string leaves the current folder alone. A folderId that does not exist in your company returns 400 with 'Folder not found'.

notifyUsersstring[]

List the user IDs that get emailed when a recording arrives. Optional. Each item is a non-empty string. The handler persists this list only when you also send a notification object with at least one of upload or client set, so notifyUsers on its own is accepted and then ignored.

durationobject

Set how long a recording is allowed to run. Optional. Two optional number keys, both in seconds. minDuration accepts 0 to 300, maxDuration accepts 15 to 10800. Each key is written only when it is truthy, so 0 does not overwrite the stored minDuration.

notificationobject

Choose who gets an email when a recording comes in. Optional. Two optional booleans. upload emails the users in notifyUsers when a recording arrives. client emails the respondent a confirmation, and only fires when they gave an email address. Sending this object with at least one key also writes notifyUsers, and any key you leave out is cleared on the stored notification block.

optionsobject

Turn the individual capture and upload modes on or off. Optional. Keys are all optional booleans unless noted: audio, video, screenShare, liveTranscription (also accepts null), and upload, a nested object with file, text, multiple and url. When you send this object the handler replaces the whole stored block, so send every mode you want kept or the ones you leave out are cleared.

metaobject

Brand and customize the recorder page. Optional, and unlike POST /recorder/create every key here takes effect. Strings, each written only when truthy: primaryColor, fontColor, fontFamily, theme, backgroundImg, logo. backgroundImg and logo are normalized from a signed CloudFront URL back to an S3 URI before storage. customCSS is capped at 50000 characters, is run through a CSS sanitizer before it is stored, and is written whenever you send it, so an empty string clears it. Booleans, each written whenever you send it: hideWaveform, hideTitle, hideDescription, hideSubmitButton, countdown, hideImages. submitButtonLabel is a string written only when truthy.

Response

OK

statusstring

Changes

No recorded changes to this operation across all 2 revisions of this API.