Speechace
  • Introduction
    • Overview
    • Use-Cases
  • Getting Started
    • Pre-requisites
      • API Features
      • Getting the API Key
      • API Regions and endpoints
      • API Limits
    • API Samples
    • Supported Languages
    • API Versioning
    • Authentication
    • Try the Speechace API
    • Error Handling
      • Common Errors
      • Retry Strategies
  • Solutions
    • Speaking Practice for Language Learning
    • Automated Language Assessment with AI
    • Voice AI for Early Literacy
    • Test Prep for Standardized tests
      • PTE Speaking Questions
      • IELTS Speaking Questions
      • TOEFL Speaking Questions
      • CEFR Speaking Questions
      • TOEIC Speaking Questions
    • Speaking Practice in Spanish and French
  • Features
    • Introduction
    • Scripted activities
      • Pronunciation Scoring
        • Word and Sentence pronunciation
        • Multiple choice
        • Custom pronunciations
        • Phoneme list
      • Fluency scoring
        • Passage scoring
      • Lexical stress and intonation
    • Spontaneous activities
      • Open-ended scoring
        • Language scoring
        • Relevance scoring
        • Language detection
      • Task achievement scoring
        • Describe Image
        • Re-tell Lecture
        • Answer Question
  • API Reference
    • Postman API reference
    • Score Text/Pronunciation
      • Handling overall scores
      • Handling word scores
      • Handling phoneme and syllable scores
    • Score Text/Multiple choice
      • Handling multiple choice response
    • Score Text/Markup Language
      • Handling Markup Response
    • Score Text/Stress & Intonation
      • Handing stress and intonation response
    • Score Text/Phoneme list
      • Handling phoneme list response
    • Score Text/Fluency
      • Handling fluency response
      • Fidelity detection
    • Score Text/Validate Text
    • Score Speech/Open-ended
      • Handling language scores
      • Per metric feedback
        • Grammar metrics
        • Vocabulary metrics
        • Coherence metrics
    • Score Speech/Relevance
      • Handling relevance response
    • Score Speech/Language Detection
    • Score Task/Task Achievement
  • Guides on common topics
    • Intepreting quality score
    • Interpreting overall scores
      • Pronunciation Bands
      • Fluency Bands
      • Vocabulary Bands
      • Grammar Bands
      • Coherence Bands
    • Scoring rubrics
    • Interpreting fidelity class
    • Phonetic notation
      • US English (en-us)
      • UK English (en-gb)
      • French (fr-fr, fr-ca)
      • Spanish (es-es, es-mx)
    • Getting word timestamps in audio
    • Automatic handling of unknown words
    • Phoneme to letter mapping
    • Markup Language
  • Other Resources
    • Requesting Support
    • Rate Limiting
    • Data Retention
    • FAQs
    • Appendices
Powered by GitBook
On this page
  • Request Format
  • Query Parameters
  • Request Body
  • Response Example
  1. API Reference

Score Text/Phoneme list

PreviousHanding stress and intonation responseNextHandling phoneme list response

Last updated 6 months ago

Run in Postman:

With the phone list API, you can score a sequence of phonemes that make up any word or non-word.

Individual words, such as "Gotcha," which are American vernacular and not valid dictionary words, can be scored using the phoneme list API. The phoneme list uses a different url endpoint and expects the list of phonemes in .

Request Format

The endpoint that is to be used will depend on the of your subscription. For example, for US West, the endpoint is .

POST

curl --location -g 'https://api.speechace.co/api/scoring/phone_list/v9/json?key={{speechacekey}}&dialect=en-us' \
--form 'phone_list="g|ao|ch|ah"' \
--form 'user_audio_file=@"gotcha.wav"'

Query Parameters

Parameter
Type
Description

key

String

dialect

String

user_id

String

Optional: A unique anonymized identifier for the end-user who spoke the audio.

Request Body

Parameter
Type
Description

phone_list

String

A phoneme list to score. For example: g|ao|ch|ah

user_audio_file

File

file with user audio (wav, mp3, m4a, webm, ogg, aiff).

question_info

String

Optional flag: A unique identifier (generated by your application) for the activity or question this user audio is answering.

Response Example

The API response includes phone_score_list[] : a list of phonemes with it's own quality_score.

Each element within the phone_score_list[] also includes its own quality_score, its extent information indicating its start and end, and additional fields like the actual sound_most_like phone based on the speaker's attempt.

{
  "status": "success",
  "quota_remaining": -1,
  "word_score": {
    "word": "g|ao|ch|ah",
    "quality_score": 97,
    "phone_score_list": [
      {
        "phone": "g",
        "stress_level": null,
        "extent": [
          51,
          60
        ],
        "quality_score": 100,
        "sound_most_like": "g"
      },
      {
        "phone": "ao",
        "stress_level": null,
        "extent": [
          60,
          72
        ],
        "quality_score": 91,
        "sound_most_like": "ao"
      },
      {
        "phone": "ch",
        "stress_level": null,
        "extent": [
          72,
          87
        ],
        "quality_score": 100,
        "sound_most_like": "ch"
      },
      {
        "phone": "ah",
        "stress_level": null,
        "extent": [
          87,
          102
        ],
        "quality_score": 96,
        "sound_most_like": "ah"
      }
    ]
  },
  "version": "9.0"
}

API issued by Speechace.

This is the to be scored. Supported only for en-us and en-gb

Score a Phoneme list
Arpabet notation
region
https://api.speechace.co
https://api.speechace.co/api/scoring/phone_list/v9/json
key
dialect