Skip to content
Viralmaxing Logo
VIRALMAXING

Developer portal

Two ways to drive Viralmaxing programmatically: an MCP server for AI agents and a REST API for everything else. Both authenticate with the same key and are scoped to your workspace.

Quickstart

  1. Create an API key in Settings → API. Keys start with vmx_ and are shown once.
  2. Point your agent at the MCP endpoint below, or call REST directly with the X-API-Key header.
  3. Start with list_my_accounts and get_account_overview — both are free reads that confirm auth and show what the workspace tracks.

MCP server

Streamable HTTP transport. Claude, Cursor and any MCP-capable client can connect with OAuth 2.1 (dynamic client registration and PKCE) or with an API key.

Endpoint
POST https://api.viralmaxing.com/api/mcp
Authentication
OAuth 2.1 — discovery at /.well-known/oauth-protected-resource — or X-API-Key: vmx_…
Tools
30 tools, 6 of which spend energy: create_account_report, discover_competitors, export_posts, fetch, find_ideas, get_account_overview, get_account_report, get_automation_lead_thread, get_automation_stats, get_discovery_results, get_energy_balance, get_idea_results, get_operation, get_post_detail, get_scenario, get_transcript, list_automation_leads, list_automations, list_competitors, list_my_accounts, list_posts, list_scenarios, save_automation_lead, save_scenario, search, set_scenario_status, take_into_work, track_accounts, track_discovered_competitor, transcribe_post

REST API

The same data over plain HTTP. Every endpoint reachable with an API key is documented in the OpenAPI reference; business errors come back as 400 with details, expired credentials as 401.

Base URL
https://api.viralmaxing.com/api
Authentication
X-API-Key: vmx_… (or Authorization: Bearer vmx_…)

What costs energy

Reading what the account already holds is free: accounts, videos, existing transcripts, the content plan, reports, automations. Energy is spent producing something new.

Importing a tracked account
1 per video (×2 on Facebook)
Transcribing a video (plus its measured cost)
1+
Keyword idea search
30
Account breakdown
100
Competitor discovery
200

Every paid tool requires a confirm_cost argument holding the exact price: the agent has to state the cost and get the user's agreement before calling. A wrong number is refused, and the refusal carries the right one.

Sandbox

There is no separate sandbox environment. Read tools are non-destructive and free, so the safe way to explore is a real workspace: create one, add a couple of competitor accounts, and read them. Write operations (save_scenario, set_scenario_status) always target real data — test them on a scenario you created for that purpose.

Machine-readable files

  • /llms.txt — when to use Viralmaxing, how to call it, and a map of the docs.
  • /agents.md — the same instructions as a standalone agent file.
  • /llms-full.txt — the full documentation corpus in one file.
  • Any public page also answers Accept: text/markdown, and exposes the same content at <path>.md.

Links