Updated on 2025-09-12 GMT+08:00

API Overview

SIS supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details, see Table 1.

Table 1 RESTful API functions

API

Function

API URI

Short Sentence Recognition

Short Sentence Recognition

POST /v1/{project_id}/asr/short-audio

Hot Word Management

Hot Word Management APIs

Create a hot word table: POST /v1/{project_id}/asr/vocabularies

Update a hot word table: PUT /v1/{project_id}/asr/vocabularies/{vocabulary_id}

Query a hot word table: GET /v1/{project_id}/asr/vocabularies/{vocabulary_id}

Delete a hot word table: DELETE /v1/{project_id}/asr/vocabularies/{vocabulary_id}

Query a hot word table list: GET /v1/{project_id}/asr/vocabularies

Table 2 WebSocket API functions

API

Function

API URI

RASR (Request)

Starting Recognition

The following three request modes are supported:

  • Streaming

    WSS /v1/{project_id}/rasr/short-stream

  • Continuous

    WSS /v1/{project_id}/rasr/continue-stream

  • Single-Sentence

    WSS /v1/{project_id}/rasr/sentence-stream

Sending Audio Data

Ending Recognition

Real-Time TTS (Request)

WebSocket Handshake Requests

WSS /v1/{project_id}/rtts