Getting Started

Welcome to the Ned AI API! This guide will help you get up and running in under 5 minutes.

Prerequisites

• A Ned AI account with an active subscription (Essential tier or higher)
• Your Shopify store connected to Ned

Step 1: Create an API Key

1. Log in to Ned AI
2. Go to Settings → Developer
3. Click Create API Key
4. Give your key a name (e.g., "Production API")
5. Copy the key - you'll only see it once!

Your API key will look like: ned_live_a1b2c3d4e5f6...

Step 2: Make Your First Request

curl -H "Authorization: Bearer ned_live_YOUR_KEY_HERE" \
  "https://api.meetned.com/api/v1/sales/analytics"

You should get a JSON response with your sales data!

Step 3: Choose Your Integration Method

Option A: TypeScript SDK (Recommended)

npm install @ned-ai/sdk

import { NedClient } from '@ned-ai/sdk';

const ned = new NedClient({ apiKey: process.env.NED_API_KEY });
const sales = await ned.analytics.getSalesContext({ period: 'today' });
console.log(sales);

Option B: MCP Server (For AI Assistants)

npx @ned-ai/mcp-server

Configure with Claude Desktop to ask natural language questions about your data.

Option C: CLI Tool

npx @ned-ai/cli login

Next Steps

• Authentication - Learn about API keys and rate limits
• API Reference - Full endpoint documentation
• SDK Guide - TypeScript SDK usage
• MCP Integration - Connect to Claude Desktop