API Reference

The VoiceCheap API is organized around REST principles. It uses standard HTTP methods, returns JSON-encoded responses, and uses standard HTTP response codes.

Base URL

All API requests should be made to:

https://api.voicecheap.ai

Authentication

All requests require an API key passed in the x-api-key header. See the Authentication page for details.

Content Types

Request: Use multipart/form-data for file uploads, application/json for other requests
Response: All responses are returned as application/json

Available Endpoints

Start Translation

POST /v1/translateUpload a video or audio file and start a translation project.

Get Translation Status

GET /v1/translate/{projectId}/statusCheck the status of a translation project and retrieve results.

Get Project Details

GET /v1/projects/{projectId}Retrieve translated version history, lip-sync history, and project state.

Delete Project

DELETE /v1/translate/{projectId}Permanently delete a translation project and its assets.

Translation Workflow

The typical workflow for translating a video is:

Response Format

All successful responses follow this general structure:

{
  "success": true,
  "message": "Description of the result"
  // Additional fields specific to the endpoint
}

Error responses follow this structure:

{
  "code": "ERROR_CODE",
  "message": "Human-readable error description"
}

HTTP Status Codes

Status Code	Description
200	Success
400	Bad Request - Invalid parameters
401	Unauthorized - Invalid or missing API key
403	Forbidden - Insufficient permissions or credits
404	Not Found - Resource doesn’t exist
429	Too Many Requests - Rate limit exceeded
500	Internal Server Error

Authentication

​API Reference

​Base URL

​Authentication

​Content Types

​Available Endpoints

Start Translation

Get Translation Status

Get Project Details

Delete Project

​Translation Workflow

​Response Format

​HTTP Status Codes

API Reference

Base URL

Authentication

Content Types

Available Endpoints

Translation Workflow

Response Format

HTTP Status Codes