OpenAI API 文档总览

OpenAI API 平台提供文本、图像、音频、工具调用和智能体相关接口。第一次接入可以从创建 API 密钥、发送一个 Responses 请求开始，再按任务选择模型和文档入口。

开发者快速开始

在开发者快速开始中配置环境、安装 SDK 并运行首次请求；密钥在控制台创建。下面展示首页提供的各语言及命令行请求。运行前须按快速开始完成环境变量和依赖配置。

cURL / Bash

## 生成一个简短睡前故事
curl https://api.openai.com/v1/responses \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -d '{
    "model": "gpt-6-astra",
    "input": "Write a short bedtime story about a unicorn."
  }'

JavaScript

// 生成一个简短睡前故事；从环境读取凭证，发送请求并读取响应
import OpenAI from "openai";
// 创建客户端；使用 OPENAI_API_KEY 环境变量，不在代码中写入真实密钥
const client = new OpenAI();

const response = await client.responses.create({
  model: "gpt-6-astra",
  input: "Write a short bedtime story about a unicorn.",
});

// 显示本次结果；实际文本与示例不必逐字相同
console.log(response.output_text);

Python

## 生成一个简短睡前故事；从环境读取凭证，发送请求并读取响应
from openai import OpenAI

## 创建客户端；使用 OPENAI_API_KEY 环境变量，不在代码中写入真实密钥
client = OpenAI()

response = client.responses.create(model="gpt-6-astra", input="Write a short bedtime story about a unicorn.")

## 显示本次结果；实际文本与示例不必逐字相同
print(response.output_text)

Go

// 生成一个简短睡前故事；从环境读取凭证，发送请求并读取响应
package main

import (
    "context"
    "fmt"

    "github.com/openai/openai-go/v3"
    "github.com/openai/openai-go/v3/responses"
)

func main() {
    // 创建客户端；使用 OPENAI_API_KEY 环境变量，不在代码中写入真实密钥
    client := openai.NewClient()

    response, err := client.Responses.New(context.Background(), responses.ResponseNewParams{
        Model: "gpt-6-astra",
        Input: responses.ResponseNewParamsInputUnion{
            OfString: openai.String("Write a short bedtime story about a unicorn."),
        },
    })
    if err != nil {
        panic(err)
    }

    // 显示本次结果；实际文本与示例不必逐字相同
    fmt.Println(response.OutputText())
}

Java

// 生成一个简短睡前故事；从环境读取凭证，发送请求并读取响应
import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.responses.Response;
import com.openai.models.responses.ResponseCreateParams;

public class PlatformOverviewExample {
  public static void main(String[] args) {
    // 创建客户端；使用 OPENAI_API_KEY 环境变量，不在代码中写入真实密钥
    OpenAIClient client = OpenAIOkHttpClient.fromEnv();

    ResponseCreateParams params =
        ResponseCreateParams.builder().model("gpt-6-astra").input("Write a short bedtime story about a unicorn.").build();

    Response response = client.responses().create(params);
    response.output().stream()
        .flatMap(item -> item.message().stream())
        .flatMap(message -> message.content().stream())
        .flatMap(content -> content.outputText().stream())
        .forEach(outputText -> System.out.println(outputText.text()));
  }
}

C# / .NET

// 生成一个简短睡前故事
using OpenAI.Responses;
#pragma warning disable OPENAI001

string key = Environment.GetEnvironmentVariable("OPENAI_API_KEY")!;
// 创建客户端；使用 OPENAI_API_KEY 环境变量，不在代码中写入真实密钥
ResponsesClient client = new(key);

ResponseResult response = await client.CreateResponseAsync(
    "gpt-6-astra",
    "Write a short bedtime story about a unicorn."
);

// 显示本次结果；实际文本与示例不必逐字相同
Console.WriteLine(response.GetOutputText());

Ruby

## 生成一个简短睡前故事；从环境读取凭证，发送请求并读取响应
require "openai"

## 创建客户端；使用 OPENAI_API_KEY 环境变量，不在代码中写入真实密钥
openai = OpenAI::Client.new

response = openai.responses.create(
  model: "gpt-6-astra",
  input: "Write a short bedtime story about a unicorn."
)

## 显示本次结果；实际文本与示例不必逐字相同
puts(response.output_text)

OpenAI CLI / Bash

## 生成一个简短睡前故事
openai responses create \
  --model gpt-6-astra \
  --input "Write a short bedtime story about a unicorn." \
  --raw-output \
  --transform 'output.#(type=="message").content.0.text'

在 ChatGPT 和 Codex 中使用 OpenAI API

OpenAI Developers 插件可将 ChatGPT、Codex 与 OpenAI 平台连接起来，辅助遵循 API 接入步骤，并在应用需要密钥时处理项目 API 密钥的创建流程。插件入口为OpenAI Developers 插件。

选择开发路径

模型入口

官方首页将 GPT-6 Astra 列为复杂推理和编码的起点，将 GPT-6.1 Sol 用于兼顾能力与成本的场景，将 GPT-6 Luna 用于对成本敏感、调用量较大的场景。选择时再核对任务所需的模型能力和账户访问条件。

可从模型目录查看完整列表，或查看 GPT-6 Astra、GPT-6.1 Sol、GPT-6 Luna 的详情。

按能力开始构建

开发资源

• 帮助中心：账户和账单常见问题。
• 开发者论坛：与其他开发者交流。
• Cookbook：开放的示例和实践指南。
• 服务状态：查询 OpenAI 服务运行状态。