API v1

OpenAPI and Markdown

Download the API definition, a page index for AI assistants and the Markdown of every page.

View Markdown
On this page

The documentation also comes in machine-readable forms, for generating client code or handing to an AI assistant.

API definition

api-openapi.json is the API definition in OpenAPI 3.1. It holds only the customer endpoints and the callback events and can be imported into API tools or code generators.

llms.txt

api-llms.txt lists the Markdown address and a one-line summary of every English page, as an entry point for AI assistants.

Markdown

  • Every page has Copy Markdown and View Markdown at the top, with the same content as the page.
  • The whole Chinese documentation in one file: api-docs.md.
  • The whole English documentation in one file: api-docs-en.md.

Next steps