Skip to main content

快速开始

API 概述

服务地址​

https://api.fireflyai.chat

Firefly 开放平台提供兼容 OpenAI 协议的 HTTP API，您可以直接使用 OpenAI SDK 接入。

使用 SDK 时，base_url 设置为 https://api.fireflyai.chat/v1；直接调用 HTTP 端点时，完整路径如 https://api.fireflyai.chat/v1/chat/completions。

兼容 OpenAI​

我们的 API 在请求/响应格式上兼容 OpenAI Chat Completions API。这意味着：

  • 可以直接使用 OpenAI 官方 SDK（Python / Node.js）
  • 支持大多数兼容 OpenAI 的第三方工具和框架（LangChain、Dify、Coze、Zed 等）
  • 只需将 base_url 指向 https://api.fireflyai.chat/v1 即可切换

认证​

所有 API 请求需要在 HTTP 头中携带 API Key：

Authorization: Bearer $FIREFLY_API_KEY

API Key 可在 Firefly 控制台 创建和管理。

  API Key 是敏感信息，请妥善保管。不要在客户端代码、公开仓库或日志中暴露。建议通过环境变量管理。

SDK 安装​

pip install --upgrade 'openai>=1.0'
npm install openai

初始化客户端：

import os

from openai import OpenAI

client = OpenAI(
    api_key=os.environ["FIREFLY_API_KEY"],
    base_url="https://api.fireflyai.chat/v1",
)
const OpenAI = require("openai");

const client = new OpenAI({
    apiKey: process.env.FIREFLY_API_KEY,
    baseURL: "https://api.fireflyai.chat/v1",
});

Python 版本需 ≥ 3.7.1，Node.js 版本需 ≥ 18，OpenAI SDK 版本需 ≥ 1.0.0。

python -c 'import openai; print("version =", openai.__version__)'

通用请求头​

请求头值说明
Content-Typeapplication/json请求体格式
AuthorizationBearer $FIREFLY_API_KEY认证令牌

错误处理​

请求失败时返回 JSON 格式的错误响应，包含 error.type 和 error.message 字段。常见的 HTTP 状态码包括 400（请求错误）、401（认证失败）、429（速率限制）、500（服务端错误）等。

API 端点一览​

端点方法说明
/v1/chat/completionsPOST创建对话补全
/v1/modelsGET列出模型

下一步​

模型总览

创建对话补全