For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
メインナビゲーション
Theme

SDK と CLI

OpenAI API を使った開発では、用途に合わせてツールを選びます。アプリケーション開発には SDK、ターミナルでの作業には CLI、オーケストレーションには Agents SDK を使用できます。

このページでは、OpenAI API を使って開発する主な方法を紹介します。アプリケーションのコードからは公式 SDK を、シェルでの作業には OpenAI CLI を、オーケストレーションには Agents SDK を使用できます。使い慣れた HTTP クライアントも利用できます。

API キーの作成とエクスポート

まず、ダッシュボードで API キーを作成します。このキーを使って安全に API にアクセスします。キーは、.zshrc ファイルやコンピューター上の別のテキストファイルなど、安全な場所に保存してください。API キーを生成したら、ターミナルで環境変数としてエクスポートします。

macOS または Linux で環境変数をエクスポート
export OPENAI_API_KEY="your_api_key_here"

OpenAI の SDK は、システムの環境変数から API キーを自動的に読み取ります。

公式 SDK のインストール

Node.js、Deno、Bun などのサーバーサイド JavaScript 環境から OpenAI API を呼び出すには、公式の TypeScript および JavaScript 向け OpenAI SDK を利用できます。まず、npm またはお好みのパッケージマネージャーで SDK をインストールします。

npm を使った OpenAI SDK のインストール
npm install openai

OpenAI SDK をインストールしたら、example.mjs というファイルを作成し、次のサンプルコードを貼り付けます。

基本的な API リクエストのテスト
import OpenAI from "openai";
const client = new OpenAI();

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

console.log(response.output_text);

node example.mjs でコードを実行します(Deno または Bun を使う場合は、対応するコマンドを使います)。しばらくすると、API リクエストの結果が表示されます。

GitHub で詳細を確認

SDK のその他の機能やオプションについては、GitHub リポジトリの README をご覧ください。

Agents SDK の利用

API に直接リクエストを送るには、上記の OpenAI 公式 SDK を使用します。アプリケーションでエージェント、ツール、ハンドオフ、ガードレール、トレーシング、サンドボックスでの実行などをコードでオーケストレーションする必要がある場合は、Agents SDK を使用します。

API に直接リクエストを送る方法と、コードでオーケストレーションする方法のどちらを選ぶか迷った場合は、Responses API と Agents SDK の比較を参照してください。

Agents SDK クイックスタート

Agents SDK を使って最初のエージェントを作成します。

Azure OpenAI ライブラリ

Microsoft の Azure チームは、OpenAI API と Azure OpenAI サービスの両方に対応するライブラリを保守しています。各ライブラリで OpenAI API を利用する方法は、以下のドキュメントを参照してください。


コミュニティが提供するライブラリ

以下のライブラリは、開発者コミュニティが開発・保守しています。GitHub で OpenAI の OpenAPI 仕様リポジトリをウォッチすると、OpenAI が API を変更した際に通知を受け取れます。

OpenAI は、これらのプロジェクトの正確性や安全性を検証していません。ご自身の責任で使用してください。

Clojure

Dart/Flutter

Delphi

Elixir

Kotlin

PHP

Rust

Scala

Swift

Unity

Unreal Engine

その他の OpenAI リポジトリ

  • tiktoken - トークン数の計算
  • simple-evals - シンプルな評価ライブラリ
  • mle-bench - 機械学習エンジニアの業務を担うエージェントを評価するライブラリ
  • gym - 強化学習ライブラリ
  • swarm - オーケストレーションを学ぶためのリポジトリ