Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.agentic.scope3.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Authentication

The Interchange API supports two authentication methods: OAuth for AI agent connectors and API keys for programmatic integrations.
When connecting through Claude Connectors or ChatGPT MCP Connectors, authentication is handled automatically via OAuth. Users log in with their Scope3 credentials and the agent receives a secure token.
  • No API keys to create or manage
  • Tokens are scoped to the authenticated user
  • Works with Claude.ai (Team/Enterprise), Claude Desktop, and ChatGPT
See the Built for Agents guide for setup instructions.

​
API Keys

For CLI tools (Claude Code, Cursor), custom agents, and direct REST API integrations, use an API key.

​
Getting Your API Key

  1. Visit interchange.io/user-api-keys
  2. Sign up or log into your Scope3 account
  3. Generate a new API key for your integration
  4. Copy the key — it starts with scope3_
Keep your API key secure! Don’t commit it to version control or share it publicly. Use environment variables or secure key management systems.

​
API Key Format

scope3_<client_id>_<secret>

​
Using Your API Key

Pass the key as a Bearer token in the Authorization header: 
curl -X GET "https://api.interchange.io/api/v2/buyer/advertisers" \
  -H "Authorization: Bearer scope3_your_api_key_here" \
  -H "Content-Type: application/json"

​
MCP Authentication

For AI agent integrations using the Model Context Protocol: 
import { Client } from '@modelcontextprotocol/sdk/client/index.js';
import { HttpClientTransport } from '@anthropic-ai/mcp-client-http';

const transport = new HttpClientTransport({
  url: 'https://api.interchange.io/mcp/buyer',
  headers: {
    'Authorization': `Bearer ${process.env.SCOPE3_API_KEY}`,
  },
});

const client = new Client({ name: 'my-agent', version: '1.0.0' });
await client.connect(transport);

const result = await client.callTool('health', {});

​
Base URLs

TypeProductionStaging
Buyer RESThttps://api.interchange.io/api/v2/buyerhttps://api.staging.interchange.io/api/v2/buyer
Storefront RESThttps://api.interchange.io/api/v2/storefronthttps://api.staging.interchange.io/api/v2/storefront
Buyer MCPhttps://api.interchange.io/mcp/buyerhttps://api.staging.interchange.io/mcp/buyer
Storefront MCPhttps://api.interchange.io/mcp/storefronthttps://api.staging.interchange.io/mcp/storefront

​
Versioning

REST and MCP endpoints come in two forms — pick based on whether you want to pin to a specific major version or auto-roll with the platform.
FormExampleBehaviorWhen to use
Versioned (canonical)/api/v2/buyer, /mcp/v2/buyerPinned to v2. Will keep serving v2 even after a future v3 ships.Production integrations, SDKs, anywhere a breaking change would silently break you.
Unversioned (alias)/api/buyer, /mcp/buyer308-redirects to whatever major version is currently stable (today: v2). Auto-rolls when a new major is cut.Quick demos, links you don’t want to update, or environments where you actively want to follow latest.
The same pattern applies to storefront endpoints (/api/v2/storefront vs /api/storefront, /mcp/v2/storefront vs /mcp/storefront). The Base URLs table above lists the versioned form because it’s what we recommend for any integration you don’t plan to revisit on every major release.

​
Next Steps

Quick Start

Get up and running in minutes.

Built for Agents

Connect Claude, ChatGPT, Cursor, and more.

SSO Setup

Configure single sign-on for your organization.