Skip to main content

API Keys

API keys let you authenticate programmatic requests to the Iara Data API.

Creating an API Key

  1. Go to SettingsManage API Keys
  2. Click Create Key
  3. Give it a name (e.g., "Production Pipeline")
  4. Optionally set scopes to restrict access (e.g., ingest:write, kpi:read)
  5. Click Create

Screenshot of the API key creation modal with name and scopes inputs

warning

Copy your key immediately! The full key is only shown once. After closing the dialog, you'll only see a truncated version.

Managing Keys

Screenshot of the API keys table showing key (truncated), name, scopes, last used, and action buttons

ColumnDescription
KeyTruncated key with copy button
NameHuman-readable label
ScopesComma-separated list of permissions
Last UsedRelative timestamp (e.g., "2 hours ago")
CreatedWhen the key was created

Actions

ActionDescription
CopyCopy the truncated key to clipboard
RotateGenerate a new key value (old key stops working immediately)
DeletePermanently remove the key

Available Scopes

ScopeAccess
ingest:writeUpload data, create/manage pipelines
ingest:readRead datasets and ingestion history
curupira:queryUse the AI chat
kpi:readRead KPI values and dashboards
kpi:writeCreate/modify KPIs and dashboards
analyze:invokeRun analyses and investigations
billing:readView billing and usage information
users:manageInvite/manage team members
audit:readView audit logs
keys:readList API keys
keys:writeCreate/rotate/delete API keys
webhooks:readList webhooks
webhooks:writeCreate/modify/delete webhooks

Usage Example

# Fetch your datasets
curl https://lake.iaradata.com/api/v1/datasets \
-H "Authorization: Bearer sk_live_abc123..."
# Ask the AI a question
curl -X POST https://lake.iaradata.com/api/v1/curupira/ask \
-H "Authorization: Bearer sk_live_abc123..." \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"question": "What was total revenue last month?",
"mode": "agentic",
"execute": true
}'