Acapela Cloud

Dictionary

- Startup guide
Start using Acapela Cloud Dictionary

- Share dictionary / Lock entries
Share Acapela Cloud Dictionary

If you have the dispatcher option and need to share your dictionary with your subscribers you need to go to the dispatcher menu.
You can then select the dictionary to share and give access to the subscriber(s) you want.
It will appear in the dictionary list for your subscriber(s)

When a dictionary is shared you may want to prevent a validated entry to be modified

For that you simply need to click on the lock/unlock icon
Once locked an entry can be modified/unlocked/deleted only by the user that locked it.

The entry is not locked and can be modified by any user

The entry is locked by another user and cannot be modified by you

You locked the entry and only you can modify it

Each entry can be flagged as validated by clicking on the tick mark

✓

The word and its transcription are validated and will be added to the dictionary when generated

The word is not validated and won't be added to the dictionary when generated

API

- Dico api
Manage your diuctionaries/entries with the API

GET Language list

Get dictionary language list

GET Nature list

Get word nature list

Authorization header

Field	Type	Description
token	String	Token returned by the login function 'Authorization': 'Token ' + token

Parameters

Field	Type	Value - Description
type	String	nature_list

Responses

Value	Description	Response
200	List of the nature available for a the words	Json string
400	Error	{'error':'Error description'}

                response=$(curl --silent -G --data-urlencode "type=nature_list" 
                'https://www.acapela-cloud.com/api/dicoeditor/' -H 'Authorization: Token '$token)
                echo "nature_list : $response"
                echo ""
                

                import requests
                import json

                headers = {
                  'Authorization': 'Token ' + token,
                  'Content-Type': 'application/json',
                }
              
                params = {'type': 'nature_list'}
                response = requests.get(server_url + '/api/dicoeditor/', headers=headers, params=params)
              
                return response
                

GET Phoneme list

Get phonemes available for a given language

Authorization header

Field	Type	Description
token	String	Token returned by the login function 'Authorization': 'Token ' + token

Parameters

Field	Type	Value - Description
type	String	phoneme_list
language	String	language id (id value returned by the language list function)

Responses

Value	Description	Response
200	List of the phoneme available for a given language	Json string
400	Error	{'error':'Error description'}

Samples

Curl
Python

                response=$(curl --silent -G --data-urlencode "type=phoneme_list" --data-urlencode "language=13" 
                'https://www.acapela-cloud.com/api/dicoeditor/' -H 'Authorization: Token '$token)
                echo "phoneme_list : $response"
                echo ""
                

                import requests
                import json

                headers = {
                  'Authorization': 'Token ' + token,
                  'Content-Type': 'application/json',
                }

                params = {'type': 'phoneme_list','language': language_id}
                response = requests.get(server_url + '/api/dicoeditor/', headers=headers, params=params)
                

POST Add dictionary

Add a new dictionary

Authorization header

Field	Type	Description
token	String	Token returned by the login function 'Authorization': 'Token ' + token

Parameters

Field	Type	Value - Description
type	String	add_dico
name	String	dictionary name
language	String	language of dictionary (value returned by the language_list function)
voice (optional)	String	specific voice (some voice may have specific phonetic rules) e.g. max, harry ...)

Responses

Value	Description	Response
200	Dictionary added	Json string
400	Error	{'error':'Error description'}

Samples

Curl
Python

                response=$(curl --silent -X POST 'http://localhost/api/dicoeditor/' 
                -d '{"type":"add_dico","name":"test_add_dico","language":"13"}' 
                -H 'Authorization: Token '$token -H 'Content-Type: application/json') 
                echo $response
                echo ""
                

                import requests
                import json

                headers = {
                  'Authorization': 'Token ' + token,
                    'Content-Type': 'application/json',
                }
              
                data = '{"type": "' + "add_dico" + '","name": "' + name  + '","language": "' + language + '","voice": "' + voice + '"}'
                response = requests.post(server_url + '/api/dicoeditor/',  headers=headers, data=data)
              
                return response

                

GET Dico list

Get your dictionary list

Authorization header

Field	Type	Description
token	String	Token returned by the login function 'Authorization': 'Token ' + token

Parameters

Field	Type	Value - Description
type	String	dico_list

Responses

Value	Description	Response
200	List of the your dictionaries	Json string
400	Error	{'error':'Error description'}

Samples

Curl
Python

                response=$(curl --silent -G --data-urlencode "type=dico_list"
                'https://www.acapela-cloud.com/api/dicoeditor/' -H 'Authorization: Token '$token)
                echo "dico_list : $response"
                echo ""
                

                import requests
                import json

                headers = {
                  'Authorization': 'Token ' + token,
                  'Content-Type': 'application/json',
                }

                params = {'type': 'dico_list'}
                response = requests.get(server_url + '/api/dicoeditor/', headers=headers, params=params)
                

GET Word phonetic transcription

Get word phonetic transcription

Authorization header

Field	Type	Description
token	String	Token returned by the login function 'Authorization': 'Token ' + token

Parameters

Field	Type	Value - Description
type	String	check_word
word	String	word for which you want the phonetic transcription
language	String	word language id (id returned by the get language function)
voice (optional)	String	specific voice (some voice may have specific phonetic rules) e.g. max, harry ...)

Responses

Value	Description	Response
200	List of the language available	Json string
400	Error	{'error':'Error description'}

Details

Value	Description
is_oov = false	The item is very likely well pronounced
is_ool = false	The item is most likely well pronounced
is_oov = true or is_ool = true	The item may be mispronounced

if (is_oov == false) { good } else if (is_ool == false) { medium } else { low }

Samples

Curl
Python

                response=$(curl --silent -G --data-urlencode "type=check_word" --data-urlencode "word=hello" 
                --data-urlencode "language=13"  
                'https://www.acapela-cloud.com/api/dicoeditor/' -H 'Authorization: Token '$token)
                echo "dico_list : $response"
                echo ""
                
                

                import requests
                import json

                headers = {
                      'Authorization': 'Token ' + token,
                      'Content-Type': 'application/json',
                }

                params = {'type': 'check_word','word': word,'language': language}
                response = requests.get(server_url + '/api/dicoeditor/', headers=headers, params=params)
              
                return response
                

POST Add/Update entry

Add or update an entry (word/nature/transcription) in a dictionary

Authorization header

Field	Type	Description
token	String	Token returned by the login function 'Authorization': 'Token ' + token

Parameters

Field	Type	Value - Description
type	String	add_entry
dic_id	String	Dictionary id in which you want to add/update the entry (id returned by the dico list function)
word	String	word for which you want to add/update an alternative transcription/pronunciation
nature	String	Nature of the word (id returned by the nature list function)
transcription	String	Phonetic transcription for the word (you can get the phonetic transcription of a word using check_word function)
validated	boolean	True if want the word to be exported when you generate the dictionary

Responses

Value	Description	Response
200	Entry added/updated	Json string
400	Error	{'error':'Error description'}

Samples

Curl
Python

                  response=$(curl --silent -X POST 'https://www.acapela-cloud.com/api/dicoeditor/' 
                  -d '{"type":"add_entry","dic_id":"638","word":"cool","nature":"13","transcription":"k l","validated":"true"}' 
                  -H 'Authorization: Token '$token -H 'Content-Type: application/json') 
                  echo $response
                  echo ""
                

                import requests
                import json

                headers = {
                  'Authorization': 'Token ' + token,
                    'Content-Type': 'application/json',
                }
              
                data = '{"type": "' + "add_entry" + '","dic_id": "' + dic_id 
                + '","word": "' + word + '","nature": "' + nature + '","transcription": "' 
                + transcription + '","validated": "' + validated + '"}'
                response = requests.post(server_url + '/api/dicoeditor/',  headers=headers, data=data)
                            
                return response

                

GET Dico content

Get dictionary content

Authorization header

Field	Type	Description
token	String	Token returned by the login function 'Authorization': 'Token ' + token

Parameters

Field	Type	Value - Description
type	String	dico_content
dic_id	String	dictionary id (returned by the dico list function)

Responses

Value	Description	Response
200	List of the entries in the dictionary	Json string
400	Error	{'error':'Error description'}

Samples

Curl
Python

                  response=$(curl --silent -G --data-urlencode "type=dico_content" 
                  --data-urlencode "dic_id=638"  
                  'https://www.acapela-cloud.com/api/dicoeditor/' -H 'Authorization: Token '$token)
                  echo "dico_list : $response"
                  echo ""
                

                import requests
                import json

                headers = {
                  'Authorization': 'Token ' + token,
                  'Content-Type': 'application/json',
                }

                params = {'type': 'dico_content','dic_id': dic_id}
                response = requests.get(server_url + '/api/dicoeditor/', headers=headers, params=params)
              
                return response
              
                

DELETE Delete entry

Delete an entry/word from a dictionary

Authorization header

Field	Type	Description
token	String	Token returned by the login function 'Authorization': 'Token ' + token

Parameters

Field	Type	Value - Description
type	String	delete_entry
dic_id	String	Dictionary id in which you want to add/update the entry (id returned by the dico list function)
entry_id	String	Entry id (id returned by the dico content function)

Responses

Value	Description	Response
200	Entry deleted	Json string
400	Error	{'error':'Error description'}

Samples

Curl
Python

                  response=$(curl --silent -X DELETE  'https://www.acapela-cloud.com/api/dicoeditor/'  
                  -d '{"type":"delete_entry","dic_id":"638","entry_id":"109907"}' 
                  -H 'Authorization: Token '$token -H 'Content-Type: application/json') 
                  echo 'response : ' $response
                  echo ""
                

                import requests
                import json

                headers = {
                  'Authorization': 'Token ' + token,
                    'Content-Type': 'application/json',
                }
              
                data = '{"type": "' + "delete_entry" + '","dic_id": "' + dic_id  + '","entry_id": "' + entry_id + '"}'
                response = requests.delete(server_url + '/api/dicoeditor/',  headers=headers, data=data)
                     
                return response

                

POST Generate a dictionary

Generate a dictionary to be used in your TTS commands

Authorization header

Field	Type	Description
token	String	Token returned by the login function 'Authorization': 'Token ' + token

Parameters

Field	Type	Value - Description
type	String	export_dico
dic_id	String	Dictionary id to generate (id returned by the dico list function)
dic_name	String	The dictionary filename that will be used for the generated dictionary

Responses

Value	Description	Response
200	Dictionary generated	Json string
400	Error	{'error':'Error description'}

Samples

Curl
Python

                response=$(curl --silent -X DELETE  'http://localhost/api/dicoeditor/'  
                -d '{"type":"delete_entry","dic_id":"639","entry_id":"109907"}' 
                -H 'Authorization: Token '$token -H 'Content-Type: application/json') 
                echo 'response : ' $response
                echo ""
                

                import requests
                import json

                headers = {
                  'Authorization': 'Token ' + token,
                    'Content-Type': 'application/json',
                }
              
                data = '{"type": "' + "export_dico" + '","dic_id": "' + dic_id  + '","dic_name": "' + dic_name + '"}'
                response = requests.post(server_url + '/api/dicoeditor/',  headers=headers, data=data)
              
                return response

                

DELETE Delete dictionary

Delete a dictionary

Authorization header

Field	Type	Description
token	String	Token returned by the login function 'Authorization': 'Token ' + token

Parameters

Field	Type	Value - Description
type	String	delete_dico
dic_id	String	Dictionary id in which you want to add/update the entry (id returned by the dico list function)

Responses

Value	Description	Response
200	Dictionary deleted	Json string
400	Error	{'error':'Error description'}

Samples

Curl
Python

                response=$(curl --silent -X DELETE  'https://www.acapela-cloud.com/api/dicoeditor/'  
                -d '{"type":"delete_dico","dic_id":"638"}' 
                -H 'Authorization: Token '$token -H 'Content-Type: application/json') 
                echo 'response : ' $response
                echo ""
                

                import requests
                import json

                headers = {
                  'Authorization': 'Token ' + token,
                    'Content-Type': 'application/json',
                }
              
                data = '{"type": "' + "delete_dico" + '","dic_id": "' + dic_id + '"}'
                response = requests.delete(server_url + '/api/dicoeditor/',  headers=headers, data=data)              
              
                return response
              
                

Snippets

Script

Python