Codex + Raims
Agente da OpenAI para desenvolver e revisar sua integração Raims no terminal, no editor ou na nuvem.
Início rápido
Instale o Codex
Com Node.js e npm disponíveis, instale o CLI:
Shellnpm install -g @openai/codexO guia oficial do CLI apresenta também os instaladores de Windows, macOS e Linux. Se preferir o aplicativo, o editor ou a nuvem, siga o início rápido da OpenAI.
Abra a pasta da sua aplicação
Na raiz do projeto que você pretende integrar à Raims, execute:
ShellcodexConclua a autenticação indicada pelo Codex. A conta do agente e a chave da API Raims têm finalidades diferentes.
Forneça o contexto da Raims
Peça ao Codex para ler o índice da documentação e localizar os guias de autenticação e cobranças. O conteúdo consolidado também pode ser usado como referência.
Experimente um prompt
Leia https://docs.raims.com/llms.txt e os guias de autenticação e cobranças. Analise o backend desta aplicação e proponha um plano para consultar uma cobrança existente em Sandbox com GET /v1/charges/{id}. Prepare um exemplo com a chave em configuração protegida do servidor. Não envie requisições nem use credenciais reais. Apresente as fontes e os arquivos que pretende alterar antes de editar.
Contexto do projeto
Acrescente estas orientações ao AGENTS.md na raiz da sua aplicação, preservando
as instruções existentes. O Codex lê os arquivos AGENTS.md ao iniciar uma
sessão e considera também instruções mais específicas dos diretórios.
# Integração Raims
- Consulte https://docs.raims.com/llms.txt antes de escolher endpoints e campos.
- Use https://docs.raims.com/llms-full.txt para a documentação completa.
- URL base da API: https://api.raims.com.
- Nos exemplos de instalação de produtos Raims, obtenha a versão estável mais
recente pelo gerenciador de pacotes (`latest` quando disponível).
- Prepare exemplos para Sandbox, com autenticação Bearer no backend.
- Mantenha a chave em configuração protegida do servidor. Não coloque segredos
no código, em prompts, logs ou aplicações de navegador.
- Explique o plano e peça autorização antes de enviar requisições à API.Depois de salvar, inicie uma nova sessão no projeto para carregar as instruções.
Verificar a configuração
Peça ao Codex para resumir as instruções ativas, indicar os guias consultados e explicar onde a aplicação carregará a chave. Confira o plano e o código antes de autorizar um teste.
Ler a documentação não autentica a aplicação. As requisições usam uma chave de API Raims da empresa e do ambiente desejados, armazenada na parte privada do sistema.
Problemas comuns
Confira se a sessão foi aberta na pasta correta, salve AGENTS.md e inicie
outra sessão. Peça ao Codex para informar quais instruções carregou.
Confira as permissões de rede do agente. Você também pode fornecer o trecho público do guia como contexto e pedir que o Codex identifique as informações que ainda faltam.
Peça a revisão da autenticação. A aplicação usa a chave Raims no header Bearer; as credenciais usadas para acessar o Codex não a substituem.