Exports

Multi-export

You can export multiple media at once. We're going to zip the documents and send it to you as an arraybuffer.

Request rules. No field is conditionally required. Some behaviour depends on what you send rather than on validation, so read the field descriptions below.

With fileType set to csv-labels, the ZIP holds one <file name>-labels.csv for each file that has labels, and files without labels are left out. With isMerged set to true it holds one merged_export.csv with the rows of every file. When none of the files has labels, the request returns a JSON body instead of a ZIP, with HTTP status 200, status set to failed and message set to No labels found for these files. Check the response content type before you save it as a ZIP. The columns are the same as for a single export.

A text note in the set is skipped rather than failed when fileType is sourceFile, csv-transcript or csv-transcript-sentiment, so the ZIP can hold fewer files than you asked for. The notification Speak AI raises when the export finishes counts the files it actually wrote against the number you requested.

post/media/exportMultiple

Request

  • Base URL: https://api.speakai.co/v1
  • URL: https://api.speakai.co/v1/media/exportMultiple
  • Auth: API key in header x-speakai-key and API key in header x-access-token

Request body

mediaIdsstring[] required

List the IDs of the media files you want to export together. Required. the schema with no.items call, so the server does not validate the item type and applies no maximum array length. Pass an empty array to fall back to exporting a whole folder through folderId.

fileType'csv' | 'csv-insights' | 'csv-labels' | 'csv-transcript' | 'csv-transcript-sentiment' | 'csv-text-sentiment' | 'docx' | 'html' | 'json' | 'md' | 'pdf' | 'sourceFile' | 'srt' | 'ttml' | 'txt' | 'vtt' | 'mp4'

Choose the file format used for every file in the export. Must be one of the accepted values. There is no default, and the schema does not mark it required, but the controller dereferences it unconditionally, so omitting it returns a 500 rather than a validation error. Treat it as required in practice.

isSpeakerNamesboolean

Set to true to print speaker names next to each segment of the transcript.

isSpeakerEmailboolean

Set to true to print speaker email addresses next to each segment of the transcript. Null is accepted. The schema declares a default of false, but the validation middleware discards the schema's converted output, so omitting the property leaves it unset. Unset behaves the same as false.

isTimeStampsboolean

Set to true to print a timestamp on each segment of the transcript.

isInsightVisualizedboolean

Set to true to render insights as charts and visuals in the exported files instead of plain text.

isRedactedboolean

Set to true to redact sensitive content from the exported files.

redactedCategoriesstring[]

List the categories of sensitive content you want redacted when isRedacted is true. the schema with no.items call, so the server does not validate the item type and applies no maximum array length. The server code types the value as string[].

folderIdstring

Give the ID of a folder to export every media file inside it. The server uses this only when mediaIds is empty. An empty string is explicitly allowed. The schema declares a default of empty string, but the validation middleware discards the schema's converted output, so an omitted folderId reaches the controller as undefined rather than as an empty string.

isMergedboolean

Set to true to combine every media file into one document instead of one file per media inside the ZIP. The schema declares a default of false, but that default is not written back to the request, so omitting it leaves it unset. Unset behaves the same as false.

Response

Success

Changes

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