示例：Chat Completions 对话/流式对话

POST

/v1/chat/completions

调用网关域名下的当前路径即可，调用方不能指定 NewAPI 上游地址。

Authorization：NewAPI 的访问令牌，格式为 Bearer sk-xxx，网关原样透传。

domi-ai-metadata：必传的集团业务元数据。值是一个完整 JSON object 字符串，不要再套一层对象；网关读取后删除，不转发给 NewAPI。

请求体：NewAPI/OpenAI 兼容 JSON，网关不解析、不改写，按原始字节转发。

流式调用：请求体设置 stream: true，同时发送 Accept: text/event-stream。

响应头：网关返回 X-Domi-Request-Id；NewAPI 请求 ID 响应头也会继续透传。

可用模型：调用 GET /domi/gateway/api/model/names 获取当前支持的模型名称；文档中的模型名仅为请求示例。

浏览器原生 EventSource 无法设置自定义 header 时，才使用同名 query 参数传递元数据；header 与 query 同时存在时以 header 为准。

请求参数

Authorization

JWT Bearer

在 Header 添加参数

Authorization

示例：

Authorization: ********************

API Key

在 header 添加参数

deviceId

示例：

deviceId: ********************

API Key

在 header 添加参数

deviceType

示例：

deviceType: ********************

API Key

在 header 添加参数

appVersion

示例：

appVersion: ********************

Query 参数

Header 参数

Body 参数application/json必填

示例

普通对话SSE 流式对话

普通对话

{
    "model": "gpt-4o-mini",
    "messages": [
        {
            "role": "system",
            "content": "你是 CRM 销售助手。"
        },
        {
            "role": "user",
            "content": "请总结客户的主要诉求。"
        }
    ],
    "temperature": 0.2,
    "stream": false
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

普通对话SSE 流式对话

curl --location --globoff 'https://gateway.domi-kids.com/v1/chat/completions?domi-ai-metadata={%0A%20%20%20%20%22schema_version%22%3A%201%2C%0A%20%20%20%20%22business_request_id%22%3A%20%22order-ai-20260716-0001%22%2C%0A%20%20%20%20%22source_system_code%22%3A%20%22crm%22%2C%0A%20%20%20%20%22application_id%22%3A%20%22crm-copilot%22%2C%0A%20%20%20%20%22business_line_id%22%3A%20%22sales%22%2C%0A%20%20%20%20%22organization_id%22%3A%20%22org-1001%22%2C%0A%20%20%20%20%22user_id%22%3A%20%22u-2001%22%2C%0A%20%20%20%20%22classify%22%3A%20{%0A%20%20%20%20%20%20%20%20%221%22%3A%20%22p-3001%22%2C%0A%20%20%20%20%20%20%20%20%222%22%3A%20%22cc-310%22%2C%0A%20%20%20%20%20%20%20%20%223%22%3A%20%22knowledge_qa%22%2C%0A%20%20%20%20%20%20%20%20%2220%22%3A%20%22%22%0A%20%20%20%20}%0A}' \
--header 'domi-ai-metadata: {
    "schema_version": 1,
    "business_request_id": "order-ai-20260716-0001",
    "source_system_code": "crm",
    "application_id": "crm-copilot",
    "business_line_id": "sales",
    "organization_id": "org-1001",
    "user_id": "u-2001",
    "classify": {
        "1": "p-3001",
        "2": "cc-310",
        "3": "knowledge_qa",
        "20": ""
    }
}' \
--header 'Accept: text/event-stream' \
--header 'Authorization: Bearer <token>' \
--header 'deviceId: <api-key>' \
--header 'deviceType: <api-key>' \
--header 'appVersion: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "model": "gpt-4o-mini",
    "messages": [
        {
            "role": "system",
            "content": "你是 CRM 销售助手。"
        },
        {
            "role": "user",
            "content": "请总结客户的主要诉求。"
        }
    ],
    "temperature": 0.2,
    "stream": false
}'

返回响应

🟢200

application/json

NewAPI 的非流式 JSON 响应或流式 SSE 响应

Body

示例

{
    "choices": [
        {
            "finish_reason": "stop",
            "index": 0,
            "logprobs": null,
            "message": {
                "content": "Quantum entanglement is a quantum mechanical phenomenon in which particles share a linked state even when separated by a large distance.",
                "role": "assistant"
            }
        }
    ],
    "created": 1784529011,
    "id": "02178452900387485c9a7acb047d6dabbfa02bbf3a2b67bef3b39",
    "model": "doubao-seed-2-0-pro-260215",
    "service_tier": "default",
    "object": "chat.completion",
    "usage": {
        "completion_tokens": 274,
        "prompt_tokens": 53,
        "total_tokens": 327,
        "prompt_tokens_details": {
            "cached_tokens": 0
        },
        "completion_tokens_details": {
            "reasoning_tokens": 0
        }
    }
}

🟠401

🔴500

🟠4XX

🔴5XX

修改于 2026-07-28 04:34:48

示例：Embeddings 向量化

参数说明（非接口请求）：domi-ai-metadata 业务元数据