VOOZH about

URL: https://developers.openai.com/api/docs/libraries

⇱ SDKs and CLI | OpenAI API


Search the API docs

Primary navigation

Evaluation

Legacy APIs

This page covers the main ways to build with the OpenAI API: official SDKs for application code, the OpenAI CLI for shell-native workflows, the Agents SDK for orchestration, or your own preferred HTTP client.

Create and export an API key

Before you begin, create an API key in the dashboard, which you’ll use to securely access the API. Store the key in a safe location, like a .zshrc file or another text file on your computer. Once you’ve generated an API key, export it as an environment variable in your terminal.

macOS / Linux
Windows

OpenAI SDKs are configured to automatically read your API key from the system environment.

Install an official SDK

JavaScript

To use the OpenAI API in server-side JavaScript environments like Node.js, Deno, or Bun, you can use the official OpenAI SDK for TypeScript and JavaScript. Get started by installing the SDK using npm or your preferred package manager:

With the OpenAI SDK installed, create a file called example.mjs and copy the example code into it:

Execute the code with node example.mjs (or the equivalent command for Deno or Bun). In a few moments, you should see the output of your API request.

Learn more on GitHub

Discover more SDK capabilities and options on the library’s GitHub README.

Python

To use the OpenAI API in Python, you can use the official OpenAI SDK for Python. Get started by installing the SDK using pip:

With the OpenAI SDK installed, create a file called example.py and copy the example code into it:

Execute the code with python example.py. In a few moments, you should see the output of your API request.

Learn more on GitHub

Discover more SDK capabilities and options on the library’s GitHub README.

.NET

In collaboration with Microsoft, OpenAI provides an officially supported API client for C#. You can install it with the .NET CLI from NuGet.

dotnet add package OpenAI

A simple API request to the Responses API would look like this:

Java

OpenAI provides an API helper for the Java programming language, currently in beta. You can include the Maven dependency using the following configuration:

<dependency>
 <groupId>com.openai</groupId>
 <artifactId>openai-java</artifactId>
 <version>4.0.0</version>
</dependency>

A simple API request to Responses API would look like this:

To learn more about using the OpenAI API in Java, check out the GitHub repo linked below!

Learn more on GitHub

Discover more SDK capabilities and options on the library’s GitHub README.

Go

OpenAI provides an API helper for the Go programming language, currently in beta. You can import the library using the code below:

import (
 "github.com/openai/openai-go" // imported as openai
)

A simple API request to the Responses API would look like this:

To learn more about using the OpenAI API in Go, check out the GitHub repo linked below!

Learn more on GitHub

Discover more SDK capabilities and options on the library’s GitHub README.

Ruby

To use the OpenAI API in Ruby, you can use the official OpenAI SDK for Ruby. Get started by adding the gem to your application:

With the OpenAI SDK installed, create a file called example.rb and copy the example code into it:

Execute the code with ruby example.rb. In a few moments, you should see the output of your API request.

Learn more on GitHub

Discover more SDK capabilities and options on the library’s GitHub README.

CLI

To call the OpenAI API directly from your terminal, install the generated openai command-line tool:

Then run a basic API request from your shell:

Use the CLI for repeatable terminal workflows such as extracting structured data from files, generating images, creating speech, and composing API calls with shell tools like jq.

OpenAI CLI guide

Learn more about CLI workflows and command patterns.

Use the Agents SDK

Use the official OpenAI SDKs above for direct API requests. Use the Agents SDK when your application needs code-first orchestration for agents, tools, handoffs, guardrails, tracing, or sandbox execution.

Agents SDK quickstart

Build your first agent with the Agents SDK.

Azure OpenAI libraries

Microsoft’s Azure team maintains libraries that are compatible with both the OpenAI API and Azure OpenAI services. Read the library documentation below to learn how you can use them with the OpenAI API.


Community libraries

The libraries below are built and maintained by the broader developer community. You can also watch our OpenAPI specification repository on GitHub to get timely updates on when we make changes to our API.

Please note that OpenAI does not verify the correctness or security of these projects. Use them at your own risk!

Clojure

Dart/Flutter

Delphi

Elixir

Kotlin

PHP

Rust

Scala

Swift

Unity

Unreal Engine

Other OpenAI repositories

  • tiktoken - counting tokens
  • simple-evals - simple evaluation library
  • mle-bench - library to evaluate machine learning engineer agents
  • gym - reinforcement learning library
  • swarm - educational orchestration repository

Loading docs agent...