API tools and SDKs
The playground, Postman collection, and SDKs available for working with the Awell Orchestration API.
Tools for exploring and building against the Orchestration API. All of them need an API key — see Authentication.
GraphQL playground
An in-browser tool for writing, validating and testing GraphQL queries against the API.
Open the playground: developers.awellhealth.com/awell-orchestration/playground
Start here when learning the API. Because GraphQL is introspective, the playground shows the schema as a query is typed, which is faster than reading a reference page to find a field name.
The playground is connected to the Sandbox environment only. There is no playground against Production.
Before running a query, set the API key in the Request headers pane at the bottom of the playground:
{ "apiKey": "YOUR_API_KEY" }Postman collection
A Postman collection covering the API's operations, for testing outside the browser or sharing a request with a colleague.
Open in Postman: Run the Awell Orchestration collection
Set the API key once, in the collection's Variables tab, rather than per request.
Server-side SDK
A Node.js SDK for calling the API from a backend, published on npm as @awell-health/awell-sdk.
The Orchestration API is machine-to-machine, so all calls belong on a server that can hold an API key safely. Never call it from a browser or a mobile app; a key in client code is a key anyone can read. See Authentication.
UI library
A set of React components for building a custom interface on the API. Source and documentation: awell-health/ui-library on GitHub.
⛳ Check before building on this. Navi covers the same job, rendering care flow activities in your own product, and is the actively developed path. If you're starting fresh, start with Navi. Confirm with support@awellhealth.com before choosing the UI library.
Example projects
Awell publishes example projects showing the API in use, which are worth reading before designing an integration loop: orchestration-stories on GitHub. See Domain model for the loop they implement.
Next steps
Next: Domain model, then Start a care flow.