List of synthesis sessions

Use this endpoint to get list of synthesis sessions. The report covers all synthesis providers (e.g. yandex-grpc-v2, eleven-labs, google, microsoft). Use the optional system parameter to filter by a single provider.
For a reseller account the report also includes the sessions of its subordinate companies. Use the companyId field to tell which company a record belongs to. The price field answers a single question — what the requesting account is charged for that session: records of the account itself carry its own price, while records of a subordinate company carry the reseller price.
The subordinate network is expanded either when companyId is omitted, or when it is set to the caller's own company and withSupervisedCompanies is passed. Requesting another company always returns that company alone and never expands its network. Note that an export to a file pins the request to the caller's own company, so for a file the withSupervisedCompanies parameter is required to get the subordinate companies.
The voice name is resolved from the CIS voices reference book; deleted voices still resolve, so historical records keep their voice name.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer

The company identifier. When omitted, the company of the authenticated user is used.

string
^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\+[0-9]{2}:[0-9]{2}$

The start date (for example, 2018-05-27T21:30:54+00:00). (For get request need encode url)

string
^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\+[0-9]{2}:[0-9]{2}$

The end date (for example, 2018-05-27T21:30:54+00:00). (For get request need encode url)

string

Comma-separated list of a record's fields to be fetched. Available fields: id, sourceId, text, source, system, voiceName, voiceId, length, cached, createdAt, companyId, price.

boolean

Determines whether the zip archive should be returned.

string
enum

Determines the output format. CSV_EXCEL format includes UTF-8 BOM and semicolon delimiter for better Excel compatibility.

Allowed:
string

Base filename (without extension) to be downloaded.

string

Optional synthesis provider filter. When omitted, sessions from all providers are returned.

boolean
Defaults to false

Expand the caller's own downstream reseller network into a report that explicitly requests the caller's own company. Only that case is governed by this flag: with companyId omitted the network is expanded anyway and the flag changes nothing, while a request for another company is never expanded. Defaults to false.

Responses

400

Invalid input parameters

401

User is not authenticated

403

Invalid user permissions

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json