Quickstart

Redgold has three primary entry paths. Use the hosted website for the full browser experience, install the terminal client to work from a shell, or call the API from an existing application. All three use the same Redgold account.

1. Use the website

Redgold account creation is currently invite-only. If you have an invitation, follow its link and sign in at redgold.ai. Otherwise, request access. Public self-service signup is planned at auth.redgold.ai; that Authentik endpoint is currently disabled.

After signing in, the website detects an incomplete workspace and opens the onboarding flow. You can use the managed Gitea service at git.redgold.ai to host code, or connect GitHub and choose the repositories the redgold-ai GitHub App may access. Repository access stays limited to the repositories you select.

At the end of onboarding, choose Ask an agent to guide me. The first conversation is prepared with a setup request so an agent can check the workspace state and walk through code hosting, repository access, provider keys, and the first task one step at a time. The same walkthrough can be started later from Setup → Ask an agent to guide setup.

Once setup is complete, give an AI coding agent a task. The agent runs on managed compute while the website keeps its conversation, tool calls, and session state available for later inspection.

The website is the starting point for account settings, workspaces, conversations, and API keys. You can begin here without installing a local client.

2. Install the terminal client

The redgold terminal client connects to the same conversations and remote agent sessions as the website. First sign in and open Settings → API Keys. Create an sk-rg- key and copy its full value when it is shown.

Export the key, run the installer, and add the installed binaries to your PATH:

export REDGOLD_API_KEY=sk-rg-...
curl -fsSL https://redgold.ai/install.sh | bash
export PATH="$PATH:$HOME/.redgold/bin"

Launch the terminal interface:

redgold

The installer also adds rac, the operational agent CLI available to accounts with managed fleet access. See Install the terminal client for supported platforms, expected output, and troubleshooting.

3. Use the API

Create an API key from Settings → API Keys and export it as shown above. Send the key as a bearer token to list the models available to your account:

curl https://api.redgold.ai/v1/models \
  -H "Authorization: Bearer $REDGOLD_API_KEY"

The response is an OpenAI-style model list. Use one of its model identifiers with the model API, or follow the first API call and Python client examples.

Use the API with coding agents

The same public API works as the model provider for Claude Code, Codex, Oh My Pi, and OpenCode. Choose a model from /v1/models that matches the client's wire format: Claude Code uses the Anthropic-compatible /v1/messages surface, while the examples for the other clients use the OpenAI-compatible /v1/responses or /v1/chat/completions surface.

For Claude Code, point the Anthropic base URL at the Redgold host and use a Messages-compatible model identifier:

ANTHROPIC_BASE_URL=https://api.redgold.ai \
ANTHROPIC_AUTH_TOKEN="$REDGOLD_API_KEY" \
ANTHROPIC_MODEL="model-id-from-v1-models" \
ANTHROPIC_SMALL_FAST_MODEL="model-id-from-v1-models" \
claude

For Codex, add a custom Responses provider to $HOME/.codex/config.toml:

model = "redgold-flint"
model_provider = "redgold"

[model_providers.redgold]
name = "Redgold"
base_url = "https://api.redgold.ai/v1"
env_key = "REDGOLD_API_KEY"
wire_api = "responses"

Then run codex normally. Replace redgold-flint with another Responses-compatible identifier returned for your account when appropriate.

For Oh My Pi, define the provider in $HOME/.omp/agent/models.yml:

providers:
  redgold:
    baseUrl: https://api.redgold.ai/v1
    apiKey: REDGOLD_API_KEY
    api: openai-responses
    models:
      - id: redgold-flint
        name: Redgold Flint

Start omp and select redgold/redgold-flint from /model.

For OpenCode, run /connect, choose Other, enter redgold as the provider ID, and paste the API key. Then add the provider to your project-level opencode.json:

{
  "$schema": "https://opencode.ai/config.json",
  "provider": {
    "redgold": {
      "npm": "@ai-sdk/openai-compatible",
      "name": "Redgold",
      "options": {
        "baseURL": "https://api.redgold.ai/v1"
      },
      "models": {
        "redgold-flint": {
          "name": "Redgold Flint"
        }
      }
    }
  }
}

Run /models in OpenCode and select the Redgold model. Clients built around the newer Responses API can use OpenCode's @ai-sdk/openai adapter instead.

Optional session orchestration works behind the same coding-client connection. When it is enabled for your account, keep using the client normally: Redgold triages each request, gathers focused analysis in parallel, and supplies the combined context to the model producing the response. The client continues to receive its standard streamed response, so its commands, tool use, and project instructions work the same way.

Continue

Pipeline applications turn a description of what you need into a managed app. Coding agents prepare the application for your review, and Redgold operates its data, workflows, API, and deployment. Continue with Pipeline Applications to see how a support request becomes a running application and what you control along the way.

Use the common task index to find another guide, or browse the examples for step-by-step recipes. How Redgold works explains how pipeline applications, data, coding agents, model access, and managed deployment fit together.