Quickstart

Create an API key, a patient and a visit, and read the note.

1. Create an API key

   In RxNote, open Settings → API (for yourself) or Organization → API (for a system many clinicians use) and create a key with the scopes patients:write, visits:write and visits:read. Copy the secret — it is shown once.

   export RXNOTE_API_KEY="rxn_test_..."
   export RXNOTE_API="https://dev.rxnote.ai/api/v1"   # or http://localhost:3000/api/v1
   
2. Create the patient

   curl -X POST "$RXNOTE_API/patients" \
     -H "Authorization: Bearer $RXNOTE_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{ "name": "Test Patient", "age": 42, "sex": "female", "external_id": "P-1001" }'
   

   Response (201)

   { "id": 4821, "name": "Test Patient", "age": 42, "sex": "female", "external_id": "P-1001", "...": "..." }
   

   Keep id. With external_id, sending the same patient again returns this one instead of a duplicate, so you never need to store RxNote’s id if you’d rather look patients up by your own.

   Using an organization key? Add "clinician_email" — the RxNote member creating the patient.
3. Create a visit from a transcript

   cURL

   curl -X POST "$RXNOTE_API/visits" \
     -H "Authorization: Bearer $RXNOTE_API_KEY" \
     -H "Idempotency-Key: quickstart-0001" \
     -H "Content-Type: application/json" \
     -d '{
       "patient_id": 4821,
       "language": "en",
       "transcript": "Doctor: What brings you in today? Patient: A sore throat for three days..."
     }'
   

   Response (201)

   { "id": 90211, "patient_id": 4821, "status": "processing", "...": "..." }
   
4. Get the note

   Poll until status is completed (most notes take one to three minutes). Webhooks are coming soon.

   curl "$RXNOTE_API/visits/90211" -H "Authorization: Bearer $RXNOTE_API_KEY"
   

   The note holds the template’s sections and fields in order, plus html for display. See the note format.

With a recording

A recording takes one more step: you upload the file straight to storage, then ask RxNote to process it — the same upload-then-process sequence the app’s recorder uses.

1. Create the visit with audio details

   curl -X POST "$RXNOTE_API/visits" \
     -H "Authorization: Bearer $RXNOTE_API_KEY" \
     -H "Idempotency-Key: quickstart-audio-0001" \
     -H "Content-Type: application/json" \
     -d '{
       "patient_id": 4821,
       "language": "en",
       "audio": { "content_type": "audio/webm", "size_bytes": 4812733 }
     }'
   

   The response has status: "recording" and an upload object.

2. Upload the file

   PUT the file to upload.url with exactly the headers in upload.headers. No API key on this request.

   curl -X PUT "<upload.url>" -H "Content-Type: audio/webm" --data-binary @consultation.webm
   
3. Process

   curl -X POST "$RXNOTE_API/visits/90212/process" -H "Authorization: Bearer $RXNOTE_API_KEY"
   

   The visit moves to processing, then transcribing, generating-soap and completed.