For the complete documentation index, see llms.txt. This page is also available as Markdown.

Validate Text

Run in Postman: Validate text

The Validate Text API checks that every word in a piece of text is in the Speechace lexicon — a quick way to confirm authored content can be scored accurately before you use it in a scoring activity. Words not found in the lexicon can be reported to support@speechace.com for possible inclusion; alternatively, Score Word can score out-of-lexicon terms via arpa_mark, or you can let the API automatically handle unknown words.

Request Format

The endpoint you use depends on the region of your subscription. For example, for US West the endpoint is https://api.speechace.co.

POST https://api.speechace.co/api/validating/text/v9/json

All parameters are passed in the query string; this request has no body or audio.

Query Parameters

Parameter
Type
Description

key

String

API key issued by Speechace.

dialect

String

This is the dialect in which the speaker will be assessed. Supported only for en-us and en-gb.

text

String

A sentence or sequence of words to validate. For example: - With unknown words: Validate these words existeee. - With known words: Validate these words exist.

Request Examples

Example
Query Parameters
When to use

A. Unknown words

text="Validate these words existeee."

Detect words the lexicon does not recognise.

B. Known words

text="Validate these words exist."

Confirm all words are recognised and scorable.

Response Examples

When an unknown word is found, the API returns the error_unknown_words error with the offending word in detail_message. When all words are known, it returns status: success.

Last updated