Skip to content

docs: add the X Calls API (preview, don't merge yet) - #479

Open
santiagomed wants to merge 3 commits into
mainfrom
smedina/x-calls-api
Open

santiagomed wants to merge 3 commits into
mainfrom
smedina/x-calls-api

Conversation

@santiagomed

Copy link
Copy Markdown
Collaborator

Adds a Calls API product for the X Calls developer API, which is in development. Don't merge yet: merging publishes these pages on docs.x.com before the API is available. This PR is here for the Mintlify preview.

Pages

  • Start here: introduction, quickstart, authentication.
  • Guides: media WebSocket, calling people, scheduled calls, example agent, errors and limits.
  • API reference for all 10 endpoints (/2/calls, /2/calls/:id, join, leave, and /2/calls/scheduled list, schedule, get, update, cancel, rsvp), rendered from xcalls/openapi.json.

xcalls/openapi.json is generated from the X API route registry's development version, so it matches what the platform serves. The guides follow the calls-api developer guide in the xai repo.

Checks

  • mint broken-links: no broken links.
  • Every new page compiles as MDX, and every reference page resolves to its operation in xcalls/openapi.json with Mintlify's own resolver; the spec passes Mintlify's OpenAPI validation.

A Calls API product: introduction, quickstart, authentication, the media
WebSocket, calling people, scheduled calls, an example agent, errors and
limits, and an API reference rendered from xcalls/openapi.json (generated
from the X API route registry's development version).
@mintlify

mintlify Bot commented Oct 5, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
x-corp 🟢 Ready View Preview Oct 6, 2026, 12:04 AM

X Calls launches without linked Google or Outlook calendars: the list
returns X Calls events only, and scheduled calls have no calendar field.
GET /2/calls/scheduled lists events on linked Outlook calendars that meet in
an X call (calendar: "outlook", no id) next to X Calls events (calendar: "x").

This branch was successfully deployed

1 active deployment
staging — b8b777f4 Deployed Oct 6, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant