Quick Start

Get up and running with AIDP in 5 minutes.

Choose Your Path

Business OwnerDeveloperAI Platform

For Business Owners

Step 1: Sign Up

Visit platform.aidp.dev and create your account:

1. Click "Get Started"
2. Choose "Business Owner"
3. Enter your email and create password
4. Verify your email

Step 2: Create Your Profile

Fill in your business information:

• Basic Info: Name, category, description

• Location: Address and service area

• Contact: Phone, email, website

• Services: What you offer and pricing

• Hours: When you're open

Time: ~10 minutes

Step 3: Add AI-Exclusive Content

This is what sets you apart! Add content only AI users will see:

• Insider Tips: "Ask for the Ethiopian Yirgacheffe - not on menu but always available"

• Local Secrets: "We source beans directly from Colombian farmers"

• Behind the Scenes: "We roast every Tuesday and Thursday morning"

• Sustainability: "100% compostable packaging, solar-powered roasting"

Time: ~5 minutes

Step 4: Go Live

1. Review your profile

2. Click "Publish"

3. Your business is now discoverable by AI assistants!

Step 5: Monitor Analytics

Check your dashboard to see:

• Impressions: How many times AI mentioned you

• Citations: When AI quoted your business

• Intent Journeys: How consumers found you

• Bookings: Direct bookings from AI platforms

Full business owner guide →

---

For Developers

Step 1: Install SDK

npm install @aidp/sdk
# or
pip install aidp-sdk

Step 2: Get API Key

# Sign up at platform.aidp.dev
# Navigate to Settings > API Keys
# Create new API key

Step 3: Make Your First Request

import { AIDPClient } from '@aidp/sdk';

const client = new AIDPClient({
  apiKey: process.env.AIDP_API_KEY
});

// Search for businesses
const results = await client.searchBusinesses({
  query: 'coffee shops with outdoor seating',
  location: { city: 'Portland', country: 'USA' },
  filters: { verified: true, openNow: true }
});

console.log(results.businesses);

Step 4: Explore the API

Try these endpoints:

// Get business details
const business = await client.getBusinessDetails('biz_abc123');

// Check availability
const slots = await client.checkAvailability({
  businessId: 'biz_abc123',
  serviceId: 'svc_001',
  date: '2025-12-08'
});

// Create booking
const booking = await client.createBooking({
  businessId: 'biz_abc123',
  serviceId: 'svc_001',
  scheduledAt: '2025-12-08T10:00:00Z',
  customerInfo: {
    name: 'John Doe',
    email: '[e-mail]',
    phone: '[phone]'
  }
});

Full API reference →

---

For AI Platforms

Step 1: Set Up MCP Client

import { MCPClient } from '@modelcontextprotocol/sdk';

const mcp = new MCPClient({
  serverUrl: 'https://api.aidp.dev/mcp',
  authentication: {
    apiKey: process.env.AIDP_API_KEY
  }
});

Step 2: Discover Available Tools

const tools = await mcp.listTools();

console.log(tools);
// [
//   { name: 'search_businesses', description: '...' },
//   { name: 'get_business_details', description: '...' },
//   { name: 'check_availability', description: '...' },
//   ...
// ]

Step 3: Execute Search

const result = await mcp.executeTool('search_businesses', {
  location: { city: 'Portland', country: 'USA' },
  category: 'restaurants',
  filters: { verified: true }
});

console.log(result.businesses);

Step 4: Integrate into Your Assistant

// In your AI assistant's tool execution
async function handleBusinessSearch(userQuery: string) {
  const result = await mcp.executeTool('search_businesses', {
    query: userQuery,
    location: extractLocation(userQuery),
    filters: extractFilters(userQuery)
  });
  
  return formatResponse(result.businesses);
}

Full AI platform integration guide →

---

Common Tasks

Validate AIDP Schema

npm install -g @aidp/validator

# Validate a business profile
aidp-validate profile business-profile.json

# Validate MCP server
aidp-validate mcp http://localhost:3000

Migrate from Google Business Profile

npm install -g @aidp/gbp-migrator

aidp-migrate gbp \
  --account-id YOUR_ACCOUNT_ID \
  --location-id YOUR_LOCATION_ID \
  --output business-profile.json

Migrate from Yelp

npm install -g @aidp/yelp-migrator

aidp-migrate yelp \
  --business-id your-business-id \
  --api-key YOUR_YELP_API_KEY \
  --output business-profile.json

Run Local Development

# Clone the repository
git clone https://github.com/gugga7/aidp
cd aidp-platform

# Install dependencies
npm install

# Set up environment
cp .env.example .env.local
# Edit .env.local with your configuration

# Start services
docker-compose up -d

# Run development server
npm run dev

Full self-hosting guide →

---

Next Steps

For Business Owners

• Complete your profile

• Add AI-exclusive content

• Understand analytics

For Developers

• Explore API reference

• Set up MCP integration

• View code examples

For AI Platforms

• Integration guide

• Best practices

• Get certified

Learn More

• What is AIDP?

• Key concepts

• AIDP Schema specification

---

Need Help?

• 📚 Documentation: Browse the full docs

• 💬 GitHub Discussions: github.com/aidp/platform/discussions

• 📧 Email: [e-mail]

• 🐛 Issues: GitHub Issues