get_research_status

Monitoring & Reporting Read

Check the status of a research job

Endpoint

POST https://api.adspirer.ai/api/v1/tools/get_research_status/execute

Headers

Authorization: Bearer sk_live_... — your Adspirer API key (required)
Content-Type: application/json (required)
Idempotency-Key: <uuid> — recommended for write operations to make retries safe

Description

Check the status of a research job.

**What it does:**
- Shows current progress percentage
- Indicates if job is pending, in progress, completed, or failed
- Provides summary when complete

**When to use:**
- "Check on my research"
- "Is my analysis done?"
- "What's the status of job [ID]?"

Request body

All tool arguments are wrapped in an arguments object.

Field	Type	Description
`job_id`	`string` required	ID of the research job

Example request

{
  "arguments": {
    "job_id": "string"
  }
}

Example responses

200 — Success

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

400 — Tool-level error (bad arguments / multi-account selection)

{
  "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": "get_research_status"
}

402 — Quota exhausted

{
  "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": "get_research_status",
  "quota": {
    "used": 150,
    "limit": 150,
    "tier": "plus",
    "period_end": "2026-05-01",
    "upgrade_url": "https://adspirer.ai"
  }
}

Try it live

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