Create a pronunciation item

Creates a new pronunciation item inside a pronunciations-type group. The referenced group_id must belong to your organization and have type: pronunciations.

Authorization

bearerAuth

AuthorizationBearer <token>

API key in the Authorization: Bearer <key> header. Keys are created in the SMAO dashboard (Settings → API Keys).

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

group_id*string

Match^[a-f0-9]{24}$

word*string

The written single-token form to match. Whitespace and angle brackets (<, >) are rejected.

Match^[^\s<>]+$

Length1 <= length <= 200

replacement?string

Phonetic respelling. Angle brackets (<, >) are rejected. Must be empty when spell_out is true.

Lengthlength <= 1000

Default""

ipa?string

International Phonetic Alphabet transcription. Applied on v2 voices; ignored on v1 voices. Must be empty when spell_out is true.

Lengthlength <= 1000

Default""

spell_out?boolean

When true, the matched word is spoken letter by letter — API is spoken as A, P, I.

Defaultfalse

rate?|

Speaking-rate override. null inherits the voice/request speed; medium is explicit normal speed.

Defaultnull

Value in

null
"slow"
"medium"
"fast"

case_sensitive?boolean

Defaultfalse

active?boolean

Defaulttrue

Response Body

`application/json`

curl -X POST "https://example.com/pronunciation" \  -H "Content-Type: application/json" \  -d '{    "group_id": "65a1234567890abcdef01234",    "word": "SMAO",    "spell_out": true  }'

{  "data": {    "id": "string",    "group_id": "string",    "group_name": "string",    "word": "string",    "replacement": "string",    "ipa": "string",    "spell_out": false,    "rate": null,    "case_sensitive": false,    "active": true,    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z"  }}

Create a pronunciation item

Authorization

Request Body

Response Body

201application/json

400application/json

401application/json

402application/json

403application/json

404application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`