'"}}, "produces": ["application/json"]}, "post": {"summary": "Upload lexicon file", "description": "Uploads and stores a custom lexicon file, to be used with /speak endpoint during synthesis. A custom lexicon can be used to add or overridenew pronunciations to the TTS output. Once a user lexicon has been uploaded, it will be used in synthesis withvoices in the specified language and accent. The user lexicon is not shared with other accounts.
User Lexicon Format
The user lexicon format consists of a headword and pronunciation, one per line. Example lexicon line (EnglishRP):
mourinho m_@@0_r_ii1_n_y_ou2
The headword should be lower case, and consist of alphabetic characters only (to process a string that includes non-alphabetic characters, use an abbreviations file). Vowel phonemes, such as @@, ii and ou in the example pronunciation, can have stress levels specified. The stress levels are 1 for primary stress, 2 for secondary stress, and 0 for no stress.
Each accent has a different phone set. Different user lexicons are required for British and American voices, for example. However, the same user lexicon could be used between voices with the same accent, for example the Sarah and William English RP voices. See the CereVoice Phone Sets document for example pronunciations.", "parameters": [{"in": "query", "name": "language", "description": "language code in iso format", "type": "string", "required": true}, {"in": "query", "name": "accent", "description": "The two-letter CereProc accent code associated with the lexicon file", "type": "string", "required": true}, {"in": "body", "name": "file", "description": "Custom user lexicon ", "required": true, "schema": {"type": "string", "example": "mourinho m_@@0_r_ii1_n_y_ou2"}}], "consumes": ["text/plain"], "security": [{"BearerAuth": []}], "responses": {"200": {"examples": {"application/json": {"message": "The lexicon file has been uploaded successfully"}}, "description": "OK"}, "400": {"description": "The lexicon file could not be uploaded"}, "401": {"description": "No access token found
Access token has expired
Access token is invalid
Bad Authorization header. Expected value 'Bearer \\'"}}, "produces": ["application/json"]}}, "/abbreviations": {"get": {"summary": "List available abbreviation files", "description": "Lists the custom abbreviation files that are available for synthesis on the CereVoice Cloud.", "security": [{"BearerAuth": []}], "responses": {"200": {"examples": {"application/json": {"abbreviations": [{"url": "https://url.to.abbreviation/file", "language": "en", "last_modified": "2019-12-20 09:37:43", "size": 250}]}}, "description": "OK"}, "401": {"description": "Access token has expired
Access token is invalid"}}, "produces": ["application/json"]}, "post": {"summary": "Upload abbreviation file", "description": "Uploads and stores a custom abbreviation file, to be used with /speak endpoint during synthesis. User abbreviations can be used to expand mixed case tokens, or tokens including digits, into words. Once a custom abbreviation file has been uploaded, it will be used in synthesis with voices in the specified language.
User Abbreviations Format
The user lexicon format consists of a token, no break flag, and replacement text, line-by-line. Example entries (taken from the current CereProc abbreviation list): 3G 0 three g
7/11 0 seven eleven
Dr 1 doctor
FAQ 0 f a:letter q
The first column is a whitespace-delimited token in the input text. The second column, the no break flag, describes the handling of punctuation following the token. When set to 1, following punctuation is ignored. In the examples, this would cause \"Dr. Johnson\" to be read without a pause between the words.
Some languages, such as English, have single letters that can be pronounced differently in an acronym compared to free text. The letter pronunciation can be ensured by adding :letter after the letter (see the example for FAQ).
", "parameters": [{"in": "query", "name": "language", "description": "language in iso format", "type": "string", "required": true}, {"in": "body", "name": "file", "description": "Custom user abbreviations ", "required": true, "schema": {"type": "string", "example": "3G 0 three g"}}], "consumes": ["text/plain"], "security": [{"BearerAuth": []}], "responses": {"200": {"examples": {"application/json": {"message": "The abbreviations file has been uploaded successfully"}}, "description": "OK"}, "400": {"description": "The abbreviations file could not be uploaded"}, "401": {"description": "No access token found
Access token has expired
Access token is invalid"}}, "produces": ["application/json"]}}, "/credit": {"get": {"summary": "Get credit", "description": "Retrieves the credit information for the given account. 1 credit = 1 character of text input.
Free credit is deducted first, until there is no free credit remaining, at which point the paid credit will be deducted for subsequent synthesis requests. The free credit amount is reset at the start of each month.", "security": [{"BearerAuth": []}], "responses": {"200": {"examples": {"application/json": {"free_credit": 1000, "paid_credit": 1000, "total": 2000}}, "description": "OK"}, "401": {"description": "No access token found
Access token has expired
Access token is invalid
Bad Authorization header. Expected value 'Bearer \\'"}}, "produces": ["application/json"]}}, "/credit-threshold": {"get": {"summary": "Get credit threshold", "description": "Retrieves the credit threshold, which specifies at which amount of credits email alerts will be sent out. Amount will be equal to 0 if none was set.", "security": [{"BearerAuth": []}], "responses": {"200": {"examples": {"application/json": {"credit_threshold": 100}}, "description": "OK"}, "401": {"description": "No access token found
Access token has expired
Access token is invalid
Bad Authorization header. Expected value 'Bearer \\'"}}, "produces": ["application/json"]}, "post": {"summary": "Set credit threshold", "description": "Sets the credit threshold, which specifies at which amount of credits email alerts will be sent out. To remove the alert, set the threshold to 0.", "parameters": [{"in": "query", "name": "amount", "description": "credit threshold", "type": "integer", "required": false}], "security": [{"BearerAuth": []}], "responses": {"200": {"examples": {"application/json": {"message": "The credit threshold was set successfully"}}, "description": "OK"}, "400": {"description": "The credit threshold could not be set"}, "401": {"description": "No access token found
Access token has expired
Access token is invalid
Bad Authorization header. Expected value 'Bearer \\'"}}, "produces": ["application/json"]}}}}