Ai-RGUS Configuration API
38
AI ReadinessNon-Ready (F)38/100
Community OpenAPI document · agent-readyIOTDevice Managementbasic6 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For 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.
Use for: I need to create a client account in Ai-RGUS, I want to register a new device for a client account, List all client accounts under my Ai-RGUS profile, Get the devices configured for a specific account
Not supported: Does not handle live video, alerts, or incident review. Use for Ai-RGUS client account and device configuration only.
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.
Install Jentic One Beta
Connect the Ai-RGUS Configuration API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Ai-RGUS Configuration API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fai-rgus.com%2Fai-rgus" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fai-rgus.com%2Fai-rgus" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Ai-RGUS Configuration API.
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
Patterns agents use Ai-RGUS Configuration API for, with concrete tasks.
★ 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.
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.
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.
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
6 endpoints — the ai-rgus configuration api provisions the client accounts and monitored devices that ai-rgus watches on your behalf.
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
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
Jentic AI Readiness Score
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.
A
Ai-RGUS Configuration API
- Non-Ready (F)38/100
100
Foundational Compliance75
Developer Experience & Jentic Compatibility37
AI-Readiness & Agent Experience94
Agent Usability10
Security58
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.2
Show dimension breakdown
100
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: A+Signals: 4
99%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
100%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
100%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
75
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: A-Signals: 4
50%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
50%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
37
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: FSignals: 4
49%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
100%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
0%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
10
Security
Trust, risk posture, and security compliance.
Grade: FSignals: 1
10%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
58
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: C+Signals: 1
58%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
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 isolation
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.
Intent-based discovery
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
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Ai-RGUS Configuration API through Jentic.
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.
GET STARTED