API Reference

Interpretation WebSocket

Simultaneous interpretation over Protobuf binary WebSocket frames.

GET https://api.tu-zi.com/v1/realtime?model={model}

Preview guide

Paste into an AI assistant to help with integration. Documentation and examples only; no real credentials.

# Interpretation WebSocket

Simultaneous interpretation over Protobuf binary WebSocket frames.

## Endpoint and authentication

`GET https://api.tu-zi.com/v1/realtime?model={model}`

Transport: websocket

Use an inference API key. Examples contain placeholders; read credentials from environment variables.

```http
Authorization: Bearer YOUR_API_KEY
```

## Query parameters

| Field | Type | Required | Description / constraints |
| --- | --- | --- | --- |
| model | string | Yes | Exact model name in the URL query. |

## Body parameters

| Field | Type | Required | Description / constraints |
| --- | --- | --- | --- |
| request_meta.session_id | string | Yes | Session UUID. |
| event | integer | Yes | AST session events; 100 starts the session. |
| source_audio | object | Yes | Input audio settings: 16 kHz mono 16-bit PCM. |
| request | object | Yes | s2t/s2s mode and source/target languages. |

## Minimal request example

```json
{
  "request_meta": {
    "session_id": "YOUR_SESSION_UUID"
  },
  "event": 100,
  "source_audio": {
    "format": "wav",
    "rate": 16000,
    "bits": 16,
    "channel": 1
  },
  "request": {
    "mode": "s2t",
    "source_language": "zh",
    "target_language": "en"
  }
}
```

## Before running

Replace https://api.tu-zi.com with this site origin (do not append /v1 twice), and YOUR_MODEL with the exact marketplace model ID. Install requests for Python; use Node.js 20+ and save JavaScript as .mjs. WebSocket samples list their own dependencies.

Create an inference key on the site and set API_KEY in the environment; replace YOUR_API_KEY in cURL. Prepare local input.png/input.wav files for upload examples.

Start with a minimal request, then read the result using the response fields below. For async APIs, a returned task ID requires polling; acceptance does not mean generation has finished.

## Code examples

### curl

```bash
# Requires a Protobuf WebSocket client. Download the official AST demo and replace its URL and headers with the values below.
```

### python

```python
# pip install "websockets>=14" "protobuf>=6.31.1"
# Copy python_protogen/ from the official AST Python demo beside this script.
import asyncio, os, uuid, wave
from websockets.asyncio.client import connect
from python_protogen.products.understanding.ast.ast_service_pb2 import TranslateRequest, TranslateResponse

async def main():
    async with connect("wss://api.tu-zi.com/v1/realtime?model=YOUR_MODEL", additional_headers={
        "Authorization": "Bearer " + os.environ["API_KEY"]
    }, max_size=2**21, open_timeout=15) as ws:
        sid = str(uuid.uuid4())
        req = TranslateRequest(event=100)
        req.request_meta.SessionID = sid
        req.source_audio.format = "wav"
        req.source_audio.rate, req.source_audio.bits, req.source_audio.channel = 16000, 16, 1
        req.request.mode, req.request.source_language, req.request.target_language = "s2t", "zh", "en"
        await ws.send(req.SerializeToString())
        async def send_audio():
            with wave.open("input.wav", "rb") as audio:
                assert (audio.getframerate(), audio.getnchannels(), audio.getsampwidth()) == (16000, 1, 2)
                while chunk := audio.readframes(1280):
                    req = TranslateRequest(event=200)
                    req.source_audio.binary_data = chunk
                    await ws.send(req.SerializeToString())
                    await asyncio.sleep(0.08)
            await ws.send(TranslateRequest(event=102).SerializeToString())
        sender = None
        try:
            async for frame in ws:
                event = TranslateResponse.FromString(frame)
                if event.event == 150: sender = asyncio.create_task(send_audio())
                if event.text: print(event.event, event.text)
                if event.event == 154: print(event.response_meta.Billing)
                if event.event in (152, 153): break
        finally:
            if sender:
                sender.cancel()
                await asyncio.gather(sender, return_exceptions=True)

asyncio.run(main())
```

### javascript

```javascript
// Use the official Go/Python AST Protobuf demo or protobufjs.
// URL: wss://api.tu-zi.com/v1/realtime?model=YOUR_MODEL
// Authorization: Bearer YOUR_API_KEY
// Send TranslateRequest as binary; wait for event 150 before audio, finish with event 102.
// See the complete Python example.
```

## Response fields

| Field | Type | Description / constraints |
| --- | --- | --- |
| event | integer | AST response event type. |
| text | string | Caption content when emitted. |
| data | binary | Audio bytes when emitted. |

## Streaming

The JSON illustrates Protobuf message content; do not send JSON text directly over WebSocket. Use a client generated from the official AST .proto files; the model quick start provides a Python example.

## Errors and retries

Check HTTP status and protocol-specific errors; do not mix error formats across protocols. For 401/403 check credentials and permissions, for 429 back off, and for 5xx check gateway/upstream status. Error bodies may contain error/message/code depending on the protocol.

Use bounded exponential backoff for reads. Do not blindly retry task creation, generation, or key mutations, to avoid duplicate billing or execution.

## Constraints

This page describes the base protocol. Use the selected model quick start for supported fields, enums, limits and asynchronous behavior. Replace YOUR_MODEL. Form initial values are not upstream defaults.

## Documentation source

Definition version: 1

Reviewed: 2026-11-02

Source: https://api.tu-zi.com/en/docs/api/reference-relay-seed-interpretation

Related protocol guide: https://api.tu-zi.com/docs/api/audio-realtime

This export contains documentation and examples only, without real credentials, account data or user requests.

Updated 2026-11-02 · Reviewed 2026-11-02

Endpoint and authentication

GET https://api.tu-zi.com/v1/realtime?model={model}

Transport: websocket

Use an inference API key. Examples contain placeholders; read credentials from environment variables.

Authorization: Bearer YOUR_API_KEY

Minimal request example

{
  "request_meta": {
    "session_id": "YOUR_SESSION_UUID"
  },
  "event": 100,
  "source_audio": {
    "format": "wav",
    "rate": 16000,
    "bits": 16,
    "channel": 1
  },
  "request": {
    "mode": "s2t",
    "source_language": "zh",
    "target_language": "en"
  }
}

Before running

Replace https://api.tu-zi.com with this site origin (do not append /v1 twice), and YOUR_MODEL with the exact marketplace model ID. Install requests for Python; use Node.js 20+ and save JavaScript as .mjs. WebSocket samples list their own dependencies.

Create an inference key on the site and set API_KEY in the environment; replace YOUR_API_KEY in cURL. Prepare local input.png/input.wav files for upload examples.

Start with a minimal request, then read the result using the response fields below. For async APIs, a returned task ID requires polling; acceptance does not mean generation has finished.

Constraints

This page describes the base protocol. Use the selected model quick start for supported fields, enums, limits and asynchronous behavior. Replace YOUR_MODEL. Form initial values are not upstream defaults.

Query parameters

Field	Type	Required	Description / constraints
model	string	Yes	Exact model name in the URL query.

Body parameters

Field	Type	Required	Description / constraints
request_meta.session_id	string	Yes	Session UUID.
event	integer	Yes	AST session events; 100 starts the session.
source_audio	object	Yes	Input audio settings: 16 kHz mono 16-bit PCM.
request	object	Yes	s2t/s2s mode and source/target languages.

Response fields

Field	Type	Description / constraints
event	integer	AST response event type.
text	string	Caption content when emitted.
data	binary	Audio bytes when emitted.

Streaming

The JSON illustrates Protobuf message content; do not send JSON text directly over WebSocket. Use a client generated from the official AST .proto files; the model quick start provides a Python example.

Errors and retries

Check HTTP status and protocol-specific errors; do not mix error formats across protocols. For 401/403 check credentials and permissions, for 429 back off, and for 5xx check gateway/upstream status. Error bodies may contain error/message/code depending on the protocol.

Use bounded exponential backoff for reads. Do not blindly retry task creation, generation, or key mutations, to avoid duplicate billing or execution.

Document information and sources

Documentation source

Definition version: 1

Reviewed: 2026-11-02

Source: https://api.tu-zi.com/en/docs/api/reference-relay-seed-interpretation

Related protocol guide: https://api.tu-zi.com/docs/api/audio-realtime

This export contains documentation and examples only, without real credentials, account data or user requests.

Request examples

# Requires a Protobuf WebSocket client. Download the official AST demo and replace its URL and headers with the values below.

# pip install "websockets>=14" "protobuf>=6.31.1"
# Copy python_protogen/ from the official AST Python demo beside this script.
import asyncio, os, uuid, wave
from websockets.asyncio.client import connect
from python_protogen.products.understanding.ast.ast_service_pb2 import TranslateRequest, TranslateResponse

async def main():
    async with connect("wss://api.tu-zi.com/v1/realtime?model=YOUR_MODEL", additional_headers={
        "Authorization": "Bearer " + os.environ["API_KEY"]
    }, max_size=2**21, open_timeout=15) as ws:
        sid = str(uuid.uuid4())
        req = TranslateRequest(event=100)
        req.request_meta.SessionID = sid
        req.source_audio.format = "wav"
        req.source_audio.rate, req.source_audio.bits, req.source_audio.channel = 16000, 16, 1
        req.request.mode, req.request.source_language, req.request.target_language = "s2t", "zh", "en"
        await ws.send(req.SerializeToString())
        async def send_audio():
            with wave.open("input.wav", "rb") as audio:
                assert (audio.getframerate(), audio.getnchannels(), audio.getsampwidth()) == (16000, 1, 2)
                while chunk := audio.readframes(1280):
                    req = TranslateRequest(event=200)
                    req.source_audio.binary_data = chunk
                    await ws.send(req.SerializeToString())
                    await asyncio.sleep(0.08)
            await ws.send(TranslateRequest(event=102).SerializeToString())
        sender = None
        try:
            async for frame in ws:
                event = TranslateResponse.FromString(frame)
                if event.event == 150: sender = asyncio.create_task(send_audio())
                if event.text: print(event.event, event.text)
                if event.event == 154: print(event.response_meta.Billing)
                if event.event in (152, 153): break
        finally:
            if sender:
                sender.cancel()
                await asyncio.gather(sender, return_exceptions=True)

asyncio.run(main())

// Use the official Go/Python AST Protobuf demo or protobufjs.
// URL: wss://api.tu-zi.com/v1/realtime?model=YOUR_MODEL
// Authorization: Bearer YOUR_API_KEY
// Send TranslateRequest as binary; wait for event 150 before audio, finish with event 102.
// See the complete Python example.