Public reference

Kb

Every endpoint in this group. Open one for its parameters and a worked example.

28 Endpoints

Kb

GET /api/v1/kb/articles View the knowledge base & self-service insights prm_kb_view

Authentication: Staff token or session
Requires permission: prm_kb_view View the knowledge base & self-service insights

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

POST /api/v1/kb/articles Author knowledge base articles & troubleshooting guides prm_kb_manage

Authentication: Staff token or session
Requires permission: prm_kb_manage Author knowledge base articles & troubleshooting guides
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

POST /api/v1/kb/articles/bulk-archive Author knowledge base articles & troubleshooting guides prm_kb_manage

Authentication: Staff token or session
Requires permission: prm_kb_manage Author knowledge base articles & troubleshooting guides
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

POST /api/v1/kb/articles/bulk-delete Author knowledge base articles & troubleshooting guides prm_kb_manage

Authentication: Staff token or session
Requires permission: prm_kb_manage Author knowledge base articles & troubleshooting guides
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

POST /api/v1/kb/articles/bulk-publish Author knowledge base articles & troubleshooting guides prm_kb_manage

Authentication: Staff token or session
Requires permission: prm_kb_manage Author knowledge base articles & troubleshooting guides
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

POST /api/v1/kb/articles/bulk-unpublish Author knowledge base articles & troubleshooting guides prm_kb_manage

Authentication: Staff token or session
Requires permission: prm_kb_manage Author knowledge base articles & troubleshooting guides
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

DELETE /api/v1/kb/articles/{id} Author knowledge base articles & troubleshooting guides prm_kb_manage

Authentication: Staff token or session
Requires permission: prm_kb_manage Author knowledge base articles & troubleshooting guides
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

GET /api/v1/kb/articles/{id} View the knowledge base & self-service insights prm_kb_view

Authentication: Staff token or session
Requires permission: prm_kb_view View the knowledge base & self-service insights

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

PATCH /api/v1/kb/articles/{id} Author knowledge base articles & troubleshooting guides prm_kb_manage

Authentication: Staff token or session
Requires permission: prm_kb_manage Author knowledge base articles & troubleshooting guides
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

POST /api/v1/kb/articles/{id}/attach Author knowledge base articles & troubleshooting guides prm_kb_manage

Authentication: Staff token or session
Requires permission: prm_kb_manage Author knowledge base articles & troubleshooting guides
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

DELETE /api/v1/kb/articles/{id}/attachments/{attId} Author knowledge base articles & troubleshooting guides prm_kb_manage

Authentication: Staff token or session
Requires permission: prm_kb_manage Author knowledge base articles & troubleshooting guides
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

GET /api/v1/kb/articles/{id}/attachments/{attId} View the knowledge base & self-service insights prm_kb_view

Authentication: Staff token or session
Requires permission: prm_kb_view View the knowledge base & self-service insights

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

GET /api/v1/kb/articles/{id}/versions View the knowledge base & self-service insights prm_kb_view

Authentication: Staff token or session
Requires permission: prm_kb_view View the knowledge base & self-service insights

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

GET /api/v1/kb/articles/{id}/versions/{version} View the knowledge base & self-service insights prm_kb_view

Authentication: Staff token or session
Requires permission: prm_kb_view View the knowledge base & self-service insights

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

POST /api/v1/kb/articles/{id}/versions/{version}/restore Author knowledge base articles & troubleshooting guides prm_kb_manage

Authentication: Staff token or session
Requires permission: prm_kb_manage Author knowledge base articles & troubleshooting guides
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

GET /api/v1/kb/categories View the knowledge base & self-service insights prm_kb_view

Authentication: Staff token or session
Requires permission: prm_kb_view View the knowledge base & self-service insights

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

POST /api/v1/kb/categories Author knowledge base articles & troubleshooting guides prm_kb_manage

Authentication: Staff token or session
Requires permission: prm_kb_manage Author knowledge base articles & troubleshooting guides
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

DELETE /api/v1/kb/categories/{id} Author knowledge base articles & troubleshooting guides prm_kb_manage

Authentication: Staff token or session
Requires permission: prm_kb_manage Author knowledge base articles & troubleshooting guides
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

PATCH /api/v1/kb/categories/{id} Author knowledge base articles & troubleshooting guides prm_kb_manage

Authentication: Staff token or session
Requires permission: prm_kb_manage Author knowledge base articles & troubleshooting guides
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

GET /api/v1/kb/insights View the knowledge base & self-service insights prm_kb_view

Authentication: Staff token or session
Requires permission: prm_kb_view View the knowledge base & self-service insights

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

GET /api/v1/kb/search View the knowledge base & self-service insights prm_kb_view

Authentication: Staff token or session
Requires permission: prm_kb_view View the knowledge base & self-service insights

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

GET /api/v1/kb/ticket-categories View the knowledge base & self-service insights prm_kb_view

Authentication: Staff token or session
Requires permission: prm_kb_view View the knowledge base & self-service insights

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

GET /api/v1/kb/wizards View the knowledge base & self-service insights prm_kb_view

Authentication: Staff token or session
Requires permission: prm_kb_view View the knowledge base & self-service insights

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

POST /api/v1/kb/wizards Author knowledge base articles & troubleshooting guides prm_kb_manage

Authentication: Staff token or session
Requires permission: prm_kb_manage Author knowledge base articles & troubleshooting guides
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

POST /api/v1/kb/wizards/bulk-delete Author knowledge base articles & troubleshooting guides prm_kb_manage

Authentication: Staff token or session
Requires permission: prm_kb_manage Author knowledge base articles & troubleshooting guides
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

DELETE /api/v1/kb/wizards/{id} Author knowledge base articles & troubleshooting guides prm_kb_manage

Authentication: Staff token or session
Requires permission: prm_kb_manage Author knowledge base articles & troubleshooting guides
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

GET /api/v1/kb/wizards/{id} View the knowledge base & self-service insights prm_kb_view

Authentication: Staff token or session
Requires permission: prm_kb_view View the knowledge base & self-service insights

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

PATCH /api/v1/kb/wizards/{id} Author knowledge base articles & troubleshooting guides prm_kb_manage

Authentication: Staff token or session
Requires permission: prm_kb_manage Author knowledge base articles & troubleshooting guides
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

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.

Try it on your own network.

5000 subscribers for 90 days. You pay nothing.

Try it free Talk to us