Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion forms/livestream-api-access.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,5 @@ Have the following information ready before you start:
- Approximate monthly active users or customers

<Note>
Livestream API access is subject to review and may require an Enterprise or custom commercial agreement. By submitting the form you agree to comply with the [X Developer Agreement and Policy](/developer-terms) and applicable API terms. If you already have an Enterprise agreement, ask your X account team to enable the Livestream API for your app.
Livestream API access is limited to whitelisted apps and is subject to review. By submitting the form you agree to comply with the [X Developer Agreement and Policy](/developer-terms) and applicable API terms.
</Note>
4 changes: 2 additions & 2 deletions livestream-api/authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Use **OAuth 2.0 Authorization Code Flow with PKCE** to obtain a user-context acc

### Requirements

- Your application must be enabled for the Livestream API under an Enterprise plan. To request access, submit the [Livestream API Access Form](/forms/livestream-api-access).
- Your application must be whitelisted for the Livestream API. To request access, submit the [Livestream API Access Form](/forms/livestream-api-access).
- Request the `broadcast.read` and `broadcast.write` scopes at minimum — these cover most operations. Add `offline.access` if you need a refresh token.
- The authorizing user's numeric ID must exactly match the `:user_id` in the path. Mismatches are rejected with `400 Bad Request`.

Expand Down Expand Up @@ -58,7 +58,7 @@ OAuth 1.0a 3-legged user context is still accepted for existing integrations.

- Use OAuth 1.0a with **HMAC-SHA1** signatures (3-legged user context).
- Include a properly constructed `Authorization: OAuth ...` header on every request.
- Your application must be enabled for the Livestream API under an Enterprise plan.
- Your application must be whitelisted for the Livestream API.
- The application must have **Read + Write** (or ReadWriteDm) access level.
- The numeric user ID from the OAuth 1.0a access token must exactly match the `:user_id` in the path. Mismatches are rejected with `400 Bad Request`.

Expand Down
10 changes: 5 additions & 5 deletions livestream-api/getting-started.mdx
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
---
title: Getting Started
sidebarTitle: Getting Started
description: "Prerequisites for the X Livestream API: Enterprise access, OAuth credentials (OAuth 2.0 recommended, OAuth 1.0a also supported), user permissions, and an RTMP encoder."
keywords: ["Livestream API access", "Enterprise", "OAuth 2.0", "OAuth 1.0a", "prerequisites", "RTMP encoder", "getting started"]
description: "Prerequisites for the X Livestream API: whitelisted app access, OAuth credentials (OAuth 2.0 recommended, OAuth 1.0a also supported), user permissions, and an RTMP encoder."
keywords: ["Livestream API access", "whitelist", "OAuth 2.0", "OAuth 1.0a", "prerequisites", "RTMP encoder", "getting started"]
---

The Livestream API is available exclusively under the Enterprise plan. To use it, you need the following:
Access to the Livestream API is limited to whitelisted apps. To use it, you need the following:

<Steps>
<Step title="Enterprise access">
Your X application (OAuth client) must be enabled for the Livestream API, which is only available to Enterprise customers. To request access, submit the [Livestream API Access Form](/forms/livestream-api-access). If you already have an Enterprise agreement, ask your X account team to enable the Livestream API for your app.
<Step title="Livestream API access">
Your X application (OAuth client) must be whitelisted for the Livestream API. To request access, submit the [Livestream API Access Form](/forms/livestream-api-access).
</Step>
<Step title="OAuth credentials">
All Livestream endpoints support both OAuth 2.0 and OAuth 1.0a. OAuth 2.0 is the recommended method: request the `broadcast.read` and `broadcast.write` scopes at minimum, which cover most operations. OAuth 1.0a is still accepted for existing integrations. Store your credentials securely.
Expand Down
2 changes: 1 addition & 1 deletion livestream-api/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Endpoints are hosted under `https://api.x.com`.

<CardGroup cols={3}>
<Card title="Get started" icon="rocket" href="/livestream-api/getting-started">
Prerequisites, Enterprise access, and credentials.
Prerequisites, access, and credentials.
</Card>
<Card title="Typical workflow" icon="list-check" href="/livestream-api/typical-workflow">
From stream source to live broadcast, step by step.
Expand Down
2 changes: 1 addition & 1 deletion livestream-api/scheduled-broadcasts/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The API supports one-time and recurring schedules. A scheduled broadcast is asso

### Access

The Livestream API, including the scheduling endpoints, is only available under the Enterprise plan. To request access, submit the [Livestream API Access Form](/forms/livestream-api-access). See [Getting Started](/livestream-api/getting-started) for the full list of prerequisites.
The Livestream API, including the scheduling endpoints, is only available to whitelisted apps. To request access, submit the [Livestream API Access Form](/forms/livestream-api-access). See [Getting Started](/livestream-api/getting-started) for the full list of prerequisites.

### Authentication

Expand Down