openai/openai-openapi

OpenAPI specification for the OpenAI API

解決する課題

OpenAI REST API の機械可読で標準化された説明を提供します。これにより、エンドポイント、認証、リクエスト/レスポンススキーマの信頼できる唯一の情報源が提供されるため、開発者がクライアントライブラリや API エクスプローラーを手動で作成する必要がなくなります。

仕組み

このプロジェクトは、OpenAI API 定義を OpenAPI 3.1 形式 (.yaml および .json ファイルとして利用可能) で公開します。これらのファイルは上流のソースから同期された生成物であり、OpenAPI エコシステムをサポートする任意のツールにインポートして、API 統合の開発を自動化できます。

対象者

OpenAPI 互換のワークフローを使用して、型付けされたクライアント、API エクスプローラーを構築したり、OpenAI API のテストツールを構成したい開発者。

ハイライト

  • 標準化されたフォーマット: 業界のツールとの幅広い互換性のために OpenAPI 3.1 を使用します。
  • API の SBOM: Python、JavaScript、.NET、Go、Java、Ruby などの言語での公式 OpenAI SDK の基盤として機能します。
  • 自動同期: 仕様は上流のソースから自動的に同期され、正確性が確保されます。

関連

  • プロジェクト
    openai/openai-python

    OpenAI の API 用の公式 Python SDK。同期／非同期クライアント、チャット、コンプリーション、ビジョン、リアルタイム音声、ストリーミング、ページネーション、ファイルアップロード、Webhook 検証、および現代的なワークロードアイデンティティ認証（K8s、Azure、GCP、X.509）を完全に型チェック済みで提供。

  • プロジェクト
    openai/openai-node

    OpenAI REST API用の公式TypeScriptおよびJavaScriptライブラリ。テキスト、ビジョン、リアルタイムのマルチモーダルモデルへの型付きアクセスを提供します。

  • プロジェクト
    openai/openai-go

    Goで書かれたアプリケーション向けに、OpenAI REST API に型安全にアクセスできる公式の OpenAI Go ライブラリです。

  • プロジェクト
    openai/openai-cli

    OpenAI CLIは、OpenAI REST APIの公式コマンドラインクライアントです。Homebrewまたは`go install`でインストールし、APIキーを設定して、`openai responses create`や管理者用クエリを実行できます。カスタムヘッダー、相互TLS (mTLS)、柔軟な出力形式、ファイルアップロード、およびOpenAI Go SDKの任意のバージョンとリンク可能です。Apache 2.0ライセンスで提供されています。

  • プロジェクト
    openai/openai-dotnet

    .NETアプリケーション向けのOpenAI REST APIに便利で型安全なアクセスを提供する公式OpenAI .NET APIライブラリ。