Skip to main content
The REST API is the transport layer beneath every Verial integration. It exposes resources for environments, simulators, datasets, benchmarks, and runs, plus per-protocol endpoints that your agent targets during a run (FHIR, HL7, fax, messaging, payer portals, CDS Hooks). Use the REST API directly when you want to:
  • Integrate from a language without an official SDK
  • Wire your agent’s actions against the sandbox protocol endpoints
  • Build custom dashboards or automations over run data

Introduction

Request format, base URL, and conventions.

Authentication

Issue and use API keys.

Resources

Browse every REST resource and endpoint.

Errors

Error codes and retry guidance.