Success and Error Responses

This document explains the structure and handling of successful and error responses for API requests.
The Gaudio Developers API uses standard HTTP response codes along with its own resultCode to indicate the success or failure of a request.

Success Responses

A successful response has an HTTP status code of 200, and the resultCode in the response body is 1000.

{
    "resultCode": 1000,
    "resultData": {
        "status": "success",
        "downloadUrl": {
            "vocal": {
                "mp3": "https://cdn_url/input-file_vocal.mp3",
                "wav": "https://cdn_url/input-file_vocal.wav"
            },
        ...
    }
}

• The detailed structure of resultData may vary depending on the endpoint.
• For more information, please refer to the documentation for each endpoint.

Error Responses

HTTP 4XX Errors

If there is an issue with the client request, an HTTP status code in the 4XX range will be returned. Common causes include:

• The request format is incorrect (e.g., missing required parameters, wrong data type)
• Authentication information is incorrect or missing
• Attempting to access a resource without permission
• The requested resource does not exist

Error Code Details

HTTP Code	Message	Description
400	Bad Request	The x-ga-apikey is missing from the request header.
401	Invalid API key: verification failed.	The provided API key is invalid or incorrect.
401	Invalid API key: This API key has been deleted.	The provided API key has been deleted.
401	Invalid API key: The key is inactive.	The provided API key is inactive.
403	The requested upload URL is not permitted: {uploadUrl}	The requested upload URL is not permitted.
403	The requested product is not permitted for this API key: {productjName}	The API key does not have permission to access the specified product. 1. Ensure you are using the API key issued for the correct project. 2. If the API key does not have the necessary permissions, request them from the project manager or modify the API key settings in the Developer Console.

HTTP 5XX Errors

If the HTTP status code is in the 5XX range, it is likely that an internal error occurred on the Gaudio Developers API server.

• This may be a temporary issue, so please try again later.
• If the problem persists, please contact customer support or the designated channel.

HTTP 200 but resultCode ≠ 1000

If the HTTP status code is 200 but the resultCode in the response body is not 1000, it means the request was received successfully but failed due to business logic. A resultMessage will be present to explain the reason.

{
    "resultCode": 1102,
    "resultMessage": "Insufficient credit balance."
}

• resultCode and resultMessage may vary depending on the endpoint.
• For more information, please refer to the documentation for each endpoint.

Error Code Details

Result Code	Message	Description
1007	The specified language does not match the text content.	The specified language option does not match the actual text.
1008	Text must contain at least two lines.	The provided text does not contain at least two lines.
1014	Unsupported sampling frequency.	An unsupported sampling frequency was provided.
1015	Unsupported channel.	An unsupported audio channel was provided.
1102	Insufficient credit balance.	The credit balance is 0.
1103	Contract is invalid or has expired.	The product contract is invalid or has expired (Enterprise only).
1104	Requested job ID not found.	The requested job ID is missing or not found.
1105	Requested upload ID not found.	The requested upload ID is missing or not found.
1106	Upload ID has expired.	The validity period of the upload ID has expired.
1107	Unsupported audio file format.	The provided audio format is not supported.
1108	Audio file duration detected as 0 seconds.	The audio duration is 0 seconds.
1109	Audio file duration exceeds the allowed limit.	The audio duration exceeds the allowed limit.
1110	Audio file size exceeds the allowed limit.	The audio file size exceeds the allowed limit.
1111	Unsupported text language.	The specified text language is not supported.
1112	Unsupported text file format.	The provided text format is not supported.
1113	Unsupported file name format.	The file name format is not supported.
1114	Project has been deleted.	The requested project has been deleted.
1100	Unknown error.	An unknown error occurred. If it persists, please contact customer support.