Skip to main content

Authentication

All MIRI API requests require an API key that you provision in the MIRI Console.

Get Your API Key​

  1. Sign in to the MIRI Developer Console.
  2. Open the API Keys section.
  3. Select Create API Key. The full value is shown only once—copy it immediately.
  4. Store the key in your backend or secrets manager. Never expose it in client-side code.

Need a guided walkthrough? See Quick Start for the end-to-end flow.

Send Authenticated Requests​

Include your API key in the Miri-Api-Key header for every request:

Miri-Api-Key: miri_live_sk_xxxxxxxxxxxxxxxxxxxxxxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Important

All API keys start with the miri_ prefix. Keys without this prefix are rejected.

Key Format​

Keys follow a fixed layout enforced by the edge authentication filter:

miri_<env>_sk_<24 lowercase hex characters>.<48 lowercase hex characters>

Keys use the miri_live_sk_ prefix. Sandbox routes accept the same key—there is no separate sandbox credential.

Rotation & Revocation​

When a key is exposed or no longer needed, revoke it from the console and issue a replacement. Keys take effect immediately after creation, and revoked keys stop working right away.

Last updated on