跳转到内容
ESP文档

AI服务

接口文档

Section titled “接口文档”

模型列表

Section titled “模型列表”

使用openai兼容的模型列表，可参考：https://developers.openai.com/api/reference/resources/models/methods/list

GET /ai/v1/models

Authorization: Bearer sk-xxxxxxxxx

# 生产环境
curl https://esp.xkw.cn/ai/v1/models \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <ESP API KEY>" \

返回内容

Section titled “返回内容”
{
   "data": [
       {
           "id": "gpt-5.5",
           "object": "generative.model",
           "inputModality": 3
           "outputModality": 1
           "thinking": "hybrid",
           "created": 1777276579,
           "supportOpenAIChatCompletions": true,
           "supportOpenAIResponses": true,
           "supportAnthropicMessages": false,
           "supportOpenAIEmbeddings": false,
           "supportOpenAIImagesGenerations": false,
           "owned_by": "esp"
       },
       {
           "id": "gpt-image-2",
           "object": "generative.model",
           "inputModality": 1
           "outputModality": 2
           "thinking": "disabled",
           "created": 1779328410,
           "supportOpenAIChatCompletions": false,
           "supportOpenAIResponses": false,
           "supportAnthropicMessages": false,
           "supportOpenAIEmbeddings": false,
           "supportOpenAIImagesGenerations": true,
           "owned_by": "esp"
       }
   ],
   "object": "list"
}

字段说明

Section titled “字段说明”
字段描述
id模型名称
object模型分类（text.generative.model：文本生成模型，image.generative.model：图片生成模型，audio.generative.model：音频生成模型，video.generative.model：视频生成模型，text.embedding.model：嵌入模型）
inputModality输入模态（位掩码：文本 = 1 (0001)，图像 = 2 (0010)，音频 = 4 (0100)，视频 = 8 (1000))
outputModality输出模态（位掩码：文本 = 1 (0001)，图像 = 2 (0010)，音频 = 4 (0100)，视频 = 8 (1000))
thinking思考模式（disabled：非思考，enabled：仅思考，hybrid：混合思考）
created创建时间
supportOpenAIChatCompletions是否支持OpenAI的ChatCompletions接口：/v1/chat/completions
supportOpenAIResponses是否支持OpenAI的Responses接口：/v1/responses
supportAnthropicMessages是否支持Anthropic的Messages接口：/v1/messages
supportOpenAIImagesGenerations是否支持OpenAI的ImagesGenerations接口：/v1/images/generations
supportOpenAIEmbeddings是否支持OpenAI的Embeddings接口：/v1/embeddings
owned_by供应商

模型列表

Section titled “模型列表”
分类模型ID
Anthropicclaude-haiku-4-5, claude-opus-4-5-20251101, claude-opus-4-5-20251101-thinking, claude-opus-4-6, claude-opus-4-7, claude-sonnet-4-5-20250929, claude-sonnet-4-5-20250929-thinking, claude-sonnet-4-6
DeepSeekdeepseek-v3.2, deepseek-v4-flash, deepseek-v4-pro
ByteDance (Doubao)doubao-seed-2.0-pro, doubao-seedream-5-0-260128
Googlegemini-3-pro-preview, gemini-3-pro-preview-thinking, gemini-3.1-pro,gemini-3-pro-image-preview
Zhipu AIglm-4.7, glm-5, glm-5-turbo, glm-5.1, glm-5v-turbo
OpenAIgpt-5.3-codex, gpt-5.4, gpt-5.5,gpt-image-2
Moonshot AI (Kimi)kimi-k2.6
MiniMaxminimax-2.7
Alibaba Cloud (Qwen)qwen3-235b-a22b-instruct-2507, qwen3-coder-flash-2025-07-28, qwen3-coder-plus-2025-07-22, qwen3-max, qwen3.5-plus, qwen3.6-flash, qwen3.6-max-preview, qwen3.6-plus

生成模型

Section titled “生成模型”

文本

Section titled “文本”
OpenAI-ChatCompletions
Section titled “OpenAI-ChatCompletions”

使用openai兼容的接口协议，可参考：https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create

POST /ai/v1/chat/completions

Authorization: Bearer sk-xxxxxxxxx

# 生产环境
curl https://esp.xkw.cn/ai/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <ESP API KEY>" \
  -d '{
        "model": "gpt-5.5",
        "messages": [
          {"role": "system", "content": "You are a helpful assistant."},
          {"role": "user", "content": "Hello!"}
        ],
        "stream": false
      }'
OpenAI-Responses
Section titled “OpenAI-Responses”

使用openai新的接口协议，可参考：https://developers.openai.com/api/reference/resources/responses/methods/create

POST /ai/v1/responses

Authorization: Bearer sk-xxxxxxxxx

# 生产环境
curl https://esp.xkw.cn/ai/v1/responses \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <ESP API KEY>" \
  -d '{
      "model": "gpt-5.5",
      "input": [
        {"role": "user", "content": "Hello!"}
      ],
      "stream": true
}'
Anthropic-Messagees
Section titled “Anthropic-Messagees”

使用anthropic的接口协议，可参考：https://platform.claude.com/docs/en/api/java/messages/create

POST /ai/v1/messages

Authorization: Bearer sk-xxxxxxxxx

# 生产环境
curl https://esp.xkw.cn/ai/v1/messages \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <ESP API KEY>" \
  -d '{
      "model": "claude-opus-4-7",
      "messages": [
        { "role": "user", "content": "Hello!" }
      ],
      "stream": true
}'

思考

Section titled “思考”
思考模式
Section titled “思考模式”

模型列表/v1/models接口返回thinking值，思考模式（disabled：非思考，enabled：仅思考，hybrid：混合思考）

  1. disabled：非思考，“深度思考”选项关闭，不可开启；

  2. enabled：仅思考，“深度思考”选项开启，不可关闭；

  3. hybrid：混合思考，“深度思考”选项可以开启/关闭，开启的时候，gpt和claude模型显示“思考强度”选项；

模型接口调用参数
Section titled “模型接口调用参数”

兼容不同的供应商，不同的接口协议

  1. 是否开户思考，参数thinking_type，值为disabled/enabled；

  2. 思考强度，参数thinking_effort， 目前仅gpt和claude模型支持；

    • claude思考强度：low，medium，high，xhigh，max

    • gpt思考强度：low，medium，high，xhigh

gpt-5.5调用例子
Section titled “gpt-5.5调用例子”
# 生产环境
curl https://esp.xkw.cn/ai/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <ESP API KEY>" \
  -d '{
        "model": "gpt-5.5",
        "messages": [
          {"role": "system", "content": "You are a helpful assistant."},
          {"role": "user", "content": "Hello!"}
        ],
        "thinking_type":"enabled",
        "thinking_effort":"high"
        "stream": true
      }'

也可以使用不兼容的，按各自供应商的参数，比如GPT模型，使用reasoning: {“effort”:“high”}

# 生产环境
curl https://esp.xkw.cn/ai/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <ESP API KEY>" \
  -d '{
        "model": "gpt-5.5",
        "messages": [
          {"role": "system", "content": "You are a helpful assistant."},
          {"role": "user", "content": "Hello!"}
        ],
        reasoning: {"effort":"high"}，
        "stream": true
      }'

图片

Section titled “图片”
OpenAI-ImagesGenerations
Section titled “OpenAI-ImagesGenerations”

使用openai新的接口协议，可参考：https://developers.openai.com/api/reference/resources/images/methods/generate

POST /ai/v1/images/generations

Authorization: Bearer sk-xxxxxxxxx

# 生产环境
curl https://esp.xkw.cn/ai/v1/images/generations \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <ESP API KEY>" \
  -d '{
    "model": "gpt-image-2",
    "prompt": "生成..."
  }'

返回的data中图片数组，有url和b64_json格式

图生图，不使用openai的编辑接口/v1/images/edits，直接在文生图的接口中增加参数image，是图片的url数组。

# 生产环境
curl https://esp.xkw.cn/ai/v1/images/generations \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <ESP API KEY>" \
  -d '{
    "model": "gpt-image-2",
    "prompt": "使用这3张图片，生成..."，
    "image": ["https://image1.png","https://image2.png","https://image3.png"]
  }'

嵌入模型

Section titled “嵌入模型”

使用openai兼容的嵌入模型，可参考：https://platform.openai.com/docs/api-reference/embeddings/create

POST /ai/v1/embeddings

Authorization: Bearer sk-xxxxxxxxx

# 生产环境
curl https://esp.xkw.cn/ai/v1/embeddings \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <ESP API KEY>" \
  -d '{
        "model": "text-embedding-v4",
        "input": "You are a helpful assistant.",
        "dimension": "1024",
        "encoding_format": "float"
    }'

秘塔搜索

Section titled “秘塔搜索”

POST /ai/v1/metaso/search

Authorization: Bearer sk-xxxxxxxxx

参数

Section titled “参数”
参数名称描述
q查询内容
scope搜索范围，默认网页：webpage，文库：document，学术：scholar，图片：image，视频：video，播客：podcast
size返回结果数量，默认：10
conciseSnippet是否返回精简的原文匹配信息，默认：false
includeSummary是否通过网页的摘要信息进行召回增强，默认：false
includeRawContent是否抓取所有来源网页原文，默认：false

请求内容

Section titled “请求内容”
{
  "q": "巴浪鱼的营养价值",
  "scope": "webpage",
  "size": 2,
  "conciseSnippet": false,
  "includeSummary": false,
  "includeRawContent": false
}

返回内容

Section titled “返回内容”
{
    "credits": 3,
    "searchParameters": {
        "q": "巴浪鱼的营养价值",
        "scope": "webpage",
        "size": 2,
        "includeSummary": false,
        "includeRawContent": false,
        "conciseSnippet": false,
        "format": "chat_completions"
    },
    "webpages": [
        {
            "title": "巴浪鱼的营养价值探析",
            "link": "https://mobile-phone.taobao.com/baike/k/yingyang_2/768bd00752a916d9e70efb5efc75d6ea.html",
            "score": "high",
            "snippet": "一、富含优质蛋白质和Omega-3脂肪酸\n巴浪鱼，又称鳕鱼或白鱼，是一种深受人们喜爱的海鱼。\n其肉质细腻，含有丰富的蛋白质，每100克巴浪鱼肉就约含20克左右的蛋白质，这对于维持肌肉组织的健康和促进身体修复至关重要。\n同时，Omega-3脂肪酸，特别是DHA和EPA，是大脑发育和眼睛健康的必需营养素，巴浪鱼中的含量相对较高，有助于提高记忆力和视力保健。\n二、维生素与矿物质的宝藏\n巴浪鱼还富含维生素B12，这是一种对神经系统功能至关重要的营养素，对于素食者尤其重要，因为它们通常难以从植物性食物中获取。\n此外， 它还含有适量的钙、磷、铁等矿物质，这些对于骨骼健康、血液携氧能力以及铁元素缺乏导致的贫血有一定的预防作用。",
            "position": 1,
            "date": "2024年09月26日"
        },
        {
            "title": "巴浪鱼的营养和功效",
            "link": "https://www.yilianmeiti.com/article/2318321.html",
            "score": "high",
            "snippet": "巴浪鱼的营养通常是富含蛋白质、含有丰富的不饱和脂肪酸，功效是补充营养、提供能量、促进胃肠蠕动。\n一、营养\n1.富含蛋白质：巴浪鱼的蛋白质含量非常丰富，在每100克鱼肉中约含有20克以上的优质蛋白质。\n这些蛋白质含有人体所需的全部氨基酸，具有很高的生物学价值，能够被身体充分吸收利用。\n2.含有丰富的不饱和脂肪酸：尤其是ω-3多不饱和脂肪酸，对人体有很多益处，包括降低血脂、预防心血管疾病、抗炎抗氧化等。\n此外，ω-3多不饱和脂肪酸还对大脑发育和视力保护有很好的作用。",
            "position": 2,
            "date": "2024年09月02日"
        }
    ],
    "total": 32
}

秘塔简单问答

Section titled “秘塔简单问答”

POST /ai/v1/metaso/chat/completions

Authorization: Bearer sk-xxxxxxxxx

参数

Section titled “参数”
参数名称描述
q查询内容
scope搜索范围，默认网页：webpage，文库：document，学术：scholar，图片：image，视频：video，播客：podcast
model模型，默认极速：fast，极速思考：fast_thinking，长思考R1：ds-r1
conciseSnippet是否返回精简的原文匹配信息，默认：false

请求内容

Section titled “请求内容”
{
  "q": "巴浪鱼的营养价值高不高？仅需回答‘高’或‘不高’",
  "scope": "webpage",
  "model": "fast",
  "conciseSnippet": false
}

返回内容

Section titled “返回内容”
{
    "answer": "高",
    "sources": [
        {
            "title": "巴浪鱼的营养价值",
            "link": "https://m.iask.sina.com.cn/b/new1yGGtGutNDXn.html",
            "summary": "巴浪鱼具有较高的营养价值，能补充蛋白质，有助于补脑益智、祛风除湿、补肾补血。其蛋白质含量丰富，可促进新陈代谢，增强免疫力。同时富含磷脂和硒等微量元素，对预防风湿骨痛、改善肾虚和贫血有积极作用。文中还包含其他 unrelated 内容，如关于开颅手术后生存期的疑问、鹅的高傲表现、整形医院推荐、转轮术解释等，但这些内容与巴浪鱼的营养价值无关，未作深入讨论。",
            "date": "2024年07月28日"
        },
        {
            "title": "巴浪鱼养殖技术大全",
            "link": "http://ask.17house.com/q-378266.html",
            "snippet": "巴浪鱼的营养价值高不高\n- A：巴浪鱼，学名蓝圆鲹，别名又名刺巴鱼、棍子鱼、池鱼、黄占、池仔。\n是鲹科的一种海洋中上层鱼类 ，在我国南海、东海及黄海均有分布 ，尤以南海、东海产量较多。\n这种鱼肌*发达 ，味道鲜美 ，营养丰富，每百克鱼*含蛋白质 22. 7克 ，脂肪 2. 9克 ，是高蛋白且为人体吸收率较高的鱼。\n而且价格还很便宜。",
            "date": "2025年03月08日"
        },
        {
            "title": "核桃的功效与作用 营养价值这么高",
            "link": "http://ask.17house.com/q-402106.html",
            "snippet": "其规格通常为 3mm×3′×7′、 2.7～3 mm×4′×8′。也可根据客户要求按定单进行特殊规格生产。表面色彩鲜艳，品种繁多，深受建筑装饰业和家具*的喜爱。希望我的回答能帮助你。\n巴浪鱼的营养价值高不高\n\n- A：巴浪鱼，学名蓝圆鲹，别名又名刺巴鱼、棍子鱼、池鱼、黄占、池仔。是鲹科的一种海洋中上层鱼类 ，在我国南海、东海及黄海均有分布 ，尤以南海、东海产量较多。这种鱼肌*发达 ，味道鲜美 ，营养丰富，每百克鱼*含蛋白质 22. 7克 ，脂肪 2. 9克 ，是高蛋白且为人体吸收率较高的鱼。",
            "date": "2025年02月23日"
        }
    ],
    "credits": 6
}

腾讯录音文件识别

Section titled “腾讯录音文件识别”

POST /ai/v1/tencent/flash-recognition

Authorization: Bearer sk-xxxxxxxxx

参数

Section titled “参数”
参数名称描述
voiceUrl录音文件地址
engineType引擎模型类型，电话场景：8k_zh：中文电话通用，8k_zh_finance：中文电话金融，8k_en：英文电话通用。非电话场景：16k_zh：中文通用，16k_zh-PY：中英粤，16k_zh-TW：中文繁体，16k_zh_edu：中文教育，16k_zh_medical：中文医疗，16k_zh_court：中文法庭
voiceFormat语音编码方式，可选，默认值为4。1：pcm；4：speex(sp)；6：silk；8：mp3；10：opus（opus 格式音频流封装说明）；12：wav；14：m4a（每个分片须是一个完整的 m4a 音频）；16：aac
speakerDiarization话者分离，0-关闭，1-开启，默认：0
hotwordList临时热词表：该参数用于提升识别准确率。

请求内容

Section titled “请求内容”
{
    "voiceUrl": "https://oss-dataoper-repo.oss-cn-hangzhou.aliyuncs.com/call-log/20210112/0026606b-65ac-40e3-8d34-6c5fbb9ac600.mp3?x-oss-credential=LTAI4Fo68Hmv3cCMPMWr6zKD%2F20251028%2Fcn-hangzhou%2Foss%2Faliyun_v4_request&x-oss-date=20251028T030250Z&x-oss-expires=3600&x-oss-signature-version=OSS4-HMAC-SHA256&x-oss-signature=ef01281389244b85d5d9c8cff3a18cb88ff6215aa08e048af1da25a08204a357",
    "engineType": "8k_zh_large",
    "voiceFormat": "mp3"
}

返回内容

Section titled “返回内容”
{
    "request_id": "69003262aa5fe609eb0b04b0",
    "code": 0,
    "message": "",
    "audio_duration": 197939,
    "flash_result": [
        {
            "text": "喂你好喂喂，哎你好你好你好，是马主任吗。哎，你刚打电话了，对对对你好，那马主任这样呃，我这边这个贝壳资源网站的学科网胡瑞胜，然后那个早上客服这边有申请您一个这个在线呃，想体验一下学科网的是吧。啊，那个学科网，我们学校这有有那个账户了，嗯，诶那个您是在山东这边吗。啊，山东这边那个，咱们不是那个还没有合作吗？您的账号是您。所用的那个用个人账号是吧。啊个人账户啊啊用的那个个人账号，您看您用的个人账号呢，那那个平时肯定也有遇到一些这个像那个储值啊，精品啊，或者是高起点啊，这这个这个高起点啊这方面。都是需要充值去用的吗？啊嗯，对，您看您这方面就是要去充值。充值去用的，呃您看呃听您这么说，您应该对我们学科网也是挺了解的。呃，我们那个我们您看这么多老师，您这个老师充值用那个老师充值用一年下来也是要不少钱呢。我们也是看看那个学校老师在认可的基础上，能否这个做一个长期资源一个考虑呢，马主任。那个，你们那个会员多少钱一年？呃，一年的话，咱们是那个初中和高中是都有是吧？啊嗯，咱们是完中学校，完中学校呢，这个相对价格这个可能要高一些。呃，我们的这个包年服务原价的话，呃39800，现在做的优惠应该是在两万五左右一年。啊，对对对对，但是做多年期的话，呃，优惠要更多一些。做多年期，单独资源这方面，呃，3年也就在5万块钱。啊对对对对，那我先了解一下，我下来问一下学校，看怎么看有没有这样方面的那个啊。比这个这个我们学校有那个学科网的那个那个账户了，我先查一下吧，这个没有没有没有，我们学校没有合作。啊，嗯，我们学校没有合作这方面，这个今年教学这边也是您在负责吗，马主任？呃，我没有负责，我只是个人想用一下，所以就。所以申请一下啊，就是个人在再再用一下，那那个您这样呢，那个那个马主任近期的话，您看学校有没有相关行政会，呃您跟领导咱们那个提一下呢，新学期这个也不像说，呃今年也不像说去年这个年底由于一些经费紧张还是怎么样呢。近年这个经费应该也拨下来了。呃，行行，我现在再再考虑再看啊嗯，行行，那这样那那个方便加您一下微信吗，马主任。呃，行啊，你加吧这个电话号码嗯，好的好的好的好的，我稍后加您一下这个加您一下微信，然后刚刚那个报价，我给您做一份详细的报价方案，给您做一个电子档的发给您。嗯嗯，诶好的好的，那麻烦您费心了马主任。嗯诶诶好再见，诶冯主任好再见，嗯好。",
            "channel_id": 0,
            "sentence_list": [
                {
                    "text": "喂你好喂喂，哎你好你好你好，是马主任吗。",
                    "start_time": 540,
                    "end_time": 5230,
                    "speaker_id": 0,
                    "word_list": null
                },
                {
                    "text": "哎，你刚打电话了，对对对你好，那马主任这样呃，我这边这个贝壳资源网站的学科网胡瑞胜，然后那个早上客服这边有申请您一个这个在线呃，想体验一下学科网的是吧。",
                    "start_time": 6520,
                    "end_time": 20110,
                    "speaker_id": 0,
                    "word_list": null
                }
            ]
        }
    ]
}

腾讯实时语音识别

Section titled “腾讯实时语音识别”

使用 websocket进行对接。

生产环境：wss://esp.xkw.cn/ai/ws/v1/tencent/asr?engineModelType=xxx&voiceFormat=xxx

验收环境：wss://uat-esp.xkw.cn/ai/ws/v1/tencent/asr?engineModelType=xxx&voiceFormat=xxx

测试环境：wss://test-esp.xkw.cn/ai/ws/v1/tencent/asr?engineModelType=xxx&voiceFormat=xxx

开发环境：wss://dev-esp.xkw.cn/ai/ws/v1/tencent/asr?engineModelType=xxx&voiceFormat=xxx

请求头

Section titled “请求头”

将密钥放在请求头中。

Authorization: Bearer sk-xxxxxxxxx

参数

Section titled “参数”
参数名称描述
engineType引擎模型类型，电话场景：8k_zh：中文电话通用，8k_zh_finance：中文电话金融，8k_en：英文电话通用。非电话场景：16k_zh：中文通用，16k_zh-PY：中英粤，16k_zh-TW：中文繁体，16k_zh_edu：中文教育，16k_zh_medical：中文医疗，16k_zh_court：中文法庭
voiceFormat语音编码方式，可选，默认值为4。1：pcm；4：speex(sp)；6：silk；8：mp3；10：opus（opus 格式音频流封装说明）；12：wav；14：m4a（每个分片须是一个完整的 m4a 音频）；16：aac

例如生产环境：

wss://esp.xkw.cn/ai/ws/v1/tencent/asr?engineModelType=16k_zh&voiceFormat=10

豆包录音文件识别

Section titled “豆包录音文件识别”

POST /ai/v1/doubao/flash-recognize

Authorization: Bearer sk-xxxxxxxxx

参数

Section titled “参数”
参数名称描述
voiceUrl录音文件地址
engineTypevolc.bigasr.auc_turbo
voiceFormatraw / wav / mp3 / ogg
speakerDiarization话者分离，0-关闭，1-开启，默认：0
hotwordList临时热词表：该参数用于提升识别准确率。

请求内容

Section titled “请求内容”
{
    "voiceUrl": "https://oss-dataoper-dev.oss-cn-hangzhou.aliyuncs.com/call-log/20241112/3a63d1d3-77db-4fb2-94ff-a84b3c7ecb69.mp3?OSSAccessKeyId=LTAI5tLsR7t7SwiuXAraMK84&Expires=1777361142&Signature=MvXFrTjz1natm3qXPYOzG1vUomc%3D",
    "engineType": "volc.bigasr.auc_turbo",
    "voiceFormat": "mp3"
}

返回内容

Section titled “返回内容”
{
  "audio_info": {
    "duration": 2499
  },
  "result": {
    "additions": {
      "duration": "2499"
    },
    "text": "关闭透传。",
    "utterances": [
      {
        "end_time": 1530,
        "start_time": 450,
        "text": "关闭透传。",
        "words": [
          {
            "confidence": 0,
            "end_time": 770,
            "start_time": 450,
            "text": "关"
          },
          {
            "confidence": 0,
            "end_time": 970,
            "start_time": 770,
            "text": "闭"
          },
          {
            "confidence": 0,
            "end_time": 1210,
            "start_time": 1130,
            "text": "透"
          },
          {
            "confidence": 0,
            "end_time": 1530,
            "start_time": 1490,
            "text": "传"
          }
        ]
      }
    ]
  }
}

豆包实时语音识别

Section titled “豆包实时语音识别”

使用 websocket进行对接。

地址

Section titled “地址”

生产环境：wss://esp.xkw.cn/ai/ws/v1/forward/doubao-asr?language=zh-CN&format=wav

验收环境：wss://uat-esp.xkw.cn/ai/ws/v1/forward/doubao-asr?language=zh-CN&format=wav

测试环境：wss://test-esp.xkw.cn/ai/ws/v1/forward/doubao-asr?language=zh-CN&format=wav

开发环境：wss://dev-esp.xkw.cn/ai/ws/v1/forward/doubao-asr?language=zh-CN&format=wav

请求头

Section titled “请求头”

将密钥放在请求头中。

Authorization: Bearer sk-xxxxxxxxx

参数

Section titled “参数”
参数名称描述
language指定可识别的语言，当该键为空时，该模型支持中英文、上海话、闽南语，四川、陕西、粤语识别。当将其设置为下方特定键时，它可以识别指定语言。中文普通话 zh-CN，英语：en-US，日语：ja-JP，印尼语：id-ID，西班牙语：es-MX，葡萄牙语：pt-BR，德语：de-DE，法语：fr-FR，韩语：ko-KR，菲律宾语：fil-PH，马来语：ms-MY，泰语：th-TH，阿拉伯语 ar-SA，意大利语 it-IT，孟加拉语 bn-BD，希腊语 el-GR，荷兰语 nl-NL，俄语 ru-RU，土耳其语 tr-TR，越南语 vi-VN，波兰语 pl-PL，罗马尼亚语 ro-RO，尼泊尔语 ne-NP，乌克兰语 uk-UA，粤语 yue-CN
format音频容器格式，pcm / wav / ogg / mp3

例如生产环境：

wss://esp.xkw.cn/ai/ws/v1/forward/doubao-asr?language=zh-CN&format=wav

豆包实时语音合成

Section titled “豆包实时语音合成”

使用 websocket进行对接

地址

Section titled “地址”

生产环境：wss://esp.xkw.cn/ai/ws/v1/forward/doubao-tts?text=我要语音合成&voice=zh_female_vv_uranus_bigtts&encoding=mp3

验收环境：wss://uat-esp.xkw.cn/ai/ws/v1/forward/doubao-tts?text=我要语音合成&voice=zh_female_vv_uranus_bigtts&encoding=mp3

测试环境：wss://test-esp.xkw.cn/ai/ws/v1/forward/doubao-tts?text=我要语音合成&voice=zh_female_vv_uranus_bigtts&encoding=mp3

开发环境：wss://dev-esp.xkw.cn/ai/ws/v1/forward/doubao-tts?text=我要语音合成&voice=zh_female_vv_uranus_bigtts&encoding=mp3

请求头

Section titled “请求头”

将密钥放在请求头中。

Authorization: Bearer sk-xxxxxxxxx

参数

Section titled “参数”
参数名称描述
voice音色 zh_female_vv_uranus_bigtts
encoding音频容器格式，pcm / wav / ogg / mp3
text文本

例如生产环境：

wss://esp.xkw.cn/ai/ws/v1/forward/doubao-tts?text=我要语音合成&voice=zh_female_vv_uranus_bigtts&encoding=mp3

交互

Section titled “交互”

连接建立后客户端发送START_SSEION 触发时机 onopen回调

{
  "eventType": "100",
  "sessionId": "550e8400-e29b-41d4-a716-446655440000"
}

等待确认消息STARTED_SESSION

{
  "eventType": "150",
  "sessionId": "550e8400-e29b-41d4-a716-446655440000"
}

发送文本 TASK_REQUEST

{
  "eventType": "200",
  "sessionId": "550e8400-e29b-41d4-a716-446655440000",
  "text": "你"
}

发送完成FINISH_SESSION

{
  "eventType": "102",
  "sessionId": "550e8400-e29b-41d4-a716-446655440000",
}

服务器端返回SESSION_FINISHED

{
  "eventType": "152",
  "sessionId": "550e8400-e29b-41d4-a716-446655440000",
}