Polly

PollyX Assistant · Online

Hi! I'm Polly 👋 I can answer any questions about PollyX — how reports work, what's included, pricing, or anything else. What would you like to know?

PollyX API

The PollyX API lets you generate sentiment reports programmatically and integrate brand intelligence directly into your applications, dashboards, or workflows.

Authentication

All API requests must include an API key in the Authorization header as a Bearer token.

http

Authorization: Bearer px_live_your_api_key_here

You can create and manage API keys in your account settings. API keys start with px_live_.

Credits

Each API call to create a report uses 1 credit from your account. Purchase credits from your pricing page.

Rate limits

1 request per 30 seconds per API key. Exceeding this returns a 429 Too Many Requests response.

POST/api/v1/reports

Creates a new sentiment report. Report generation is asynchronous — you will receive a poll_url to check progress and retrieve results when done.

Request body

Field	Type	Required	Description
company_name	string	Yes	Name of the company or brand to analyse.
industry	string	No	Industry sector (e.g. "SaaS", "Retail").
location	string	No	Geographic market (e.g. "United States").
website	string	No	Brand website URL to help target the analysis.
what_to_know	string	No	Custom focus area or question for the report.
competitors	string[]	No	Up to 5 competitor names for direct comparison.
language	"en" \| "es"	No	Report language. Defaults to "en".

Response 202 Accepted

json

{
  "report_id": "rpt_abc123xyz",
  "status": "generating",
  "poll_url": "/api/v1/reports/rpt_abc123xyz"
}

GET/api/v1/reports/:id

Poll the status of a report. Returns status: "generating" while the report is still being processed, and the full report content once status: "completed".

Response 200 OK

json

{
  "report_id": "rpt_abc123xyz",
  "status": "completed",
  "sentiment_score": 7.4,
  "content": {
    "executive_summary": "Acme Corp enjoys strong positive sentiment...",
    "sentiment_score": 7.4,
    "platform_breakdown": [...],
    "positive_themes": [...],
    "negative_themes": [...],
    "competitor_comparison": [...],
    "trending_topics": [...],
    "crisis_alerts": [],
    "recommendations": [...],
    "improvement_plan": [...]
  },
  "created_at": "2026-05-22T08:00:00.000Z",
  "updated_at": "2026-05-22T08:02:15.000Z"
}

Full curl example

Step 1 — create the report:

bash

curl -X POST https://pollyx.org/api/v1/reports \
  -H "Authorization: Bearer px_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "company_name": "Acme Corp",
    "industry": "SaaS",
    "location": "United States",
    "website": "https://acmecorp.com",
    "what_to_know": "Focus on customer support sentiment",
    "competitors": ["Rival Corp", "Other Inc"],
    "language": "en"
  }'

Step 2 — poll until complete (typically 1–3 minutes):

bash

curl https://pollyx.org/api/v1/reports/rpt_abc123xyz \
  -H "Authorization: Bearer px_live_your_key_here"

Ready to integrate?

Create an API key in your settings and start generating reports in minutes.

Get your API key →