{
  "schemaVersion": "1.0",
  "item": {
    "slug": "unloopa-api",
    "name": "Unloopa Api",
    "source": "tencent",
    "type": "skill",
    "category": "开发工具",
    "sourceUrl": "https://clawhub.ai/echris6/unloopa-api",
    "canonicalUrl": "https://clawhub.ai/echris6/unloopa-api",
    "targetPlatform": "OpenClaw"
  },
  "install": {
    "downloadMode": "redirect",
    "downloadUrl": "/downloads/unloopa-api",
    "sourceDownloadUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=unloopa-api",
    "sourcePlatform": "tencent",
    "targetPlatform": "OpenClaw",
    "installMethod": "Manual import",
    "extraction": "Extract archive",
    "prerequisites": [
      "OpenClaw"
    ],
    "packageFormat": "ZIP package",
    "includedAssets": [
      "SKILL.md"
    ],
    "primaryDoc": "SKILL.md",
    "quickSetup": [
      "Download the package from Yavira.",
      "Extract the archive and review SKILL.md first.",
      "Import or place the package into your OpenClaw setup."
    ],
    "agentAssist": {
      "summary": "Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.",
      "steps": [
        "Download the package from Yavira.",
        "Extract it into a folder your agent can access.",
        "Paste one of the prompts below and point your agent at the extracted folder."
      ],
      "prompts": [
        {
          "label": "New install",
          "body": "I downloaded a skill package from Yavira. Read SKILL.md from the extracted folder and install it by following the included instructions. Tell me what you changed and call out any manual steps you could not complete."
        },
        {
          "label": "Upgrade existing",
          "body": "I downloaded an updated skill package from Yavira. Read SKILL.md from the extracted folder, compare it with my current installation, and upgrade it while preserving any custom configuration unless the package docs explicitly say otherwise. Summarize what changed and any follow-up checks I should run."
        }
      ]
    },
    "sourceHealth": {
      "source": "tencent",
      "status": "healthy",
      "reason": "direct_download_ok",
      "recommendedAction": "download",
      "checkedAt": "2026-05-07T17:22:31.273Z",
      "expiresAt": "2026-05-14T17:22:31.273Z",
      "httpStatus": 200,
      "finalUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=afrexai-annual-report",
      "contentType": "application/zip",
      "probeMethod": "head",
      "details": {
        "probeUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=afrexai-annual-report",
        "contentDisposition": "attachment; filename=\"afrexai-annual-report-1.0.0.zip\"",
        "redirectLocation": null,
        "bodySnippet": null
      },
      "scope": "source",
      "summary": "Source download looks usable.",
      "detail": "Yavira can redirect you to the upstream package for this source.",
      "primaryActionLabel": "Download for OpenClaw",
      "primaryActionHref": "/downloads/unloopa-api"
    },
    "validation": {
      "installChecklist": [
        "Use the Yavira download entry.",
        "Review SKILL.md after the package is downloaded.",
        "Confirm the extracted package contains the expected setup assets."
      ],
      "postInstallChecks": [
        "Confirm the extracted package includes the expected docs or setup files.",
        "Validate the skill or prompts are available in your target agent workspace.",
        "Capture any manual follow-up steps the agent could not complete."
      ]
    },
    "downloadPageUrl": "https://openagent3.xyz/downloads/unloopa-api",
    "agentPageUrl": "https://openagent3.xyz/skills/unloopa-api/agent",
    "manifestUrl": "https://openagent3.xyz/skills/unloopa-api/agent.json",
    "briefUrl": "https://openagent3.xyz/skills/unloopa-api/agent.md"
  },
  "agentAssist": {
    "summary": "Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.",
    "steps": [
      "Download the package from Yavira.",
      "Extract it into a folder your agent can access.",
      "Paste one of the prompts below and point your agent at the extracted folder."
    ],
    "prompts": [
      {
        "label": "New install",
        "body": "I downloaded a skill package from Yavira. Read SKILL.md from the extracted folder and install it by following the included instructions. Tell me what you changed and call out any manual steps you could not complete."
      },
      {
        "label": "Upgrade existing",
        "body": "I downloaded an updated skill package from Yavira. Read SKILL.md from the extracted folder, compare it with my current installation, and upgrade it while preserving any custom configuration unless the package docs explicitly say otherwise. Summarize what changed and any follow-up checks I should run."
      }
    ]
  },
  "documentation": {
    "source": "clawhub",
    "primaryDoc": "SKILL.md",
    "sections": [
      {
        "title": "Unloopa API",
        "body": "You control the Unloopa platform through its REST API. All requests go to https://dashboard.unloopa.com/api/v1/ with Bearer token authentication."
      },
      {
        "title": "Authentication",
        "body": "Every request needs the header:\n\nAuthorization: Bearer $UNLOOPA_API_KEY\n\nThe API key is set in the UNLOOPA_API_KEY environment variable. Keys start with unlpa_live_.\n\nIf the user hasn't configured their key yet, tell them:\n\nGo to https://dashboard.unloopa.com/settings and click the \"API\" tab\nClick \"Create API Key\" and copy the key (it's only shown once)\nConfigure it in your OpenClaw settings, or set the environment variable: export UNLOOPA_API_KEY=unlpa_live_...\n\nIf you get a 401 unauthorized error, the key is missing or invalid — ask the user to check their key."
      },
      {
        "title": "First Call: Always Start With GET /quota",
        "body": "Before doing anything else, call GET /quota to discover:\n\nWhat plan the user is on (starter or pro)\nWhether voice and video features are enabled\nHow many leads and credits remain\nPurchase links if they need to upgrade or buy credits\n\nThis single call tells you everything about what the user can and can't do. Adapt your behavior based on the response:\n\nquota fieldWhat it meansvoice_enabled: falseDon't offer voice calling — they need Pro plan. Share purchase_links.upgradevideo_enabled: falseDon't offer video generation — they need Pro planvoice_credits: 0Can't make calls — share purchase_links.voice_creditswebsites.remaining: 0Can't generate leads — quota resets at resets_at"
      },
      {
        "title": "Error Format",
        "body": "All errors return:\n\n{ \"error\": { \"code\": \"error_code\", \"message\": \"Human-readable message\", \"details\": {} } }\n\nError codes: unauthorized (401), invalid_input (400), not_found (404), plan_required (403), insufficient_credits (402), quota_exceeded (429), rate_limited (429), setup_required (400), limit_reached (400), invalid_state (400), internal_error (500).\n\nWhen you get plan_required (403), share the upgrade link from quota. When you get insufficient_credits (402), share the credit purchase links. When rate limited, check the Retry-After header (seconds)."
      },
      {
        "title": "Plans",
        "body": "Starter ($47/mo): 1,000 leads/month, email outreach, templates\nPro ($97/mo): 5,000 leads/month, 200 videos/month, voice calling, AI agents, phone numbers"
      },
      {
        "title": "1. Full Lead Pipeline (any plan)",
        "body": "The /command endpoint runs the entire pipeline automatically: scrape leads → generate websites → enrich emails → send outreach. Just describe what you want.\n\n1. GET  /quota                    → check websites.remaining > 0\n2. POST /command                  → submit natural language command (full pipeline runs automatically)\n3. GET  /jobs/{job_id}            → poll every 5-10s until status=completed\n4. GET  /leads?job_id={job_id}    → view generated leads with websites, emails, etc."
      },
      {
        "title": "2. Email Outreach (any plan)",
        "body": "1. GET  /outreach/status          → verify configured=true, remaining_today > 0\n2. GET  /leads?has_email=true     → find leads with emails\n3. GET  /outreach/templates       → pick a template\n4. POST /outreach/send            → queue emails\n\nIf configured=false, tell the user to connect an email account at the setup_url in the response."
      },
      {
        "title": "3. Voice Calling (Pro plan only)",
        "body": "Skip this workflow entirely if voice_enabled=false in /quota. Tell the user they need Pro and share the upgrade link.\n\nPrerequisites: voice_enabled=true + voice_credits > 0 + at least 1 phone number + at least 1 voice agent.\n\n1. GET  /quota                    → voice_enabled? voice_credits > 0?\n   If voice_credits=0 → share purchase_links.voice_credits\n2. GET  /phone-numbers            → count > 0? (max 3)\n   If empty → POST /phone-numbers/search + POST /phone-numbers/buy\n3. GET  /voice/agents             → count > 0? (max 3)\n   If empty → POST /voice/agents (create one)\n4. POST /voice/call               → single call, OR:\n5. POST /voice/campaigns          → bulk campaign (starts as draft)\n6. PATCH /voice/campaigns/{id}    → action=activate, then action=trigger"
      },
      {
        "title": "4. Full Funnel",
        "body": "The /command endpoint now handles steps 1-3 automatically. Voice calling is the only manual step.\n\n1. GET  /quota                    → know the plan, adapt accordingly\n2. POST /command → poll /jobs/{id} → GET /leads  (scrape + websites + emails + outreach all automatic)\n3. Voice (Pro only): /phone-numbers → /voice/agents → /voice/campaigns"
      },
      {
        "title": "POST /command",
        "body": "Submit a natural language lead generation command. The API automatically runs the full pipeline: scrape → generate websites → enrich emails/socials → send outreach. No need to mention each step in the command.\n\nBody:\n\n{\n  \"command\": \"Find 50 plumbers in Miami\",\n  \"max_results\": 50,\n  \"with_video\": false,\n  \"with_vsl\": false\n}\n\ncommand (required, string, max 1000 chars) — just describe the niche and location. Any number mentioned in the command is ignored — use max_results to control lead count.\nmax_results (optional, 1-100, default: 100, or 10 when with_video/with_vsl is true)\nwith_video (optional, bool, Pro plan only)\nwith_vsl (optional, bool, Pro plan only)\n\nDefault behavior: The API always overrides what's in the command text. It scrapes up to max_results leads (default 100), generates a website for each, finds email addresses, enriches social profiles, and sends outreach emails — all automatically. Numbers in the command like \"Find 15 plumbers\" are ignored; use max_results instead.\n\nResponse: { job_id, status: \"processing\", defaults: { max_results, generate_websites, enrich_emails, send_outreach, with_video, with_vsl }, quota: { used, limit, remaining } }"
      },
      {
        "title": "GET /jobs",
        "body": "List submitted commands.\n\nQuery: ?limit=20&offset=0 (limit max 100)\n\nResponse: { jobs: [{ job_id, command, intent, status, error, created_at, updated_at }], total, limit, offset }"
      },
      {
        "title": "GET /jobs/{id}",
        "body": "Poll a job for progress and results.\n\nResponse:\n\n{\n  \"job_id\": \"uuid\",\n  \"status\": \"processing|completed|failed\",\n  \"progress\": 75,\n  \"current_step\": \"Generating websites...\",\n  \"steps\": [{ \"name\": \"scraping\", \"status\": \"completed\", \"message\": \"Found 50 leads\", \"count\": 50 }],\n  \"result\": {\n    \"websites\": [{ \"id\": \"uuid\", \"url\": \"https://...\", \"business_name\": \"...\", \"city\": \"...\", \"industry\": \"...\" }],\n    \"leads_scraped\": 50,\n    \"emails_sent\": 0\n  },\n  \"error\": null\n}\n\nPoll every 5-10 seconds. Jobs take 30s to 5 minutes depending on count and video."
      },
      {
        "title": "GET /leads",
        "body": "List and filter leads.\n\nQuery params (all optional):\n\nlimit (1-100, default 50), offset (default 0)\ncity — partial match (e.g. \"miami\")\nindustry — partial match (e.g. \"plumber\")\nhas_phone=true — only leads with phone numbers\nhas_email=true — only leads with email addresses\nmin_rating — minimum Google rating (e.g. 4.0)\nmin_reviews — minimum review count\njob_id — leads from a specific command\nsearch — free text search across name, city, industry\ncreated_after — ISO date (e.g. \"2025-01-15\")\ncreated_before — ISO date\nhas_website=true — only leads with generated website URLs\nhas_video=true — only leads with video\nvideo_status — pending|generating|completed|failed\n\nResponse:\n\n{\n  \"leads\": [{\n    \"id\": \"uuid\",\n    \"business_name\": \"Acme Plumbing\",\n    \"city\": \"Miami\",\n    \"industry\": \"Plumber\",\n    \"phone\": \"+13055551234\",\n    \"email\": \"info@acme.com\",\n    \"rating\": 4.8,\n    \"reviews\": 127,\n    \"url\": \"https://unlora.com/acme-plumbing-miami\",\n    \"language\": \"en\",\n    \"video_url\": \"https://...\",\n    \"video_status\": \"completed\",\n    \"vsl_url\": \"https://...\",\n    \"vsl_status\": \"completed\",\n    \"socials\": { \"instagram\": \"...\", \"facebook\": \"...\", \"linkedin\": \"...\", \"twitter\": \"...\" },\n    \"created_at\": \"2025-01-15T...\"\n  }],\n  \"total\": 50, \"limit\": 50, \"offset\": 0\n}"
      },
      {
        "title": "GET /leads/{id}",
        "body": "Full lead detail including existing website analysis.\n\nResponse: Same fields as list plus:\n\nslug — URL slug\nexisting_website: { url, pagespeed_score, load_time, mobile_optimized } or null"
      },
      {
        "title": "GET /websites",
        "body": "Simpler list of generated websites.\n\nQuery: ?limit=20&offset=0\n\nResponse: { websites: [{ id, url, slug, business_name, city, industry, phone, email, language, video_url, vsl_url, created_at }], total, limit, offset }"
      },
      {
        "title": "GET /quota",
        "body": "Check plan, usage, credits, and purchase links.\n\nResponse:\n\n{\n  \"plan\": \"pro\",\n  \"plan_status\": \"active\",\n  \"websites\": { \"used\": 150, \"limit\": 5000, \"remaining\": 4850 },\n  \"videos\": { \"used\": 0, \"limit\": 200, \"remaining\": 200 },\n  \"voice_credits\": 45,\n  \"voice_enabled\": true,\n  \"video_enabled\": true,\n  \"resets_at\": \"2025-02-01T00:00:00.000Z\",\n  \"purchase_links\": {\n    \"voice_credits\": {\n      \"50_credits_$10\": \"https://whop.com/checkout/plan_xBEWrVWZ8MRvM/\",\n      \"200_credits_$35\": \"https://whop.com/checkout/plan_ucYBrssGb4E2G/\",\n      \"500_credits_$75\": \"https://whop.com/checkout/plan_zTX2bQyWLCqlx/\"\n    },\n    \"upgrade\": \"https://whop.com/unloopa/\"\n  }\n}"
      },
      {
        "title": "GET /outreach/status",
        "body": "Check email configuration, daily capacity, DNS health.\n\nResponse:\n\n{\n  \"configured\": true,\n  \"accounts\": [{\n    \"id\": \"uuid\",\n    \"email\": \"outreach@company.com\",\n    \"display_name\": \"Company\",\n    \"daily_limit\": 25,\n    \"sent_today\": 10,\n    \"remaining_today\": 15,\n    \"warmup_enabled\": true,\n    \"warmup_day\": 14,\n    \"health\": { \"score\": 85, \"status\": \"good\", \"checked_at\": \"2025-01-15T...\" },\n    \"created_at\": \"2025-01-01T...\"\n  }],\n  \"summary\": {\n    \"total_accounts\": 1,\n    \"total_daily_capacity\": 25,\n    \"total_sent_today\": 10,\n    \"total_remaining_today\": 15,\n    \"pending_in_queue\": 5,\n    \"accounts_with_health_issues\": 0\n  },\n  \"setup_url\": \"https://dashboard.unloopa.com/settings?tab=email\"\n}\n\nNew SMTP accounts warm up over 4 weeks: 5/day -> 10/day -> 15/day -> 25/day."
      },
      {
        "title": "GET /outreach/templates",
        "body": "List prebuilt and custom email templates.\n\nResponse: { templates: [{ id, name, subject, body, is_custom: false, is_default: true, language }], custom_templates: [{ id, name, subject, body, is_custom: true, is_default, language }] }\n\nTemplates support placeholders: {{business_name}}, {{city}}, {{industry}}, {{website_url}}, {{video_url}} (Pro only)."
      },
      {
        "title": "POST /outreach/templates",
        "body": "Create custom email template.\n\nBody:\n\n{\n  \"name\": \"Miami Pitch\",\n  \"subject\": \"{{business_name}} - New Website Ready\",\n  \"body\": \"Hi! I built a website for {{business_name}} in {{city}}...\",\n  \"language\": \"en\",\n  \"is_default\": true\n}\n\nRequired: name, subject, body."
      },
      {
        "title": "PATCH /outreach/templates/{id}",
        "body": "Update a custom template. Only custom templates can be edited.\n\nBody: { name?, subject?, body?, language?, is_default? }"
      },
      {
        "title": "DELETE /outreach/templates/{id}",
        "body": "Delete a custom template."
      },
      {
        "title": "POST /outreach/send",
        "body": "Send emails to leads.\n\nBody:\n\n{\n  \"lead_ids\": [\"uuid1\", \"uuid2\"],\n  \"template_id\": \"uuid\",\n  \"custom_subject\": \"Optional override\",\n  \"custom_body\": \"Optional override\"\n}\n\nlead_ids (required, 1-100 UUIDs)\ntemplate_id (optional if custom_subject + custom_body provided)\n\nResponse: { emails_queued, emails_waiting_for_video, skipped_duplicates, failed, manual_outreach: [] }\n\nRequires SMTP configured (check /outreach/status first). Duplicate detection prevents re-sending."
      },
      {
        "title": "GET /phone-numbers",
        "body": "List active phone numbers. Pro plan required.\n\nResponse: { numbers: [{ id, phone_number, area_code, locality, region, country, monthly_cost_cents, created_at }], count: 2, limit: 3 }\n\nMax 3 phone numbers. Check count vs limit before buying."
      },
      {
        "title": "POST /phone-numbers/search",
        "body": "Search available numbers by area code. Pro plan required.\n\nBody: { \"area_code\": \"305\", \"country\": \"US\" }\n\narea_code (required, 3 digits)\ncountry (optional, default \"US\")\n\nResponse: { numbers: [{ phone_number: \"+13055551234\", friendly_name, locality, region }] }"
      },
      {
        "title": "POST /phone-numbers/buy",
        "body": "Purchase a phone number. Pro plan required. $1/month per number.\n\nBody: { \"phone_number\": \"+13055551234\" }\nMust be E.164 format from search results.\n\nResponse: { number: { id, phone_number, area_code, monthly_cost_cents, created_at } }"
      },
      {
        "title": "DELETE /phone-numbers/{id}",
        "body": "Release a phone number. Pro plan required.\n\nResponse: { success: true }"
      },
      {
        "title": "GET /voice/agents",
        "body": "List voice agents. Pro plan required.\n\nResponse: { agents: [{ id, name, voice_id, voice_name, elevenlabs_agent_id, has_script, has_first_message, created_at }], count: 1, limit: 3 }\n\nMax 3 agents."
      },
      {
        "title": "POST /voice/agents",
        "body": "Create a voice agent. Pro plan required.\n\nBody:\n\n{\n  \"name\": \"Sales Agent\",\n  \"voice_id\": \"cjVigY5qzO86Huf0OWal\",\n  \"voice_name\": \"Eric\",\n  \"script\": \"You are a friendly sales rep calling {{business_name}} in {{city}}...\",\n  \"first_message\": \"Hi there, do you have just a moment?\",\n  \"agent_config\": { \"stability\": 0.3, \"similarityBoost\": 0.85 }\n}\n\nRequired: name, voice_id, script.\n\nScripts support dynamic variables: {{business_name}}, {{city}}, {{industry}}, {{website_url}} — auto-populated from lead data during calls."
      },
      {
        "title": "PATCH /voice/agents/{id}",
        "body": "Update a voice agent. Syncs changes to ElevenLabs automatically.\n\nBody: { name?, voice_id?, voice_name?, script?, first_message?, agent_config? }"
      },
      {
        "title": "DELETE /voice/agents/{id}",
        "body": "Delete a voice agent. Also removes from ElevenLabs."
      },
      {
        "title": "POST /voice/call",
        "body": "Make a single outbound call. Costs 1 voice credit. Pro plan required.\n\nBody:\n\n{\n  \"agent_id\": \"uuid\",\n  \"phone_number\": \"+13055551234\",\n  \"dynamic_variables\": { \"business_name\": \"Acme\", \"city\": \"Miami\", \"industry\": \"Plumbing\", \"website_url\": \"https://...\" }\n}\n\nRequired: agent_id, phone_number.\n\nResponse: { call_id, conversation_id, status: \"initiated\", phone_number }"
      },
      {
        "title": "GET /voice/calls",
        "body": "List voice calls with filters. Pro plan required.\n\nQuery: ?limit=50&offset=0&campaign_id=uuid&status=completed&outcome=interested\n\nstatus: pending, queued, in_progress, completed, failed, cancelled\noutcome: interested, not_interested, voicemail, no_answer, callback\n\nResponse: { calls: [{ id, campaign_id, business_name, phone_number, status, outcome, outcome_notes, duration_secs, transcript, analysis, started_at, completed_at, created_at }], total, limit, offset }"
      },
      {
        "title": "GET /voice/calls/{id}",
        "body": "Full call detail with transcript and analysis.\n\nResponse: { call_id, business_name, phone_number, status, outcome, outcome_notes, duration_secs, transcript, analysis, started_at, completed_at, created_at }"
      },
      {
        "title": "GET /voice/campaigns",
        "body": "List voice campaigns with stats. Pro plan required.\n\nResponse:\n\n{\n  \"campaigns\": [{\n    \"id\": \"uuid\",\n    \"name\": \"Miami Plumbers\",\n    \"status\": \"active\",\n    \"stats\": { \"total\": 50, \"connected\": 30, \"interested\": 8, \"not_interested\": 15, \"no_answer\": 7, \"failed\": 0, \"avg_duration_secs\": 45 },\n    \"created_at\": \"...\", \"updated_at\": \"...\"\n  }]\n}"
      },
      {
        "title": "POST /voice/campaigns",
        "body": "Create a calling campaign. Starts as draft. Pro plan + voice credits required.\n\nBody:\n\n{\n  \"name\": \"Miami Plumbers Campaign\",\n  \"phone_number_id\": \"uuid\",\n  \"agent_id\": \"uuid\",\n  \"lead_filter\": { \"city\": \"Miami\", \"industry\": \"plumber\" },\n  \"timezone\": \"America/New_York\",\n  \"calling_window_start\": \"09:00\",\n  \"calling_window_end\": \"17:00\",\n  \"calling_days\": [\"mon\", \"tue\", \"wed\", \"thu\", \"fri\"],\n  \"calls_per_hour\": 10,\n  \"max_calls\": 50\n}\n\nRequired: name, phone_number_id, and either agent_id OR voice_id + script.\nLead selection: provide lead_ids (array of UUIDs) or lead_filter (dynamic). Only leads with phone numbers are included.\n\nResponse: { campaign: { id, name, status: \"draft\", leads_count, callable_leads, created_at } }"
      },
      {
        "title": "GET /voice/campaigns/{id}",
        "body": "Campaign detail with full config and stats.\n\nResponse includes: id, name, status, script, script_version, first_message, voice_id, voice_name, timezone, calling_window, calling_days, calls_per_hour, max_calls, stats (with pending count), timestamps."
      },
      {
        "title": "PATCH /voice/campaigns/{id}",
        "body": "Control campaign lifecycle or update fields.\n\nLifecycle actions (body: { \"action\": \"...\" }):\n\nactivate — draft/paused -> active\npause — active -> paused\ncancel — any -> completed (cancels pending calls)\ntrigger — active campaign: initiate up to 10 pending calls immediately. Each call costs 1 voice credit. Optional: { \"action\": \"trigger\", \"limit\": 5 }\n\nField updates (draft/paused only, body: { \"updates\": {...} }):\n\nscript, voice_id, voice_name, first_message, calling_window_start, calling_window_end, timezone, calling_days, calls_per_hour, agent_config\n\nTrigger response: { triggered: 5, calls: [{ id, business_name, conversation_id }] }"
      },
      {
        "title": "Important Notes",
        "body": "Job processing takes ~8-10 minutes for a full pipeline run. Scraping is fast (~20 seconds), but website generation takes ~8 minutes for all websites. Do NOT assume the job is stuck — poll every 15-20 seconds and be patient during the website_generation step\nEmail warmup: new SMTP accounts start at 5/day, ramping to 25/day over 4 weeks\nVoice campaigns must be: created (draft) -> activated -> triggered\nThe trigger action initiates up to 10 calls at a time, costing 1 credit each\nDynamic variables ({{business_name}}, etc.) are auto-populated from lead data\nDuplicate email detection prevents re-sending to the same lead\nVideo features (with_video, with_vsl) are Pro plan only\nPhone numbers and voice agents have a hard limit of 3 each\nAlways check preconditions before taking action (quota, credits, SMTP, plan)"
      }
    ],
    "body": "Unloopa API\n\nYou control the Unloopa platform through its REST API. All requests go to https://dashboard.unloopa.com/api/v1/ with Bearer token authentication.\n\nAuthentication\n\nEvery request needs the header:\n\nAuthorization: Bearer $UNLOOPA_API_KEY\n\n\nThe API key is set in the UNLOOPA_API_KEY environment variable. Keys start with unlpa_live_.\n\nIf the user hasn't configured their key yet, tell them:\n\nGo to https://dashboard.unloopa.com/settings and click the \"API\" tab\nClick \"Create API Key\" and copy the key (it's only shown once)\nConfigure it in your OpenClaw settings, or set the environment variable: export UNLOOPA_API_KEY=unlpa_live_...\n\nIf you get a 401 unauthorized error, the key is missing or invalid — ask the user to check their key.\n\nFirst Call: Always Start With GET /quota\n\nBefore doing anything else, call GET /quota to discover:\n\nWhat plan the user is on (starter or pro)\nWhether voice and video features are enabled\nHow many leads and credits remain\nPurchase links if they need to upgrade or buy credits\n\nThis single call tells you everything about what the user can and can't do. Adapt your behavior based on the response:\n\nquota field\tWhat it means\nvoice_enabled: false\tDon't offer voice calling — they need Pro plan. Share purchase_links.upgrade\nvideo_enabled: false\tDon't offer video generation — they need Pro plan\nvoice_credits: 0\tCan't make calls — share purchase_links.voice_credits\nwebsites.remaining: 0\tCan't generate leads — quota resets at resets_at\nError Format\n\nAll errors return:\n\n{ \"error\": { \"code\": \"error_code\", \"message\": \"Human-readable message\", \"details\": {} } }\n\n\nError codes: unauthorized (401), invalid_input (400), not_found (404), plan_required (403), insufficient_credits (402), quota_exceeded (429), rate_limited (429), setup_required (400), limit_reached (400), invalid_state (400), internal_error (500).\n\nWhen you get plan_required (403), share the upgrade link from quota. When you get insufficient_credits (402), share the credit purchase links. When rate limited, check the Retry-After header (seconds).\n\nPlans\nStarter ($47/mo): 1,000 leads/month, email outreach, templates\nPro ($97/mo): 5,000 leads/month, 200 videos/month, voice calling, AI agents, phone numbers\nWorkflows\n1. Full Lead Pipeline (any plan)\n\nThe /command endpoint runs the entire pipeline automatically: scrape leads → generate websites → enrich emails → send outreach. Just describe what you want.\n\n1. GET  /quota                    → check websites.remaining > 0\n2. POST /command                  → submit natural language command (full pipeline runs automatically)\n3. GET  /jobs/{job_id}            → poll every 5-10s until status=completed\n4. GET  /leads?job_id={job_id}    → view generated leads with websites, emails, etc.\n\n2. Email Outreach (any plan)\n1. GET  /outreach/status          → verify configured=true, remaining_today > 0\n2. GET  /leads?has_email=true     → find leads with emails\n3. GET  /outreach/templates       → pick a template\n4. POST /outreach/send            → queue emails\n\n\nIf configured=false, tell the user to connect an email account at the setup_url in the response.\n\n3. Voice Calling (Pro plan only)\n\nSkip this workflow entirely if voice_enabled=false in /quota. Tell the user they need Pro and share the upgrade link.\n\nPrerequisites: voice_enabled=true + voice_credits > 0 + at least 1 phone number + at least 1 voice agent.\n\n1. GET  /quota                    → voice_enabled? voice_credits > 0?\n   If voice_credits=0 → share purchase_links.voice_credits\n2. GET  /phone-numbers            → count > 0? (max 3)\n   If empty → POST /phone-numbers/search + POST /phone-numbers/buy\n3. GET  /voice/agents             → count > 0? (max 3)\n   If empty → POST /voice/agents (create one)\n4. POST /voice/call               → single call, OR:\n5. POST /voice/campaigns          → bulk campaign (starts as draft)\n6. PATCH /voice/campaigns/{id}    → action=activate, then action=trigger\n\n4. Full Funnel\n\nThe /command endpoint now handles steps 1-3 automatically. Voice calling is the only manual step.\n\n1. GET  /quota                    → know the plan, adapt accordingly\n2. POST /command → poll /jobs/{id} → GET /leads  (scrape + websites + emails + outreach all automatic)\n3. Voice (Pro only): /phone-numbers → /voice/agents → /voice/campaigns\n\nEndpoints Reference\nPOST /command\n\nSubmit a natural language lead generation command. The API automatically runs the full pipeline: scrape → generate websites → enrich emails/socials → send outreach. No need to mention each step in the command.\n\nBody:\n\n{\n  \"command\": \"Find 50 plumbers in Miami\",\n  \"max_results\": 50,\n  \"with_video\": false,\n  \"with_vsl\": false\n}\n\ncommand (required, string, max 1000 chars) — just describe the niche and location. Any number mentioned in the command is ignored — use max_results to control lead count.\nmax_results (optional, 1-100, default: 100, or 10 when with_video/with_vsl is true)\nwith_video (optional, bool, Pro plan only)\nwith_vsl (optional, bool, Pro plan only)\n\nDefault behavior: The API always overrides what's in the command text. It scrapes up to max_results leads (default 100), generates a website for each, finds email addresses, enriches social profiles, and sends outreach emails — all automatically. Numbers in the command like \"Find 15 plumbers\" are ignored; use max_results instead.\n\nResponse: { job_id, status: \"processing\", defaults: { max_results, generate_websites, enrich_emails, send_outreach, with_video, with_vsl }, quota: { used, limit, remaining } }\n\nGET /jobs\n\nList submitted commands.\n\nQuery: ?limit=20&offset=0 (limit max 100)\n\nResponse: { jobs: [{ job_id, command, intent, status, error, created_at, updated_at }], total, limit, offset }\n\nGET /jobs/{id}\n\nPoll a job for progress and results.\n\nResponse:\n\n{\n  \"job_id\": \"uuid\",\n  \"status\": \"processing|completed|failed\",\n  \"progress\": 75,\n  \"current_step\": \"Generating websites...\",\n  \"steps\": [{ \"name\": \"scraping\", \"status\": \"completed\", \"message\": \"Found 50 leads\", \"count\": 50 }],\n  \"result\": {\n    \"websites\": [{ \"id\": \"uuid\", \"url\": \"https://...\", \"business_name\": \"...\", \"city\": \"...\", \"industry\": \"...\" }],\n    \"leads_scraped\": 50,\n    \"emails_sent\": 0\n  },\n  \"error\": null\n}\n\n\nPoll every 5-10 seconds. Jobs take 30s to 5 minutes depending on count and video.\n\nGET /leads\n\nList and filter leads.\n\nQuery params (all optional):\n\nlimit (1-100, default 50), offset (default 0)\ncity — partial match (e.g. \"miami\")\nindustry — partial match (e.g. \"plumber\")\nhas_phone=true — only leads with phone numbers\nhas_email=true — only leads with email addresses\nmin_rating — minimum Google rating (e.g. 4.0)\nmin_reviews — minimum review count\njob_id — leads from a specific command\nsearch — free text search across name, city, industry\ncreated_after — ISO date (e.g. \"2025-01-15\")\ncreated_before — ISO date\nhas_website=true — only leads with generated website URLs\nhas_video=true — only leads with video\nvideo_status — pending|generating|completed|failed\n\nResponse:\n\n{\n  \"leads\": [{\n    \"id\": \"uuid\",\n    \"business_name\": \"Acme Plumbing\",\n    \"city\": \"Miami\",\n    \"industry\": \"Plumber\",\n    \"phone\": \"+13055551234\",\n    \"email\": \"info@acme.com\",\n    \"rating\": 4.8,\n    \"reviews\": 127,\n    \"url\": \"https://unlora.com/acme-plumbing-miami\",\n    \"language\": \"en\",\n    \"video_url\": \"https://...\",\n    \"video_status\": \"completed\",\n    \"vsl_url\": \"https://...\",\n    \"vsl_status\": \"completed\",\n    \"socials\": { \"instagram\": \"...\", \"facebook\": \"...\", \"linkedin\": \"...\", \"twitter\": \"...\" },\n    \"created_at\": \"2025-01-15T...\"\n  }],\n  \"total\": 50, \"limit\": 50, \"offset\": 0\n}\n\nGET /leads/{id}\n\nFull lead detail including existing website analysis.\n\nResponse: Same fields as list plus:\n\nslug — URL slug\nexisting_website: { url, pagespeed_score, load_time, mobile_optimized } or null\nGET /websites\n\nSimpler list of generated websites.\n\nQuery: ?limit=20&offset=0\n\nResponse: { websites: [{ id, url, slug, business_name, city, industry, phone, email, language, video_url, vsl_url, created_at }], total, limit, offset }\n\nGET /quota\n\nCheck plan, usage, credits, and purchase links.\n\nResponse:\n\n{\n  \"plan\": \"pro\",\n  \"plan_status\": \"active\",\n  \"websites\": { \"used\": 150, \"limit\": 5000, \"remaining\": 4850 },\n  \"videos\": { \"used\": 0, \"limit\": 200, \"remaining\": 200 },\n  \"voice_credits\": 45,\n  \"voice_enabled\": true,\n  \"video_enabled\": true,\n  \"resets_at\": \"2025-02-01T00:00:00.000Z\",\n  \"purchase_links\": {\n    \"voice_credits\": {\n      \"50_credits_$10\": \"https://whop.com/checkout/plan_xBEWrVWZ8MRvM/\",\n      \"200_credits_$35\": \"https://whop.com/checkout/plan_ucYBrssGb4E2G/\",\n      \"500_credits_$75\": \"https://whop.com/checkout/plan_zTX2bQyWLCqlx/\"\n    },\n    \"upgrade\": \"https://whop.com/unloopa/\"\n  }\n}\n\nGET /outreach/status\n\nCheck email configuration, daily capacity, DNS health.\n\nResponse:\n\n{\n  \"configured\": true,\n  \"accounts\": [{\n    \"id\": \"uuid\",\n    \"email\": \"outreach@company.com\",\n    \"display_name\": \"Company\",\n    \"daily_limit\": 25,\n    \"sent_today\": 10,\n    \"remaining_today\": 15,\n    \"warmup_enabled\": true,\n    \"warmup_day\": 14,\n    \"health\": { \"score\": 85, \"status\": \"good\", \"checked_at\": \"2025-01-15T...\" },\n    \"created_at\": \"2025-01-01T...\"\n  }],\n  \"summary\": {\n    \"total_accounts\": 1,\n    \"total_daily_capacity\": 25,\n    \"total_sent_today\": 10,\n    \"total_remaining_today\": 15,\n    \"pending_in_queue\": 5,\n    \"accounts_with_health_issues\": 0\n  },\n  \"setup_url\": \"https://dashboard.unloopa.com/settings?tab=email\"\n}\n\n\nNew SMTP accounts warm up over 4 weeks: 5/day -> 10/day -> 15/day -> 25/day.\n\nGET /outreach/templates\n\nList prebuilt and custom email templates.\n\nResponse: { templates: [{ id, name, subject, body, is_custom: false, is_default: true, language }], custom_templates: [{ id, name, subject, body, is_custom: true, is_default, language }] }\n\nTemplates support placeholders: {{business_name}}, {{city}}, {{industry}}, {{website_url}}, {{video_url}} (Pro only).\n\nPOST /outreach/templates\n\nCreate custom email template.\n\nBody:\n\n{\n  \"name\": \"Miami Pitch\",\n  \"subject\": \"{{business_name}} - New Website Ready\",\n  \"body\": \"Hi! I built a website for {{business_name}} in {{city}}...\",\n  \"language\": \"en\",\n  \"is_default\": true\n}\n\n\nRequired: name, subject, body.\n\nPATCH /outreach/templates/{id}\n\nUpdate a custom template. Only custom templates can be edited.\n\nBody: { name?, subject?, body?, language?, is_default? }\n\nDELETE /outreach/templates/{id}\n\nDelete a custom template.\n\nPOST /outreach/send\n\nSend emails to leads.\n\nBody:\n\n{\n  \"lead_ids\": [\"uuid1\", \"uuid2\"],\n  \"template_id\": \"uuid\",\n  \"custom_subject\": \"Optional override\",\n  \"custom_body\": \"Optional override\"\n}\n\nlead_ids (required, 1-100 UUIDs)\ntemplate_id (optional if custom_subject + custom_body provided)\n\nResponse: { emails_queued, emails_waiting_for_video, skipped_duplicates, failed, manual_outreach: [] }\n\nRequires SMTP configured (check /outreach/status first). Duplicate detection prevents re-sending.\n\nGET /phone-numbers\n\nList active phone numbers. Pro plan required.\n\nResponse: { numbers: [{ id, phone_number, area_code, locality, region, country, monthly_cost_cents, created_at }], count: 2, limit: 3 }\n\nMax 3 phone numbers. Check count vs limit before buying.\n\nPOST /phone-numbers/search\n\nSearch available numbers by area code. Pro plan required.\n\nBody: { \"area_code\": \"305\", \"country\": \"US\" }\n\narea_code (required, 3 digits)\ncountry (optional, default \"US\")\n\nResponse: { numbers: [{ phone_number: \"+13055551234\", friendly_name, locality, region }] }\n\nPOST /phone-numbers/buy\n\nPurchase a phone number. Pro plan required. $1/month per number.\n\nBody: { \"phone_number\": \"+13055551234\" } Must be E.164 format from search results.\n\nResponse: { number: { id, phone_number, area_code, monthly_cost_cents, created_at } }\n\nDELETE /phone-numbers/{id}\n\nRelease a phone number. Pro plan required.\n\nResponse: { success: true }\n\nGET /voice/agents\n\nList voice agents. Pro plan required.\n\nResponse: { agents: [{ id, name, voice_id, voice_name, elevenlabs_agent_id, has_script, has_first_message, created_at }], count: 1, limit: 3 }\n\nMax 3 agents.\n\nPOST /voice/agents\n\nCreate a voice agent. Pro plan required.\n\nBody:\n\n{\n  \"name\": \"Sales Agent\",\n  \"voice_id\": \"cjVigY5qzO86Huf0OWal\",\n  \"voice_name\": \"Eric\",\n  \"script\": \"You are a friendly sales rep calling {{business_name}} in {{city}}...\",\n  \"first_message\": \"Hi there, do you have just a moment?\",\n  \"agent_config\": { \"stability\": 0.3, \"similarityBoost\": 0.85 }\n}\n\n\nRequired: name, voice_id, script.\n\nScripts support dynamic variables: {{business_name}}, {{city}}, {{industry}}, {{website_url}} — auto-populated from lead data during calls.\n\nPATCH /voice/agents/{id}\n\nUpdate a voice agent. Syncs changes to ElevenLabs automatically.\n\nBody: { name?, voice_id?, voice_name?, script?, first_message?, agent_config? }\n\nDELETE /voice/agents/{id}\n\nDelete a voice agent. Also removes from ElevenLabs.\n\nPOST /voice/call\n\nMake a single outbound call. Costs 1 voice credit. Pro plan required.\n\nBody:\n\n{\n  \"agent_id\": \"uuid\",\n  \"phone_number\": \"+13055551234\",\n  \"dynamic_variables\": { \"business_name\": \"Acme\", \"city\": \"Miami\", \"industry\": \"Plumbing\", \"website_url\": \"https://...\" }\n}\n\n\nRequired: agent_id, phone_number.\n\nResponse: { call_id, conversation_id, status: \"initiated\", phone_number }\n\nGET /voice/calls\n\nList voice calls with filters. Pro plan required.\n\nQuery: ?limit=50&offset=0&campaign_id=uuid&status=completed&outcome=interested\n\nstatus: pending, queued, in_progress, completed, failed, cancelled\noutcome: interested, not_interested, voicemail, no_answer, callback\n\nResponse: { calls: [{ id, campaign_id, business_name, phone_number, status, outcome, outcome_notes, duration_secs, transcript, analysis, started_at, completed_at, created_at }], total, limit, offset }\n\nGET /voice/calls/{id}\n\nFull call detail with transcript and analysis.\n\nResponse: { call_id, business_name, phone_number, status, outcome, outcome_notes, duration_secs, transcript, analysis, started_at, completed_at, created_at }\n\nGET /voice/campaigns\n\nList voice campaigns with stats. Pro plan required.\n\nResponse:\n\n{\n  \"campaigns\": [{\n    \"id\": \"uuid\",\n    \"name\": \"Miami Plumbers\",\n    \"status\": \"active\",\n    \"stats\": { \"total\": 50, \"connected\": 30, \"interested\": 8, \"not_interested\": 15, \"no_answer\": 7, \"failed\": 0, \"avg_duration_secs\": 45 },\n    \"created_at\": \"...\", \"updated_at\": \"...\"\n  }]\n}\n\nPOST /voice/campaigns\n\nCreate a calling campaign. Starts as draft. Pro plan + voice credits required.\n\nBody:\n\n{\n  \"name\": \"Miami Plumbers Campaign\",\n  \"phone_number_id\": \"uuid\",\n  \"agent_id\": \"uuid\",\n  \"lead_filter\": { \"city\": \"Miami\", \"industry\": \"plumber\" },\n  \"timezone\": \"America/New_York\",\n  \"calling_window_start\": \"09:00\",\n  \"calling_window_end\": \"17:00\",\n  \"calling_days\": [\"mon\", \"tue\", \"wed\", \"thu\", \"fri\"],\n  \"calls_per_hour\": 10,\n  \"max_calls\": 50\n}\n\n\nRequired: name, phone_number_id, and either agent_id OR voice_id + script. Lead selection: provide lead_ids (array of UUIDs) or lead_filter (dynamic). Only leads with phone numbers are included.\n\nResponse: { campaign: { id, name, status: \"draft\", leads_count, callable_leads, created_at } }\n\nGET /voice/campaigns/{id}\n\nCampaign detail with full config and stats.\n\nResponse includes: id, name, status, script, script_version, first_message, voice_id, voice_name, timezone, calling_window, calling_days, calls_per_hour, max_calls, stats (with pending count), timestamps.\n\nPATCH /voice/campaigns/{id}\n\nControl campaign lifecycle or update fields.\n\nLifecycle actions (body: { \"action\": \"...\" }):\n\nactivate — draft/paused -> active\npause — active -> paused\ncancel — any -> completed (cancels pending calls)\ntrigger — active campaign: initiate up to 10 pending calls immediately. Each call costs 1 voice credit. Optional: { \"action\": \"trigger\", \"limit\": 5 }\n\nField updates (draft/paused only, body: { \"updates\": {...} }):\n\nscript, voice_id, voice_name, first_message, calling_window_start, calling_window_end, timezone, calling_days, calls_per_hour, agent_config\n\nTrigger response: { triggered: 5, calls: [{ id, business_name, conversation_id }] }\n\nImportant Notes\nJob processing takes ~8-10 minutes for a full pipeline run. Scraping is fast (~20 seconds), but website generation takes ~8 minutes for all websites. Do NOT assume the job is stuck — poll every 15-20 seconds and be patient during the website_generation step\nEmail warmup: new SMTP accounts start at 5/day, ramping to 25/day over 4 weeks\nVoice campaigns must be: created (draft) -> activated -> triggered\nThe trigger action initiates up to 10 calls at a time, costing 1 credit each\nDynamic variables ({{business_name}}, etc.) are auto-populated from lead data\nDuplicate email detection prevents re-sending to the same lead\nVideo features (with_video, with_vsl) are Pro plan only\nPhone numbers and voice agents have a hard limit of 3 each\nAlways check preconditions before taking action (quota, credits, SMTP, plan)"
  },
  "trust": {
    "sourceLabel": "tencent",
    "provenanceUrl": "https://clawhub.ai/echris6/unloopa-api",
    "publisherUrl": "https://clawhub.ai/echris6/unloopa-api",
    "owner": "echris6",
    "version": "1.3.0",
    "license": null,
    "verificationStatus": "Indexed source record"
  },
  "links": {
    "detailUrl": "https://openagent3.xyz/skills/unloopa-api",
    "downloadUrl": "https://openagent3.xyz/downloads/unloopa-api",
    "agentUrl": "https://openagent3.xyz/skills/unloopa-api/agent",
    "manifestUrl": "https://openagent3.xyz/skills/unloopa-api/agent.json",
    "briefUrl": "https://openagent3.xyz/skills/unloopa-api/agent.md"
  }
}