Start Research

Start an AI-powered research job (runs in background).

What it does:

Performs deep analysis that takes 5 minutes to 2 hours
Runs asynchronously - you’ll be notified when complete
Provides comprehensive insights and recommendations

Research Types:

competitor_analysis - Analyze competitor ad strategies Required context: competitors (list of competitor domains/names)
keyword_research - Discover high-value keywords Required context: seed_keywords (list of starting keywords)
market_landscape - Industry overview and trends Required context: industry (industry name)
audience_insights - Target audience analysis Required context: target_audience (description of audience)
campaign_strategy - Strategic recommendations Required context: campaign_goals (what you want to achieve)

Depth Levels:

quick: 5-10 minutes
standard: 15-30 minutes
comprehensive: 1-2 hours

Example: User: “Research my competitors” → Call start_research with:

research_type: “competitor_analysis”
depth: “standard”
context: {"competitors": ["competitor1.com", "competitor2.com"]}

POST

/

api

/

v1

/

tools

/

start_research

/

execute

Start Research

curl --request POST \
  --url https://api.adspirer.ai/api/v1/tools/start_research/execute \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "arguments": {
    "context": {
      "goals": [
        "increase brand awareness",
        "drive purchases"
      ],
      "industry": "ecommerce",
      "target_audience": "runners aged 25-45"
    },
    "depth": "standard",
    "notify_destination": "string",
    "notify_method": "email",
    "research_type": "string"
  }
}
'

{
  "data": {
    "quota": {
      "limit": 150,
      "period_end": "2026-05-01",
      "tier": "plus",
      "used": 42
    },
    "text": "(tool-specific textual output for start_research)"
  },
  "success": true,
  "tool": "start_research"
}

Authorizations

Authorization

string

header

required

API key from https://adspirer.ai/keys. Prefix sk_live_. Treat as a secret — never commit.

Headers

Idempotency-Key

string<uuid>

Client-generated UUID to make writes idempotent. Strongly recommended for write tools. A repeat call with the same key returns the cached result instead of re-executing. Example: 550e8400-e29b-41d4-a716-446655440000

Body

application/json

All tool arguments are wrapped in an arguments object. The fields accepted inside arguments are listed below — required fields are marked with a red asterisk.

arguments

object

required

Input for starting a research job.

Show child attributes

Response

Tool executed successfully. data.text carries the human-readable result (markdown-friendly). data.quota shows your current usage against the plan limit. data.structured appears when the tool emits machine-parseable structured content. data.content appears for tools that return non-text blocks (images, resources).

Returned on HTTP 200. data.text is the primary human-readable output. data.quota is always present for billable calls. data.structured is set only when the tool emits machine-parseable structured content. data.content is set only when the tool emits non-text content blocks.

data

object

required

Show child attributes

success

boolean

required

tool

string

required

Echoed tool_name from the request URL.

Last modified on April 23, 2026

Test MonitorDry-run a monitor against current data WITHOUT triggering alerts or sending notifications. **What it does:** - Evaluates the monitor's conditions against current campaign data - Shows which campaigns would match and which would be skipped - Does NOT create triggers, send emails, or queue auto-actions - Useful for verifying a monitor is configured correctly before enabling **When to use:** - "Test my CPA monitor" - "Would this alert trigger right now?" - "Check if my monitor is set up correctly" - "Dry run the budget overspend alert" Requires the monitor's alert_id (get from list_monitors).

Start Research

curl --request POST \
  --url https://api.adspirer.ai/api/v1/tools/start_research/execute \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "arguments": {
    "context": {
      "goals": [
        "increase brand awareness",
        "drive purchases"
      ],
      "industry": "ecommerce",
      "target_audience": "runners aged 25-45"
    },
    "depth": "standard",
    "notify_destination": "string",
    "notify_method": "email",
    "research_type": "string"
  }
}
'

{
  "data": {
    "quota": {
      "limit": 150,
      "period_end": "2026-05-01",
      "tier": "plus",
      "used": 42
    },
    "text": "(tool-specific textual output for start_research)"
  },
  "success": true,
  "tool": "start_research"
}