Public reference
Permissions
Every endpoint in this group. Open one for its parameters and a worked example.
1
Endpoints
Permissions
1GET /api/v1/permissions List the permission catalogue
Every permission code this build defines, with its group, label, help text, stated effect and risk class. This is the authoritative list a role editor or a token scope picker should render from.
- Authentication
- Staff token or session
- Requires permission
-
prm_roles_manageManage roles & permissions
English only, and deliberately not translated — these are operator-facing catalogue strings baked into the build, not localized messages. risk is read, write or danger, and is the right signal for warning someone before they tick a box.
Response
200 OK
{
"data": [
{
"code": "prm_users_index",
"group": "Subscribers",
"label": "View subscribers",
"desc": "See the subscriber list and open a subscriber record.",
"effect": "Read-only.",
"risk": "read"
}
]
}No endpoint matches that search.
Written to be read by machines too
The reference is public and needs no account, so a tool that has never seen X-Radius can reach a correct first call on its own.
- /llms.txt
- An index of every page, with one-line summaries.
- /llms-full.txt
- The whole reference as one Markdown file, with no navigation to crawl.
- /openapi.json
- OpenAPI 3.1, generated from the router that serves this instance.
- /skill.md
- A ready-made skill file for an assistant: authentication, the response envelope and the error codes in one page.
<page-url>.md- Append .md to any reference URL for the same page as Markdown.
Accept: text/markdown- Send this header on the ordinary URL and the answer comes back as Markdown instead.
Hand this to your assistant
Read https://x-radius.com/llms.txt, then fetch the endpoint you need as Markdown by appending .md to its URL.