API 参考 · API 协议

OpenAI 兼容 API

用常见的 OpenAI SDK 和工具调用对话补全接口。

端点与鉴权

在 Authorization 请求头中发送 Bearer Token，并使用 Foyton API 的 OpenAI 兼容 Base URL。

HTTP

POST /v1/chat/completions HTTP/1.1
Host: fytapi.com
Authorization: Bearer <FYTAPI_API_KEY>
Content-Type: application/json

JavaScript SDK 示例

OpenAI 官方 SDK 只需替换 apiKey 与 baseURL，其余调用方式保持不变。

TypeScript

import OpenAI from 'openai'

const client = new OpenAI({
  apiKey: process.env.FYTAPI_API_KEY,
  baseURL: 'https://fytapi.com/v1',
})

const response = await client.chat.completions.create({
  model: 'gpt-5',
  messages: [{ role: 'user', content: 'Hello' }],
})

console.log(response.choices[0].message.content)

流式响应

将 stream 设为 true 并逐步消费 SSE 事件。客户端需要处理断开连接、部分输出以及流结束标记。

Request fragmentjson

{
  "model": "gpt-5",
  "messages": [{"role": "user", "content": "Explain streaming"}],
  "stream": true
}

兼容性说明

可选参数是否生效取决于所选上游模型。
不要假设所有模型都支持工具调用、图片、JSON 模式或流式选项。
以代码构建请求时，应保留显式传入的 0 与 false。