Projects

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

Get Projects

Returns a list of projects on the workspace. An optional parameter "type" can be passed in the request that will filter the results by project type. The available options are ["line-dubbing", "media-dubbing", "audio-production"]. If no type is included in the request, it will default to "line-dubbing".

Method: GET

Endpoint: https://api.revoiceit.com/projects

Query Parameters:

Field	Type	Description	Required
type	string	Options: ["line-dubbing", "media-dubbing", "audio-production"] Default: "line-dubbing"	Optional

Response:

[
  {
    "id": string,
    "name": string,
    "status": string,
    "type": string,
    "model": string,
    "createdAt": ISOString,
    "updatedAt": ISOString
  }
]

Returned HTTP Codes

Http Code	Description
200	Success
404	No workspace found
500	Internal server error

Get Project by ID

Returns a project based on the projectId specified in the request url.

Method: GET

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

Response:

{
  "id": string,
  "name": string,
  "status": string,
  "type": string,
  "model": string,
  "createdAt": ISOString,
  "updatedAt": ISOString
}

Returned HTTP Codes

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

Create Project

Creates a project in the workspace associated with the credentials used.

Method: POST

Endpoint: https://api.revoiceit.com/projects

Request:

{
  //Required Parameters

  "name" : string
  "targetLanguages": array<string>
  "type" : string
  "model" : string

  //Optional Parameters:

  "sourceLanguage" : string
}

Request Fields:

Field	Type	Description	Required
name	string	Name of the project.	Required
targetLanguages	array<string>	An array of target language ids, which can be obtained from the Get Languages endpoint.	Required
type	string	Options: ["line-dubbing", "media-dubbing", "audio-production"]	Required
model	string	The model to be used for this project. A list of available models is returned by the Get Models endpoint.	Required
sourceLanguage	string	Language id for the source language. It's required for "media-dubbing" and "line-dubbing" projects, and optional only for "audio-production" projects.	Required

Response:

{
  "id": string,
  "name": string,
  "status": string,
  "type": string,
  "model": string,
  "createdAt": ISOString,
  "updatedAt": ISOString
}

Returned HTTP Codes

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

Update Project

Update a project's name or status by passing its id in the request URL

Method: PUT

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

Request:

{
  // Optional Parameters:

  "name" : string,
  "status" : string
}

Request Fields:

Field	Type	Description	Required
name	string	A new name for the project.	Optional
status	string	A new status for the project. Options: ["active", "archived"]	Optional

Response:

{
  "id": string,
  "name": string,
  "status": string,
  "type": string,
  "model": string,
  "createdAt": ISOString,
  "updatedAt": ISOString
}

Returned HTTP Codes

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

Archive/Unarchive Projects

Archives/unarchives projects defined in the request body by project id.

Method: POST

Endpoint: https://api.revoiceit.com/projects/archive

Request:

{
  // Required Parameters:

  "action": string
  "projectIds" : array<string>
}

Request Fields:

Field	Type	Description	Required
action	string	An action with the possible options of ["archive", "unarchive"].	Required
projectIds	array<string>	An array project ids to be archived/unarchived.	Required

Returned HTTP Codes

Http Code	Description
204	Projects archived/unarchived successfully
400	Invalid input
500	Internal server error

Delete Project

Delete a project by passing its id in the request url

Method: DELETE

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

Returned HTTP Codes

Http Code	Description
204	Deleted successfully
404	Project not found
500	Internal server error

Get Workspace Users

Returns a list of users in the workspace associated with the provided client credentials

Method: GET

Endpoint: https://api.revoiceit.com/users

Response:

[
  {
    "id": string,
    "firstName": string,
    "lastName": string,
    "email": string
  }
]

Returned HTTP Codes

Http Code	Description
200	Success
500	Internal server error

Get Project Team

Returns a list of team members in the project identified by the projectId specified in the request URL.

Method: GET

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

Response:

[
  {
    "id": string,
    "firstName": string,
    "lastName": string,
    "email": string,
    "role": string
  }
]

Returned HTTP Codes

Http Code	Description
200	Success
500	Internal server error

Add Project Team Member

Adds a new member to the project team with the specified user role, based on the projectId provided in the request URL.

Method: POST

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

Request:

{
  "teamMembers": [
    {
      "userId": string,
      "role": string
    }
  ]
}

Request Fields:

Field	Type	Description	Required
userId	string	The ID of the user to be added to the project team.	Required
role	string	A user role with the possible options of ["project-owner", "project-manager", "project-editor"].	Required

Returned HTTP Codes

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

Delete Project Team Members

Deletes one or more members from the project team, based on the projectId provided in the request URL.

Method: POST

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

Request:

{
  "teamMembers": array<string>
}

Request Fields:

Field	Type	Description	Required
teamMembers	array<string>	An array of user IDs to be deleted from the project team.	Required

Returned HTTP Codes

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

Add Project Language

Adds a new language to the project, based on the projectId provided in the request URL.

Method: POST

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

Request:

{
  "languages": array<string>
}

Request Fields:

Field	Type	Description	Required
languages	string	An array of language IDs to associate with the project.	Required

Returned HTTP Codes

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

Get Project Characters

Returns a list of characters in the project identified by the projectId specified in the request URL.

Method: GET

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

Response:

[
  {
    "id": string,
    "name": string,
    "voice": {
      "name": string,
      "gender": string,
      "voiceTag": string,
      "description": string
    },
    "createdAt": ISOString,
    "updatedAt": ISOString
  }
]

Returned HTTP Codes

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

Get Project Glossary

Returns a list of glossary lines in the project identified by the projectId specified in the request URL.

Method: GET

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

Response:

[
  {
    "id": string,
    "word": string,
    "languageId":  string,
    "phonemization": string,
    "phonemizationLanguageId": string,
    "pronunciationLanguageId": string,
    "pronounceAs": string,
    "caseSensitive": boolean,
    "createdAt": ISOString,
    "updatedAt": ISOString
  }
]

Returned HTTP Codes

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

Assign Character Voice

Assigns a voice to the character based on the projectId and characterId specified in the request URL.

Method: POST

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

Request:

{
  "voice": string
}

Request Fields:

Field	Type	Description	Required
voice	string	The name of the voice to be assigned to the character. It can be obtained from the Get Voices endpoint.	Required

Returned HTTP Codes

Http Code	Description
204	Voice assigned successfully
404	Character or Voice not found
500	Internal server error

Projects

Get Projects​

Get Project by ID​

Create Project​

Update Project​

Archive/Unarchive Projects​

Delete Project​

Get Workspace Users​

Get Project Team​

Add Project Team Member​

Delete Project Team Members​

Add Project Language​

Get Project Characters​

Get Project Glossary​

Assign Character Voice​

Get Projects

Get Project by ID

Create Project

Update Project

Archive/Unarchive Projects

Delete Project

Get Workspace Users

Get Project Team

Add Project Team Member

Delete Project Team Members

Add Project Language

Get Project Characters

Get Project Glossary

Assign Character Voice