Documentation Index
Fetch the complete documentation index at: https://docs.verial.ai/llms.txt
Use this file to discover all available pages before exploring further.
Manage simulated healthcare environments that define the system your agent interacts with.
Actions
| Action | Description |
|---|
list | List all environments in the organization |
create | Create a new environment |
get | Get an environment by ID |
update | Update an environment’s name or description |
delete | Delete an environment |
addSimulator | Attach a simulator to an environment |
removeSimulator | Detach a simulator from an environment |
Parameters
list
No parameters.
create
| Parameter | Type | Required | Description |
|---|
name | string | yes | Name of the environment |
description | string | no | Description of the environment |
get
| Parameter | Type | Required | Description |
|---|
id | string | yes | Environment ID |
update
| Parameter | Type | Required | Description |
|---|
id | string | yes | Environment ID |
name | string | no | Updated name |
description | string | null | no | Updated description, or null to clear |
delete
| Parameter | Type | Required | Description |
|---|
id | string | yes | Environment ID |
addSimulator
| Parameter | Type | Required | Description |
|---|
id | string | yes | Environment ID |
simulatorId | string | yes | Simulator ID to attach |
removeSimulator
| Parameter | Type | Required | Description |
|---|
id | string | yes | Environment ID |
simulatorId | string | yes | Simulator ID to detach |
Examples
List all environments
Create a primary care clinic environment
{
"action": "create",
"name": "Primary Care Clinic",
"description": "Simulated primary care setting with EHR and phone system"
}
Add a FHIR simulator to an environment
{
"action": "addSimulator",
"id": "env_abc123",
"simulatorId": "sim_fhir456"
}
