API Documentation

Integrate Voice Research Swarm into your applications

Overview

The VRS API allows you to programmatically trigger research calls, retrieve research results, and integrate voice research into your workflows.

Base URL: https://asktheswarm.com/api

Authentication

Currently, the API is open for public use. Rate limits apply.

Endpoints

GET /history

Get Call History

Retrieve all research calls for a phone number.

Query Parameters

GET /api/history?phone=%2B19084050853

Response:
{
  "calls": [
    {
      "id": "uuid",
      "status": "complete",
      "created_at": "2026-02-05T21:31:23Z",
      "completed_at": "2026-02-05T21:34:15Z"
    }
  ]
}
GET /report/:id

Get Research Report

Retrieve a complete research report by ID.

Path Parameters

GET /api/report/44e332e1-...

Response:
{
  "id": "uuid",
  "status": "complete",
  "transcript": "AI: Hey, what are you...",
  "threads": [...],
  "synthesis": "### Key findings...",
  "voice_brief": "Hey, here's what we found...",
  "agent_results": [...]
}
POST /unlock/:id

Unlock Report

Verify phone number to unlock a report.

Request Body

POST /api/unlock/44e332e1-...
Content-Type: application/json

{
  "phone": "+19084050853"
}

Response:
{
  "success": true
}
GET /swarm/status

Get System Status

Get real-time system health metrics.

GET /api/swarm/status

Response:
{
  "totalCalls": 42,
  "successRate": 95,
  "avgTime": 180,
  "recentCalls": [...]
}

Webhooks

VRS supports VAPI-compatible webhooks for call events. Configure your serverUrl to receive:

Example: Trigger Research via Phone

The simplest integration is to have users call:

# Users dial
+1 (908) 752-4025

# Ask any question
"What are the best SEO tools for agencies?"

# Receive callback in ~3 minutes with findings
# Get SMS with link to full report

Rate Limits

Support

Questions? Email: kai@snappedai.com