For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Navigation principale

Démarrage rapide pour les développeurs

Faites vos premiers pas avec l’API OpenAI.

L’API OpenAI offre une interface unifiée pour accéder à des modèles d’IA de pointe pour la génération de texte, le traitement du langage naturel, la vision par ordinateur et bien plus encore. Pour commencer, créez une clé API et effectuez votre premier appel API. Découvrez comment générer du texte, analyser des images, créer des agents et bien plus encore.

Créez et exportez une clé API

Créer une clé API

Avant de commencer, créez une clé API dans le tableau de bord. Elle vous permettra d’accéder à l’API de manière sécurisée. Conservez cette clé dans un emplacement sûr, comme un fichier .zshrc ou un autre fichier texte sur votre ordinateur. Une fois la clé API générée, exportez-la en tant que variable d’environnement dans votre terminal.

Exportez une variable d’environnement sur macOS ou Linux
export OPENAI_API_KEY="your_api_key_here"

Chaque SDK OpenAI lit automatiquement votre clé API dans les variables d’environnement du système.

Installez le SDK OpenAI et effectuez un appel API

Pour utiliser l’API OpenAI dans des environnements JavaScript côté serveur comme Node.js, Deno ou Bun, vous pouvez utiliser le SDK OpenAI officiel pour TypeScript et JavaScript. Commencez par installer le SDK avec npm ou votre gestionnaire de paquets préféré :

Installez le SDK OpenAI avec npm
npm install openai

Une fois le SDK OpenAI installé, créez un fichier nommé example.mjs et copiez-y le code d’exemple :

Testez une requête API simple
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);

Exécutez le code avec node example.mjs (ou la commande équivalente pour Deno ou Bun). Au bout de quelques instants, vous devriez voir le résultat de votre requête API.

En savoir plus sur GitHub

Découvrez d’autres capacités et options du SDK dans le README de la bibliothèque sur GitHub.

Application de démarrage pour Responses

Commencez à développer avec l’API Responses.

Génération de texte et conception de prompts

Découvrez la conception de prompts, les rôles des messages et la création d’applications conversationnelles.

Ajoutez des crédits pour continuer à développer

Accéder à la facturation

Bravo, vous avez effectué une requête API de test gratuite ! Commencez à créer de véritables applications avec des limites plus élevées et utilisez nos modèles pour générer du texte, de l’audio, des images, des vidéos et bien plus encore.

Découvrez les outils et la documentation conçus pour vous aider à livrer vos applications plus rapidement :

Playground de discussion

Créez et testez des prompts conversationnels, puis intégrez-les à votre application.

Créez des agents

Utilisez l’Agents SDK pour créer, exécuter et observer des workflows d’agents.

Analysez des images et des fichiers

Envoyez directement au modèle des URL d’images, des fichiers importés ou des documents PDF pour extraire du texte, classer du contenu ou détecter des éléments visuels.

Analysez le contenu d’une image
import OpenAI from "openai";
const client = new OpenAI();

const response = await client.responses.create({
  model: "gpt-6-astra",
  input: [
    {
      role: "user",
      content: [
        {
          type: "input_text",
          text: "What is in this image?",
        },
        {
          type: "input_image",
          image_url:
            "https://openai-documentation.vercel.app/images/cat_and_otter.png",
          detail: "auto",
        },
      ],
    },
  ],
});

console.log(response.output_text);
Guide des images en entrée

Apprenez à fournir des images en entrée au modèle et à en extraire des informations.

Guide des fichiers en entrée

Apprenez à fournir des fichiers en entrée au modèle et à extraire des informations de documents.

Étendez les capacités du modèle avec des outils

Donnez au modèle accès à des données et à des fonctions externes en lui associant des outils. Utilisez des outils intégrés comme la recherche web ou la recherche de fichiers, ou définissez vos propres outils pour appeler des API, exécuter du code ou intégrer des systèmes tiers.

Utilisez la recherche web dans une réponse
import OpenAI from "openai";
const client = new OpenAI();

const response = await client.responses.create({
  model: "gpt-6-astra",
  tools: [{ type: "web_search" }],
  input: "What was a positive news story from today?",
});

console.log(response.output_text);
Utilisez les outils intégrés

Découvrez des outils intégrés puissants comme la recherche web et la recherche de fichiers.

Guide de l’appel de fonction

Apprenez à permettre au modèle d’appeler votre propre code personnalisé.

Diffusez les réponses en streaming et créez des applications en temps réel

Utilisez les événements de streaming envoyés par le serveur pour afficher les résultats au fur et à mesure de leur génération, ou utilisez la Realtime API pour créer des applications vocales interactives et des applications acceptant du texte, de l’audio et des images en entrée.

Diffusez en streaming les événements envoyés par le serveur de l’API
import { OpenAI } from "openai";
const client = new OpenAI();

const stream = await client.responses.create({
  model: "gpt-6-astra",
  input: [
    {
      role: "user",
      content: "Say 'double bubble bath' ten times fast.",
    },
  ],
  stream: true,
});

for await (const event of stream) {
  console.log(event);
}
Utilisez les événements de streaming

Utilisez les événements envoyés par le serveur pour diffuser rapidement les réponses du modèle en streaming aux utilisateurs.

Faites vos premiers pas avec la Realtime API

Utilisez WebRTC ou WebSockets pour créer des applications d’IA parole à parole ultrarapides.

Créez des agents

Utilisez la plateforme OpenAI pour créer des agents capables d’agir pour le compte de vos utilisateurs, par exemple en contrôlant des ordinateurs. Utilisez l’Agents SDK pour créer une logique d’orchestration sur votre serveur.

Créez un agent d’orientation selon la langue
import { Agent, run } from "@openai/agents";

const spanishAgent = new Agent({
  name: "Spanish agent",
  instructions: "You only speak Spanish.",
});

const englishAgent = new Agent({
  name: "English agent",
  instructions: "You only speak English",
});

const triageAgent = new Agent({
  name: "Triage agent",
  instructions:
    "Handoff to the appropriate agent based on the language of the request.",
  handoffs: [spanishAgent, englishAgent],
});

const result = await run(triageAgent, "Hola, ¿cómo estás?");
console.log(result.finalOutput);
Créez des agents capables d’agir

Apprenez à utiliser la plateforme OpenAI pour créer des agents d’IA puissants et performants.