Stream speech as it's made

POST

/api/v1/audio/stream

Up to 12,000 characters per request (text up to 200,000). A documentId also needs documents:read.

App integration: Read the binary audio stream, not JSON. Submit text or documentId, never both. Continue at Handwrite-Next-Offset until the header is absent. Offsets are UTF-16 units. Aborting playback is not a guarantee that already generated audio will be uncharged.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

OAuth 2.0

Authorization Code

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Authorize URL: https://handwrites.io/oauth/authorize

Token URL: https://handwrites.io/api/oauth/token

Refresh URL: https://handwrites.io/api/oauth/token

Scopes:

audio:read-Stream and fetch spoken audio (uses your monthly characters)

Body Params application/jsonRequired

Examples

Responses

🟢200

audio/mpeg

Chunked audio.

Headers

🟠400BadRequest

🟠401Unauthorized

🟠403Forbidden

🟠404NotFound

🟠429TooManyRequests

🔴500ServerError

🔴502BadGateway

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/v1/audio/stream' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "text": "string",
    "documentId": "string",
    "voice": "string",
    "format": "mp3",
    "model": "string",
    "language": "en",
    "offset": 0
}'

Response Example

400 - Example 1

{
    "error": {
        "code": "string",
        "message": "string"
    }
}

Modified at 2026-10-26 12:58:15

The whole document as one audio file

Speech with word timings (read-along)