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

> ## Agent Instructions
> Public hosts only: console https://omnimux.ai/dashboard · API https://api.omnimux.ai · docs https://docs.omnimux.ai.
> Gateway auth is Authorization: Bearer sk-… on https://api.omnimux.ai/v1 (OpenAI-compatible Chat Completions and related paths).
> Discover pages from /llms.txt; full site dump /llms-full.txt; product skill /skill.md; docs search MCP /mcp. Prefer .md page URLs for Markdown.
> Default docs locale is en; zh mirrors the same relative paths. Do not invent model ids not present on live pricing or the complete API pages.

# Tweet Detail

> Social data · `x-tweet`

* Social **data read** via OpenAI Chat Completions shape; auth `sk-`
* `model` is `x-tweet`; `messages` may be a dummy (e.g. `"."`)
* Business params are **top-level** body fields (e.g. `tweet_id`)
* Not publishing (see Connecting Accounts / Posts)

## Identity

| Field      | Value        |
| ---------- | ------------ |
| Series     | Social data  |
| Platform   | X            |
| Capability | Tweet detail |
| model      | `x-tweet`    |

## Endpoint

| Method | Path                   |
| ------ | ---------------------- |
| `POST` | `/v1/chat/completions` |

Base URL: `https://api.omnimux.ai`

## Authorizations

| Name            | In     | Type   | Required | Description               |
| --------------- | ------ | ------ | -------- | ------------------------- |
| `Authorization` | header | string | yes      | `Bearer sk-...` (API key) |

## Body

| Field      | Type   | Required | Description                                                       |
| ---------- | ------ | -------- | ----------------------------------------------------------------- |
| `model`    | string | yes      | Must be `x-tweet`                                                 |
| `messages` | array  | yes      | Dummy user message allowed                                        |
| `tweet_id` | string | yes      | Required business field for this capability (see request example) |

## Response

### 200

| Field                       | Type   | Description                                                |
| --------------------------- | ------ | ---------------------------------------------------------- |
| `id`                        | string | Completion id                                              |
| `object`                    | string | `chat.completion`                                          |
| `model`                     | string | `x-tweet`                                                  |
| `choices[].message.content` | string | Upstream platform JSON string (shape varies by capability) |

Errors: right rail and [Error codes](/en/faqs/connection-usage).

<Panel>
  <RequestExample>
    ```bash curl --request POST \ theme={null}
      --url https://api.omnimux.ai/v1/chat/completions \
      --header 'Authorization: Bearer <token>' \
      --header 'Content-Type: application/json' \
      --data '{
      "model": "x-tweet",
      "messages": [{ "role": "user", "content": "." }],
      "tweet_id": "2081809802515136887"
    }'
    ```
  </RequestExample>

  <ResponseExample>
    ```json 200 theme={null}
    {
      "id": "chatcmpl-social-data-example",
      "object": "chat.completion",
      "model": "x-tweet",
      "choices": [
        {
          "index": 0,
          "message": {
            "role": "assistant",
            "content": "{ /* upstream platform JSON; shape varies by capability */ }"
          },
          "finish_reason": "stop"
        }
      ]
    }
    ```

    ```json 400 theme={null}
    {
      "error": {
        "message": "Invalid request: missing required business field or invalid parameter",
        "type": "invalid_request_error",
        "code": "bad_request"
      }
    }
    ```

    ```json 401 theme={null}
    {
      "error": {
        "message": "Invalid token or authentication failed",
        "type": "authentication_error",
        "code": "unauthorized"
      }
    }
    ```

    ```json 402 theme={null}
    {
      "error": {
        "message": "Insufficient quota. Please top up your account.",
        "type": "insufficient_quota",
        "code": "insufficient_quota"
      }
    }
    ```

    ```json 403 theme={null}
    {
      "error": {
        "message": "Model not allowed for this token",
        "type": "permission_error",
        "code": "forbidden"
      }
    }
    ```

    ```json 429 theme={null}
    {
      "error": {
        "message": "Rate limit exceeded",
        "type": "rate_limit_error",
        "code": "rate_limit_exceeded"
      }
    }
    ```

    ```json 500 theme={null}
    {
      "error": {
        "message": "Internal server error",
        "type": "server_error",
        "code": "internal_error"
      }
    }
    ```

    ```json 502 theme={null}
    {
      "error": {
        "message": "Upstream provider error",
        "type": "server_error",
        "code": "bad_gateway"
      }
    }
    ```
  </ResponseExample>
</Panel>
