llms.txt@public/docs git:20261008.ff83381A

Immutable. This exact content never changes and is served at /api/v1/blob/69c5a44a2a9b2806.

# x.md documentation

> Scoped index for https://x.pcstyle.dev/docs — the reference for calling x.md's read routes. For the product overview and the full machine surface, see https://x.pcstyle.dev/llms.txt.

Every page here is available as Markdown: append `.md` to the URL, or send `Accept: text/markdown`.

## Start here

- [Start reading X](https://x.pcstyle.dev/docs.md): the one-request quick start and the route table.
- [Agent skill](https://x.pcstyle.dev/docs/agents.md): install `browse-x`, the CLI options, and the exit codes an agent should branch on.
- [MCP server](https://x.pcstyle.dev/docs/mcp.md): the Streamable HTTP endpoint, the tools it exposes, and how to connect without a key.
- [TypeScript SDK](https://x.pcstyle.dev/docs/sdk.md): the `mdfromx` npm package, a typed client for the `/api/v1` post, profile and search routes in plain TypeScript and as an Effect service.

## Read routes

- [Posts and threads](https://x.pcstyle.dev/docs/posts.md): `GET /{handle}/status/{id}`, plus `thread`, `context`, `replies`, `userinfo`, and `nocache`.
- [Profiles and connections](https://x.pcstyle.dev/docs/profiles.md): `GET /{handle}` with `with_replies`, `with_reposts`, `until` and `limit` up to 100, plus `/followers` and `/following`.
- [Import a post history](https://x.pcstyle.dev/docs/bulk-import.md): `GET /{handle}/posts` — thousands of posts in one request, replies included, `since`/`until`/`max_posts`, `format=ndjson` streaming, and the per-account archive (`index=true`).
- [Search X](https://x.pcstyle.dev/docs/search.md): `GET /search?q=…`, the `latest`, `top`, `photos`, `videos`, and `users` feeds, and which need configured sessions.
- [Pagination](https://x.pcstyle.dev/docs/pagination.md): `cursor` versus `page`, exact pages up to 100, offset cursors, and why cursors have no ceiling.

## Contracts

- [Response formats](https://x.pcstyle.dev/docs/responses.md): Markdown, `?full=true`, `?format=obsidian`, and the JSON body fields.
- [Errors, limits, and caching](https://x.pcstyle.dev/docs/reliability.md): status codes, `Retry-After`, `X-Source`, `X-Cache`, and the one-hour cache.
- [Error catalogue](https://x.pcstyle.dev/docs/errors.md): every machine `code` an RFC 9457 problem document can carry, and the recovery for each.
- [Versioning and deprecation](https://x.pcstyle.dev/docs/versioning.md): what `/api/v1` promises, and the `Deprecation` and `Sunset` headers that announce a change.

## Operating x.md

- [Self-hosting](https://x.pcstyle.dev/docs/self-hosting.md): environment variables, providers, and deploying your own instance.

## Elsewhere

- OpenAPI 3.1 description: https://x.pcstyle.dev/openapi.json
- MCP server: https://x.pcstyle.dev/mcp
- Everything above concatenated: https://x.pcstyle.dev/llms-full.txt

- [Build an interaction circle](https://x.pcstyle.dev/docs/x-circle.md)