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.

• Modelos de agente - modelos openai/* pelo runtime Codex; entre com autenticação Codex para uso de assinatura ChatGPT/Codex ou configure um backup de chave de API OpenAI compatível com Codex quando você quiser intencionalmente autenticação por chave de API.
• APIs OpenAI sem agente - acesso direto à OpenAI Platform com cobrança baseada em uso por meio de OPENAI_API_KEY ou onboarding de chave de API da OpenAI.
• Configuração legada - referências de modelo openai-codex/* são reparadas por openclaw doctor --fix para openai/* mais o runtime Codex.

​

Escolha rápida

​

Mapa de nomes

​

Cobertura de recursos do OpenClaw

​

Embeddings de memória

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

​

Introdução

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 }],
      },
    },
  },
}

​

Autenticação nativa do servidor de aplicativo do Codex

1. Perfis de autenticação OpenAI ordenados para o agente, de preferência em auth.order.openai. Perfis openai-codex:* existentes e auth.order.openai-codex continuam válidos para instalações mais antigas.
2. A conta existente do servidor de aplicativo, como um login local do ChatGPT pela CLI do Codex.
3. Somente para inicializações locais do servidor de aplicativo stdio, CODEX_API_KEY e depois OPENAI_API_KEY, quando o servidor de aplicativo não relata nenhuma conta e ainda exige autenticação OpenAI.

​

Geração de imagens

{
  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

​

Geração de vídeo

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

​

Contribuição de prompt do GPT-5

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

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

​

Voz e fala

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

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

​

Endpoints do Azure OpenAI

• Você já tem uma assinatura, cota ou contrato empresarial do Azure OpenAI
• Você precisa de residência regional de dados ou controles de conformidade fornecidos pelo Azure
• Você quer manter o tráfego dentro de uma locação existente do Azure

​

Configuração

{
  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

• Envia o cabeçalho api-key em vez de Authorization: Bearer
• Usa caminhos com escopo de implantação (/openai/deployments/{deployment}/...)
• Anexa ?api-version=... a cada solicitação
• Usa um tempo limite de solicitação padrão de 600s para chamadas de geração de imagens do Azure. Valores timeoutMs por chamada ainda substituem esse padrão.

​

Versão da API

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

​

Nomes de modelos são nomes de implantação

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

​

Disponibilidade regional

​

Diferenças de parâmetros

​

Configuração avançada

{
  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" },
    },
  },
}

​

Relacionado