Skip to content

Authentication

All API requests require authentication using an API key provided by EMMI.

Contact support@emmi.io to receive your API key.


Understanding Accounts and Customers

EMMI uses a two-level hierarchy for access and usage tracking:

Concept Description Identifier
Account Your organization. EMMI provides you with an API key tied to your account. API Key (emmi_sk_...)
Customer A subdivision within your account for tracking usage. Could represent internal teams, departments, clients, or any grouping that makes sense for your billing and analytics. Customer ID (UUID)

Why this model?

  • Flexible usage tracking — Track API usage however you need: by client, by team, by project
  • Billing attribution — Allocate costs to the right cost center
  • Analytics — Understand who is using what
Your Account
    └── API Key (emmi_sk_...)
         └── Customer: "Trading Desk A"
         └── Customer: "Risk Team"
         └── Customer: "Client: Acme Corp"
         └── Customer: "Internal Research"

API Key

API keys follow this format:

emmi_sk_{random_64_characters}

Include your API key in the X-API-Key header with every request.


Customer Identification

All data endpoints require a X-Customer-ID header to identify which customer the request is for. This enables:

  • Usage tracking per customer
  • Billing attribution to specific customers
  • Analytics on usage patterns

Customers must be registered via the customer management API before making data requests. The returned EMMI customer UUID is used as the X-Customer-ID value.


Required Headers Summary

Header Description Required For
X-API-Key Your API key All endpoints
X-Customer-ID EMMI customer UUID Data/analysis endpoints
Content-Type application/json POST requests

Customer Onboarding Workflow

  1. Register a customer via POST /latest/api/v1/customers with your internal identifier
  2. Store the returned UUID — this is the X-Customer-ID for subsequent requests
  3. Use the customer ID in data endpoint requests
  4. Monitor usage via the usage endpoints

For full customer endpoint details (request/response schemas, error codes, usage tracking), see the API Developer Docs.