Getting Started

Project API keys

Project API keys are the authorization layer for Playground, Code, the Upload API, and n8n in Calypso RAG.

Why API keys matter

In Calypso RAG, project API keys are part of the operating model, not a late-stage implementation detail.

You need a project API key for:

  • Playground requests
  • OpenAI-compatible Code integrations
  • the knowledge Upload API
  • n8n credentials

Where to manage them

Open:

Project → API Keys

The RAG variant keeps this surface visible because it is foundational to the product loop.

Important concepts

Project-scoped

Keys belong to the current project. This keeps knowledge, agent policy, and integrations aligned to one workspace scope.

Active keys only

Only active keys should be used in real testing or production integrations.

Default web key

Some RAG flows prefer the protected default web key when it exists, especially hosted web-oriented paths.

Common issues

Playground cannot send

Usually one of these is true:

  • no active key exists
  • the wrong key is selected
  • the selected key is no longer active

The docs example works differently in your app

Check:

  • the exact key being used
  • the correct base URL for the environment
  • whether the target agent is actually configured for grounded retrieval

Next steps