聊天接口 - freegpt

请求参数

Header 参数

Authorization

string

必需

示例值:

Bearer sk-xxxxxxxx

Content-Type

string

必需

示例值:

application/json

session-id

string

可选

后续备用，建议每个会话分配一个唯一的uuid，比如Chat Next Web中每个会话都有一个sessionId

示例值:

iKe52WhIxJ8khgkpbG1qM

Body 参数application/json

model

string

必需

要使用的模型的 ID。有关哪些模型可与聊天 API 一起使用的详细信息,请参阅模型端点兼容性表。

messages

array [object {2}]

必需

以聊天格式生成聊天完成的消息。

role

string

可选

content

string

可选

conversation_id

string <uuid>

可选

自定义的，代表当前连续会话的ID，用来标记跟踪会话，对于一些逆向渠道是必须的，否则无法保证上下文连续

>= 6 字符<= 32 字符

示例值:

iKe52WhIxJ8khgkpbG1qM

stream

boolean

可选

默认为 false 如果设置,则像在 ChatGPT 中一样会发送部分消息增量。标记将以仅数据的服务器发送事件的形式发送,这些事件在可用时,并在 data: [DONE] 消息终止流。Python 代码示例。

temperature

integer

可选

使用什么采样温度，介于 0 和 2 之间。较高的值（如 0.8）将使输出更加随机，而较低的值（如 0.2）将使输出更加集中和确定。我们通常建议改变这个或top_p但不是两者。

top_p

integer

可选

一种替代温度采样的方法，称为核采样，其中模型考虑具有 top_p 概率质量的标记的结果。所以 0.1 意味着只考虑构成前 10% 概率质量的标记。我们通常建议改变这个或temperature但不是两者。

max_tokens

integer

可选

默认为 inf
在聊天补全中生成的最大标记数。

输入标记和生成标记的总长度受模型的上下文长度限制。计算标记的 Python 代码示例。

user

string

可选

代表您的最终用户的唯一标识符，可以帮助 OpenAI 监控和检测滥用行为。了解更多。

示例

{
  "model": "gpt-4o-mini",
  "messages": [
    {
      "role": "user",
      "content": "hello"
    }
  ],
  "stream": false,
  "max_tokens": 19,
  "temperature": 0.5,
  "top_p": 1,
  "conversation_id": "iKe52WhIxJ8khgkpbG1qM",
  "user": "username"
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.freegpt.work/v1/chat/completions' \
--header 'Authorization: Bearer sk-xxxxxxxx' \
--header 'session-id: iKe52WhIxJ8khgkpbG1qM' \
--header 'Content-Type: application/json' \
--data-raw '{
    "model": "gpt-4o-mini",
    "messages": [
        {
            "role": "user",
            "content": "hello"
        }
    ],
    "stream": false,
    "max_tokens": 19,
    "temperature": 0.5,
    "top_p": 1,
    "conversation_id": "iKe52WhIxJ8khgkpbG1qM",
    "user": "username"
}'

返回响应

🟢200成功

application/json

Body

id

string

必需

object

string

必需

created

integer

必需

choices

array [object {3}]

必需

index

integer

可选

message

object

可选

finish_reason

string

可选

usage

object

必需

不要相信此项生成的，自己用代码重新计算

prompt_tokens

integer

必需

completion_tokens

integer

必需

total_tokens

integer

必需

示例

{
  "id": "chatcmpl-123",
  "object": "chat.completion",
  "created": 1677652288,
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "\n\nHello there, how may I assist you today?"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 9,
    "completion_tokens": 12,
    "total_tokens": 21
  }
}