Parallel Works
View as Markdown
Share:

Connect External Tools

Use your platform AI models with external tools and editors. Any tool that supports an OpenAI-compatible provider can send requests through the ACTIVATE AI gateway, authenticated with an AI key and governed by the same budgets and usage tracking as the rest of the platform.

To open the page, navigate to AI > Providers in the sidebar and click Connect Tools.

Base URL and API Key

External tools need two values, both available at the top of the page:

  • Base URL — your organization's gateway endpoint, https://<your-activate-domain>/api/openai/v1. Click the URL on the page to copy it with your actual domain filled in.
  • AI API Key — click Create Key to generate a key without leaving the page. Keys are shown once at creation; see AI Keys for managing them.

Available Models

The Your models list shows every model you can access across your providers — click a model to copy its ID. Model IDs use the format owner:provider-name/model-name. If the list is empty, add or get access to a provider first; see AI Providers.

Setup Guides

The page includes step-by-step guides for popular tools. Each guide inserts your Base URL, API key, and model IDs in place.

Open WebUI

A self-hosted, feature-rich web interface for AI chat.

  1. Open your Open WebUI instance, click your avatar in the bottom-left corner, and select "Admin Panel".
  2. Go to the Settings tab, then navigate to Connections > OpenAI.
  3. Click the "+" button to add a new connection.
  4. Enter your Base URL.
  5. Paste your API key into the Auth field (leave the type set to "Bearer").
  6. Click "Save" to add the connection.

OpenCode

An AI coding assistant with OpenAI-compatible provider support.

Desktop

  1. Open OpenCode and go to Settings > Providers.
  2. Scroll down to "Custom provider" and click "+ Connect".
  3. Enter a Provider ID (e.g. "pw") and a Display name (e.g. "Parallel Works").
  4. Set the Base URL to your gateway Base URL.
  5. Paste your API key into the API key field.
  6. Under Models, enter one of your model IDs and a display name, then click "Submit". Repeat to add more.

CLI

  1. Launch OpenCode in your terminal and run the /connect command to register a new provider credential.

  2. Enter a Provider ID (e.g. "pw") and select "Other" when prompted for a provider.

  3. Paste your API key when OpenCode prompts for it.

  4. Open (or create) opencode.json in your project root or at ~/.config/opencode/opencode.json, then add this provider entry:

    {
  "$schema": "https://opencode.ai/config.json",
  "provider": {
    "pw": {
      "npm": "@ai-sdk/openai-compatible",
      "name": "Parallel Works",
      "options": {
        "baseURL": "https://<your-activate-domain>/api/openai/v1"
      },
      "models": {
        "model-id-here": {
          "name": "Model Display Name"
        }
      }
    }
  }
}

  5. Replace model-id-here with one of your model IDs. Add more entries under models for every model you want available.

  6. Restart OpenCode. Your custom provider and models will appear in the model picker.

Tip

OpenCode Desktop and CLI share the same opencode.json. If you already set up the desktop variant above, the CLI will pick up the same provider. The quickest path is often to configure in the desktop and then just run opencode in your terminal.

Kilo Code

An open-source AI coding assistant for VS Code with OpenAI-compatible provider support.

  1. Open VS Code and install the Kilo Code extension.
  2. Open the Kilo Code panel, open Settings, and choose Providers.
  3. Click "Connect" next to "Custom provider".
  4. Enter a Provider ID (e.g. "pw") and a Display name (e.g. "Parallel Works").
  5. Set the Base URL to your gateway Base URL.
  6. Paste your API key into the API key field.
  7. Kilo Code fetches your available models automatically. Select the ones you want and click "Add N model(s)".

Cursor

An AI-powered code editor built on VS Code with integrated chat and code generation.

  1. Open Cursor and go to Settings > Models.
  2. Expand the "API Keys" section and enable the "OpenAI API Key" toggle.
  3. Paste your API key into the OpenAI API Key field.
  4. Enable the "Override OpenAI Base URL" toggle and set it to your gateway Base URL.
  5. Scroll down and click "+ Add Custom Model", enter one of your model IDs, and click "Add". Repeat for every model you want available.
  6. Turn off "Auto" mode in the model picker. Otherwise Cursor ignores your custom models and routes to its own.

Related Documentation