OpenAI

Documentation Index

Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

• Modèles d’agent - modèles openai/* via le runtime Codex ; connectez-vous avec l’authentification Codex pour l’utilisation d’un abonnement ChatGPT/Codex, ou configurez une sauvegarde par clé d’API OpenAI compatible Codex lorsque vous voulez intentionnellement une authentification par clé d’API.
• API OpenAI hors agent - accès direct à la plateforme OpenAI avec facturation à l’usage via OPENAI_API_KEY ou l’onboarding par clé d’API OpenAI.
• Configuration héritée - les références de modèle openai-codex/* sont réparées par openclaw doctor --fix en openai/* plus le runtime Codex.

​

Choix rapide

​

Carte de nommage

​

Couverture des fonctionnalités OpenClaw

​

Embeddings mémoire

{
  agents: {
    defaults: {
      memorySearch: {
        provider: "openai",
        model: "text-embedding-3-small",
      },
    },
  },
}

​

Démarrage

openclaw onboard --auth-choice openai-api-key

openclaw onboard --openai-api-key "$OPENAI_API_KEY"

openclaw models list --provider openai

{
  env: { OPENAI_API_KEY: "sk-..." },
  agents: { defaults: { model: { primary: "openai/gpt-5.5" } } },
}

{
  env: { OPENAI_API_KEY: "sk-..." },
  agents: { defaults: { model: { primary: "openai/chat-latest" } } },
}

openclaw onboard --auth-choice openai-codex

openclaw models auth login --provider openai-codex

openclaw models auth login --provider openai-codex --device-code

openclaw config set agents.defaults.model.primary openai/gpt-5.5

openclaw models list --provider openai-codex

{
  plugins: { entries: { codex: { enabled: true } } },
  agents: {
    defaults: {
      model: { primary: "openai/gpt-5.5" },
    },
  },
}

{
  plugins: { entries: { codex: { enabled: true } } },
  agents: {
    defaults: {
      model: { primary: "openai/gpt-5.5" },
    },
  },
  auth: {
    order: {
      openai: [
        "openai-codex:user@example.com",
        "openai:api-key-backup",
      ],
    },
  },
}

openclaw models status
openclaw models auth list --provider openai-codex
openclaw config get agents.defaults.model --json
openclaw config get models.providers.openai.agentRuntime --json

openclaw models status --agent <id>
openclaw models auth list --agent <id> --provider openai-codex

openclaw doctor --fix
openclaw config validate

openclaw models auth login --provider openai-codex
openclaw models status --probe --probe-provider openai-codex

{
  models: {
    providers: {
      "openai-codex": {
        models: [{ id: "gpt-5.5", contextTokens: 160000 }],
      },
    },
  },
}

​

Authentification native du serveur d’application Codex

1. Profils d’authentification OpenAI ordonnés pour l’agent, de préférence sous auth.order.openai. Les profils openai-codex:* existants et auth.order.openai-codex restent valides pour les installations plus anciennes.
2. Le compte existant du serveur d’application, comme une connexion ChatGPT locale de la CLI Codex.
3. Pour les lancements locaux du serveur d’application stdio uniquement, CODEX_API_KEY, puis OPENAI_API_KEY, lorsque le serveur d’application ne signale aucun compte et nécessite encore une authentification OpenAI.

​

Génération d’images

{
  agents: {
    defaults: {
      imageGenerationModel: { primary: "openai/gpt-image-2" },
    },
  },
}

openclaw infer image generate \
  --model openai/gpt-image-1.5 \
  --output-format png \
  --background transparent \
  --prompt "A simple red circle sticker on a transparent background" \
  --json

/tool image_generate model=openai/gpt-image-2 prompt="A polished launch poster for OpenClaw on macOS" size=3840x2160 count=1

/tool image_generate model=openai/gpt-image-1.5 prompt="A simple red circle sticker on a transparent background" outputFormat=png background=transparent

/tool image_generate model=openai/gpt-image-2 prompt="Preserve the object shape, change the material to translucent glass" image=/path/to/reference.png size=1024x1536

​

Génération de vidéos

{
  agents: {
    defaults: {
      videoGenerationModel: { primary: "openai/sora-2" },
    },
  },
}

​

Contribution de prompt GPT-5

{
  agents: {
    defaults: {
      promptOverlays: {
        gpt5: { personality: "friendly" },
      },
    },
  },
}

openclaw config set agents.defaults.promptOverlays.gpt5.personality off

​

Voix et parole

{
  messages: {
    tts: {
      providers: {
        openai: { model: "gpt-4o-mini-tts", voice: "coral" },
      },
    },
  },
}

{
  tools: {
    media: {
      audio: {
        models: [
          {
            type: "provider",
            provider: "openai",
            model: "gpt-4o-transcribe",
          },
        ],
      },
    },
  },
}

​

Points de terminaison Azure OpenAI

• Vous disposez déjà d’un abonnement Azure OpenAI, d’un quota ou d’un accord d’entreprise
• Vous avez besoin de la résidence régionale des données ou des contrôles de conformité fournis par Azure
• Vous souhaitez conserver le trafic à l’intérieur d’un tenant Azure existant

​

Configuration

{
  models: {
    providers: {
      openai: {
        baseUrl: "https://<your-resource>.openai.azure.com",
        apiKey: "<azure-openai-api-key>",
      },
    },
  },
}

• *.openai.azure.com
• *.services.ai.azure.com
• *.cognitiveservices.azure.com

• Envoie l’en-tête api-key au lieu de Authorization: Bearer
• Utilise des chemins limités au déploiement (/openai/deployments/{deployment}/...)
• Ajoute ?api-version=... à chaque requête
• Utilise un délai d’expiration de requête par défaut de 600 s pour les appels de génération d’images Azure. Les valeurs timeoutMs par appel remplacent toujours cette valeur par défaut.

​

Version de l’API

export AZURE_OPENAI_API_VERSION="2024-12-01-preview"

​

Les noms de modèles sont des noms de déploiements

/tool image_generate model=openai/gpt-image-2-prod prompt="A clean poster" size=1024x1024 count=1

​

Disponibilité régionale

​

Différences de paramètres

​

Configuration avancée

{
  agents: {
    defaults: {
      models: {
        "openai/gpt-5.5": {
          params: { transport: "auto" },
        },
      },
    },
  },
}

{
  agents: {
    defaults: {
      models: {
        "openai/gpt-5.5": { params: { fastMode: true } },
      },
    },
  },
}

{
  agents: {
    defaults: {
      models: {
        "openai/gpt-5.5": { params: { serviceTier: "priority" } },
      },
    },
  },
}

{
  agents: {
    defaults: {
      models: {
        "azure-openai-responses/gpt-5.5": {
          params: { responsesServerCompaction: true },
        },
      },
    },
  },
}

{
  agents: {
    defaults: {
      models: {
        "openai/gpt-5.5": {
          params: {
            responsesServerCompaction: true,
            responsesCompactThreshold: 120000,
          },
        },
      },
    },
  },
}

{
  agents: {
    defaults: {
      models: {
        "openai/gpt-5.5": {
          params: { responsesServerCompaction: false },
        },
      },
    },
  },
}

{
  agents: {
    defaults: {
      embeddedPi: { executionContract: "strict-agentic" },
    },
  },
}

​

Associé