# iKho 开发者文档

> 全站全文合并版见 /docs/llms-full.txt;每页均有同路径 index.md 镜像。

## 页面
- [平台总览](https://ikho.cn/docs/index.md): 用真实对话数据构建你的产品:服务端的认证、文件上传与转写三组接口与记忆 MCP 现已可用,设备 SDK 与一键安装器仍在规划中。
- [Embedded 总览](https://ikho.cn/docs/embedded/overview/index.md): iKho Embedded 是开发者平台的一部分,面向想把自己的产品与 iKho 录音硬件、转写引擎深度集成的团队。
- [iKho 硬件](https://ikho.cn/docs/embedded/devices/index.md): 为对话型工作打造的录音设备:数据端上加密、由用户决定同步什么、境内存储。
- [快速开始](https://ikho.cn/docs/embedded/quickstart/index.md): iKho Embedded 有两个核心组件:转写 API 现已可用,Embedded SDK 规划中。开通内测账号后可以先从服务端接口开始。
- [工作原理](https://ikho.cn/docs/embedded/how-it-works/index.md): 走一遍完整的 Embedded 集成:从认证、绑定设备、同步音频,到上传与转写,理解 SDK 与各 API 如何拼在一起。
- [安全与合规](https://ikho.cn/docs/embedded/security/index.md): 理解 iKho Embedded 的安全设计:全链路境内处理、端上加密与绑定模型、四类凭证的职责边界、数据保留与删除,以及接入方需要自行承担的用户隐私义务。
- [常见问题](https://ikho.cn/docs/embedded/faq/index.md): 关于 iKho Embedded 当前可用范围、接入与账号、设备与 SDK、转写与数据、计费与商务的常见问题,按主题分组。
- [iOS SDK](https://ikho.cn/docs/embedded/ios-sdk/index.md): iKho Embedded SDK 的 iOS 接口形态设计:扫描并绑定 S1 录音卡、读取设备状态、把录音通过 BLE 或 Wi-Fi 同步到手机。SDK 尚未开放发放。
- [Android SDK](https://ikho.cn/docs/embedded/android-sdk/index.md): Android Embedded SDK 规划中,尚未开放。本页给出 Kotlin 侧的接口形态设计,供合作方评估。
- [认证 API 总览](https://ikho.cn/docs/api-reference/auth/overview/index.md): 接入 iKho Embedded 需要两级令牌:应用级的合作方令牌用于签发用户令牌,用户级的用户令牌用于绑定设备与上传文件。
- [获取合作方令牌](https://ikho.cn/docs/api-reference/auth/get-partner-token/index.md): 用 client_id 与 secret 换取应用级的合作方令牌,后续用它为每位用户签发用户令牌。
- [获取用户令牌](https://ikho.cn/docs/api-reference/auth/get-user-token/index.md): 用合作方令牌为你系统里的某位用户签发用户级令牌,交给 Embedded SDK 与文件上传接口使用。
- [刷新合作方令牌](https://ikho.cn/docs/api-reference/auth/refresh-partner-token/index.md): 用有效的 refresh_token 换取新的合作方访问令牌,应在当前令牌到期前刷新。
- [文件上传 API 总览](https://ikho.cn/docs/api-reference/file/overview/index.md): 把用户在 S1 上录制的音频分片上传到 iKho 存储,合并后拿到下载地址,作为 file_url 交给转写 API。
- [生成预签名上传地址](https://ikho.cn/docs/api-reference/file/generate-presigned-urls/index.md): 按文件大小申请一组分片上传用的预签名地址,每个分片一个地址。
- [合并分片完成上传](https://ikho.cn/docs/api-reference/file/complete-upload/index.md): 提交各分片的 ETag,合并为一个文件,拿到可下载地址 DownloadUrl。
- [转写 API 总览](https://ikho.cn/docs/api-reference/transcription/overview/index.md): 把音频提交给 iKho 转写引擎,异步拿回带说话人与逐句时间戳的结构化逐字稿。
- [提交音频转写](https://ikho.cn/docs/api-reference/transcription/submit/index.md): 提交一段音频发起转写任务,返回 transcription_id 用于轮询结果。
- [查询转写任务](https://ikho.cn/docs/api-reference/transcription/get-task/index.md): 按 transcription_id 查询任务状态与结果。进行中持续轮询,SUCCESS 时 data 就绪。
- [API Playground](https://ikho.cn/docs/embedded/playground/index.md): 认证、上传、转写,三步走完整条管线。演示模式在本地生成 curl 与示例响应,不发网络请求;切到「真实调用」后,各步直接请求 https://ikho.cn/developer/api 线上接口。
- [Starter App 指南](https://ikho.cn/docs/embedded/starter-app-guide/index.md): 起步应用的跑通路径:绑定 S1 录音卡、把录音同步到手机、发起转写并查看逐字稿。SDK 与起步应用仓库尚未开放提供。
- [Starter App 规格](https://ikho.cn/docs/embedded/starter-app-specs/index.md): 起步应用规划的能力清单、架构概览与目录结构。仓库尚未开放提供。
- [Web 应用套壳 iOS](https://ikho.cn/docs/embedded/web-app-wrapper/index.md): 已有 Web 产品上 iOS 的路径设计:用 WKWebView 壳加载你的站点,再原生桥接 Embedded SDK 拿到设备能力。SDK 尚未开放发放。
- [React Native 接入](https://ikho.cn/docs/embedded/react-native/index.md): React Native 桥模块的接口形态设计:在 RN 里复用 Embedded SDK 的设备能力。桥模块尚未开放提供。
- [端到端教程·后端篇](https://ikho.cn/docs/embedded/tutorial-backend/index.md): 不装任何第三方依赖,用 Node.js 20 原生能力从零搭一个合作方后端:缓存并刷新合作方令牌、给 App 签发用户令牌、接收上传回报并驱动转写直到落库。
- [端到端教程·iOS 篇](https://ikho.cn/docs/embedded/tutorial-ios/index.md): 从零创建一个 SwiftUI 应用,完整走通:从你的后端换取用户令牌、绑定 S1 录音卡、同步录音、经你的后端上传转写,最后把逐字稿渲染出来。
- [音频与语言支持](https://ikho.cn/docs/embedded/audio-specs/index.md): iKho 转写引擎支持的音频格式、采样率与声道建议、语言支持矩阵,以及说话人分离与时间戳的能力边界。
- [配额与限流](https://ikho.cn/docs/embedded/limits/index.md): Embedded 各接口的限流维度、限流响应契约与客户端重试策略;内测期具体阈值以联调口径为准。
- [错误码与故障排查](https://ikho.cn/docs/embedded/errors/index.md): iKho Embedded 平台接口的统一错误响应结构、HTTP 状态语义、按 API 分组的错误码,以及带 request_id 的排查流程。
- [版本与兼容性](https://ikho.cn/docs/embedded/versioning/index.md): Embedded SDK 与 API 的版本策略:内测期 0.x 的变更口径、正式开放后的兼容性承诺、废弃流程与系统要求。
- [术语表](https://ikho.cn/docs/embedded/glossary/index.md): 开发者平台文档中反复出现的核心术语,按平台与账号、设备与连接、文件与转写、生态四组归纳,每条附出处页面。
- [计费](https://ikho.cn/docs/embedded/billing/index.md): 内测期只对转写时长计量与拦截,免费额度 300 小时;设备连接数维度与自动结算规划中,正式商用单价以商务合同为准。
- [更新日志](https://ikho.cn/docs/embedded/changelog/index.md): iKho Embedded 内测期已实际发布的变更记录,倒序排列。
- [iKho MCP](https://ikho.cn/docs/mcp-cli/mcp/index.md): 现在可用:把 iKho 的记忆接进兼容 MCP 的 AI 客户端(记忆检索与图谱)。录音与逐字稿类工具、一键安装器与独立域名规划中。
- [iKho CLI](https://ikho.cn/docs/mcp-cli/cli/index.md): 规划中的能力:在终端里浏览、搜索、读取逐字稿、下载音频与查看智能笔记。本页记录命令形态,当前尚未提供可安装的 CLI。
- [数据与安全](https://ikho.cn/docs/mcp-cli/security/index.md): 当前记忆 MCP 的 API Key、读写范围与撤销方式,以及规划中的录音类工具与 CLI 的安全设计。
- [使用范例](https://ikho.cn/docs/mcp-cli/examples/index.md): 12 条中文 prompt 范例,覆盖会议纪要与跟进、检索与回顾、汇总报告、导出与分享四类场景。展示规划中的使用方式。
- [更新日志](https://ikho.cn/docs/mcp-cli/changelog/index.md): 记忆 MCP 的当前能力入口,以及录音类工具、一键安装器与 CLI 的版本记录。规划组件尚无发布记录。
- [联系我们](https://ikho.cn/docs/mcp-cli/contact/index.md): 申请开发者平台内测账号,以及接入过程中的技术支持。

## OpenAPI 规范
- https://ikho.cn/docs/openapi/auth.json
- https://ikho.cn/docs/openapi/file.json
- https://ikho.cn/docs/openapi/transcription.json