豆包 API(火山方舟)
  1. 对话(Chat) API
豆包 API(火山方舟)
  • 快速入门-调用模型服务
  • 介绍
    • 签名鉴权方式
    • 返回结构
    • 公共错误码
    • API 列表
    • 地域和访问域名
  • 对话(Chat) API
    • 对话(Chat)-文本 API
      POST
    • 对话(Chat)-视觉 API
      POST
  • 视频生成 API
    • 创建视频生成任务 API
      POST
    • 查询视频生成任务信息 API
      GET
    • 查询内容生成任务列表 API
      GET
    • 取消或删除内容生成任务
      DELETE
  • 向量化 API
    • 文本向量化 API
      POST
    • 未命名接口
      POST
  1. 对话(Chat) API

对话(Chat)-文本 API

POST
https://ark.cn-beijing.volces.com/api/v3/chat/completions
本文介绍Doubao语言大模型API的输入输出参数,供您使用接口向大模型发起文字对话请求时查阅字段含义。您如果希望查看接口使用示例以及使用说明,可以参考教程文本生成。
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://ark.cn-beijing.volces.com/api/v3/chat/completions' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "model": "doubao-pro-32k-240615",
    "messages": [
        {
            "role": "system",
            "content": "You are a helpful assistant."
        },
        {
            "role": "user",
            "content": "Hello!"
        }
    ]
  }'
响应示例响应示例
{
    "id": "021718067849899d92fcbe0865fdffdde********************",
    "object": "chat.completion",
    "created": 1720582714,
    "model": "doubao-pro-32k-240615",
    "choices": [{
        "index": 0,
        "message": {
            "role": "assistant",
            "content": "Hello, can i help you with something?"
        },
        "logprobs": null,
        "finish_reason": "stop"
    }],
    "usage": {
        "prompt_tokens": 22,
        "completion_tokens": 9,
        "total_tokens": 31,
        "prompt_tokens_details": {
            "cached_tokens": 0
        }
    }
}

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token
示例:
Authorization: Bearer ********************
Header 参数
Content-Type
string 
必需
示例值:
application/json
Authorization
string 
必需
示例值:
Bearer {{ARK_API_KEY}}
Body 参数application/json
model
string 
必需
messages
array [object {2}] 
必需
role
string 
必需
content
string 
必需
示例

返回响应

🟢200成功
application/json
Body
id
string 
必需
object
string 
必需
created
integer 
必需
model
string 
必需
choices
array [object {4}] 
必需
index
integer 
可选
message
object 
可选
logprobs
null 
可选
finish_reason
string 
可选
usage
object 
必需
prompt_tokens
integer 
必需
completion_tokens
integer 
必需
total_tokens
integer 
必需
prompt_tokens_details
object 
必需
上一页
地域和访问域名
下一页
对话(Chat)-视觉 API
Built with