Regions & Endpoints

Amigo provides region-specific API endpoints to support data residency and latency requirements. If your organization is provisioned in a specific region, use the corresponding base URL. For organizations on dedicated clusters, you can also target your cluster explicitly via the x-mongo-cluster-name header.

Regional Base URLs

Region	Location	Base URL
US	N. Virginia (us-east-1)	https://api.amigo.ai
EU	Frankfurt (eu-central-1)	https://api-eu-central-1.amigo.ai
AU	Sydney (ap-southeast-2)	https://api-ap-southeast-2.amigo.ai

Coming Soon Additional regions (India, Middle East, Japan) are in development. Contact your Amigo representative to request access or discuss timelines.

Region Matching Required Use the regional base URL that matches your organization's data residency. Requests to a mismatched region will return "Organization not found" errors.

Global Deployment Map

cURL example

curl -X GET \
  -H "Authorization: Bearer <YOUR_JWT_TOKEN>" \
  "https://api-eu-central-1.amigo.ai/v1/<your-org-id>/organization/"

SDK configuration

Specify the regional base URL via the SDK base_url/baseUrl setting.

Python

from amigo_sdk import AmigoClient

with AmigoClient(
    api_key="<key>",
    api_key_id="<key-id>",
    user_id="<user>",
    organization_id="<org>",
    base_url="https://api-ap-southeast-2.amigo.ai",
) as client:
    org = client.organization.get()

TypeScript

import { AmigoClient } from "@amigo-ai/sdk";

const client = new AmigoClient({
  apiKey: process.env.AMIGO_API_KEY!,
  apiKeyId: process.env.AMIGO_API_KEY_ID!,
  userId: process.env.AMIGO_USER_ID!,
  orgId: process.env.AMIGO_ORGANIZATION_ID!,
  baseUrl: "https://api-eu-central-1.amigo.ai",
});

const org = await client.organizations.getOrganization();

Environment variables

You can also set the regional endpoint via environment variables.

# US
AMIGO_BASE_URL=https://api.amigo.ai

# EU
# AMIGO_BASE_URL=https://api-eu-central-1.amigo.ai

# AU
# AMIGO_BASE_URL=https://api-ap-southeast-2.amigo.ai

Dedicated Clusters

Some enterprises run on dedicated, isolated clusters. In these cases, include x-mongo-cluster-name to direct requests to your assigned cluster.

Cluster Name Your Amigo team will provide the exact cluster name if your tenant uses a dedicated cluster. Do not guess this value.

Header: x-mongo-cluster-name: <cluster-name>

When to use:

• Required: Organization provisioning (Create Organization)

• Recommended: Early provisioning flows when the organization may not yet be discoverable via the global config

• Optional: Normal operations for established organizations — most endpoints do not require it once your org is fully set up

cURL Example (Dedicated Cluster)

curl -X PUT \
  -H "Authorization: Bearer <YOUR_JWT_TOKEN>" \
  -H "x-mongo-cluster-name: <your-dedicated-cluster-name>" \
  -H "Content-Type: application/json" \
  "https://api-eu-central-1.amigo.ai/v1/<your-org-id>/organization/" \
  -d '{
    "org_name": "Example Corp",
    "title": "Example Corp AI",
    "main_description": "Intelligent assistants for Example Corp",
    "sub_description": "Personalized, compliant AI",
    "user_dimensions": [],
    "logo": "<base64>",
    "square_logo": "<base64>",
    "favicon": "<base64>",
    "signup_page_headshot": "<base64>",
    "default_user_preferences": {},
    "onboarding_instructions": ["Welcome to Example Corp AI"],
    "azure_devops_team_name": "example-team"
  }'

SDK examples (dedicated cluster)

Python

# If your SDK version exposes a raw HTTP method, include the header
# for organization provisioning requests. Otherwise, use cURL as shown above.

TypeScript

// If your SDK version exposes a raw HTTP helper, include the header
// for organization provisioning requests. Otherwise, use cURL as shown above.

Recommendations

Best Practices

1. Confirm your organization's region with your Amigo representative and set the matching base URL

2. For dedicated cluster tenants, store your cluster name in a secure configuration store

3. Include the x-mongo-cluster-name header where instructed for dedicated clusters

Troubleshooting "Organization not found"

If you encounter this error:

• Verify you are calling the correct regional base URL

• For provisioning flows, ensure the x-mongo-cluster-name header is set (if on dedicated cluster)