Getting started with the PollyX API

Create an API key

1. 1Go to Settings, then API Keys, and choose Manage API keys.
2. 2Enter a Key name (for example "Production") and choose Generate key.
3. 3Copy the key now. It starts with px_live_ and is shown only once: we cannot show it again or recover it.

API keys are free, and you can create as many as you need. Revoke stops a key immediately. The list shows when each key was last used.

Authenticate

Send the key as a Bearer token on every request:

Authorization: Bearer px_live_your_api_key_here

What you can do

• POST /api/v1/reports creates a sentiment report. Only company_name is required; the other fields match the new report form (market, scopes, competitors, subject type, campaign hashtag, other names and exclusions). It answers at once with a report_id and a poll_url.
• GET /api/v1/reports/{id} returns the report's status and, once completed, its content.
• POST /api/v1/ai-visibility creates an AI Visibility check, optionally with your own questions (3 to 12). GET /api/v1/ai-visibility/{id} reads one, and GET /api/v1/ai-visibility lists your checks.

The full reference, with every field and example responses, is in the API documentation.

Credits and limits

• Each report or check created through the API uses 1 credit. Without credits the request is refused with a link to buy more.
• Up to 30 creations an hour per key, reports and checks combined (120 on the API plan). Reading and polling are not limited.
• Responses leave out the text of X, Instagram and TikTok posts; their links stay.

A report usually completes in about 15 minutes, and a check can take up to about an hour, so poll the poll_url every minute or so, or use completion webhooks.