Batches

The batches endpoints allow you to view, create and manage Batches in the workspace associated with your client credentials.

Get Batches

Returns a list of batches associated with a specific project. The projectId must be included in the request URL.

Method: GET

Endpoint: https://api.revoiceit.com/projects/{projectId}/batches

Response:

[
  {
    "id": string,
    "projectId": string,
    "name": string,
    "status": string,
    "message": string,
    "completionPercentage": number,
    "translations": [
      {
        "languageId": string,
        "isCompleted": boolean,
        "status": string
      },
    ],
    "isCastingCompleted": boolean,
    "createdAt": ISOString,
    "updatedAt": ISOString
  }
]

Returned HTTP Codes

Http Code	Description
200	Success
404	Project not found
500	Internal server error

Get Batch by ID

Returns a batch corresponding to the batchId specified in the request URL.

Method: GET

Endpoint: https://api.revoiceit.com/batches/{batchId}

Response:

{
  "id": string,
  "projectId": string,
  "name": string,
  "status": string,
  "message": string,
  "completionPercentage": number,
  "translations": [
    {
      "languageId": string,
      "isCompleted": boolean,
      "status": string
    },
  ],
  "isCastingCompleted": boolean,
  "createdAt": ISOString,
  "updatedAt": ISOString
}

Returned HTTP Codes

Http Code	Description
200	Success
404	Batch not found
500	Internal server error

Create Batch

Creates a batch within the specified project in the workspace associated with the provided credentials.

Audio Production batch template script: production_batch_request_template.xlsx

Line Dubbing batch template script: dubbing_batch_request_template.xlsx

Method: POST

Endpoint: https://api.revoiceit.com/projects/{projectId}/batches

Request:

{
  // Required Parameters:

  "name" : string
  "scriptPath": string
  "videoPath" : string
  "languageCode": string

  // Optional Parameters:

  "settings" : {
    "automaticInference": boolean
    "noOfAlternativeTakes": number
    "autoCasting": boolean
    "removeBackgroud": boolean
    "automaticSpeakerDetection": boolean
    "noOfSpeakers": number
    "sourceSpeakerSeparator": string
    "importText": boolean
    "importTiming": boolean
    "importCharacters": boolean
  }
}

Request Fields:

Field	Type	Description	Required
name	string	The name assigned to the batch. Used to identify and manage the batch within the project.	Required
scriptPath	string	A URL to download the source script for the batch. Optional only for Media-Dubbing projects. For Line-Dubbing batches, the Source_Audio column in the script must include either a source audio URL or a media gallery path (obtained from the Get Media Files endpoint) for each line.	Required
videoPath	string	A URL to download the source video for the batch. This can be a direct URL or a media gallery path (e.g., "files/video/myFile.mp4") obtained from the Get Media Files endpoint. Required for Media-Dubbing projects, optional for Audio-Production, and not applicable for Line-Dubbing projects.	Required
languageCode	string	Specifies the target language for the script. Required for .docx, .txt, .pdf, or .srt files. Not required for .xlsx files, as the language is expected to be defined within the file.	Required
settings	object	Contains some configuration parameters for batch creation.	Optional
automaticInference	boolean	Determines whether inference should start automatically after the batch is created. Default: true.	Optional
noOfAlternativeTakes	number	A number between 0 and 2 that specifies how many alternative takes to generate for each line. Default: 0.	Optional
autoCasting	boolean	Enables automatic voice casting immediately after batch creation. Available only for Media-Dubbing and Line-Dubbing batches. Default: true.	Optional
removeBackgroud	boolean	Removes background music and effects from the source media. Available only for Media-Dubbing batches. Default: true.	Optional
automaticSpeakerDetection	boolean	Automatically detects speakers in the source media. Available only for Media-Dubbing batches. Default: true.	Optional
noOfSpeakers	number	Specifies the number of speakers in the source media when automaticSpeakerDetection is set to false. Available only for Media-Dubbing batches.	Optional
sourceSpeakerSeparator	string	Defines the speaker separator used in script files with the .srt format. Available only for Audio Production and Media-Dubbing batches.	Optional
importText	boolean	Imports source text from the input script instead of extracting it directly from the media. Available only for Media-Dubbing batches. Default: false.	Optional
importTiming	boolean	Imports source timing from the input script rather than extracting it directly from the media. Available only for Media-Dubbing batches. Default: false.	Optional
importCharacters	boolean	Imports characters from the input script instead of extracting them directly from the media. Available only for Media-Dubbing batches. Default: false.	Optional

Response:

{
  "id": string,
  "projectId": string,
  "name": string,
  "status": string,
  "completionPercentage": number,
  "translations": [
    {
      "languageId": string,
      "type": string,
      "isCompleted": boolean,
      "status": string
    }
  ],
  "isCastingCompleted": boolean,
  "createdAt": ISOString,
  "updatedAt": ISOString
}

Returned HTTP Codes

Http Code	Description
201	Created successfully
400	Invalid input
500	Internal server error

Delete Batch

Deletes the batches specified in the request body using their batchId values.

Method: POST

Endpoint: https://api.revoiceit.com/batches/delete

Request:

{
  // Required Parameters:

  "batchIds" : array<string>
}

Request Fields:

Field	Type	Description	Required
batchIds	array<string>	An array batch ids to be deleted.	Required

Returned HTTP Codes

Http Code	Description
204	Batches deleted successfully
400	Invalid input
500	Internal server error

Create Batch in bulk

Creates a batch request to process multiple batches in parallel in specified project in the workspace associated with the credentials used. Input contains template script path where batch_name, video_path, and script_path are defined for each batch.

Template script: bulk_batch_request_template.xlsx

Method: POST

Endpoint: https://api.revoiceit.com/projects/{projectId}/batches/bulk

Request:

{
  // Required Parameters:

  "scriptPath": string

  // Optional Parameters:

  "settings" : {
    "automaticInference": boolean
    "noOfAlternativeTakes": number
    "autoCasting": boolean
    "removeBackgroud": boolean
    "automaticSpeakerDetection: boolean
    "noOfSpeakers": number
    "sourceSpeakerSeparator": string
    "importText": boolean
    "importTiming": boolean
    "importCharacters": boolean
  }
}

Request Fields:

Field	Type	Description	Required
scriptPath	string	A URL to download the template script for the batch request. The VIDEO_PATH column in the script may contain a direct video URL or a media gallery path (obtained from the Get Media Files endpoint). The LANGUAGE_CODE column specifies the target language for the script. It is required for .docx, .txt, .pdf, or .srt files, but not required for .xlsx files, as the language is expected to be defined within the file. The script may also optionally include custom settings for individual batches.	Required
settings	object	Defines configuration parameters for batch creation. These settings apply to all batches in the script unless overridden by custom settings within a specific batch.	Optional
automaticInference	boolean	Enable automatic inference directly after batch creation. Default: true	Optional
noOfAlternativeTakes	number	A number between 0 and 2 defines number of alternative takes for each line. Default: 0	Optional
autoCasting	boolean	Enable automatic casting of voices directly after batch creation. It's available only for Media Dubbing and Line Dubbing batches. Default: true	Optional
removeBackgroud	boolean	Remove background music and effects in source media. It's available only for Media Dubbing batches. Default: true	Optional
automaticSpeakerDetection	boolean	Detect speaker in source media automatically. It's available only for Media Dubbing batches. Default: true	Optional
noOfSpeakers	number	Number of speakers in source media if automaticSpeakerDetection is set to false. It's available only for Media Dubbing batches.	Optional
sourceSpeakerSeparator	string	Speaker separator for the script files in the .srt format. It's available only for Audio Production and Media Dubbing batches.	Optional
importText	boolean	Import source text from input script, not from media directly. It's available only for Media Dubbing batches. Default: false	Optional
importTiming	boolean	Import source timing from input script, not from media directly. It's available only for Media Dubbing batches. Default: false	Optional
importCharacters	boolean	Import characters from input script, not from media directly. It's available only for Media Dubbing batches. Default: false	Optional

Response:

{
  "requestId": string
}

Returned HTTP Codes

Http Code	Description
200	Batch Creation Request created successfully
400	Invalid input
404	Project not found
500	Internal server error

Get Batch Request Status

Returns the status of the batch request identified by the requestId provided in the request URL.

Method: GET

Endpoint: https://api.revoiceit.com/batches/bulk/{requestId}/status

Query Parameters:

Field	Type	Description	Required
page	number	Can be specified to get a specific page of paginated statuses (1-indexed). For example, with the limit set to 3, page:1 will return results for the first 3 lines and page:2 will return the results for the next 3	Optional
limit	number	A number between 1 and 1000 to limit how many statuses should be returned. If left empty, this field will default to 50	Optional

Response without query parameters:

{
  "requestId": string,
  "status": string,
  "progress": string //Progress displayed as a percentage
}

Response with query parameters:

{
  "requestId": string,
  "page": number,
  "limit": number,
  "batches": [
    {
      "id": string,
      "name": string,
      "status": string,
      "message": string
    }
  ]
}

Returned HTTP Codes

Http Code	Description
200	Success
400	Invalid input
404	Request Not found
500	Internal server error

Assign Batch Language Member

Assigns a new member to a specific batch language based on the provided projectId. The assigned member will have access only to this language.

Method: POST

Endpoint: https://api.revoiceit.com/batches/{batchId}/assign-member

Request:

{
  "members": [
    {
      "userId": string,
      "languageId": string
    }
  ]
}

Request Fields:

Field	Type	Description	Required
userId	string	The ID of the user to be assigned to a specific batch language.	Required
languageId	string	The ID of the language to which the member will be assigned.	Required

Returned HTTP Codes

Http Code	Description
204	Language member assigned successfully
400	Invalid input
500	Internal server error

Add Batch Language

Adds a new language to both the specified batch and its associated project, based on the provided batchId.

Method: POST

Endpoint: https://api.revoiceit.com/batches/{batchId}/languages

Request:

{
  "languages": [
    {
      "languageId": string,
      "scriptPath": string,
      "speakerSeparator": string
    }
  ]
}

Request Fields:

Field	Type	Description	Required
languageId	string	The ID of the language to which the member will be assigned.	Required
scriptPath	string	A URL to download the target script for the batch in the specified language.	Optional
speakerSeparator	string	Defines the speaker separator used in script files with the .srt format.	Optional

Returned HTTP Codes

Http Code	Description
204	Language added successfully
400	Invalid input
500	Internal server error

Batches

Get Batches​

Get Batch by ID​

Create Batch​

Delete Batch​

Create Batch in bulk​

Get Batch Request Status​

Assign Batch Language Member​

Add Batch Language​

Get Batches

Get Batch by ID

Create Batch

Delete Batch

Create Batch in bulk

Get Batch Request Status

Assign Batch Language Member

Add Batch Language