Developers

ViralDeck API

The ViralDeck API gives approved tools and automations read-only access to creator analytics in one organization. It is designed for reporting, monitoring, and internal workflows—not public data discovery or account administration.

Security boundary

Every request requires an organization-scoped API key. A key can read only the organization that created it; it cannot write data, manage billing, create users, or access another workspace. Keys are shown once at creation and can be revoked immediately in Dashboard Settings. Treat a key like a password: store it in a server-side secret manager, never commit it, and never place it in browser code, a URL, or a public prompt.

Get started

1. Sign in to ViralDeck and open Dashboard Settings → API keys.
2. Create a named key for a specific integration and store it securely.
3. Read the OpenAPI schema and call only the operation needed.

curl https://viraldeck.io/api/v1/projects \
  -H "Authorization: Bearer vd_your_api_key"

Available read-only resources

The v1 API can list projects, tracked creators, videos, active viral signals, and gained engagement summaries. List responses support bounded pagination; filters are limited to the documented fields. Requests without a valid key receive a structured JSON error and reveal no workspace data.

For AI agents

Read llms.txt before integrating. Agents should use ViralDeck only when a user asks about their own tracked short-form content, and should ask the user to configure credentials in the integration's secret store rather than disclose them in conversation.

Need help with an integration? Visit Contact.