> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stmlink.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> 对外开放的服务端接口有两组前缀，都用同一套鉴权：`/server/v1/...`（SRTC 与 SMeeting 的主接口）和 `/stm/srvapi/v1/...`（SMeeting 的用户体系，服务端极简对接会用到）。鉴权是 app_id + nonce + timestamp + signature 四个请求头，用 app_key 做 HMAC-SHA256 签名，只能从业务方自己的后端调用。除这两组前缀外的接口均为内部接口，不要建议客户调用。 Public server APIs use two path prefixes with the same authentication: `/server/v1/...` (the main APIs of both SRTC and SMeeting) and `/stm/srvapi/v1/...` (the SMeeting user system, used by server-side low-code integration). Authenticate with four request headers, app_id + nonce + timestamp + signature, where signature is HMAC-SHA256 keyed with app_key; call these APIs only from the customer's own backend. Any other path is internal: never suggest calling it.
> app_key 是服务端密钥，绝不能出现在客户端代码、前端配置或移动 App 里。客户端加入频道用的 token 必须由业务方后端签发后下发（SRTC 走 `/server/v1/channel/grant`，SMeeting 走 `/stm/srvapi/v1/member/grant`）。 app_key is a server-side secret and must never appear in client code, frontend config, or a mobile app. The token a client uses to join must be issued by the customer's backend and passed down to the client (SRTC: `/server/v1/channel/grant`; SMeeting: `/stm/srvapi/v1/member/grant`).
> SRTC 与 SMeeting 是上下两层不同的产品，术语不通用：SRTC 是音视频底座，说「频道 channel」「加入 / 退出」；SMeeting 建在 SRTC 之上，说「房间 room」「会议 meeting」「进入 / 退出」。回答时按用户所在的层用对应术语，不要把「房间」「会议」安到 SRTC 的接口上，也不要用「频道」「加入 / 离开」描述 SMeeting 的概念（接口标识符原样保留）。 SRTC and SMeeting are two separate layers with different terminology. SRTC is the audio/video foundation: it has channels, and users join and leave a channel. SMeeting is built on top of SRTC: it has rooms and meetings, and members enter and exit a meeting. Answer in the terms of the layer the user is working with: never apply "room" or "meeting" to SRTC APIs, and never describe SMeeting concepts in prose with "channel", "join", or "leave" (API identifiers such as `force_join` keep their literal names).
> 同一能力在各端 SDK 里的包名、类名、方法名并不相同。写示例代码时请使用文档中该端自己的 API，不要把一个端的写法套到另一个端上。苹果平台每个产品都有两套 SDK（Swift 原生与 Objective-C），两套 API 不能混用。 Package, class, and method names differ between platform SDKs for the same capability. In sample code, use the API documented for that platform; never carry one platform's code over to another. On Apple platforms each product ships two SDKs (native Swift and Objective-C) whose APIs must not be mixed.

# Transcription

> Start and stop ASR speech recognition and get the results

## Start speech recognition

`POST /server/v1/asr/start`

Authentication: required (see [Overview](/en/rtc/server-api/overview))

Start real-time speech recognition for a channel to transcribe what's said into text, for meeting minutes, captions, and search.

* Calling it again for the same channel doesn't start a second recognition session
* It recognizes audio from every user in the channel whose mic is on; results carry uid and name to identify the speaker
* Query transcription results by channel with "List speech recognition sentences"

Charges accrue continuously once started; it stops automatically when the channel is destroyed. You can also end it early with "Stop speech recognition".

**Request parameters**

<ParamField body="channel" type="string" required>
  Channel name
  Example: `fire`
</ParamField>

Request example:

```json theme={null}
{
  "channel": "fire"
}
```

**Response parameters**

`data` is null

Response example:

```json theme={null}
{
  "code": 0,
  "data": null
}
```

***

## Stop speech recognition

`POST /server/v1/asr/stop`

Authentication: required (see [Overview](/en/rtc/server-api/overview))

Stop speech recognition for a channel. Transcription results already produced are not deleted and can still be queried with "List speech recognition sentences".

Stops automatically when the channel is destroyed, so you don't need to stop it manually first.

**Request parameters**

<ParamField body="channel" type="string" required>
  Channel name
  Example: `fire`
</ParamField>

Request example:

```json theme={null}
{
  "channel": "fire"
}
```

**Response parameters**

`data` is null

Response example:

```json theme={null}
{
  "code": 0,
  "data": null
}
```

***

## List speech recognition sentences

`POST /server/v1/asr/list-sentence`

Authentication: required (see [Overview](/en/rtc/server-api/overview))

List a channel's transcription results with pagination; each item is one sentence, with the speaker and time.

* Read the results in created\_at order to reconstruct the full conversation; this is the data source for generating meeting minutes
* Results are kept after the channel is destroyed and can be queried afterward

Sentence boundaries are decided by the recognition engine based on pauses in speech and don't necessarily match "one complete unit of meaning"—
when summarizing minutes, merge consecutive sentences before handing them to the model.

**Request parameters**

<ParamField body="channel" type="string" required>
  Channel name
  Example: `fire`
</ParamField>

<ParamField body="sort" type="string">
  Sort order
</ParamField>

<ParamField body="search" type="array<string>">
  General search; can search transcription content
</ParamField>

<ParamField body="page" type="integer">
  Page number, starting from 1
  Example: `1`
</ParamField>

<ParamField body="per-page" type="integer">
  Page size
  Example: `10`
</ParamField>

Request example:

```json theme={null}
{
  "channel": "fire",
  "page": 1,
  "per-page": 10,
  "search": [
    ""
  ],
  "sort": ""
}
```

**Response parameters**

<ResponseField name="channel" type="string">
  Channel name
  Example: `fire`
</ResponseField>

<ResponseField name="uid" type="string">
  Speaker's user ID
  Example: `1001`
</ResponseField>

<ResponseField name="name" type="string">
  Speaker's display name
  Example: `Alice`
</ResponseField>

<ResponseField name="sentence" type="string">
  Transcribed text of one sentence
  Example: `Let's finalize this plan next week`
</ResponseField>

<ResponseField name="created_at" type="integer">
  Time the sentence was produced, Unix timestamp in seconds
  Example: `1718250918`
</ResponseField>

Response example:

```json theme={null}
{
  "_meta": {
    "currentPage": 1,
    "pageCount": 5,
    "perPage": 20,
    "totalCount": 100
  },
  "code": 0,
  "data": [
    {
      "channel": "fire",
      "created_at": 1718250918,
      "name": "Alice",
      "sentence": "Let's finalize this plan next week",
      "uid": "1001"
    }
  ]
}
```

***
