For Agents
Install Jentic One Beta
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Updox Patient Communications 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.
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%2Fupdox.com%2Fupdox" | shStep 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%2Fupdox.com%2Fupdox" | 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.
What an agent can do with Updox Patient Communications API.
Ping server without authentication
Get all contacts for account (v1.0)
Search practice-level address book
Query and filter Updox Patient Communications API records by parameters
GET STARTED
Programmatically ping server without authentication, ping with application level authentication. Covers 8 operations with apiKey authentication.
Use for: I need to ping server without authentication, I want to ping with application level authentication, Search for ping with account level authentication, Find all ping with full authentication
Not supported: Does not handle payments, communications, or crm - use for healthcare only.
API for patient communications, address book management, fax delivery, and practice management integration. The API exposes 8 endpoints secured with apiKey authentication.
Monitor Updox Patient Communications API operational status and events
Patterns agents use Updox Patient Communications API for, with concrete tasks.
★ Healthcare Operations
Use the Updox Patient Communications API to perform healthcare operations programmatically. The API provides 8 endpoints covering core functionality including ping server without authentication, ping with application level authentication, ping with account level authentication.
Call POST /io/Ping to ping server without authentication
Automated Communications Management
Automate communications operations by combining multiple Updox Patient Communications API endpoints. Agents can ping with application level authentication and then ping with account level authentication in a single workflow.
Call POST /io/PingWithApplicationAuth to ping with application level authentication, then verify the result
AI Agent Integration via Jentic
AI agents discover and call Updox Patient Communications API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.
Search Jentic for 'ping server without authentication', load the operation schema, and execute with Jentic-managed credentials
8 endpoints — api for patient communications, address book management, fax delivery, and practice management integration.
METHOD
PATH
DESCRIPTION
/io/Ping
Ping server without authentication
/io/PingWithApplicationAuth
Ping with application level authentication
/io/PingWithAccountAuth
Ping with account level authentication
/io/PingWithAuth
Ping with full authentication
/io/AddressBookList
Get all contacts for account (v1.0)
/io/AddressBookList/1.1
Get all contacts with international support (v1.1)
/io/AddressBookSearch
Search practice-level address book
/io/ContactCreate
Create a new contact
/io/Ping
Ping server without authentication
/io/PingWithApplicationAuth
Ping with application level authentication
/io/PingWithAccountAuth
Ping with account level authentication
/io/PingWithAuth
Ping with full authentication
/io/AddressBookList
Get all contacts for account (v1.0)
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the Updox Patient Communications API by hand means sending your key in the appAuth header on every call, matching each RPC-style operation to its request body, and handling responses yourself. Through Jentic you install once, import the Updox Patient Communications API from the API Directory, store the API key once, and your agent calls it.
Permission scoping
The Updox API is RPC-style and carries its targets in the request body, so scope your agent to the operations it needs, such as listing or searching the address book. You choose the operations it may call, so a write like creating a contact is not included unless you add it.
Credential isolation
Your Updox API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'search the address book' or 'ping the server', and Jentic returns the matching Updox Patient Communications API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Alternatives and complements available in the Jentic catalogue.
Specific to using Updox Patient Communications API through Jentic.
What authentication does the Updox Patient Communications API use?
The Updox Patient Communications API uses an API key passed in the `appAuth` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.
Can I ping server without authentication with the Updox Patient Communications API?
Yes. Use the POST /io/Ping endpoint. The API returns structured JSON responses that agents can parse and act on directly.
What are the rate limits for the Updox Patient Communications API?
Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.
How do I ping server without authentication through Jentic?
Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'ping server without authentication'. Jentic returns the matching Updox Patient Communications API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.
How many endpoints does the Updox Patient Communications API have?
The Updox Patient Communications API exposes 8 endpoints covering communications operations.
/io/AddressBookList/1.1
Get all contacts with international support (v1.1)
/io/AddressBookSearch
Search practice-level address book
/io/ContactCreate
Create a new contact