Schedule Brief

Schedule recurring performance briefs delivered to your inbox.

What it does:

Creates automated daily or weekly performance reports
Summarizes key metrics across all your ad platforms
Highlights top performers and underperformers
Provides AI-generated recommendations

When to use:

“Set up a daily performance report”
“Send me weekly campaign summaries”
“I want automated performance updates”
“Create a scheduled brief for my campaigns”

Execution time: 2-3 seconds to schedule

Example: User: “Send me daily performance updates at 9 AM” → Call schedule_brief with:

name: “Daily Performance Update”
schedule_type: “daily”
time: “09:00”
delivery_method: “email”
delivery_destination: “user@example.com”

POST

/

api

/

v1

/

tools

/

schedule_brief

/

execute

Schedule Brief

curl --request POST \
  --url https://api.adspirer.ai/api/v1/tools/schedule_brief/execute \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "arguments": {
    "delivery_destination": "https://example.com",
    "delivery_method": "email",
    "name": "string",
    "platforms": [
      "string"
    ],
    "schedule_type": "weekly",
    "time": "09:00",
    "timezone": "America/New_York"
  }
}
'

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

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 scheduling a performance brief.

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

Start ResearchStart 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:** 1. **competitor_analysis** - Analyze competitor ad strategies Required context: competitors (list of competitor domains/names) 2. **keyword_research** - Discover high-value keywords Required context: seed_keywords (list of starting keywords) 3. **market_landscape** - Industry overview and trends Required context: industry (industry name) 4. **audience_insights** - Target audience analysis Required context: target_audience (description of audience) 5. **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"]}`

Schedule Brief

curl --request POST \
  --url https://api.adspirer.ai/api/v1/tools/schedule_brief/execute \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "arguments": {
    "delivery_destination": "https://example.com",
    "delivery_method": "email",
    "name": "string",
    "platforms": [
      "string"
    ],
    "schedule_type": "weekly",
    "time": "09:00",
    "timezone": "America/New_York"
  }
}
'

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