文档中心

中文

English

中文

English

Appearance

Chat GPT API Examples ​

本页面提供Agentsflare Chat GPT API的使用示例，帮助您快速集成和使用我们的AI服务。

基础配置 ​

在开始使用API之前，请确保您已经获取了API Key。如果还没有，请参考创建API Key。

基础信息 ​

  • API Base URL: https://api.agentsflare.com/v1/chat/completions
  • 认证方式: Bearer Token
  • 内容类型: application/json

请求示例 ​

bash
curl -X POST "https://api.agentsflare.com/v1/chat/completions" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-4",
    "messages": [
      {
        "role": "user",
        "content": "Hello, how are you?"
      }
    ],
    "max_tokens": 100,
    "temperature": 0.7
  }'
python
from openai import OpenAI
url = "https://api.agentsflare.com/v1"

client = OpenAI(
    base_url=url,
    api_key="YOUR_API_KEY"
)

completion = client.chat.completions.create(
  model="gpt-5.2",
  messages=[
    {"role": "user", "content": "You are a helpful assistant."}
  ]
)

print(completion.choices[0].message)
javascript

import OpenAI from "openai";

const client = new OpenAI({
  apiKey: process.env.AGENTSFLARE_API_KEY, 
  baseURL: "https://api.agentsflare.com/v1"    
});

async function main() {
  try {
    const res = await client.chat.completions.create({
      model: "gpt-4",
      messages: [{ role: "user", content: "Hello, how are you?" }],
      max_tokens: 100,
      temperature: 0.7
    });

    // 你也可以只取文本
    console.log(res.choices?.[0]?.message?.content);
    // 或打印完整响应
    // console.log(res);
  } catch (err) {
    // openai sdk 的错误对象里通常有更详细的 response
    console.error(err?.response?.data ?? err);
  }
}

main();
java
import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.chat.completions.ChatCompletionCreateParams;
import com.openai.models.chat.completions.ChatCompletion;

public class Main {
  public static void main(String[] args) {
    String apiKey = System.getenv("AGENTSFLARE_API_KEY"); 
    if (apiKey == null || apiKey.isBlank()) {
      throw new IllegalStateException("Missing AGENTSFLARE_API_KEY env var");
    }

    OpenAIClient client = OpenAIOkHttpClient.builder()
        .apiKey(apiKey)
        .baseUrl("https://api.agentsflare.com/v1")
        .build();

    ChatCompletionCreateParams params = ChatCompletionCreateParams.builder()
        .model("gpt-4")
        .addMessage(ChatCompletionCreateParams.Message.builder()
            .role(ChatCompletionCreateParams.Message.Role.USER)
            .content("Hello, how are you?")
            .build())
        .maxTokens(100)
        .temperature(0.7)
        .build();

    ChatCompletion res = client.chat().completions().create(params);

    String content = res.choices().get(0).message().content();
    System.out.println(content);
  }
}
go
package main

import (
	"context"
	"fmt"
	"log"
	"os"

	openai "github.com/openai/openai-go"
	"github.com/openai/openai-go/option"
)

func main() {
	apiKey := os.Getenv("AGENTSFLARE_API_KEY") // 建议用环境变量
	if apiKey == "" {
		log.Fatal("missing env AGENTSFLARE_API_KEY")
	}

	client := openai.NewClient(
		option.WithAPIKey(apiKey),
		// 关键：把 SDK 的 base url 指向 agentsflare
		option.WithBaseURL("https://api.agentsflare.com/v1"),
	)

	ctx := context.Background()

	resp, err := client.Chat.Completions.New(ctx, openai.ChatCompletionNewParams{
		Model: openai.F("gpt-4"),
		Messages: openai.F([]openai.ChatCompletionMessageParamUnion{
			openai.UserMessage("Hello, how are you?"),
		}),
		MaxTokens:   openai.F(int64(100)),
		Temperature: openai.F(0.7),
	})
	if err != nil {
		log.Fatalf("chat completion failed: %v", err)
	}

	// 打印回复文本
	if len(resp.Choices) > 0 && resp.Choices[0].Message.Content != "" {
		fmt.Println(resp.Choices[0].Message.Content)
	} else {
		fmt.Printf("empty response: %+v\n", resp)
	}
}
javascript
const { OpenAI } = require("openai");

const client = new OpenAI({
  apiKey: process.env.AGENTSFLARE_API_KEY, 
  baseURL: "https://api.agentsflare.com/v1"    
});

async function main() {
  try {
    const res = await client.chat.completions.create({
      model: "gpt-4",
      messages: [{ role: "user", content: "Hello, how are you?" }],
      max_tokens: 100,
      temperature: 0.7
    });

    // 你也可以只取文本
    console.log(res.choices?.[0]?.message?.content);
    // 或打印完整响应
    // console.log(res);
  } catch (err) {
    // openai sdk 的错误对象里通常有更详细的 response
    console.error(err?.response?.data ?? err);
  }
}

main();

响应示例 ​

{
    "choices": [
        {
            "content_filter_results": {
                "hate": {
                    "filtered": false,
                    "severity": "safe"
                },
                "protected_material_code": {
                    "filtered": false,
                    "detected": false
                },
                "protected_material_text": {
                    "filtered": false,
                    "detected": false
                },
                "self_harm": {
                    "filtered": false,
                    "severity": "safe"
                },
                "sexual": {
                    "filtered": false,
                    "severity": "safe"
                },
                "violence": {
                    "filtered": false,
                    "severity": "safe"
                }
            },
            "finish_reason": "stop",
            "index": 0,
            "logprobs": null,
            "message": {
                "annotations": [

                ],
                "content": "你好！有什么我可以帮忙的吗？😊",
                "refusal": null,
                "role": "assistant"
            }
        }
    ],
    "created": 1767765293,
    "id": "chatcmpl-CvGnN6pDPthK2Aw5pToFy1K098dhV",
    "model": "gpt-4.1-mini-2025-04-14",
    "object": "chat.completion",
    "prompt_filter_results": [
        {
            "prompt_index": 0,
            "content_filter_results": {
                "hate": {
                    "filtered": false,
                    "severity": "safe"
                },
                "jailbreak": {
                    "filtered": false,
                    "detected": false
                },
                "self_harm": {
                    "filtered": false,
                    "severity": "safe"
                },
                "sexual": {
                    "filtered": false,
                    "severity": "safe"
                },
                "violence": {
                    "filtered": false,
                    "severity": "safe"
                }
            }
        }
    ],
    "system_fingerprint": "fp_3dcd5944f5",
    "usage": {
        "completion_tokens": 11,
        "completion_tokens_details": {
            "accepted_prediction_tokens": 0,
            "audio_tokens": 0,
            "reasoning_tokens": 0,
            "rejected_prediction_tokens": 0
        },
        "prompt_tokens": 10,
        "prompt_tokens_details": {
            "audio_tokens": 0,
            "cached_tokens": 0
        },
        "total_tokens": 21
    }
}

Responses API 调用示例 ​

Responses API 是 OpenAI 推出的新一代对话接口，适用于 Codex 系列模型和需要高级功能（如 function calling、代码生成）的场景。

基础信息 ​

  • API 地址: https://api.agentsflare.com/v1/responses
  • 认证方式: Bearer Token
  • 内容类型: application/json
bash
curl -X POST "https://api.agentsflare.com/v1/responses" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5.3-codex",
    "input": [
      {
        "role": "user",
        "content": "写一个 Python 函数来计算斐波那契数列"
      }
    ],
    "max_tokens": 2048,
    "temperature": 0.7
  }'
python
from openai import OpenAI

client = OpenAI(
    base_url="https://api.agentsflare.com/v1",
    api_key="YOUR_API_KEY"
)

response = client.responses.create(
    model="gpt-5.3-codex",
    input=[
        {"role": "user", "content": "写一个 Python 函数来计算斐波那契数列"}
    ],
    max_tokens=2048,
    temperature=0.7
)

print(response.output_text)
javascript
import OpenAI from "openai";

const client = new OpenAI({
  apiKey: process.env.AGENTSFLARE_API_KEY,
  baseURL: "https://api.agentsflare.com/v1"
});

async function main() {
  try {
    const res = await client.responses.create({
      model: "gpt-5.3-codex",
      input: [
        { role: "user", content: "写一个 Python 函数来计算斐波那契数列" }
      ],
      max_tokens: 2048,
      temperature: 0.7
    });

    console.log(res.output_text);
  } catch (err) {
    console.error(err?.response?.data ?? err);
  }
}

main();

Responses API 响应示例 ​

json
{
  "id": "resp_abc123",
  "object": "response",
  "created_at": 1767765293,
  "model": "gpt-5.3-codex",
  "output": [
    {
      "type": "message",
      "role": "assistant",
      "content": [
        {
          "type": "output_text",
          "text": "```python\ndef fibonacci(n):\n    if n <= 0:\n        return []\n    elif n == 1:\n        return [0]\n    \n    fib = [0, 1]\n    for i in range(2, n):\n        fib.append(fib[-1] + fib[-2])\n    return fib\n```",
          "annotations": []
        }
      ]
    }
  ],
  "usage": {
    "input_tokens": 15,
    "output_tokens": 78,
    "total_tokens": 93
  }
}

💡 提示

  • Responses API 使用 input 字段代替 messages 字段
  • 支持 Codex 系列模型（gpt-5.3-codex、gpt-5.2-codex 等）及 Pro 模型
  • 支持 function calling、代码生成、文件解析等高级特性
  • 参数详见 Responses API

请求参数 ​

参数详见 Chat Completions API

Batch 调用示例 ​

以下示例展示如何一次提交多个对话请求（batch）。实际 endpoint 与参数以平台公告或 SDK 为准；下列示例为参考用法，示例中使用的 endpoint 为 POST https://api.agentsflare.com/v1/chat/batch。

cURL（同步示例） ​

bash
curl -X POST "https://api.agentsflare.com/v1/chat/batch" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "requests": [
      {
        "model": "gpt-4.1",
        "messages": [{"role": "user", "content": "请把下面句子翻译成英文：你好"}],
        "max_tokens": 100
      },
      {
        "model": "gpt-5",
        "messages": [{"role": "user", "content": "总结这段文本的要点：..."}],
        "max_tokens": 200
      }
    ]
  }'

Python（requests） ​

python
import requests, os
url = "https://api.agentsflare.com/v1/chat/batch"
api_key = os.getenv("AGENTSFLARE_API_KEY")

payload = {
  "requests": [
    {"model": "gpt-4.1", "messages": [{"role":"user","content":"将这句话翻译为英文：你好"}], "max_tokens": 100},
    {"model": "gpt-5", "messages": [{"role":"user","content":"请提取以下文本的关键信息：..."}], "max_tokens": 200}
  ]
}

resp = requests.post(url, headers={
    "Authorization": f"Bearer {api_key}",
    "Content-Type": "application/json"
}, json=payload)

data = resp.json()
for i, item in enumerate(data.get("results", [])):
    print(f"request {i} ->", item.get("choices", [{}])[0].get("message", {}).get("content"))

JavaScript（fetch） ​

javascript
const resp = await fetch("https://api.agentsflare.com/v1/chat/batch", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.AGENTSFLARE_API_KEY}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    requests: [
      { model: "gpt-4.1", messages: [{ role: "user", content: "Translate: 你好" }], max_tokens: 100 },
      { model: "gpt-5", messages: [{ role: "user", content: "Summarize this text: ..." }], max_tokens: 200 }
    ]
  })
});
const data = await resp.json();
console.log(data.results);

说明：不同 SDK/版本可能提供更高阶的 batch API（异步任务、任务 id 查询、回调 webhook 等），请以平台 SDK 文档为准。

通道说明（Batch 支持） ​

  • 标准通道（Standard）：不可直接使用 OpenAI 官方 endpoints（即不能使用 openai.com 的官方 SDK）；平台提供自有 Batch 接口。支持的 Batch 模型：gpt-4.1, gpt5, gpt-5.1。
  • 高级通道（Advanced）：与标准通道限制相同（不可使用 OpenAI 官方 endpoints），支持 Batch 的模型：gpt-4.1, gpt5, gpt-5.1。
  • 专属通道（Dedicated / 专属）：可使用 OpenAI 官方 endpoints（可直接使用 OpenAI 官方 SDK/客户端），支持平台当前所有可 Batch 的 GPT 系列模型（包括 gpt-4.1, gpt5, gpt-5.1 及将来支持的其他 batch 模型）。

若需确认某个具体模型或通道的 Batch 能力，请联系平台运营或查看你的账号通道权限页（或通过 API/控制台查询当前可用模型列表）。

支持的模型 ​

以下模型可通过本接口调用（按推荐程度排序）：

  • gpt-5.5 New
  • gpt-5.4-pro
  • gpt-5.4
  • gpt-5.4-mini New
  • gpt-5.4-nano New
  • gpt-5.3-codex
  • gpt-5.2-codex 即将下线
  • gpt-5.2-pro
  • gpt-5.2
  • gpt-5.1
  • gpt-5.1-chat-latest 即将下线
  • gpt-5.1-codex 即将下线
  • gpt-5.1-codex-max 即将下线
  • gpt-5-chat-latest 即将下线
  • gpt-5-pro
  • gpt-5-mini
  • gpt-5-nano
  • gpt-5
  • gpt-4.1
  • gpt-4.1-mini
  • gpt-4.1-nano 即将下线
  • gpt-4o
  • gpt-4o-mini
  • gpt-4o-2024-05-13 即将下线
  • gpt-4-turbo 即将下线
  • gpt-4 即将下线
  • gpt-3.5-turbo 即将下线
  • gpt-3.5 即将下线
  • o3-pro
  • o3
  • o3-deep-research 即将下线
  • o3-mini 即将下线
  • o1-pro 即将下线
  • o1 即将下线
  • o1-mini
  • o4-mini 即将下线
  • o4-mini-deep-research 即将下线
  • gpt-realtime-2 New
  • gpt-realtime-mini New
  • whisper-1 New
  • gpt-4o-transcribe New
  • gpt-4o-transcribe-diarize New
  • gpt-4o-mini-transcribe New
  • gpt-image-2 New
  • gpt-image-1.5
  • sora-2 即将下线
  • sora-2-pro 即将下线

💡 提示

请求示例中的 model 字段可替换为上方任意模型名称。

本文档遵循 CC BY-SA 4.0 协议。

版权所有 © 2024 Agentsflare 保留所有权利