OpenAI GPT API

鉴权方式

Header：Authorization: Bearer $OPENAI_API_KEY
Header：Content-Type: application/json

Chat completions

方法：POST
地址：https://api.openai.com/v1/chat/completions
用途：兼容式 Chat Completions 接口

Chat completions 请求参数

参数	类型	必填	说明
`model`	string	是	模型 ID。
`messages`	array	是	消息数组。
`messages[].role`	string	是	角色，例如 `developer`、`system`、`user`、`assistant`、`tool`、`function`。
`messages[].content`	string \| array	是	消息内容。
`store`	boolean	否	是否存储 chat completion。
`metadata`	object	否	元数据。
`modalities`	array	否	输出模态，例如 `["text"]`、`["text", "audio"]`。
`audio`	object	否	音频输出配置。
`audio.format`	string	否	音频格式，例如 `wav`、`mp3`、`flac`、`opus`、`pcm16`。
`audio.voice`	string \| object	否	音频语音。
`prediction`	object	否	Predicted output 配置。
`temperature`	number	否	温度。
`top_p`	number	否	top-p。
`n`	integer	否	返回候选数量。
`stream`	boolean	否	是否流式返回。
`stream_options`	object	否	流式输出选项。
`stop`	string \| array	否	停止序列。
`max_tokens`	integer	否	最大输出 token 数。
`max_completion_tokens`	integer	否	最大 completion token 数。
`presence_penalty`	number	否	presence penalty。
`frequency_penalty`	number	否	frequency penalty。
`reasoning_effort`	string	否	推理强度。
`logit_bias`	object	否	logit bias。
`logprobs`	boolean	否	是否返回 logprobs。
`top_logprobs`	integer	否	top logprobs 数量。
`response_format`	object	否	响应格式。
`response_format.type`	string	否	响应格式类型，例如 `text`、`json_object`、`json_schema`。
`seed`	integer	否	随机种子。
`web_search_options`	object	否	Web search 选项。
`service_tier`	string	否	服务层。
`tools`	array	否	工具数组。
`tool_choice`	string \| object	否	工具选择策略。
`functions`	array	否	旧式函数定义数组。
`function_call`	string \| object	否	旧式函数调用策略。
`parallel_tool_calls`	boolean	否	是否允许并行工具调用。
`safety_identifier`	string	否	安全标识符。
`user`	string	否	用户标识。

Chat completions 请求示例

curl


curl https://api.openai.com/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -d '{
    "model": "VAR_chat_model_id",
    "messages": [
      {
        "role": "developer",
        "content": "You are a helpful assistant."
      },
      {
        "role": "user",
        "content": "Hello!"
      }
    ]
  }'

TypeScript


import OpenAI from "openai";
 
const client = new OpenAI({
  apiKey: process.env.OPENAI_API_KEY,
});
 
const completion = await client.chat.completions.create({
  model: "gpt-4.1",
  store: true,
  metadata: {
    project: "ggpu-docs",
  },
  messages: [
    {
      role: "developer",
      content: "You are a helpful assistant.",
    },
    {
      role: "user",
      content: "Write a concise product launch announcement for GGPU Platform.",
    },
  ],
  temperature: 0.7,
  max_tokens: 300,
  response_format: {
    type: "text",
  },
  service_tier: "auto",
});
 
console.log(completion.choices[0]?.message?.content);

Python


import os
from openai import OpenAI
 
client = OpenAI(api_key=os.environ["OPENAI_API_KEY"])
 
completion = client.chat.completions.create(
    model="gpt-4.1",
    store=True,
    metadata={
        "project": "ggpu-docs",
    },
    messages=[
        {
            "role": "developer",
            "content": "You are a helpful assistant.",
        },
        {
            "role": "user",
            "content": "Write a concise product launch announcement for GGPU Platform.",
        },
    ],
    temperature=0.7,
    max_tokens=300,
    response_format={
        "type": "text",
    },
    service_tier="auto",
)
 
print(completion.choices[0].message.content)

Java


import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
 
public class OpenAIChatCompletionsExample {
  public static void main(String[] args) throws IOException, InterruptedException {
    String apiKey = System.getenv("OPENAI_API_KEY");
    String body = """
      {
        "model": "gpt-4.1",
        "store": true,
        "metadata": {
          "project": "ggpu-docs"
        },
        "messages": [
          {
            "role": "developer",
            "content": "You are a helpful assistant."
          },
          {
            "role": "user",
            "content": "Write a concise product launch announcement for GGPU Platform."
          }
        ],
        "temperature": 0.7,
        "max_tokens": 300,
        "response_format": {
          "type": "text"
        },
        "service_tier": "auto"
      }
      """;
 
    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://api.openai.com/v1/chat/completions"))
        .header("Content-Type", "application/json")
        .header("Authorization", "Bearer " + apiKey)
        .POST(HttpRequest.BodyPublishers.ofString(body))
        .build();
 
    HttpResponse<String> response = HttpClient.newHttpClient()
        .send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  }
}

Go


package main
 
import (
	"bytes"
	"fmt"
	"net/http"
	"os"
)
 
func main() {
	body := []byte(`{
  "model": "gpt-4.1",
  "store": true,
  "metadata": {
    "project": "ggpu-docs"
  },
  "messages": [
    {
      "role": "developer",
      "content": "You are a helpful assistant."
    },
    {
      "role": "user",
      "content": "Write a concise product launch announcement for GGPU Platform."
    }
  ],
  "temperature": 0.7,
  "max_tokens": 300,
  "response_format": {
    "type": "text"
  },
  "service_tier": "auto"
}`)
 
	req, err := http.NewRequest(http.MethodPost, "https://api.openai.com/v1/chat/completions", bytes.NewBuffer(body))
	if err != nil {
		panic(err)
	}
 
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("Authorization", "Bearer "+os.Getenv("OPENAI_API_KEY"))
 
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
 
	buf := new(bytes.Buffer)
	_, _ = buf.ReadFrom(resp.Body)
	fmt.Println(buf.String())
}

Chat completions 请求返回结果

参数	类型	说明
`id`	string	completion ID。
`object`	string	对象类型，通常为 `chat.completion`。
`created`	integer	创建时间戳。
`request_id`	string	请求 ID。
`model`	string	实际使用模型。
`tool_choice`	string \| object \| null	实际工具选择配置。
`tools`	array \| null	实际工具列表。
`metadata`	object	元数据。
`choices`	array	候选数组。
`choices[].index`	integer	候选索引。
`choices[].message`	object	assistant 消息对象。
`choices[].message.role`	string	角色，通常为 `assistant`。
`choices[].message.content`	string \| null	返回文本。
`choices[].message.tool_calls`	array	工具调用数组。
`choices[].message.function_call`	object \| null	旧式函数调用对象。
`choices[].finish_reason`	string	停止原因。
`choices[].logprobs`	object \| null	logprobs 对象。
`usage.prompt_tokens`	integer	prompt token 数。
`usage.completion_tokens`	integer	completion token 数。
`usage.total_tokens`	integer	总 token 数。
`seed`	integer \| null	随机种子。
`temperature`	number \| null	实际温度。
`top_p`	number \| null	实际 top-p。
`presence_penalty`	number \| null	实际 presence penalty。
`frequency_penalty`	number \| null	实际 frequency penalty。
`input_user`	string \| null	输入用户标识。
`service_tier`	string \| null	服务层。
`system_fingerprint`	string \| null	系统指纹。
`response_format`	object \| null	实际响应格式。

Chat completions 请求返回示例


{
  "id": "chatcmpl-B9MBs8CjcvOU2jLn4n570S5qMJKcT",
  "object": "chat.completion",
  "created": 1741569952,
  "model": "gpt-5.4",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "Hello! How can I assist you today?",
        "refusal": null,
        "annotations": []
      },
      "logprobs": null,
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 19,
    "completion_tokens": 10,
    "total_tokens": 29,
    "prompt_tokens_details": {
      "cached_tokens": 0,
      "audio_tokens": 0
    },
    "completion_tokens_details": {
      "reasoning_tokens": 0,
      "audio_tokens": 0,
      "accepted_prediction_tokens": 0,
      "rejected_prediction_tokens": 0
    }
  }
  ,
  "service_tier": "default"
}

Responses

方法：POST
地址：https://api.openai.com/v1/responses
用途：统一文本生成、多模态输入、结构化输出、工具调用、流式输出

Responses 请求参数

参数	类型	必填	说明
`model`	string	是	模型 ID，例如 `gpt-5`。
`input`	string \| array	否	输入内容。
`instructions`	string	否	高层指令。
`conversation`	string \| object	否	会话上下文。
`include`	array	否	额外返回字段。
`max_output_tokens`	integer	否	最大输出 token 数。
`metadata`	object	否	自定义元数据。
`parallel_tool_calls`	boolean	否	是否允许并行工具调用。
`previous_response_id`	string	否	上一个 response 的 ID。
`prompt`	object	否	Prompt 模板引用。
`reasoning`	object	否	推理配置。
`service_tier`	string	否	服务层级。
`store`	boolean	否	是否存储。
`stream`	boolean	否	是否流式输出。
`temperature`	number	否	温度。
`text`	object	否	文本输出配置。
`tool_choice`	string \| object	否	工具选择策略。
`tools`	array	否	工具数组。
`top_p`	number	否	top-p。
`truncation`	string	否	截断策略。
`user`	string	否	用户标识。
`background`	boolean	否	是否后台执行。

Responses 请求示例

curl


curl https://api.openai.com/v1/responses \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -d '{
    "model": "gpt-5",
    "input": [
      {
        "role": "user",
        "content": [
          {
            "type": "input_text",
            "text": "Write a concise product launch announcement for GGPU Platform."
          }
        ]
      }
    ],
    "instructions": "Use a professional but energetic tone.",
    "max_output_tokens": 300,
    "temperature": 0.7,
    "text": {
      "format": {
        "type": "text"
      }
    }
  }'

TypeScript


import OpenAI from "openai";
 
const client = new OpenAI({
  apiKey: process.env.OPENAI_API_KEY,
});
 
const response = await client.responses.create({
  model: "gpt-5",
  input: [
    {
      role: "user",
      content: [
        {
          type: "input_text",
          text: "Write a concise product launch announcement for GGPU Platform.",
        },
      ],
    },
  ],
  instructions: "Use a professional but energetic tone.",
  max_output_tokens: 300,
  temperature: 0.7,
  text: {
    format: {
      type: "text",
    },
  },
});
 
console.log(response.output_text);

Python


import os
from openai import OpenAI
 
client = OpenAI(api_key=os.environ["OPENAI_API_KEY"])
 
response = client.responses.create(
    model="gpt-5",
    input=[
        {
            "role": "user",
            "content": [
                {
                    "type": "input_text",
                    "text": "Write a concise product launch announcement for GGPU Platform.",
                }
            ],
        }
    ],
    instructions="Use a professional but energetic tone.",
    max_output_tokens=300,
    temperature=0.7,
    text={
        "format": {
            "type": "text",
        }
    },
)
 
print(response.output_text)

Java


import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
 
public class OpenAIResponsesExample {
  public static void main(String[] args) throws IOException, InterruptedException {
    String apiKey = System.getenv("OPENAI_API_KEY");
    String body = """
      {
        "model": "gpt-5",
        "input": [
          {
            "role": "user",
            "content": [
              {
                "type": "input_text",
                "text": "Write a concise product launch announcement for GGPU Platform."
              }
            ]
          }
        ],
        "instructions": "Use a professional but energetic tone.",
        "max_output_tokens": 300,
        "temperature": 0.7,
        "text": {
          "format": {
            "type": "text"
          }
        }
      }
      """;
 
    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://api.openai.com/v1/responses"))
        .header("Content-Type", "application/json")
        .header("Authorization", "Bearer " + apiKey)
        .POST(HttpRequest.BodyPublishers.ofString(body))
        .build();
 
    HttpResponse<String> response = HttpClient.newHttpClient()
        .send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  }
}

Go


package main
 
import (
	"bytes"
	"fmt"
	"net/http"
	"os"
)
 
func main() {
	body := []byte(`{
  "model": "gpt-5",
  "input": [
    {
      "role": "user",
      "content": [
        {
          "type": "input_text",
          "text": "Write a concise product launch announcement for GGPU Platform."
        }
      ]
    }
  ],
  "instructions": "Use a professional but energetic tone.",
  "max_output_tokens": 300,
  "temperature": 0.7,
  "text": {
    "format": {
      "type": "text"
    }
  }
}`)
 
	req, err := http.NewRequest(http.MethodPost, "https://api.openai.com/v1/responses", bytes.NewBuffer(body))
	if err != nil {
		panic(err)
	}
 
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("Authorization", "Bearer "+os.Getenv("OPENAI_API_KEY"))
 
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
 
	buf := new(bytes.Buffer)
	_, _ = buf.ReadFrom(resp.Body)
	fmt.Println(buf.String())
}

Responses 请求返回结果

参数	类型	说明
`id`	string	响应对象 ID。
`object`	string	对象类型，通常为 `response`。
`created_at`	integer	创建时间戳。
`status`	string	当前状态。
`error`	object \| null	错误对象。
`incomplete_details`	object \| null	未完成详情。
`instructions`	string \| null	实际使用指令。
`max_output_tokens`	integer \| null	实际最大输出 token。
`model`	string	实际使用模型。
`output`	array	输出项数组。
`output_text`	string	扁平文本输出。
`parallel_tool_calls`	boolean	是否允许并行工具调用。
`previous_response_id`	string \| null	上一个 response ID。
`reasoning`	object	推理元信息。
`service_tier`	string \| null	服务层。
`store`	boolean	是否存储。
`temperature`	number \| null	实际温度。
`text`	object	文本输出配置。
`tool_choice`	string \| object	工具选择。
`tools`	array	工具列表。
`top_p`	number \| null	实际 top-p。
`truncation`	string \| null	截断策略。
`usage.input_tokens`	integer	输入 token 数。
`usage.output_tokens`	integer	输出 token 数。
`usage.total_tokens`	integer	总 token 数。
`usage.output_tokens_details.reasoning_tokens`	integer	推理 token 数。
`user`	string \| null	用户标识。
`metadata`	object	元数据。

Responses 请求返回示例


{
  "id": "resp_67cb71b351908190a308f3859487620d06981a8637e6bc44",
  "object": "response",
  "created_at": 1741386163,
  "status": "completed",
  "error": null,
  "incomplete_details": null,
  "instructions": "Use a professional but energetic tone.",
  "max_output_tokens": 300,
  "model": "gpt-5",
  "output": [
    {
      "id": "msg_67cb71b4223c8190a8f3859487620d06",
      "type": "message",
      "role": "assistant",
      "content": [
        {
          "type": "output_text",
          "text": "GGPU Platform is now available, bringing teams a faster and more reliable way to build, run, and scale intelligent workflows.",
          "annotations": []
        }
      ]
    }
  ],
  "output_text": "GGPU Platform is now available, bringing teams a faster and more reliable way to build, run, and scale intelligent workflows.",
  "parallel_tool_calls": true,
  "previous_response_id": null,
  "reasoning": {
    "effort": null,
    "summary": null
  },
  "service_tier": "default",
  "store": true,
  "temperature": 0.7,
  "text": {
    "format": {
      "type": "text"
    }
  },
  "tool_choice": "auto",
  "tools": [],
  "top_p": null,
  "truncation": "disabled",
  "usage": {
    "input_tokens": 31,
    "output_tokens": 28,
    "total_tokens": 59,
    "output_tokens_details": {
      "reasoning_tokens": 0
    }
  },
  "user": null,
  "metadata": {}
}