For AI agents: the complete documentation index is available at /en/llms.txt, the full documentation bundle is available at /en/llms-full.txt, and this page is available as Markdown at /en/api/index.md.
  • English

      • Using the API

      Base URL

      Development requests default to http://localhost:8000; production uses VITE_BASE_URL. Paths in this section omit the base URL.

      Headers

      Authorization: Bearer <token>
User-Language: zh
Content-Type: application/json

      Use multipart/form-data for uploads. Except for routes explicitly marked public, send a valid token and hold the required permission.

      Permission keys

      Tables list the suffix combined with the controller permission prefix. Current-user /system endpoints do not use the same class-level permission prefix and rely on their authentication behavior.

      Responses

      { "data": [], "success": true, "msg": "ok", "showType": 0 }

      success describes the business result, while HTTP statuses still represent authentication, validation, and transport errors. See Responses and Errors.

      These tables follow current route attributes in app/Http/Controllers/Admin/. Synchronize src/api/, access rules, and both documentation languages when endpoints change.