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

# Introduction

> The fastest, simplest X (Twitter) API — one API key, no OAuth dance.

## Welcome to OmniX

OmniX is a developer API for X (Twitter). It lets you **read** profiles,
tweets, timelines, lists, articles and direct messages, and **write** on behalf
of a real X account — post tweets, like, retweet, bookmark, follow, update a
profile, publish articles and send DMs (including end‑to‑end encrypted chats) —
all through clean REST endpoints. You can also receive activity **in real time** via
**webhooks** — DMs, mentions, replies, likes and follows pushed to your server.

* **One key, no OAuth.** Authenticate every request with a single `Authorization: Bearer` API key.
* **Real account actions.** Every call runs as the X account you supply, so viewer‑relative fields (like `canDm`) are always accurate.
* **Flat, predictable pricing.** Every billed endpoint costs **\$0.001** per successful call. No tiers, no surprises.
* **Test it live.** Every endpoint in the **API Reference** has an interactive playground — fill in your keys and hit **Send**.

<CardGroup cols={2}>
  <Card title="Quickstart" icon="bolt" href="/quickstart">
    Make your first call in under a minute.
  </Card>

  <Card title="Authentication" icon="key" href="/authentication">
    How API keys and X account tokens work.
  </Card>

  <Card title="Tweet Search" icon="magnifying-glass" href="/api-reference/advanced-search">
    Advanced search with filters for dates, keywords and more.
  </Card>

  <Card title="User Networks" icon="users" href="/api-reference/get-followers">
    Access follower and following relationships.
  </Card>

  <Card title="Direct Messages" icon="comments" href="/direct-messages">
    Read, send and manage DMs — including encrypted XChat conversations.
  </Card>

  <Card title="Webhooks" icon="bolt" href="/webhooks">
    Get X activity pushed to your server in real time — DMs, mentions, follows.
  </Card>
</CardGroup>

## Base URL

All endpoints are served under a single base URL:

```
https://api.omnixapi.com/api/v1/twitter
```

<Info>
  Every endpoint in the **API Reference** has a live playground pointed at this base URL —
  add your API key and `auth_token` and hit **Send** to try it.
</Info>

## How a request works

Every request carries **two** credentials:

1. **Your API key** — identifies your account and is billed (`Authorization: Bearer <api_key>`).
2. **An X account token** — the `auth_token` cookie of the X account the action runs as.

Optionally, any X endpoint also accepts a **`proxy`** — the call is then routed
through it. See [Authentication](/authentication#routing-through-a-proxy-optional).

The action is always performed *as that X account*, never a shared bot. See
[Authentication](/authentication) for exactly where each value goes.

## API overview

| Category            | Endpoints | Examples                                                         |
| ------------------- | --------- | ---------------------------------------------------------------- |
| **Tweets**          | 13        | search, detail, thread, replies, create, like, retweet, bookmark |
| **Users**           | 24        | info, followers, following, timeline, follow, update profile     |
| **Lists**           | 1         | list members                                                     |
| **Media**           | 1         | upload image / GIF / video                                       |
| **Articles**        | 7         | get, create, update, list, publish, unpublish, delete            |
| **Direct Messages** | 7         | inbox, read, send, media, delete, react, edit                    |
| **Webhooks**        | 5         | create, list, validate, delete, replay                           |

That's **58 endpoints** today, and growing.