For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Navegação principal

SDKs e CLI

Escolha a melhor forma de desenvolver com a API da OpenAI: um SDK para aplicativos, a CLI para fluxos de trabalho no terminal ou o Agents SDK para orquestração.

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.

Exporte uma variável de ambiente em sistemas macOS ou Linux
export 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:

Instale o OpenAI SDK com npm
npm install openai

Com o OpenAI SDK instalado, crie um arquivo chamado example.mjs e copie o código de exemplo para ele:

Teste uma requisição básica à 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);

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.

Saiba mais no GitHub

Conheça mais capacidades e opções do SDK no README da biblioteca no GitHub.

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.

Início rápido do 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.


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

Dart/Flutter

Delphi

Elixir

Kotlin

PHP

Rust

Scala

Swift

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