canonical: https://jentic.com/apis/swaggerhub.advancedcomputersoft/adastra-ivr-api

# Advancedcomputersoft Adastra IVR API

Introduction The API provides option to search for a patient based on the phone number and the date of birth and create a case if the details match. The API exposes 3 endpoints secured with bearer authentication.

## For AI agents

Programmatically obtain jwt token, get patient details. Covers 3 operations with bearer authentication.

## Scope

Does not handle payments, communications, or crm - use for healthcare only.

## Capabilities

- Obtain JWT token
- Get patient details
- Create case
- Query and filter Adastra IVR API records by parameters
- Monitor Adastra IVR API operational status and events

## Use cases

### Healthcare Operations

Use the Adastra IVR API to perform healthcare operations programmatically. The API provides 3 endpoints covering core functionality including obtain jwt token, get patient details, create case.

Example prompt: Call POST /authenticate to obtain jwt token

### Automated Authentication Management

Automate authentication operations by combining multiple Adastra IVR API endpoints. Agents can get patient details and then create case in a single workflow.

Example prompt: Call POST /patient-search to get patient details, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Adastra IVR 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 bearer tokens manually.

Example prompt: Search Jentic for 'obtain jwt token', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | /authenticate | Obtain JWT token |
| POST | /patient-search | Get patient details |
| POST | /cases | Create case |

## Key resources

- **Authentication** — Operations related to authentication
- **Patient** — Operations related to lookup of patient based on phone number and date of birth
- **Case** — Operations related to creation of case based on the patient details

## Why Jentic

- **Setup:** Wiring the Adastra IVR API by hand means calling /authenticate for a JWT bearer token, attaching it to every request, and building the patient-search and case-creation payloads yourself. Through Jentic you install once, import the Adastra IVR API from the API Directory, store the bearer token once, and your agent calls it.
- **Permission scoping:** The Adastra IVR API takes its targets in the request body rather than the URL path, so scope by operation: limit the agent to the operations it needs, such as searching for a patient. Every operation the agent can run is one you have added to its allowed set, so case creation is included only if you add it.
- **Credential handling:** Your Adastra IVR bearer token 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.
- **Discovery method:** Agents search Jentic by intent such as 'obtain a JWT token' or 'search for a patient', and Jentic returns the matching Adastra IVR operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Oystehr** — Alternative healthcare API
- **Athenahealth** — Alternative healthcare API

## FAQ

### What authentication does the Adastra IVR API use?

The Adastra IVR API uses a Bearer token in the Authorization 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 obtain jwt token with the Adastra IVR API?

Yes. Use the POST /authenticate endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Adastra IVR 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 obtain jwt token through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'obtain jwt token'. Jentic returns the matching Adastra IVR API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Adastra IVR API have?

The Adastra IVR API exposes 3 endpoints covering authentication, patient, case operations.

### Can I limit what my agent is allowed to do with the Adastra IVR API?

Yes. Because you run Jentic One yourself, your own rules decide which Adastra IVR operations and credentials the agent may use. Since this API passes its targets in the request body rather than the URL path, you scope by operation: add only what the agent needs, such as POST /authenticate for a JWT token and POST /patient-search to look up a patient. Case creation via POST /cases is available to the agent only if you add it to the allowed set.