Monitoring & Reporting Write
Start an AI-powered research job (runs in background)
POST https://api.adspirer.ai/api/v1/tools/start_research/execute
Authorization: Bearer sk_live_... — your Adspirer API key (required)Content-Type: application/json (required)Idempotency-Key: <uuid> — recommended for write operations to make retries safeAll tool arguments are wrapped in an arguments object.
| Field | Type | Description |
|---|---|---|
research_type | string required | Type: 'competitor_analysis', 'keyword_research', 'market_landscape', 'audience_insights', 'campaign_strategy' |
depth | string optional | Depth: 'quick' (5-10 min), 'standard' (15-30 min), 'comprehensive' (1-2 hours) default: "standard" |
context | object required | Research context (varies by type). See tool description for required fields. |
notify_method | string optional | How to notify when complete: 'email', 'slack', 'in_app' default: "email" |
notify_destination | string optional | Email address or Slack channel for notification |
{
"arguments": {
"research_type": "string",
"context": {
"industry": "ecommerce",
"target_audience": "runners aged 25-45",
"goals": [
"increase brand awareness",
"drive purchases"
]
},
"depth": "standard",
"notify_method": "email",
"notify_destination": "string"
}
}
{
"success": true,
"data": {
"text": "(tool-specific textual output for start_research)",
"quota": {
"used": 42,
"limit": 150,
"tier": "plus",
"period_end": "2026-05-01"
}
},
"tool": "start_research"
}
{
"success": false,
"error": "You have 25 meta_ads accounts connected. Please specify which account to use by passing the ad_account_id parameter:\n - Acme Holdings (ad_account_id=\"act_123456789\")\n - Acme EU (ad_account_id=\"act_987654321\")",
"is_error": true,
"tool": "start_research"
}
{
"success": false,
"error": "\ud83d\udea8 Monthly limit reached (150/150 tool calls on Plus tier).\nUpgrade to Pro at https://adspirer.ai to keep building.",
"is_error": true,
"tool": "start_research",
"quota": {
"used": 150,
"limit": 150,
"tier": "plus",
"period_end": "2026-05-01",
"upgrade_url": "https://adspirer.ai"
}
}
Interactive: Swagger UI
Machine-readable: OpenAPI 3.1 spec · llms-full.txt
More tools: Monitoring & Reporting · All tools
Adspirer REST API — get an API key at adspirer.ai/keys · adspirer.ai