Skip to main content

Scripted API

The Scripted API enables pronunciation and fluency assessment using different audio submission methods. Below are the available endpoints categorized by functionality.

Scripted V2 (Legacy)​

Single-word/sentence assessment - Upload via File​

  • This endpoint allows you to upload an audio file for assessment.
  • The API processes the file and returns a pronunciation and fluency score.

Includes:

  • Audio file submission via multipart/form-data
  • Synchronous processing and scoring
  • JSON response with structured evaluation

Single-word/sentence assessment - Upload via File Path​

  • This endpoint supports an audio file submission via a remote URL.
  • The API retrieves the file and performs an assessment.

Includes:

  • Submission of a remote audio file (URL-based)
  • Pronunciation & fluency scoring
  • JSON structured response

Single-word/sentence assessment - Upload via Data Stream​

  • This endpoint allows direct audio data submission via Base64 encoding.
  • Useful when file uploads are not feasible.

Includes:

  • Base64-encoded audio submission
  • Real-time assessment and scoring
  • JSON response with structured feedback

Scripted V3 (Latest Version)​

Single-word/sentence assessment - Upload via Data Stream​

  • The latest version with enhanced assessment accuracy and faster processing.
  • Supports direct Base64-encoded audio submission.

Includes:

  • Base64-encoded audio data processing
  • More accurate scoring system
  • Improved response time

Single-word/sentence assessment - Upload via File​

  • This endpoint processes locally uploaded audio files for scoring.
  • Ideal for assessing pronunciation, fluency, and accuracy.

Includes:

  • Audio file submission (MP3, WAV)
  • Pronunciation accuracy scoring
  • JSON response with structured results

Single-word/sentence assessment - Upload via File Path​

  • Enables assessment for remotely hosted audio files via a URL.
  • API fetches and evaluates the file.

Includes:

  • Submission via an Amazon S3 URL or other cloud storage
  • Advanced fluency analysis
  • JSON response with structured evaluation