Skip to main content

​
Prerequisites

  • A Telepatia API key (contact your account manager to obtain one)
  • The base URL (see Overview)
The examples below use the production URL.

​
Step 0: List session templates (optional)

Scribe session templates define the structure of the medical documentation produced during a consultation (e.g. “Cardiology Consultation”, “General Medicine”). Fetching the list before the consultation lets you present a template selector to the clinician or auto-assign one based on specialty. 
curl https://synapse.telepatia.ai/v1/scribe-session-configurations \
  -H "Authorization: Bearer YOUR_API_KEY"
Response: 
{
  "items": [
    { "id": "ssc_a1b2c3d4e5f6g7h8", "name": "Cardiology Consultation" },
    { "id": "ssc_i9j0k1l2m3n4o5p6", "name": "General Medicine" }
  ],
  "total": 2,
  "page": 1,
  "limit": 20,
  "totalPages": 1
}
Save the id of the desired template — you’ll pass it as scribeSessionConfigurationId in Step 1.

​
Step 1: Set consultation context

Before the consultation, send the patient information to Telepatia. You should include a consultationInternalId — this is your own internal identifier that links the session back to your system. If you don’t provide one, Telepatia will generate one for you. Optionally pass a scribeSessionConfigurationId (from Step 0) to pre-select the documentation template for this session. 
curl -X POST https://synapse.telepatia.ai/v1/set-consultation-context \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "John Doe",
    "idCountry": "CO",
    "idType": "CC",
    "idValue": "123456789",
    "notes": "Patient reports recurring headache and dizziness",
    "pastMedicalHistory": "Hypertension diagnosed 2020. Diabetes Type 2 controlled with metformin.",
    "consultationInternalId": "CONSULT-12345",
    "scribeSessionModality": "IN_PERSON",
    "scribeSessionConfigurationId": "ssc_a1b2c3d4e5f6g7h8"
  }'
Response: 
{
  "success": true,
  "consultationInternalId": "CONSULT-12345"
}
Save the consultationInternalId from the response. You will need it in the next steps — both to generate the login link and to retrieve the session results later.
Generate a verification code to open the Telepatia scribe. Pass the consultationInternalId so the session is linked to the consultation context you set in Step 1. 
curl -X POST https://synapse.telepatia.ai/v1/auth/login \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"consultationInternalId": "CONSULT-12345"}'
Response: 
{
  "code": "a1b2c3d4e5",
  "expiresAt": "2026-02-20T18:30:00+00:00",
  "expiresIn": 300,
  "redirectUrl": "https://scribe.telepatia.ai/#/onboarding/sign-in?code=a1b2c3d4e5&consultationInternalId=CONSULT-12345"
}
Redirect the user to the redirectUrl to open the Telepatia scribe.

​
Step 3: Conduct the session

Once the user is redirected, they will land in the Telepatia scribe interface. From there:
  1. The scribe starts recording the consultation
  2. The clinician conducts the visit as usual
  3. When done, the clinician finishes the session in the scribe
No API calls are needed during this step — it all happens in the Telepatia app.

​
Step 4: Retrieve the scribe session

After the session is finished, retrieve the results using the consultationInternalId: 
curl https://synapse.telepatia.ai/v1/scribe-sessions/CONSULT-12345 \
  -H "Authorization: Bearer YOUR_API_KEY"
Response: 
{
  "id": "session-abc-123",
  "status": "completed",
  "createdAt": "2026-02-20T10:00:00Z",
  "completedAt": "2026-02-20T10:30:00Z",
  "patientName": "John Doe",
  "scribeSessionModality": "IN_PERSON",
  "consultationInternalId": "CONSULT-12345",
  "specialty": "Cardiology",
  "medicalRecordMutable": {
    "chiefComplaint": {
      "title": "Chief Complaint",
      "type": "text",
      "status": "completed",
      "content": "Patient reports headache"
    }
  }
}
If the session is still in progress, the status field will reflect that. You can poll this endpoint until the status is completed.