Base URL
https://worker.rushed.com.br
Authentication
Every request requires an API key via the X-API-Key header:
X-API-Key: rsh_live_xxxxxxxxxxxxxxxxxxxx
The only endpoint that does not require authentication is GET /health.
The include parameter
Article endpoints support an include query parameter to request enrichment modules beyond the base fields:
GET /api/articles?include=sentiment,entities,translations
| Module | Description | Min Plan |
|---|
sentiment | Sentiment score, label, confidence | Pro |
market_impact | Impact level, horizon, scope, confidence | Pro |
entities | Extracted entities with prominence and sentiment | Pro |
translations | Bilingual PT/EN titles, subtitles, summaries | Starter |
scoring | 5-dimension quality score (0–100) | Pro |
classification | Secondary sectors and topics | Starter |
meta | Source tier, paywall, word count, reading time | Starter |
Sorting
Article endpoints support a sort parameter:
| Value | Description |
|---|
publishedAt | Most recent first (default) |
baseScore | Highest quality score first |
urgencyLevel | Most urgent first (CRITICAL > HIGH > MEDIUM > LOW) |
relevance | Composite of score + recency. A high-score article from 1h ago beats a higher-score article from 2 days ago. Best for feeds that need both quality and freshness. |
{
"success": true,
"data": { ... },
"pagination": {
"limit": 20,
"offset": 0,
"total": 1847,
"hasMore": true
}
}
Plan tiers
| Feature | Starter | Pro | Business |
|---|
| Requests / month | 500K | 3M | Unlimited |
| Base article fields | Yes | Yes | Yes |
| Translations, classification, meta | Yes | Yes | Yes |
| Sentiment, market impact, entities, scoring | — | Yes | Yes |
| Priority support | — | — | Yes |
Rate limiting
Requests are rate-limited per API key. See Rate Limits for headers and backoff strategies.
Status codes
| Code | Meaning |
|---|
200 | Success |
400 | Invalid request parameters |
401 | Missing or invalid API key |
403 | Plan does not include requested module |
404 | Resource not found |
429 | Rate limit exceeded |
500 | Internal server error |
