Quick Start for AI Agents

Primary Endpoint: POST /api/generate

Generate synthetic data using natural language or structured parameters.

Request Headers:

Content-Type: application/json
X-API-Key: your_api_key (optional)

Request Body Options:

• Natural Language
• Structured

{
  "query": "Generate 10 e-commerce customer orders with products and pricing"
}

{
  "query": "Create 5 employee records with salaries and departments"
}

{
  "query": "Generate financial transaction data for Q1 analysis"
}

{
  "category": "ecommerce",
  "size": 10
}

{
  "category": "employee", 
  "size": 5
}

{
  "category": "finance",
  "size": 100
}

Response Format:

{
  "success": true,
  "data": [
    {
      "order_id": "ORD-2024-001",
      "customer_name": "Sarah Chen",
      "product": "Wireless Headphones",
      "price": 149.99,
      "order_date": "2024-08-04",
      "shipping_address": "123 Tech St, Austin TX"
    }
  ],
  "metadata": {
    "size": 10,
    "category": "ecommerce", 
    "query": "Generate customer orders",
    "generated_at": "2025-08-04T23:45:00Z",
    "remaining_limit": 490
  }
}

Available Data Categories

Rate Limits & Authentication

Error Codes

Example Requests

# E-commerce data
curl -X POST https://synth-pipe-agentcreator.replit.app/api/generate \
  -H "Content-Type: application/json" \
  -d '{"query": "Generate 5 product sales with customer info"}'

# Financial transactions  
curl -X POST https://synth-pipe-agentcreator.replit.app/api/generate \
  -d '{"category": "finance", "size": 10}'

# Employee records
curl -X POST https://synth-pipe-agentcreator.replit.app/api/generate \
  -d '{"query": "Create HR dataset with 20 employees and salaries"}'

# Any custom request
curl -X POST https://synth-pipe-agentcreator.replit.app/api/generate \
  -d '{"query": "Generate student grade data for university analytics"}'

import requests

response = requests.post('https://synth-pipe-agentcreator.replit.app/api/generate', 
    headers={'Content-Type': 'application/json', 'X-API-Key': 'your_key'},
    json={'category': 'medical', 'size': 10}
)
data = response.json()