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

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 上の 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 - オーケストレーションを学ぶためのリポジトリ