API and automation

The viral.app API lets your team automate brand workflows outside the UI. Use it for programmatic access to tracked accounts, tracked videos, analytics, projects, Creator Hub, payout workflows, integrations, and live lookups when your plan includes API access. For the product-level view, start with the viral.app API overview.

This page gives a broad overview. Use the API reference for exact endpoints, request fields, response fields, and examples.

Create an API key

Use API Keys to create and manage API keys for your workspace.

When you create a key, give it a clear name, such as Weekly reporting workflow or Finance payout review. You can also set an expiration date.

viral.app shows the full API key only once after creation. Save it in your team's secure secrets manager before you leave the page. If you lose the key, create a new one and delete the old key.

The API key table also shows status, global rate limit, expiration, last-used time, creation date, and the teammate who added the key.

Authenticate requests

API requests use the x-api-key header. The API key identifies the workspace and controls access according to your plan.

API access is plan-gated. If your current plan does not include API access, the API Keys page shows that access is unavailable.

Use the API reference

Open the interactive API reference to explore available resources and test requests. Use the machine-readable OpenAPI spec when you need to generate clients, connect tools, or review schemas outside the browser.

The API reference is the source of truth for endpoint-specific details. Keep docs, automations, and internal tools aligned with the reference instead of copying endpoint details into team documents.

Automate UI workflows

Many workflows available in the UI can also be automated through the API where the API supports that resource area. Common automation areas include:

• Adding or reviewing tracked accounts and videos.
• Pulling analytics for reports.
• Managing projects.
• Reviewing Creator Hub data.
• Supporting payout review workflows.
• Running live lookups for fresh upstream data.

Start with tracked resources and analytics for regular reporting. Use live lookups for fresh one-off discovery or enrichment. Live lookups can use extra credits.

Use n8n

viral.app provides an n8n package for teams that build automations in n8n.

Use n8n when you want low-code workflows such as weekly performance reports, Slack alerts, spreadsheet updates, creator intake checks, or payout review notifications.

Create an API key in API Keys, then add it to your n8n credentials for the viral.app node.

Use agents

Open Agents to set up viral.app inside agent workflows such as Codex, Claude Code, Open Claw, or similar tools.

Agent workflows are useful when your team wants conversational access to analytics, tracking checks, live lookups, or Creator Hub operations. Start with read-only prompts until your team has reviewed the workflow and API key access.

The Agents page includes install commands, starter prompts, and links to the skill source.