curl https://api.northgale.io/api/v1/me \
  -H "x-api-key: ng_live_your_key_here"

npm install @northgale/sdk

import Northgale from '@northgale/sdk';

const northgale = new Northgale({ apiKey: 'ng_live_your_key_here' });

const result = await northgale.explain({
  input_text: 'Account scored 91/100. High purchase intent based on recent engagement.',
  workflow_type: 'sales',
  confidence: 0.91,
  evidence: [
    { source: 'CRM activity', text: 'Opened 14 emails in last 30 days', weight: 0.6 },
    { source: 'Intent data',  text: 'Visited pricing page 3x this week', weight: 0.4 },
  ],
  risk_factors: [
    { severity: 'low', description: 'No confirmed technical buyer identified yet' },
  ],
});

console.log(result.decision_card.next_action);
// → "Prioritize this account — confidence is high. Schedule outreach within 48 hours."
console.log(result.decision_card.confidence);
// → { score: 0.91, label: 'high' }

{
  "id": "dc_01HZR7...",
  "object": "decision_card",
  "created_at": "2026-05-18T21:00:00.000Z",
  "workflow_type": "sales",
  "decision_card": {
    "recommendation": "Account scored 91/100. High purchase intent based on recent engagement.",
    "confidence": {
      "score": 0.91,
      "label": "high"
    },
    "reasoning": "High purchase intent based on recent engagement.",
    "evidence_trail": [
      { "source": "CRM activity", "text": "Opened 14 emails in last 30 days", "weight": 0.6 },
      { "source": "Intent data",  "text": "Visited pricing page 3x this week", "weight": 0.4 }
    ],
    "risk_flags": [
      { "severity": "low", "description": "No confirmed technical buyer identified yet" }
    ],
    "next_action": "Prioritize this account — confidence is high. Schedule outreach within 48 hours."
  },
  "audit": {
    "request_id": "req_abc123",
    "tier": "pro"
  }
}

X-RateLimit-Tier: pro
X-RateLimit-Limit: 100000
X-RateLimit-Remaining: 98732

curl -X POST /api/v1/explain \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "input_text": "Applicant approved. Debt-to-income ratio within acceptable range.",
    "workflow_type": "underwriting",
    "confidence": 0.82,
    "input_model": "gpt-4o",
    "evidence": [
      { "source": "Credit bureau", "text": "DTI: 34%, below 43% threshold", "weight": 0.7 },
      { "source": "Bank statements", "text": "Stable income for 24 months",   "weight": 0.3 }
    ],
    "risk_factors": [
      { "severity": "medium", "description": "Recent hard inquiry from another lender" }
    ]
  }'

{
  "id": "dc_01HZR7KL9N2MXP4Q",
  "object": "decision_card",
  "created_at": "2026-05-18T21:00:00.000Z",
  "workflow_type": "underwriting",
  "application_id": null,
  "input_model": "gpt-4o",
  "decision_card": {
    "recommendation": "Applicant approved. Debt-to-income ratio within acceptable range.",
    "confidence": { "score": 0.82, "label": "high" },
    "reasoning": "Debt-to-income ratio within acceptable range.",
    "evidence_trail": [
      { "source": "Credit bureau",   "text": "DTI: 34%, below 43% threshold", "weight": 0.7 },
      { "source": "Bank statements", "text": "Stable income for 24 months",   "weight": 0.3 }
    ],
    "risk_flags": [
      { "severity": "medium", "description": "Recent hard inquiry from another lender" }
    ],
    "next_action": "Proceed with standard underwriting workflow. Risk profile is well-characterized."
  },
  "audit": { "request_id": "req_abc123", "tier": "pro" }
}

curl -X POST /api/v1/explain/batch \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "workflow_type": "sales",
    "items": [
      { "input_text": "Acme Corp scored 94. Strong buying signals.", "confidence": 0.94 },
      { "input_text": "BetaCo scored 51. Low engagement this quarter.", "confidence": 0.51 },
      { "input_text": "Gamma Inc scored 78. Mid-cycle, needs review.", "confidence": 0.78 }
    ]
  }'

{
  "object": "list",
  "count": 3,
  "results": [
    {
      "id": "dc_01HZR...", "object": "decision_card",
      "decision_card": {
        "recommendation": "Acme Corp scored 94...",
        "confidence": { "score": 0.94, "label": "high" },
        "next_action": "Prioritize this account — confidence is high. Schedule outreach within 48 hours."
      }
    },
    { "id": "dc_01HZS...", "decision_card": { "confidence": { "score": 0.51, "label": "medium" } } },
    { "id": "dc_01HZT...", "decision_card": { "confidence": { "score": 0.78, "label": "high" } } }
  ],
  "audit": { "request_id": "req_batch_001", "tier": "pro" }
}

curl /api/v1/explain/dc_01HZR7KL9N2MXP4Q \
  -H "x-api-key: YOUR_API_KEY"

# Get last 20 sales workflow cards
curl "/api/v1/explain?workflow_type=sales&limit=20" \
  -H "x-api-key: YOUR_API_KEY"

curl -X POST /api/v1/workflows \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Enterprise Sales Scoring",
    "workflow_type": "sales",
    "description": "High-touch enterprise account scoring for deals > $50K",
    "config": {
      "confidence_threshold": 0.75,
      "min_evidence_sources": 2,
      "escalate_below": 0.45
    }
  }'

curl /api/v1/workflows -H "x-api-key: YOUR_API_KEY"

curl /api/v1/workflows/wf_01HZR7... -H "x-api-key: YOUR_API_KEY"

curl -X DELETE /api/v1/workflows/wf_01HZR7... \
  -H "x-api-key: YOUR_API_KEY"
# → { "deleted": true, "id": "wf_01HZR7..." }

curl /api/v1/me -H "x-api-key: YOUR_API_KEY"

{
  "user_id": "usr_...",
  "tier": "pro",
  "subscription_status": "active",
  "current_period_end": "2026-06-18T00:00:00.000Z",
  "usage": {
    "tokens_used_this_month": 1247,
    "monthly_quota": 100000,
    "remaining": 98753,
    "unlimited": false
  }
}

curl /api/v1/analytics/dashboard -H "x-api-key: YOUR_API_KEY"

{
  "user_id": "usr_...",
  "metrics": {
    "total_interactions": 1247,
    "feedback": {
      "thumbs_up": 312,
      "thumbs_down": 18,
      "hallucinations_reported": 3
    },
    "usage_last_30_days": [
      { "date": "2026-04-19", "total": 42 },
      { "date": "2026-04-20", "total": 67 }
    ]
  }
}

curl "/api/v1/audit/logs?limit=10&since=2026-05-01T00:00:00Z" \
  -H "x-api-key: YOUR_API_KEY"

{
  "logs": [
    {
      "id": "log_...",
      "endpoint": "POST /api/v1/explain",
      "tokens_used": 1,
      "status_code": 200,
      "request_id": "req_abc123",
      "source_ip": "1.2.3.4",
      "tier": "pro",
      "created_at": "2026-05-18T21:00:00.000Z"
    }
  ],
  "pagination": { "limit": 10, "offset": 0, "total": 1247 }
}

# Download CSV for a monthly SOC 2 report
curl -X POST /api/v1/audit/export \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "since": "2026-05-01T00:00:00Z", "until": "2026-05-31T23:59:59Z", "format": "csv" }' \
  -o northgale-audit-may2026.csv

curl -X POST /api/v1/telemetry \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "interaction_id": "int_abc123",
    "event_type": "card_expanded",
    "client_id": "usr_hashed_456",
    "metadata": { "workflow": "sales", "card_id": "dc_01HZR7..." }
  }'

curl -X POST /api/v1/feedback \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "interaction_id": "int_abc123",
    "rating": "thumbs_up",
    "client_id": "usr_hashed_456"
  }'

npm install northgale-ui

import { ExplainableCard } from 'northgale-ui';

export default function AIOutput() {
  return (
    <ExplainableCard
      apiKey="ng_live_your_key_here"
      llmResponse={{
        recommendation: "Acme Corp is high priority.",
        confidence: { score: 0.91, label: "high" },
        reasoning: "14 email opens + 3 pricing page visits this week.",
        evidence_trail: [
          { source: "CRM", text: "Opened 14 emails in 30 days", weight: 0.6 },
          { source: "Intent", text: "Visited pricing page 3x", weight: 0.4 }
        ],
        risk_flags: [],
        next_action: "Schedule outreach within 48 hours."
      }}
      theme="dark"
      onFeedback={(fb) => console.log('Feedback:', fb)}
    />
  );
}

import { ConfidenceBadge } from 'northgale-ui';

// Auto-colors: green ≥0.75, yellow ≥0.45, red <0.45
<ConfidenceBadge score={0.88} size="sm" showLabel={true} />

import { CitationTooltip } from 'northgale-ui';

<p>
  The account was flagged because{' '}
  <CitationTooltip
    sourceText="User opened 14 emails in 30 days, 3x above average"
    url="https://crm.example.com/accounts/acme"
  >
    engagement is unusually high
  </CitationTooltip>
  {' '}this quarter.
</p>