首页 > AI教程 >OpenAI API Python 快速入门教程

OpenAI API Python 快速入门教程

来源:互联网 2026-07-22 06:21:03

完成OpenAIResponsesAPI快速开始需准备API密钥、Python3及pip,通过环境变量传递密钥而非硬编码,在统一终端中安装openaiSDK并运行example.py脚本。请求使用client.responses.create,结果通过response.output_text输出。遇到错误可按模块、认证、网络、模型或用量分类排查,确保环境与解

代码没有报语法错,运行后却卡在认证或模块导入,通常不是 Responses API 本身难,而是密钥、Python 环境和运行终端没有对上。完成这条路径后,Windows、macOS 或 Linux 电脑会得到一个可运行的 example.py:它使用官方 OpenAI Python SDK 发出一条 Responses API 请求,并从 response.output_text 打印结果。

开始前需要准备可使用 API 的 OpenAI 账号、一个能创建并妥善保管的 API 密钥、Python 3 和 pip。API 密钥属于敏感凭据,不要写进 Python 文件、截图或 Git 仓库。示例沿用 OpenAI 当前快速开始页面中的 gpt-5.6;页面示例发生变化时,应以当时的官方快速开始代码为准。

长期稳定更新的攒劲资源: >>>点此立即查看<<<

本教程将带你一步步搭建环境、编写代码,并成功运行第一次 Responses API 请求。我们还会特别关注那些容易出错的地方,并提供详细的排查方法,确保你能够顺利通过。

先让运行 Python 的终端读到密钥

  1. 入口位置:登录 OpenAI API 控制台,进入 API 密钥管理页。主要动作:点击创建 API 密钥的按钮,生成后立即复制到密码管理器或其他安全位置。成功标志:密钥列表出现新记录,并且手边保存了刚生成的完整值。失败处理:看不到创建入口时,先确认登录账号和项目权限;如果完整值已经关闭且没有保存,应撤销旧记录并重新创建,不要尝试从截图或日志找回。

  2. 入口位置:打开稍后要运行 Python 的同一个终端窗口。主要动作:macOS 或 Linux 执行 export OPENAI_API_KEY="your_api_key_here";Windows 命令提示符执行 setx OPENAI_API_KEY "your_api_key_here",然后新开一个终端让设置生效。成功标志:执行 python -c "import os; print(bool(os.environ.get('OPENAI_API_KEY')))" 返回 True,而且没有打印密钥正文。失败处理:返回 False 时,检查变量名是否完整、引号是否成对;macOS 或 Linux 还要确认没有换到另一个终端会话,Windows 使用 setx 后则必须重新打开终端。

官方快速开始把“创建密钥”和“导出环境变量”放在第一个准备环节。画面中的系统切换项用于区分 macOS、Linux 与 Windows 命令;成功标准不是看见命令,而是当前 Python 进程确实能读取 OPENAI_API_KEY

OpenAI API Python 快速入门教程

把官方 Python SDK 安装到当前解释器

  1. 入口位置:仍在刚才验证过环境变量的终端中。主要动作:执行 pip install openai。如果电脑同时安装了多个 Python,可改用与运行脚本相同解释器对应的 python -m pip install openai成功标志:安装命令正常结束,再执行 python -c "from openai import OpenAI; print('SDK ready')" 能看到 SDK ready失败处理:出现 pip 找不到时,先确认 Python 和 pip 已加入 PATH;安装成功却仍报 No module named openai,说明安装与运行使用了不同的 Python,应分别检查 python --versionpython -m pip --version 指向的位置。

Python 标签下的官方安装命令只有一个包名。这里最值得看的是页面已切换到 Python,避免把 Ja vaScript、.NET 或其他语言的安装方式复制进当前环境。

OpenAI API Python 快速入门教程

写入第一条 Responses API 请求

  1. 入口位置:在准备存放示例的空目录中新建 example.py主要动作:写入下面的代码并保存,密钥不出现在文件中,OpenAI() 会从环境读取 OPENAI_API_KEY
from openai import OpenAI

client = OpenAI()

response = client.responses.create(
    model="gpt-5.6",
    input="Write a one-sentence bedtime story about a unicorn."
)

print(response.output_text)

成功标志:文件中能看到 from openai import OpenAIclient.responses.createprint(response.output_text) 三处关键代码,编辑器没有把文件另存为 example.py.txt失败处理:如果编辑器提示缩进或引号错误,先与下方官方代码截图逐行核对;若文件扩展名被隐藏,可在终端执行 ls 或 Windows 的 dir 确认真实文件名。

请求代码里,model 决定调用的模型,input 是本次输入,返回对象的 output_text 是便于读取最终文本的属性。三者不要与旧教程里的其他接口字段混用。

OpenAI API Python 快速入门教程

运行脚本并按错误位置排查

  1. 入口位置:在终端切换到 example.py 所在目录。主要动作:执行 python example.py;macOS 或 Linux 上若系统只提供 python3,则执行 python3 example.py成功标志:等待片刻后,终端打印模型返回的一句话,而不是 Python traceback。失败处理:No module named openai 时回到 SDK 安装步骤核对解释器;认证错误时重新运行不泄露密钥的环境变量检查;连接失败时检查网络后再试;若返回模型或用量相关错误,应按响应中的错误类型核对当前项目可用模型与 API 用量设置,不要盲目重复请求。

官方页面在代码后明确给出 python example.py 这一执行方式,并把“看到 API 请求输出”作为完成信号。下图是官方运行指引,不是本机终端结果;真正验收仍要看自己的终端是否打印了 output_text

OpenAI API Python 快速入门教程

特色功能与最佳实践

本教程不仅让你跑通代码,还强调了以下关键特性,帮助你写出更健壮、更安全的应用程序。

  • 密钥安全:通过环境变量传递 API 密钥,避免了硬编码在代码中的风险。这是任何生产级应用都必需的安全实践。
  • 环境一致性:强调了在同一个终端中完成所有操作,确保环境变量、SDK 安装和脚本运行使用相同的 Python 解释器,这是解决“代码无错误但运行失败”问题的关键。
  • 精确的错误隔离:将错误分为模块、认证、网络、模型、用量等类别,让你能快速定位问题,而不是盲目重试。
  • 最小验证原则:先跑通最简代码,验证账号、环境和 SDK 正确,之后再添加复杂功能(如多轮对话、文件输入),这能极大地简化排错过程。

常见问题(FAQ)

1. 环境变量检查返回 False,但我已经设置了,怎么办?

最常见的原因是终端会话不一致。请检查你是否在同一个终端窗口中完成了设置和检查。对于 macOS 或 Linux,export 命令只对当前终端生效,新开一个窗口或标签页就会丢失。对于 Windows,setx 命令会对未来的新终端生效,但你需要重新打开一个命令提示符窗口,再执行检查命令。另外,仔细检查变量名是否完全正确,包括大小写和下划线,确保没有多余的空格。

2. 安装 openai 成功,但运行脚本时提示 ModuleNotFoundError: No module named 'openai',怎么回事?

这说明你安装 openai 的 Python 解释器,与运行 example.py 使用的 Python 解释器不是同一个。例如,你的系统可能同时安装了 Python 2 和 Python 3,或者有多个 Python 3 版本。你可以在终端中执行以下命令来确认:

  • python --versionpython -m pip --version,看它们是否指向同一个 Python 目录。
  • 使用 which python (macOS/Linux) 或 where python (Windows) 查看具体路径。

解决办法是:使用 python -m pip install openai 来安装,而不是单纯的 pip install openai。这样能确保安装到与 python 命令一致的解释器。运行脚本时,也使用相同的 python 命令。

3. 运行脚本后出现 AuthenticationError,但环境变量检查是 True,为什么?

环境变量检查返回 True 只能说明变量存在,但并不能保证它的值是正确的。可能的原因:

  • 你设置的 API 密钥本身是无效的(例如,复制时多复制了空格、引号,或者密钥已过期/被撤销)。
  • 你设置的 API 密钥属于一个不同的 OpenAI 项目,而当前项目没有使用该密钥的权限。

请回到 OpenAI 控制台,撤销旧的 API 密钥,重新创建一个新密钥,并确保在设置环境变量时,不要包含任何额外的引号或空格。例如:export OPENAI_API_KEY=sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 而不是 export OPENAI_API_KEY="sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"(虽然引号通常无害,但为了避免低级错误,建议直接使用纯值)。

4. 运行脚本后长时间没有响应,最终超时或报连接错误,怎么办?

这通常是因为网络问题。请检查:

  • 你的网络连接是否正常,能否访问外网。
  • 你的网络环境是否能够访问 OpenAI 的 API 端点(api.openai.com)。在公司或学校网络下,可能需要配置袋里。
  • 如果使用袋里,请确保你的终端或 Python 环境正确设置了袋里环境变量,如 http_proxyhttps_proxy

你可以通过 curl -I https://api.openai.com/v1/models 命令来简单测试网络连通性(注意,这需要你已经设置了 API 密钥为环境变量,或者在请求头中携带)。

5. 代码看起来和示例一样,但运行时提示 SyntaxError: invalid syntax,怎么办?

这通常是因为你的 Python 版本太低(例如使用了 Python 2),或者代码中存在不可见的字符。请确保:

  • 你使用的是 Python 3.7 或更高版本。可以通过 python --versionpython3 --version 检查。
  • 你的代码文件没有任何不可见的特殊字符。建议使用一个简单的文本编辑器(如 VS Code、Sublime Text、Notepad++)重新输入代码,而不是从网页复制粘贴,因为复制粘贴有时会引入格式错误。
  • 仔细检查你的代码,特别是 print(response.output_text) 这一行,确保是 output_text 而不是 output_text 或其他拼写错误。

用六项结果确认快速开始已经完成

  • API 密钥保存在安全位置,没有出现在源码、截图或版本库中。
  • 运行脚本的 Python 进程能读取 OPENAI_API_KEY,检查命令只返回布尔值。
  • python -m pip --version 与运行 example.py 的解释器一致。
  • from openai import OpenAI 可以导入,不再出现模块缺失错误。
  • 请求使用 client.responses.create,结果通过 response.output_text 输出。
  • 终端实际打印模型回复;若失败,能根据模块、认证、网络、模型或用量错误回到对应步骤处理。

这条请求跑通后,再把固定的英文输入换成业务中的真实问题。先保留最小代码验证账号、环境和 SDK,等输出稳定后再增加多轮上下文、文件输入或工具调用,排错会简单得多。希望这份详尽的教程能帮助你顺利起步,并让你对 OpenAI Responses API 的调用流程有更清晰的理解。

侠游戏发布此文仅为了传递信息,不代表侠游戏网站认同其观点或证实其描述

热游推荐

更多
湘ICP备14008430号-1 湘公网安备 43070302000280号
All Rights Reserved
本站为非盈利网站,不接受任何广告。本站所有软件,都由网友
上传,如有侵犯你的版权,请发邮件给xiayx666@163.com
抵制不良色情、反动、暴力游戏。注意自我保护,谨防受骗上当。
适度游戏益脑,沉迷游戏伤身。合理安排时间,享受健康生活。