Esta página apresenta as principais formas de desenvolver com a API da OpenAI: SDKs oficiais para o código do aplicativo, a OpenAI CLI para fluxos de trabalho nativos do shell, o Agents SDK para orquestração ou o cliente HTTP de sua preferência.
Crie e exporte uma chave de API
Antes de começar, crie uma chave de API no painel para acessar a API com segurança. Armazene a chave em um local seguro, como um arquivo .zshrc ou outro arquivo de texto no seu computador. Depois de gerar a chave de API, exporte-a como uma variável de ambiente no terminal.
export OPENAI_API_KEY="your_api_key_here"setx OPENAI_API_KEY "your_api_key_here"Os SDKs da OpenAI são configurados para ler automaticamente sua chave de API do ambiente do sistema.
Instale um SDK oficial
Para usar a API da OpenAI em ambientes JavaScript no servidor, como Node.js, Deno ou Bun, você pode usar o OpenAI SDK oficial para TypeScript e JavaScript. Comece instalando o SDK com npm ou com seu gerenciador de pacotes preferido:
npm install openaiCom o OpenAI SDK instalado, crie um arquivo chamado example.mjs e copie o código de exemplo para ele:
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);Execute o código com node example.mjs (ou o comando equivalente para Deno ou Bun). Em alguns instantes, você deverá ver o resultado da sua requisição à API.
Conheça mais capacidades e opções do SDK no README da biblioteca no GitHub.
Para usar a API da OpenAI em Python, você pode usar o OpenAI SDK para Python oficial. Comece instalando o SDK com o pip:
pip install openaiCom o OpenAI SDK instalado, crie um arquivo chamado example.py e copie o código de exemplo para ele:
from openai import OpenAI
client = OpenAI()
response = client.responses.create(
model="gpt-6-astra",
input="Write a one-sentence bedtime story about a unicorn.",
)
print(response.output_text)Execute o código com python example.py. Em alguns instantes, você deverá ver o resultado da sua requisição à API.
Conheça mais capacidades e opções do SDK no README da biblioteca no GitHub.
Em colaboração com a Microsoft, a OpenAI oferece um cliente de API para C# com suporte oficial. Você pode instalá-lo a partir do NuGet usando a CLI do .NET.
dotnet add package OpenAI
Uma requisição simples à Responses API seria assim:
using OpenAI.Responses;
#pragma warning disable OPENAI001
string key = Environment.GetEnvironmentVariable("OPENAI_API_KEY")!;
ResponsesClient client = new(key);
ResponseResult response = await client.CreateResponseAsync(
"gpt-6-astra",
"Say 'this is a test.'"
);
Console.WriteLine($"[ASSISTANT]: {response.GetOutputText()}");A OpenAI oferece uma biblioteca auxiliar para a API na linguagem de programação Java, atualmente em beta. Você pode incluir a dependência do Maven usando a seguinte configuração:
<dependency>
<groupId>com.openai</groupId>
<artifactId>openai-java</artifactId>
<version>4.58.0</version>
</dependency>Uma requisição simples à Responses API seria assim:
import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.responses.Response;
import com.openai.models.responses.ResponseCreateParams;
public class Main {
public static void main(String[] args) {
OpenAIClient client = OpenAIOkHttpClient.fromEnv();
ResponseCreateParams params =
ResponseCreateParams.builder().input("Say this is a test").model("gpt-6-astra").build();
Response response = client.responses().create(params);
response.output().stream()
.flatMap(item -> item.message().stream())
.flatMap(message -> message.content().stream())
.flatMap(content -> content.outputText().stream())
.forEach(outputText -> System.out.println(outputText.text()));
}
}Para saber mais sobre como usar a API da OpenAI em Java, confira o repositório no GitHub pelo link abaixo!
Conheça mais capacidades e opções do SDK no README da biblioteca no GitHub.
A OpenAI oferece uma biblioteca auxiliar para usar a API na linguagem de programação Go, atualmente em beta. Você pode importar a biblioteca usando o código abaixo:
import (
"github.com/openai/openai-go/v3" // imported as openai
)Uma primeira requisição à Responses API seria assim:
package main
import (
"context"
"fmt"
"github.com/openai/openai-go/v3"
"github.com/openai/openai-go/v3/responses"
)
func main() {
client := openai.NewClient()
resp, err := client.Responses.New(context.TODO(), responses.ResponseNewParams{
Model: "gpt-6-astra",
Input: responses.ResponseNewParamsInputUnion{OfString: openai.String("Say this is a test")},
})
if err != nil {
panic(err.Error())
}
fmt.Println(resp.OutputText())
}Para saber mais sobre como usar a API da OpenAI em Go, confira o repositório no GitHub pelo link abaixo!
Conheça mais capacidades e opções do SDK no README da biblioteca no GitHub.
Para usar a API da OpenAI em Ruby, você pode usar o OpenAI SDK para Ruby oficial. Comece adicionando a gem ao seu aplicativo:
gem "openai"Com o OpenAI SDK instalado, crie um arquivo chamado example.rb e copie o código de exemplo para ele:
require "openai"
openai = OpenAI::Client.new
response = openai.responses.create(
model: "gpt-6-astra",
input: "Write a one-sentence bedtime story about a unicorn."
)
puts(response.output_text)Execute o código com ruby example.rb. Em alguns instantes, você deverá ver o resultado da sua requisição à API.
Conheça mais capacidades e opções do SDK no README da biblioteca no GitHub.
Para chamar a API da OpenAI diretamente do seu terminal, instale a ferramenta de linha de comando gerada openai:
brew install openai/tools/openaiEm seguida, execute uma requisição básica à API pelo seu shell:
openai responses create \
--model "gpt-6-astra" \
--input "Write a one-sentence bedtime story about a unicorn." \
--raw-output \
--transform 'output.#(type=="message").content.0.text'Use a CLI para fluxos de trabalho repetíveis no terminal, como extrair dados estruturados de arquivos, gerar imagens, gerar fala e compor chamadas de API com ferramentas de shell como jq.
Saiba mais sobre fluxos de trabalho com a CLI e padrões de comandos.
Use o Agents SDK
Use os SDKs oficiais da OpenAI apresentados acima para fazer requisições diretas à API. Use o Agents SDK quando seu aplicativo precisar de orquestração definida em código para agentes, ferramentas, transferências de controle, mecanismos de proteção, rastreamento ou execução em sandbox.
Se você está decidindo entre requisições diretas à API e orquestração definida em código, veja como a Responses API se compara ao Agents SDK.
Crie seu primeiro agente com o Agents SDK.
Bibliotecas do Azure OpenAI
A equipe do Azure da Microsoft mantém bibliotecas compatíveis tanto com a API da OpenAI quanto com os serviços do Azure OpenAI. Leia a documentação das bibliotecas abaixo para saber como usá-las com a API da OpenAI.
- Biblioteca cliente do Azure OpenAI para .NET
- Biblioteca cliente do Azure OpenAI para JavaScript
- Biblioteca cliente do Azure OpenAI para Java
- Biblioteca cliente do Azure OpenAI para Go
Bibliotecas da comunidade
As bibliotecas abaixo são desenvolvidas e mantidas pela comunidade de desenvolvedores em geral. Você também pode acompanhar o repositório da nossa especificação OpenAPI no GitHub para receber notificações assim que fizermos alterações na API.
Observe que a OpenAI não verifica o funcionamento correto nem a segurança desses projetos. Use-os por sua conta e risco!
Clojure
- openai-clojure por wkok
Dart/Flutter
Delphi
- DelphiOpenAI por HemulGM
Elixir
Kotlin
PHP
Rust
- async-openai por 64bit
Scala
Swift
- AIProxySwift por Lou Zell
- OpenAIKit por dylanshine
- OpenAI por MacPaw
Unity
Unreal Engine
Outros repositórios da OpenAI
- tiktoken - contagem de tokens
- simple-evals - biblioteca simples de avaliação
- mle-bench - biblioteca para avaliar agentes que atuam como engenheiros de aprendizado de máquina
- gym - biblioteca de aprendizado por reforço
- swarm - repositório de orquestração para fins educacionais