Authentication

The Flow Myna API uses API keys to authenticate requests. This guide explains how to create, use, and manage your API keys.

API Key Format

Flow Myna API keys follow a specific format for easy identification:

fm_live_<32_random_characters>


Example: fm_live_abc123xyz789def456ghi012jkl345mn

Using Your API Key

Include your API key in every request using the Authorization header with a Bearer token:

curl -X POST 'https://api.flowmyna.com/api/public/v1/event' \
-H 'Authorization: Bearer fm_live_your_key_here' \
-H 'Content-Type: application/json' \
-d '{"event": "Test Event", "objects": [{"type": "Test", "id": "1"}]}'

Alternatively, you can use the custom header:

curl -X POST 'https://api.flowmyna.com/api/public/v1/event' \
-H 'X-FlowMyna-Api-Key: fm_live_your_key_here' \
-H 'Content-Type: application/json' \
-d '{"event": "Test Event", "objects": [{"type": "Test", "id": "1"}]}'

API Key → Dataset Linking

A key design decision: each API key is linked to exactly one dataset. This means:

• No dataset_id in requests — You don't need to specify where data goes
• Clear data lineage — All data from a key flows to one dataset
• Simple key management — Each integration gets its own key

When creating an API key, you'll either create a new dataset or select an existing one. The key will permanently write to that dataset.

Security Best Practices

Key Storage

Flow Myna never stores your full API key. We only store:

• Prefix — First 12 characters for identification (e.g., fm_live_abc1)
• SHA256 Hash — Cryptographic hash of the full key for verification

This means if our database were ever compromised, attackers couldn't retrieve your actual keys.

Recommendations

• Use environment variables — Never hardcode keys in source code
• Use secrets managers — AWS Secrets Manager, HashiCorp Vault, etc.
• Never commit keys — Add them to .gitignore
• Rotate periodically — Create new keys and revoke old ones
• Use separate keys — Different keys for dev, staging, production

import os
from flowmyna import FlowMyna


# Load from environment variable
client = FlowMyna(api_key=os.environ['FLOWMYNA_API_KEY'])

Key Lifecycle

API keys have the following states:

Permissions

API keys grant the following permissions:

• ✅ Write events — Track events to the linked dataset
• ✅ Write objects — Identify/upsert objects
• ✅ Create types — Auto-create event and object types
• ❌ Read data — API keys are write-only
• ❌ Manage workspace — No admin access

Future: Scoped permissions like events:write, objects:read may be added.