Skip to main content

​
API Key Authentication

The Aampe API uses API key authentication. Include your API key in the X-API-Key header with every request.
​
X-API-Key
string
required
Your Aampe API key

​
Test Your API Key

Enter your API key below to test it with our endpoints: 
curl -X GET \
  'https://content.api.aampe.com/health' \
  -H 'X-API-Key: YOUR_API_KEY'

​
Configure API Playground

To test endpoints interactively:
  1. Click the “Configure” button in any API endpoint page
  2. Enter your API key in the X-API-Key field
  3. Your key will be saved locally in your browser for this session
  4. Try making requests directly from the documentation
Your API key is stored locally in your browser and never sent to our documentation servers. It’s only used for direct API calls to the Aampe API.

​
Obtaining an API Key

To find your API keys, navigate to Integrations > API keys Composer Api Key Page Pn You’ll find two API keys
  • Ingestion API key: this is for sending data to Aampe via the Aampe Streaming API.
  • Surfaces API key: this is for pulling personalized content from Aampe for Surfaces.

​
Key Generation Steps

  1. Log into your Aampe Dashboard
  2. Navigate to System settings → Integrations → Aampe Endpoint
  3. Copy the API Key (hidden)

​
Security Best Practices

Never expose your API key in client-side code or public repositories

​
Next Steps

Now that you’re authenticated, let’s call an endpoint:

Test the Health Endpoint

Verify your connection is working

Get Surface Content

Retrieve personalized content for users