Docs
Checking Raims account
All agents
GitHub

GitHub Copilot + Raims

An editor assistant for planning and writing Raims integration code.

Extension
Official documentationDocumentation for agentsAPI reference

Quick start

  1. Prepare the agent

    Follow the official GitHub Copilot setup for your editor and sign in with a GitHub account that has Copilot access. This guide uses VS Code for configuration examples.

  2. Open your project

    Open the application folder you are connecting to Raims in VS Code. Open Copilot Chat and select the agent to work with the project code.

  3. Add the documentation

    Ask the agent to read Raims' documentation index and open the relevant guides. llms-full.txt provides the consolidated content. Start with authentication and charges.

  4. Try a prompt

    Read https://docs.raims.com/llms.txt and the authentication and charges guides.
Inspect this application's backend and propose a plan to retrieve an existing
Sandbox charge with GET /v1/charges/{id}. Prepare an example using protected
server configuration for the key. Do not send requests or use real credentials.
Show the sources and the files you would change before editing.

Project context

Create or update .github/copilot-instructions.md at your repository root. This file provides general instructions for Copilot sessions. Add the text below alongside your application's conventions.

Markdown
# Raims integration

- Read https://docs.raims.com/llms.txt before choosing endpoints and fields.
- Use https://docs.raims.com/llms-full.txt for the consolidated documentation.
- API base URL: https://api.raims.com.
- In Raims product installation examples, select the latest stable version
  through the package manager (`latest` where supported).
- Prepare examples for Sandbox, with Bearer authentication in the backend.
- Keep the key in protected server configuration. Never put secrets in code,
  prompts, logs, or browser applications.
- Explain the plan and request authorization before sending API requests.

Verify the setup

Ask the agent to identify the guides it read, the API base URL, and the place in your backend where the key will be loaded. It should prepare the plan and example without asking you to paste a real credential.

Reading the documentation does not authenticate the application. Requests use a Raims API key for the intended company and environment.

Common issues

Official sources

Cursor + Raims

An editor with a built-in agent for developing your Raims integration with project context.

OpenCode + Raims

A terminal agent with a choice of AI providers for implementing your Raims integration.