Skip to main content
All Synapse API endpoints require authentication via an API key passed as a Bearer token in the Authorization header.

​
Getting your API key

Contact your Telepatia account manager to obtain an API key for your institution.

​
Making authenticated requests

Include the API key in every request: 
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 headache",
    "pastMedicalHistory": "Hypertension, Diabetes Type 2",
    "consultationInternalId": "CONSULT-12345",
    "scribeSessionModality": "IN_PERSON"
  }'
See Overview for the base URL.

​
Error responses

StatusMeaning
401Missing or invalid API key
403API key does not have permission for this operation

​
Example: Missing API key

{
  "error": {
    "type": "authentication_error",
    "code": "authentication_required",
    "message": "API key is required."
  }
}

​
Example: Invalid API key

{
  "error": {
    "type": "authentication_error",
    "code": "authentication_required",
    "message": "Invalid API key."
  }
}