codecamp

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 插件。

选择开发路径

路径 适用任务 文档入口
Responses API 直接向模型发起文本、结构化输出、工具和多模态请求 文本生成
Agents SDK 用代码组织工具、交接、审批、追踪以及容器执行等智能体流程 Agents SDK 快速开始

模型入口

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

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

按能力开始构建

想要完成的任务 对应入口
读取、理解与生成文本 文本生成
处理图像输入并分析画面 图像与视觉
生成图像 图像生成
分析、转写和生成音频 音频与语音
构建会使用工具和计算机的智能体 智能体
使用推理能力处理复杂任务 推理模型
生成符合 JSON Schema 的数据 结构化输出
通过评测、微调及相关方法优化模型表现 模型优化

开发资源

OpenAI API 模型
OpenAI CLI
温馨提示
下载编程狮App,免费阅读超1000+编程语言教程
取消
确定
目录

其他能力与进阶指南

Embeddings 接口参考

审计日志接口参考

关闭

MIP.setData({ 'pageTheme' : getCookie('pageTheme') || {'day':true, 'night':false}, 'pageFontSize' : getCookie('pageFontSize') || 20 }); MIP.watch('pageTheme', function(newValue){ setCookie('pageTheme', JSON.stringify(newValue)) }); MIP.watch('pageFontSize', function(newValue){ setCookie('pageFontSize', newValue) }); function setCookie(name, value){ var days = 1; var exp = new Date(); exp.setTime(exp.getTime() + days*24*60*60*1000); document.cookie = name + '=' + value + ';expires=' + exp.toUTCString(); } function getCookie(name){ var reg = new RegExp('(^| )' + name + '=([^;]*)(;|$)'); return document.cookie.match(reg) ? JSON.parse(document.cookie.match(reg)[2]) : null; }