{"id":"pronunciation-apply","title":"Pronunciation lexicon to SSML phoneme and sub tags","description":"Applies your pronunciation lexicon (up to 200 terms, each an IPA string or a spoken alias) to a text of up to 20000 characters and returns SSML 1.1 with <phoneme alphabet=\"ipa\"> or <sub alias> around each whole-word match, XML-escaped, for an agent preparing text for a text-to-speech engine. Matching is whole-word, longest term first, left to right, deterministic. It does not guess pronunciations, convert between phonetic alphabets or check that your TTS vendor supports the tags; IPA strings are checked for character ranges only.","roi":"Brand names and acronyms mispronounced by a voice agent are fixed once, deterministically, instead of per prompt.","audience":"business","package":"identifier-text-kit","channels":["x402","mcp"],"endpoint":{"method":"POST","url":"https://agents.writerslogic.com/api/v1/pronunciation-apply","path":"/api/v1/pronunciation-apply","contentType":"application/json"},"price":{"amount":"0.005","currency":"USDC","network":"base","perCall":true,"failedCallsCharged":false},"inputSchema":{"type":"object","additionalProperties":false,"required":["text","lexicon"],"properties":{"text":{"type":"string","minLength":1,"maxLength":20000},"lexicon":{"type":"array","minItems":1,"maxItems":200,"items":{"type":"object","required":["term"],"properties":{"term":{"type":"string","minLength":1,"maxLength":100},"ipa":{"type":"string","maxLength":200,"description":"IPA transcription; becomes <phoneme alphabet=\"ipa\" ph=...>."},"alias":{"type":"string","maxLength":200,"description":"Spoken form; becomes <sub alias=...>."},"caseSensitive":{"type":"boolean","description":"Default false."}}}},"wrapSpeak":{"type":"boolean","description":"Wrap in <speak version=\"1.1\"> (default true)."},"lang":{"type":"string","maxLength":16,"description":"xml:lang of the speak element (default en-US)."}}},"resultSchema":{"type":"object","properties":{"status":{"type":"string","enum":["pass","fail","unknown","unsupported"],"description":"pass: every rule held. fail: a rule was violated (see witnesses). unknown: the input lacks the evidence to decide. unsupported: outside what this engine covers. Missing evidence is never a pass."},"ssml":{"type":"string"},"replacements":{"type":"array","items":{"type":"object","properties":{"entry":{"type":"integer"},"term":{"type":"string"},"start":{"type":"integer","description":"UTF-16 offset in the input text."},"end":{"type":"integer"},"tag":{"type":"string","enum":["phoneme","sub"]}}}},"unusedTerms":{"type":"array","items":{"type":"string"}},"witnesses":{"type":"array","items":{"type":"object","properties":{"ruleId":{"type":"string"},"detail":{"type":"string"},"path":{"type":"string","description":"JSON pointer or dotted path into the input."},"offset":{"type":"integer"},"index":{"type":"integer"},"expected":{"description":"What the rule required."},"actual":{"description":"What the input had."}}}},"versions":{"type":"object","description":"Every semantic dependency of this answer (engine, tables and their as-of dates, tokenizer, calendar, rounding profile)."},"limits":{"type":"array","items":{"type":"string"}},"deterministic":{"type":"boolean","description":"Always true: pure code, no model."}}},"outputSchema":{"type":"object","properties":{"data":{"type":"object","properties":{"status":{"type":"string","enum":["pass","fail","unknown","unsupported"],"description":"pass: every rule held. fail: a rule was violated (see witnesses). unknown: the input lacks the evidence to decide. unsupported: outside what this engine covers. Missing evidence is never a pass."},"ssml":{"type":"string"},"replacements":{"type":"array","items":{"type":"object","properties":{"entry":{"type":"integer"},"term":{"type":"string"},"start":{"type":"integer","description":"UTF-16 offset in the input text."},"end":{"type":"integer"},"tag":{"type":"string","enum":["phoneme","sub"]}}}},"unusedTerms":{"type":"array","items":{"type":"string"}},"witnesses":{"type":"array","items":{"type":"object","properties":{"ruleId":{"type":"string"},"detail":{"type":"string"},"path":{"type":"string","description":"JSON pointer or dotted path into the input."},"offset":{"type":"integer"},"index":{"type":"integer"},"expected":{"description":"What the rule required."},"actual":{"description":"What the input had."}}}},"versions":{"type":"object","description":"Every semantic dependency of this answer (engine, tables and their as-of dates, tokenizer, calendar, rounding profile)."},"limits":{"type":"array","items":{"type":"string"}},"deterministic":{"type":"boolean","description":"Always true: pure code, no model."}}},"_provenance":{"type":"object","description":"C2PA-aligned manifest and W3C VC 2.0 (eddsa-jcs-2022) issued by the hub DID; verify at POST /api/v1/verify-provenance"}},"required":["data","_provenance"]},"example":{"text":"Nvidia & AWS announced GPUs.","lexicon":[{"term":"Nvidia","ipa":"ɛnˈvɪdiə"},{"term":"AWS","alias":"A W S"}]},"openapiOperation":{"operationId":"pronunciation_apply","summary":"Pronunciation lexicon to SSML phoneme and sub tags","description":"Applies your pronunciation lexicon (up to 200 terms, each an IPA string or a spoken alias) to a text of up to 20000 characters and returns SSML 1.1 with <phoneme alphabet=\"ipa\"> or <sub alias> around each whole-word match, XML-escaped, for an agent preparing text for a text-to-speech engine. Matching is whole-word, longest term first, left to right, deterministic. It does not guess pronunciations, convert between phonetic alphabets or check that your TTS vendor supports the tags; IPA strings are checked for character ranges only.\n\nPrice: 0.005 USDC on Base (x402).","x-x402-price-usdc":"0.005","x-x402-amount":"5000","x-payment-info":{"protocols":["x402"],"price":{"mode":"fixed","currency":"USD","amount":"0.005"}},"x-audience":"business","x-sample-url":"https://agents.writerslogic.com/api/v1/samples/pronunciation-apply","security":[{"x402":[]},{"apiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["text","lexicon"],"properties":{"text":{"type":"string","minLength":1,"maxLength":20000},"lexicon":{"type":"array","minItems":1,"maxItems":200,"items":{"type":"object","required":["term"],"properties":{"term":{"type":"string","minLength":1,"maxLength":100},"ipa":{"type":"string","maxLength":200,"description":"IPA transcription; becomes <phoneme alphabet=\"ipa\" ph=...>."},"alias":{"type":"string","maxLength":200,"description":"Spoken form; becomes <sub alias=...>."},"caseSensitive":{"type":"boolean","description":"Default false."}}}},"wrapSpeak":{"type":"boolean","description":"Wrap in <speak version=\"1.1\"> (default true)."},"lang":{"type":"string","maxLength":16,"description":"xml:lang of the speak element (default en-US)."}}},"example":{"text":"Nvidia & AWS announced GPUs.","lexicon":[{"term":"Nvidia","ipa":"ɛnˈvɪdiə"},{"term":"AWS","alias":"A W S"}]}}}},"responses":{"200":{"description":"Paid result with provenance","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"status":{"type":"string","enum":["pass","fail","unknown","unsupported"],"description":"pass: every rule held. fail: a rule was violated (see witnesses). unknown: the input lacks the evidence to decide. unsupported: outside what this engine covers. Missing evidence is never a pass."},"ssml":{"type":"string"},"replacements":{"type":"array","items":{"type":"object","properties":{"entry":{"type":"integer"},"term":{"type":"string"},"start":{"type":"integer","description":"UTF-16 offset in the input text."},"end":{"type":"integer"},"tag":{"type":"string","enum":["phoneme","sub"]}}}},"unusedTerms":{"type":"array","items":{"type":"string"}},"witnesses":{"type":"array","items":{"type":"object","properties":{"ruleId":{"type":"string"},"detail":{"type":"string"},"path":{"type":"string","description":"JSON pointer or dotted path into the input."},"offset":{"type":"integer"},"index":{"type":"integer"},"expected":{"description":"What the rule required."},"actual":{"description":"What the input had."}}}},"versions":{"type":"object","description":"Every semantic dependency of this answer (engine, tables and their as-of dates, tokenizer, calendar, rounding profile)."},"limits":{"type":"array","items":{"type":"string"}},"deterministic":{"type":"boolean","description":"Always true: pure code, no model."}}},"_provenance":{"type":"object","description":"C2PA-aligned manifest and W3C VC 2.0 (eddsa-jcs-2022) issued by the hub DID; verify at POST /api/v1/verify-provenance"}},"required":["data","_provenance"]}}}},"400":{"description":"Invalid request (no payment consumed)","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string"}}}}}},"401":{"description":"Invalid X-API-KEY","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string"}}}}}},"402":{"description":"Payment required or invalid","content":{"application/json":{"schema":{"type":"object","description":"x402 v2 PaymentRequired (also base64 in the PAYMENT-REQUIRED header)","properties":{"x402Version":{"type":"integer"},"error":{"type":"string"},"code":{"type":"string"},"resource":{"type":"object"},"accepts":{"type":"array","items":{"type":"object"}},"extensions":{"type":"object"}}}}}},"502":{"description":"Upstream failure; the payment is released or not settled","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string"}}}}}}}},"links":{"docs":"https://agents.writerslogic.com/docs/pronunciation-apply/","docsJson":"https://agents.writerslogic.com/docs/pronunciation-apply.json","sample":"https://agents.writerslogic.com/api/v1/samples/pronunciation-apply","openapi":"https://agents.writerslogic.com/openapi.json","catalog":"https://agents.writerslogic.com/api/v1/catalog","verifyProvenance":"https://agents.writerslogic.com/api/v1/verify-provenance","index":"https://agents.writerslogic.com/docs/index.json"}}