IPD API Tester
Test an inpatient recording, inspect its output, and call the supporting IPD APIs.
Connection & credentials
Enter the API key and hospital ID provided for your integration. Requests run only when you click a recording or request button. The default URLs target the published service.
Enter your own API key. Edits are not saved in browser storage. REST uses X-API-Key; the socket uses the key as its subprotocol.
Patient, admission & clinician
For recording or audio upload, complete the fields marked required. Choose Doctor to enter a Practitioner ID, or Nurse to enter a Caregiver ID. For REST requests, requirements depend on the selected endpoint.
WebSocket audio
Send the admission metadata, wait for init-received, then stream audio. Stop submits the final chunk and waits for processed.
Preview initialization message
Processed result
Your processed recording will appear here as readable notes, tables and fields.
Raw WebSocket result (JSON)
No processed result yet.
REST API requests
Select an endpoint and load a request from the current fields above. Review or edit the query and JSON body before sending. POST and PUT requests can create or update data.
Response
The preview shows how returned information can be presented in your application. Labels are formatted for readability; values come from the response.
Full form payloads and response structures · TODO data and update workflow
Send a request to preview its response, or choose an example above. Examples do not call an API.
Raw REST response (JSON)
No response yet.
Session log
Request milestones and server messages appear here. Patient data in results stays visible until you clear it or close the page.
Ready. No requests have been sent.
How to run
- Keep this tester and the guide in the same folder. Serve the folder locally using
python -m http.server 8080 --bind 127.0.0.1, then open http://127.0.0.1:8080/ipd-api-tester.html. - Enter the API key, hospital ID, admission identifiers and an already registered doctor or nurse. Use the setup endpoints if provisioning is needed.
- Record audio or upload a WebM/Opus file. Wait for the processed result.
- Select an IPD form or retrieval endpoint, click Load request from fields, review it and click Send request.
A disconnect or timeout does not undo server work. Check saved admission output before retrying a submitted recording or write request.