> ## Documentation Index
> Fetch the complete documentation index at: https://docs.neoagent.io/llms.txt
> Use this file to discover all available pages before exploring further.

# CloudRadial API

> Use CloudRadial from Neo: design service catalog forms with their questions, categories and approval, and read and update each client's portal

The common use is a chat: a technician asks an agent to build or change a request form in a client's CloudRadial service catalog, such as a Leavers form that asks for everything the Leaver agent needs. Ticket agents also read a client's portal users and endpoints, and update them.

> [!NOTE]
>
> Automatically enabled when you configure CloudRadial permissions in your agent workflow.

## What It Does

* Create and edit service catalog forms: subject, category, description, questions with their type, options and order, approval settings and approvers, and PSA routing
* Create a new category by giving a form a new category name
* Read a Neo agent's instructions (with Neo API access) and design a form that asks for what that agent needs
* Read and update each client's portal users, companies, domains, certificates and replacement tokens
* Read and update endpoints, installed software, custom properties and Windows services, and refresh warranty data
* Create and edit knowledge base articles, menu tiles, quickstarts, Planner products, media and report archives
* Read feedback and assessments; manage courses, lessons and enrolments; manage flexible assets
* Send a Signal message to a client's users, read who saw it, and resolve or retract it

## Permission Groups

| Group | Covers |
| - | - |
| Service Catalog | Request forms and their questions, categories, approval settings, approvers and PSA routing |
| Portal Users | Each client's portal users |
| Companies & Domains | Companies, company groups, domains, SSL certificates, replacement tokens |
| Endpoints | Endpoints, installed applications, custom properties, Windows services and service installs |
| Portal Content | Knowledge base articles, menus, quickstarts, Planner products, media, report archives |
| Feedback & Assessments | End-user feedback and assessments |
| Training | Courses, lessons, enrolments and lesson history |
| Flexible Assets | Flexible asset types, fields and records |
| Signal Messages | Messages to client users' devices, their recipients, and enrolled devices |

## Access Profiles

| Profile | What runs |
| - | - |
| **Read Only** | Every read |
| **Helpdesk** | Every read; each change to a form, user, endpoint, content, feedback, course or flexible asset after a technician approves it. Companies and Signal messages read-only |
| **IT Admin** | Every read and change on its own, except a Signal message, which a technician approves |
| **Full Automation** | Every read and change without approval |

## Safety Controls

| Control | Behavior |
| - | - |
| **The ticket's client only** | On a run for a ticket that names a company, every call names the CloudRadial company the ticket's company is mapped to, and Neo returns only that company's records and refuses another company's. Calls across every client go out only on a run with no ticket company, such as a chat with Neo or a scheduled agent |
| **Full updates keep hidden values** | A full update (PUT) replaces the whole record, so Neo reads it first and keeps every field the agent left out |
| **Secrets stay out** | Webhook URLs on forms, agent download links, product keys, support PINs and view tokens are hidden from the agent and from scripts |
| **No message to every client** | Neo does not send a Signal message to every company at once |
| **Deleting a company asks** | Deleting a company always waits for a technician's approval |
| **File uploads** | Neo does not send the multipart media and assessment uploads; a media file can be added as base64 instead |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.