> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rushed.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# API Reference

> Complete reference for the Rushed News Intelligence API — 11 endpoints, API key authentication, and tiered enrichment modules.

## 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
```

Get your key from the [Rushed Dashboard](https://dash.therushed.com.br/api-keys). See [Authentication](/guides/authentication) for details on scopes and key management.

<Note>
  The only endpoint that does not require authentication is `GET /health`.
</Note>

## 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  |

See [Include Fields](/guides/include-fields) for the complete guide.

## 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. |

## Response format

All responses follow this pattern:

<CodeGroup>
  ```json Success theme={null}
  {
    "success": true,
    "data": { ... },
    "pagination": {
      "limit": 20,
      "offset": 0,
      "total": 1847,
      "hasMore": true
    }
  }
  ```

  ```json Error theme={null}
  {
    "success": false,
    "error": "Error message",
    "statusCode": 400
  }
  ```
</CodeGroup>

## 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](/guides/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                  |