canonical: https://jentic.com/apis/ai-rgus.com/ai-rgus # Ai-RGUS Configuration API The Ai-RGUS Configuration API provisions the client accounts and monitored devices that Ai-RGUS watches on your behalf. It creates a client account, registers a device under that account, lists the accounts and devices tied to your partner profile, and removes a device or a whole account when a site is retired. Authentication is HTTP basic, and Ai-RGUS issues an encryption key through your representative that its documentation requires alongside it. ## For AI agents Provision Ai-RGUS client accounts and register, list, or remove the devices monitored under them. Covers account and device configuration, not video or alert data. ## Scope Does not handle live video, alerts, or incident review. Use for Ai-RGUS client account and device configuration only. ## Capabilities - Create client accounts that group the sites Ai-RGUS monitors - Register a device under a specific client account - List the client accounts tied to your Ai-RGUS partner profile - List the devices configured for a given client account - Remove a device or an entire client account when a site is decommissioned ## Use cases ### Agent-Driven Device Onboarding An AI agent connected through Jentic onboards a new surveillance device by creating or selecting the client account, registering the device under it, and reading back the account's device list to confirm the device landed. This turns a manual partner-portal task into a repeatable call the agent runs whenever a new site comes online. Example prompt: Create a client account for a new site, add a device to it, and verify the device appears in that account's device list ### Partner Account Provisioning A reseller or integrator sets up a client account for each new customer before any device is installed. The API creates the account and returns it in the account list, giving back-office automation a single place to open and track the sites it manages under one Ai-RGUS partner profile. Example prompt: Create a new client account for a customer and confirm it is returned by the account-listing operation ### Site Decommissioning When a monitored site is retired, automation removes its devices and then the client account itself so stale entries do not linger in the Ai-RGUS configuration. The API exposes both the device-removal and account-removal operations, letting a cleanup job tear a site down in order rather than by hand. Example prompt: List a client account's devices, remove each one, then remove the client account and confirm it no longer appears in the account list ## Key endpoints | Method | Path | Description | | --- | --- | --- | | POST | `/createClientAccount` | Create a client account | | GET | `/getAccountsList` | List client accounts | | POST | `/addDevice` | Register a device under an account | | GET | `/getDevices` | List the devices for an account | | POST | `/remDevice` | Remove a device | | POST | `/remAccount` | Remove a client account | ## Key resources - **Client Accounts** — Create, list, and remove the client accounts that group the sites Ai-RGUS monitors - **Devices** — Register devices under a client account, list an account's devices, and remove a device ## AI readiness This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use. - **Score:** 38 / 100 - **Maturity:** Non-Ready - **Dimensions:** - Foundational Compliance: 100 / 100 - Developer Experience & Jentic Compatibility: 75 / 100 - AI-Readiness & Agent Experience: 37 / 100 - Agent Usability: 94 / 100 - Security: 10 / 100 - AI Discoverability: 58 / 100 - **View full report:** https://jentic.com/apis/ai-rgus.com/ai-rgus/scorecard - **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/ - **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview ### Score it yourself Every API in the directory is allowlisted, so you can re-score it with no key required. - **Score your own API:** https://jentic.com/scorecard.md - **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md ```sh npx @jentic/api-scorecard-cli score ``` ## Why Jentic - **Setup:** Wiring the Ai-RGUS Configuration API by hand means setting up HTTP basic authentication, supplying the encryption key your Ai-RGUS representative issues, and matching each account and device call to the right path. Through Jentic you install once, import Ai-RGUS from the API Directory, store the credential once, and your agent calls it. - **Permission scoping:** The Ai-RGUS endpoints carry account and device identifiers in the request body, not the URL path, so rules bound which operations your agent may call rather than which account. Limit it to the operations it needs, such as listing accounts and devices, so removal operations like deleting a device or an account are not included unless you add them. - **Credential handling:** Your Ai-RGUS basic auth credentials and encryption key are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'add a surveillance device' or 'list client accounts', and Jentic returns the matching Ai-RGUS operation with its input schema so the agent calls the right endpoint without reading the reference docs. ## Related APIs - **Particle Device Cloud API** — General-purpose IoT device provisioning and control, where Ai-RGUS is specific to its own monitored surveillance devices. - **balena API** — Manages the operating system and application fleet on edge devices that an Ai-RGUS site may run alongside its monitored hardware. - **Blynk API** — Adds dashboards and remote control for IoT devices that Ai-RGUS only tracks for monitoring. ## FAQ ### What authentication does the Ai-RGUS Configuration API use? The Ai-RGUS Configuration API authenticates with HTTP basic authentication per its OpenAPI spec, and Ai-RGUS also issues an encryption key through your representative that its documentation requires alongside the basic credentials. Through Jentic those secrets are stored encrypted by your own Jentic One instance and injected at call time, so they never reach the agent's context. ### Can I register and remove devices with the Ai-RGUS Configuration API? Yes. The API adds a device under a specific client account, lists the devices configured for that account, and removes a device or the whole account when a site is decommissioned. Account and device identifiers travel in the request body of each call. ### Can I limit what my agent is allowed to do with the Ai-RGUS Configuration API? Yes. Write a rule that allows only the account-listing and device-listing operations, so your agent can read your Ai-RGUS configuration but cannot add or remove devices or accounts, and every call it makes is logged. When you want the agent to onboard devices too, add the create-account and add-device operations to the same rule. ### What are the rate limits for the Ai-RGUS Configuration API? The OpenAPI spec does not define rate limits for the Ai-RGUS Configuration API. Check with your Ai-RGUS representative or the Ai-RGUS documentation for the limits that apply to your partner profile. ### How do I add a device to a client account with the Ai-RGUS Configuration API through Jentic? Search Jentic for 'add a device to an Ai-RGUS account' and it returns the add-device operation with its input schema; your agent supplies the account and device details, then calls the device-listing operation to confirm the device landed. To run it on your own infrastructure, install Jentic One from its GitHub repo. ### Is there an Ai-RGUS MCP server? You don't need an MCP server to give your agent the Ai-RGUS Configuration API. Jentic connects it directly from the API Directory: import it, store your credential once, and your agent calls it with the same scoping and credential isolation as any other API in your directory.