Pinot API Documentation

Complete documentation for Pinot platform APIs. All endpoints require API key authentication.

Magic Link Generation

Path:POST /api/v1/auth/magic-link/generate

Generate secure magic links for email authentication

Auth:API Key

Magic Link Verification

Path:GET /api/v1/auth/magic-link/verify

Verify magic link tokens and redirect users

Auth:None (token-based)

Create Notification

Path:POST /api/v1/notifications

Store notifications for users

Auth:API Key

API Status

Path:GET /api/v1/status

Check API health and status

Auth:API Key

API Documentation

Path:GET /api/v1/docs

Get OpenAPI specification

Auth:None

Authentication

All API endpoints require authentication using an API key. Include the key in the X-API-Key header.

curl -X POST https://api.pinot.dev/api/v1/endpoint \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your-api-key-here" \
  -d '{"key": "value"}'
          

API Reference

For complete OpenAPI documentation, visit:

Usage Examples

Magic Link Generation

# Generate magic link
curl -X POST https://api.pinot.dev/api/v1/auth/magic-link/generate \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your-api-key" \
  -d '{"email": "user@example.com", "language": "en"}'

# Response
{
  "success": true,
  "magicLinkUrl": "https://api.pinot.dev/verify?token=abc123",
  "message": "Magic link generated successfully"
}
              

Create Notification

# Create notification
curl -X POST https://api.pinot.dev/api/v1/notifications \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your-api-key" \
  -d '{
    "userId": "user-123",
    "eventType": "invoice",
    "eventId": "inv-456",
    "title": "New Invoice",
    "message": "Invoice #456 is ready",
    "language": "en"
  }'

# Response
{
  "success": true,
  "notificationId": "abc-123-def-456"
}
              

SDKs & Libraries

Official SDKs and libraries for Pinot API:

JavaScript@pinot/api-js
View on GitHub
TypeScriptTypes included
PythonComing soon

Support & Resources

Contact Support

Email us at support@pinot.dev

Status Page

Check system status at status.pinot.dev