用户指南
通用模型

通用对话接口(非流式)

统一的 OpenAI Chat Completions 兼容入口;与流式文档使用同一路由;成功响应为 OpenAI 原始 JSON。

  • 路由:POST /v1/chat/completions
  • 这不是另一套接口,只是同一路由加上 stream: false
  • 成功响应为 OpenAI 原始 JSON,不包 code / data

请求示例

curl --request POST \
  --url https://api.magickapi.com/v1/chat/completions \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "model": "gpt-5",
    "stream": false,
    "messages": [
      {
        "role": "system",
        "content": "你是一个专业的 AI 助手。"
      },
      {
        "role": "user",
        "content": "介绍一下人工智能的发展历史。"
      }
    ]
  }'

成功响应示例

{
  "id": "chatcmpl_123",
  "object": "chat.completion",
  "created": 1712345678,
  "model": "gpt-5",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "人工智能的发展历史通常从 20 世纪 50 年代开始讨论。"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 28,
    "completion_tokens": 20,
    "total_tokens": 48
  }
}

错误响应示例

{
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error",
    "param": null,
    "code": "invalid_request"
  }
}

认证

  • 请求头:Authorization: Bearer YOUR_API_KEY
  • API Key 请使用 Magick API 后台生成的密钥

常用参数

model

  • 类型:string
  • 必填:是

messages

  • 类型:array

  • 必填:是

    与 OpenAI Chat Completions 协议一致。

stream

  • 类型:boolean

  • 固定建议:false

    如果你需要一次性拿到完整结果,请显式传 false

其他常用字段

  • temperature
  • top_p
  • max_tokens
  • max_completion_tokens
  • tools
  • tool_choice
  • response_format
  • reasoning_effort

兼容说明

  • 流式与非流式都走 POST /v1/chat/completions

最后更新于

目录