API Reference

Complete reference for the AIDP Platform REST API.

Base URL

Production: https://api.aidp.dev/v1
Staging: https://staging-api.aidp.dev/v1
Development: http://localhost:3000/api/v1

Authentication

All API requests require authentication using JWT tokens.

Getting an API Key

  1. Navigate to Settings > API Keys

  2. Create a new API key

  3. Store securely (never commit to version control)

Using API Keys

Include your API key in the Authorization header:

Authentication Endpoints

Register

Login

Refresh Token

View authentication details →

Response Format

Success Response

Error Response

Status Codes

Code
Meaning

200

Success

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

429

Too Many Requests

500

Internal Server Error

Rate Limiting

Limits:

  • Free tier: 100 requests/hour

  • Professional: 1,000 requests/hour

  • Enterprise: 10,000 requests/hour

Headers:

Learn more about rate limiting →

Pagination

List endpoints support cursor-based pagination:

Request:

Response:

API Endpoints

Business API

Manage business profiles, services, and availability.

  • Business Profile

    • Create, read, update, delete profiles

    • Manage services and pricing

    • Update availability and hours

    • Upload media

Search API

Discover businesses with advanced filtering.

  • Search & Discovery

    • Search businesses by location

    • Filter by category, rating, price

    • Sort and rank results

    • Get recommendations

Booking API

Handle bookings and appointments.

Review API

Manage reviews and ratings.

Analytics API

Access upstream metrics and insights.

SDKs

Official SDKs available:

TypeScript/JavaScript

Python

View SDK documentation →

Code Examples

TypeScript

Python

cURL

View more examples →

Webhooks

Receive real-time notifications for events:

  • Booking created/updated

  • Review submitted

  • Profile updated

  • Payment processed

Configure webhooks →

Testing

Sandbox Environment

Test your integration without affecting production:

Test Data

Use test API keys for development:

Learn about testing →

Support

Need help with the API?

Next Steps

Last updated