Prosody

Overview

You need an API key to use the API.

API Keys

You must first obtain an API key to use the API.

Get API Key

Create and manage API keys from your dashboard.

Manage API Keys

Using API Keys

Voice APIs use X-API-Key, while the AICC Runtime API uses Authorization: Bearer.

DIVE · FRTTS · STT · Saved Voices · Dictionaries

X-API-Key: your_api_key_here

AICC Runtime API

Authorization: Bearer your_api_key_here

⚠️ Security Warning: Never expose your API key in client-side code. Use it only on the server-side.

HTTP Status Codes

Determine success or failure by the HTTP status code. Voice APIs use a nested error object, while AICC uses a flat response containing the same common code.

Error Response Format

When an error occurs, the response is returned in the following JSON format.

Voice APIs

{
  "error": {
    "code": "E4201",
    "message": "Invalid request",
    "details": "Missing required field: text"
  }
}

AICC API

{
  "error": "message or a user message in history is required",
  "code": "E4201"
}

AICC keeps a flat response for compatibility, but its code value follows the same common error-code catalog as the voice APIs.

Status Code List

CodeMeaningDescription
200OKRequest processed successfully
400Bad RequestMissing required parameters or invalid format
401UnauthorizedAPI key is invalid or missing
402Payment RequiredInsufficient credits to reserve the request
403ForbiddenNo access permission for this resource
404Not FoundRequested resource not found
405Method Not AllowedHTTP method not allowed
409ConflictThe resource is not ready to process the request
413Payload Too LargeThe request body exceeds the endpoint limit
429Too Many RequestsRequest limit exceeded (Rate Limit)
500Internal Server ErrorInternal server error
503Service UnavailableService temporarily unavailable