Skip to content
Open
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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
3 changes: 2 additions & 1 deletion enterprise-api/account-activity/create-replay-job.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
openapi: post /2/account_activity/replay/webhooks/{webhook_id}/subscriptions/all

description: Create a replay job for an enterprise Account Activity API webhook to retrieve missed events from up to the last five days for a user subscription.
title: Create Replay Job
---
2 changes: 1 addition & 1 deletion enterprise-api/account-activity/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: V2 Account Activity API
sidebarTitle: Introduction
description: Receive real-time account activity events via webhooks
description: The Account Activity API (AAA) provides a way to receive real-time events related to X user accounts via webhooks. By subscribing. Enterprise X API v2 tier.
keywords: ["account activity", "webhooks", "real-time events", "account activity API", "webhook events", "AAA", "account activity v2"]
---

Expand Down
2 changes: 1 addition & 1 deletion enterprise-api/account-activity/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Quickstart
sidebarTitle: Quickstart
description: Set up Account Activity API subscriptions and start receiving real-time events
description: This guide walks you through setting up the Account Activity API, managing user subscriptions, validating your webhook. Enterprise X API v2 tier.
keywords: ["account activity quickstart", "AAA setup", "webhook subscriptions", "account activity setup", "manage subscriptions", "replay"]
---

Expand Down
1 change: 1 addition & 0 deletions enterprise-api/activity/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Quickstart
sidebarTitle: Quickstart
keywords: ["activity API quickstart", "X Activity API quickstart", "activity quickstart", "activity tutorial", "activity guide"]
description: This guide explains how to subscribe for and receive events using the X Activity API endpoints. There generally 3 steps involved. Enterprise X API v2 tier.
---

import { Button } from '/snippets/button.mdx';
Expand Down
2 changes: 1 addition & 1 deletion enterprise-api/communities/lookup/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Communities Lookup
sidebarTitle: Introduction
description: Retrieve Community details by ID
description: The Communities lookup endpoint lets you retrieve information about X Communities by their ID. Communities are public or private. Enterprise X API v2 tier.
keywords: ["communities lookup", "get communities", "community by ID", "community details", "communities API"]
---

Expand Down
2 changes: 1 addition & 1 deletion enterprise-api/communities/search/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Communities Search
sidebarTitle: Introduction
description: Search for Communities by keyword
description: The Communities Search endpoint lets you search for Communities by keyword. Discover Communities around topics of interest. Enterprise X API v2 tier.
keywords: ["communities search", "search communities", "find communities", "communities API"]
---

Expand Down
3 changes: 2 additions & 1 deletion enterprise-api/community-notes/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
keywords: ["Community Notes", "community notes API", "AI Note Writer", "fact checking", "notes API", "community notes search", "notes evaluation"]

description: The Community Notes Endpoints in the X API v2 allow developers to search for and propose Community Notes on X programmatically. Use of the API requires ...
description: The Community Notes Endpoints in the X API v2 allow developers to search for and propose Community Notes on X programmatically. Enterprise X API v2 tier.
title: Community Notes
---

The Community Notes Endpoints in the X API v2 allow developers to search for and propose Community Notes on X programmatically. Use of the API requires your account being signed up for X Developer AI access and enrolled in Community Notes as an AI Note Writer. You can [enroll and learn more about AI Note Writers](https://communitynotes.x.com/guide/en/api/overview) in the Community Notes Guide.
Expand Down
2 changes: 1 addition & 1 deletion enterprise-api/community-notes/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Quickstart
sidebarTitle: Quickstart
description: Create and search Community Notes via the API
description: "This guide walks you through using the Community Notes API to search for eligible Posts and submit notes. Before you begin, you'll. Enterprise X API v2 tier."
keywords: ["community notes quickstart", "community notes tutorial", "create notes guide"]
---

Expand Down
3 changes: 1 addition & 2 deletions enterprise-api/compliance/batch-compliance/integrate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
title: Integration guide
sidebarTitle: Integration guide
keywords: ["batch compliance integration", "compliance batch integration", "compliance jobs integration", "batch compliance setup"]


description: When using the Batch compliance endpoints, developers can batch upload large amounts of X data and understand what action is needed. Enterprise X API v2 tier.
---
import { Button } from '/snippets/button.mdx';

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Batch Compliance
sidebarTitle: Introduction
description: Check compliance status for Posts and users in bulk
description: The Batch Compliance endpoints let you upload datasets of Post IDs or user IDs and receive their current compliance status. Use. Enterprise X API v2 tier.
keywords: ["batch compliance", "compliance API", "GDPR", "data compliance", "bulk compliance"]
---

Expand Down
2 changes: 1 addition & 1 deletion enterprise-api/compliance/batch-compliance/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Quickstart
sidebarTitle: Quickstart
description: Create and run a batch compliance job
description: This guide walks you through creating a batch compliance job to check the compliance status of Posts or users. Before you begin. Enterprise X API v2 tier.
keywords: ["compliance quickstart", "batch compliance tutorial", "compliance job guide"]
---

Expand Down
1 change: 1 addition & 0 deletions enterprise-api/compliance/streams/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Introduction
sidebarTitle: Introduction
keywords: ["compliance streams", "compliance events", "compliance API", "compliance stream", "data compliance", "compliance monitoring"]
description: X is committed to our community of developers who build with the X API. As part of this commitment, we aim to make our API open and. Enterprise X API v2 tier.
---

import { Button } from '/snippets/button.mdx';
Expand Down
2 changes: 1 addition & 1 deletion enterprise-api/connections/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Stream Connections
sidebarTitle: Introduction
description: View and manage your streaming connections for X API v2
description: "The Stream Connections endpoints let you retrieve the history of your application's streaming connections and terminate active or. Enterprise X API v2 tier."
keywords: ["stream connections", "connection history", "terminate connections", "manage streaming", "disconnect streams", "streaming API connections"]
---

Expand Down
2 changes: 1 addition & 1 deletion enterprise-api/direct-messages/blocks/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Introduction
sidebarTitle: Introduction
keywords: ["DM blocks", "direct message blocks", "block DMs", "DM blocking", "direct message blocking", "block messages"]

description: The manage DM blocks endpoints enable you to block or unblock a specified account on behalf of an authenticated user. For these endpoints, there are two...
description: The manage DM blocks endpoints enable you to block or unblock a specified account on behalf of an authenticated user. For these. Enterprise X API v2 tier.
---

The manage DM blocks endpoints enable you to block or unblock a specified account on behalf of an authenticated user. For these endpoints, there are two POST methods available:
Expand Down
1 change: 1 addition & 0 deletions enterprise-api/direct-messages/lookup/integrate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Integration Guide
sidebarTitle: Integration Guide
keywords: ["direct messages integration", "DM integration", "DM lookup integration"]
description: This guide covers the key concepts you need to integrate the Direct Messages lookup endpoints into your application. DM endpoints. Enterprise X API v2 tier.
---

import { Button } from '/snippets/button.mdx';
Expand Down
2 changes: 1 addition & 1 deletion enterprise-api/direct-messages/lookup/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Direct Messages Lookup
sidebarTitle: Introduction
description: Retrieve Direct Message events and conversations
description: The Direct Messages lookup endpoints let you retrieve DM events for the authenticated user, including messages from both one-to-one. Enterprise X API v2 tier.
keywords: ["direct messages lookup", "DM lookup", "get DMs", "direct message lookup", "DM API", "messages lookup"]
---

Expand Down
2 changes: 1 addition & 1 deletion enterprise-api/direct-messages/lookup/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Quickstart
sidebarTitle: Quickstart
description: Retrieve Direct Message events and conversations
description: This guide walks you through retrieving Direct Message events for the authenticated user. Before you begin. Enterprise X API v2 tier.
keywords: ["DM lookup quickstart", "direct messages quickstart", "get DMs tutorial", "DM lookup guide"]
---

Expand Down
1 change: 1 addition & 0 deletions enterprise-api/direct-messages/manage/integrate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Integration Guide
sidebarTitle: Integration Guide
keywords: ["manage direct messages integration", "DM management integration", "send DM integration"]
description: This guide covers the key concepts you need to integrate the manage Direct Messages endpoints into your application. DM endpoints. Enterprise X API v2 tier.
---

import { Button } from '/snippets/button.mdx';
Expand Down
2 changes: 1 addition & 1 deletion enterprise-api/direct-messages/manage/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Manage Direct Messages
sidebarTitle: Introduction
description: Send and delete Direct Messages
description: The Manage Direct Messages endpoints let you send and delete Direct Messages on behalf of authenticated users. Enterprise X API v2 tier.
keywords: ["manage DMs", "send DM", "delete DM", "direct message API", "create DM"]
---

Expand Down
2 changes: 1 addition & 1 deletion enterprise-api/direct-messages/manage/migrate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Migration guide
sidebarTitle: Migration guide
keywords: ["manage direct messages migration", "DM management migration", "v1.1 to v2 manage DMs", "DM migration guide", "migrate DM management"]

description: 1 and v2 versions of the Direct Messages endpoints provide methods for creating Direct Message messages.
description: Both v1.1 and v2 versions of the Direct Messages endpoints provide methods for creating Direct Message messages. This guide is. Enterprise X API v2 tier.
---

import { Button } from '/snippets/button.mdx';
Expand Down
2 changes: 1 addition & 1 deletion enterprise-api/direct-messages/manage/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Quickstart
sidebarTitle: Quickstart
description: Send Direct Messages and create group conversations
description: This guide walks you through sending Direct Messages and creating group conversations. Before you begin. Enterprise X API v2 tier.
keywords: ["manage direct messages quickstart", "send DM quickstart", "DM management quickstart", "create group DM"]
---

Expand Down
2 changes: 1 addition & 1 deletion enterprise-api/getting-started/about-x-api.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: About the Enterprise API
sidebarTitle: About Enterprise API
description: Overview of Enterprise API capabilities, exclusive endpoints, and dedicated support
description: The Enterprise API provides the highest tier of access to X data. It includes everything available in the standard X API plus exclusive high-volume.
keywords: ["Enterprise API", "API overview", "enterprise features", "firehose", "volume streams", "dedicated support", "high-volume"]
---

Expand Down
2 changes: 1 addition & 1 deletion enterprise-api/getting-started/getting-access.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Getting Enterprise Access
sidebarTitle: Getting Access
description: Apply for Enterprise API access and get onboarded
description: Enterprise access requires an application and onboarding process. Your dedicated account team will help you get set up with credentials and configure.
keywords: ["Enterprise access", "enterprise API", "apply", "enterprise onboarding", "API keys", "access tokens", "dedicated support"]
---

Expand Down
2 changes: 1 addition & 1 deletion enterprise-api/getting-started/pricing.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Enterprise Pricing
sidebarTitle: Pricing
description: Custom Enterprise pricing for the X API
description: "Enterprise plans are custom-tailored to your organization's needs. Work with a dedicated account team to build a package that matches your data volume."
keywords: ["Enterprise pricing", "API pricing", "enterprise access", "custom pricing", "enterprise plan", "high-volume pricing"]
---

Expand Down
1 change: 1 addition & 0 deletions enterprise-api/lists/list-lookup/integrate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Integration Guide
sidebarTitle: Integration Guide
keywords: ["list lookup integration", "lists integration guide", "list lookup implementation"]
description: This guide covers the key concepts you need to integrate the List lookup endpoints into your application. List lookup endpoints. Enterprise X API v2 tier.
---

import { Button } from '/snippets/button.mdx';
Expand Down
2 changes: 1 addition & 1 deletion enterprise-api/lists/list-lookup/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: List Lookup
sidebarTitle: Introduction
description: Retrieve List details by ID or get Lists owned by a user
description: The List lookup endpoints let you retrieve information about Lists. Look up a specific List by ID or get all Lists owned by a user. Enterprise X API v2 tier.
keywords: ["list lookup", "get lists", "list by ID", "list information", "list details", "lookup lists", "list API"]
---

Expand Down
1 change: 1 addition & 0 deletions enterprise-api/lists/list-lookup/migrate/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Overview
sidebarTitle: Overview
keywords: ["list lookup migration", "lists lookup migration", "v1.1 to v2 list lookup", "list lookup migration guide", "migrate list lookup"]
description: The v2 List lookup endpoint group will replace the standard v1.1 GET lists/show and GET lists/ownership endpoints. Reference for the enterprise X API.
---


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: v1 to v2
sidebarTitle: v1 to v2
keywords: ["v1.1 to v2 migration", "list lookup migration", "migrate list lookup", "standard to v2 list lookup", "v1 to v2 list lookup", "migration guide"]
description: If you have been working with the standard v1.1 GET lists/show and GET lists/ownerships endpoints, the goal of this guide is to help you understand.
---


Expand Down
2 changes: 1 addition & 1 deletion enterprise-api/lists/list-lookup/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Quickstart
sidebarTitle: Quickstart
description: Look up Lists by ID or owner
description: This guide walks you through looking up List information using the List lookup endpoints. Before you begin. Enterprise X API v2 tier.
keywords: ["list lookup quickstart", "get list tutorial", "list lookup guide"]
---

Expand Down
1 change: 1 addition & 0 deletions enterprise-api/lists/list-members/integrate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Integration guide
sidebarTitle: Integration guide
keywords: ["list members integration", "list members guide", "list members setup", "list membership integration", "list members integration guide"]
description: This page covers tools and key concepts for integrating the List members endpoints. Before we dive into some key concepts that will. Enterprise X API v2 tier.
---

import { Button } from '/snippets/button.mdx';
Expand Down
2 changes: 1 addition & 1 deletion enterprise-api/lists/list-members/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: List Members
sidebarTitle: Introduction
description: View, add, and remove members from Lists
description: The List Members endpoints let you view List members, add members to your Lists, and remove them. You can also see which Lists a. Enterprise X API v2 tier.
keywords: ["list members", "add member", "remove member", "list membership", "list member API"]
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: List members lookup
sidebarTitle: List members lookup
keywords: ["list members lookup migration", "v1.1 to v2 list members lookup", "migrate list members lookup", "standard to v2 list members", "list members migration"]
description: If you have been working with the standard v1.1 GET lists/members and GET lists/memberships endpoints, the goal of this guide is to. Enterprise X API v2 tier.
---


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Manage list members
sidebarTitle: Manage list members
keywords: ["manage list members migration", "v1.1 to v2 manage list members", "migrate manage list members", "standard to v2 list members", "list members migration"]
description: If you have been working with the standard v1.1 POST lists/members/create and POST lists/members/destroy endpoints, the goal of this guide is to help you.
---


Expand Down
1 change: 1 addition & 0 deletions enterprise-api/lists/list-members/migrate/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Overview
sidebarTitle: Overview
keywords: ["list members migration", "list members migrate", "v1.1 to v2 list members", "list members migration guide", "migrate list members"]
description: The v2 List members endpoint group will replace the standard v1.1 GET lists/members, GET lists/memberships, POST lists/members/create and POST.
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: List Members Lookup
sidebarTitle: List Members Lookup
description: Get members of a List
description: "This guide walks you through retrieving members of a List. Before you begin, you'll need: - A developer account with an approved. Enterprise X API v2 tier."
keywords: ["list members lookup quickstart", "list members lookup", "get list members quickstart", "list membership lookup"]
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Manage List Members
sidebarTitle: Manage List Members
description: Add and remove members from a List
description: "This guide walks you through adding and removing members from a List. Before you begin, you'll need: - A developer account with an. Enterprise X API v2 tier."
keywords: ["manage list members quickstart", "add list members quickstart", "remove list members quickstart", "list members management"]
---

Expand Down
2 changes: 1 addition & 1 deletion enterprise-api/lists/list-members/quickstart/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: List Members Overview
sidebarTitle: Overview
description: Get started with List members endpoints
description: The List members endpoints let you look up members of a List and manage List membership. Before you begin. Enterprise X API v2 tier.
keywords: ["list members quickstart", "list members overview", "list members tutorial", "list membership quickstart"]
---

Expand Down
3 changes: 1 addition & 2 deletions enterprise-api/lists/list-tweets/integrate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
title: Integration guide
sidebarTitle: Integration guide
keywords: ["list tweets integration", "list timeline integration", "list tweets guide", "list timeline setup"]


description: This page covers tools and key concepts for integrating the List Posts lookup endpoint. Before we dive into some key concepts that. Enterprise X API v2 tier.
---

import { Button } from '/snippets/button.mdx';
Expand Down
2 changes: 1 addition & 1 deletion enterprise-api/lists/list-tweets/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: List Posts
sidebarTitle: Introduction
description: Retrieve Posts from a List's timeline
description: "The List Posts endpoint lets you retrieve Posts from a List's timeline. Get the latest Posts from all members of a List. Get Posts. Enterprise X API v2 tier."
keywords: ["list tweets", "list posts", "list timeline", "list feed", "list posts API"]
---

Expand Down
1 change: 1 addition & 0 deletions enterprise-api/lists/list-tweets/migrate/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Overview
sidebarTitle: Overview
keywords: ["list tweets migration", "list timeline migration", "v1.1 to v2 list tweets", "list tweets migration guide", "migrate list tweets"]
description: The v2 List Posts lookup endpoint will replace the standard v1.1 GET lists/statuses. If you have code, apps. Reference for the enterprise X API.
---


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: v1 to v2
sidebarTitle: v1 to v2
keywords: ["v1.1 to v2 migration", "list tweets migration", "migrate list tweets", "standard to v2 list tweets", "v1 to v2 list tweets", "migration guide"]
description: If you have been working with the standard v1.1 GET lists/statuses endpoint, the goal of this guide is to help you understand the. Enterprise X API v2 tier.
---


Expand Down
2 changes: 1 addition & 1 deletion enterprise-api/lists/list-tweets/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Quickstart
sidebarTitle: Quickstart
description: Get Posts from a List timeline
description: "This guide walks you through retrieving Posts from a List timeline. Before you begin, you'll need: - A developer account with an. Enterprise X API v2 tier."
keywords: ["list tweets quickstart", "list timeline quickstart", "get list posts tutorial"]
---

Expand Down
3 changes: 1 addition & 2 deletions enterprise-api/lists/manage-lists/integrate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
title: Integration guide
sidebarTitle: Integration guide
keywords: ["manage lists integration", "list management integration", "lists integration guide", "list management setup"]


description: This page covers tools and key concepts for integrating the Lists endpoints. Before we dive into some key concepts that will help. Enterprise X API v2 tier.
---

import { Button } from '/snippets/button.mdx';
Expand Down
2 changes: 1 addition & 1 deletion enterprise-api/lists/manage-lists/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Manage Lists
sidebarTitle: Introduction
description: Create, update, and delete Lists
description: The Manage Lists endpoints let you create, update, and delete Lists on behalf of authenticated users. Create a new List Update List. Enterprise X API v2 tier.
keywords: ["manage lists", "create list", "delete list", "update list", "list API"]
---

Expand Down
1 change: 1 addition & 0 deletions enterprise-api/lists/manage-lists/migrate/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Overview
sidebarTitle: Overview
keywords: ["lists migration", "manage lists migration", "v1.1 to v2 lists", "lists migration guide", "migrate lists"]
description: The v2 manage Lists endpoints will eventually replace POST lists/create, POST lists/destroy, and POST lists/update. Reference for the enterprise X API.
---


Expand Down
Loading