Create Session

curl --request POST \
  --url https://api.eka.care/voice/v1/sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "language_hint": [
    "en"
  ],
  "model": "pro",
  "templates": [
    "clinical_notes_template"
  ],
  "upload_type": "single",
  "additional_data": {
    "source": "mobile_app",
    "app_version": "1.0.0"
  },
  "patient_details": {
    "oid": "PAT-12345",
    "name": "John Doe"
  }
}
'

import requests

url = "https://api.eka.care/voice/v1/sessions"

payload = {
    "language_hint": ["en"],
    "model": "pro",
    "templates": ["clinical_notes_template"],
    "upload_type": "single",
    "additional_data": {
        "source": "mobile_app",
        "app_version": "1.0.0"
    },
    "patient_details": {
        "oid": "PAT-12345",
        "name": "John Doe"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    language_hint: ['en'],
    model: 'pro',
    templates: ['clinical_notes_template'],
    upload_type: 'single',
    additional_data: {source: 'mobile_app', app_version: '1.0.0'},
    patient_details: {oid: 'PAT-12345', name: 'John Doe'}
  })
};

fetch('https://api.eka.care/voice/v1/sessions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

HttpResponse<String> response = Unirest.post("https://api.eka.care/voice/v1/sessions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"language_hint\": [\n    \"en\"\n  ],\n  \"model\": \"pro\",\n  \"templates\": [\n    \"clinical_notes_template\"\n  ],\n  \"upload_type\": \"single\",\n  \"additional_data\": {\n    \"source\": \"mobile_app\",\n    \"app_version\": \"1.0.0\"\n  },\n  \"patient_details\": {\n    \"oid\": \"PAT-12345\",\n    \"name\": \"John Doe\"\n  }\n}")
  .asString();

using RestSharp;


var options = new RestClientOptions("https://api.eka.care/voice/v1/sessions");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"language_hint\": [\n    \"en\"\n  ],\n  \"model\": \"pro\",\n  \"templates\": [\n    \"clinical_notes_template\"\n  ],\n  \"upload_type\": \"single\",\n  \"additional_data\": {\n    \"source\": \"mobile_app\",\n    \"app_version\": \"1.0.0\"\n  },\n  \"patient_details\": {\n    \"oid\": \"PAT-12345\",\n    \"name\": \"John Doe\"\n  }\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

require 'uri'
require 'net/http'

url = URI("https://api.eka.care/voice/v1/sessions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"language_hint\": [\n    \"en\"\n  ],\n  \"model\": \"pro\",\n  \"templates\": [\n    \"clinical_notes_template\"\n  ],\n  \"upload_type\": \"single\",\n  \"additional_data\": {\n    \"source\": \"mobile_app\",\n    \"app_version\": \"1.0.0\"\n  },\n  \"patient_details\": {\n    \"oid\": \"PAT-12345\",\n    \"name\": \"John Doe\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "session_id": "ses_abc123def456",
  "status": "created",
  "created_at": "2025-01-19T10:30:00Z",
  "expires_at": "2025-01-19T11:30:00Z",
  "upload_url": "https://api.eka.care/voice/v1/sessions/ses_abc123def456/audio",
  "patient_details": {
    "oid": "PAT-12345",
    "name": "John Doe"
  }
}

{
  "error": {
    "code": "invalid_audio_format",
    "message": "Audio format 'audio/mp3' is not supported",
    "details": {}
  }
}

{
  "error": {
    "code": "invalid_audio_format",
    "message": "Audio format 'audio/mp3' is not supported",
    "details": {}
  }
}

{
  "error": {
    "code": "invalid_audio_format",
    "message": "Audio format 'audio/mp3' is not supported",
    "details": {}
  }
}

Sessions

Create Session

Create a new scribing session. Returns a session_id that must be used in every subsequent call (audio upload, end session, status polling) and an upload_url to which audio is sent. Only upload_type is required — use single (one audio file, max 10 MB via the API; for larger recordings use the SDKs, which chunk automatically) unless you need chunked or streaming upload. The communication protocol is derived from upload_type by the server: single/chunked → http, stream → websocket.

POST

voice

sessions

Create Session

curl --request POST \
  --url https://api.eka.care/voice/v1/sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "language_hint": [
    "en"
  ],
  "model": "pro",
  "templates": [
    "clinical_notes_template"
  ],
  "upload_type": "single",
  "additional_data": {
    "source": "mobile_app",
    "app_version": "1.0.0"
  },
  "patient_details": {
    "oid": "PAT-12345",
    "name": "John Doe"
  }
}
'

import requests

url = "https://api.eka.care/voice/v1/sessions"

payload = {
    "language_hint": ["en"],
    "model": "pro",
    "templates": ["clinical_notes_template"],
    "upload_type": "single",
    "additional_data": {
        "source": "mobile_app",
        "app_version": "1.0.0"
    },
    "patient_details": {
        "oid": "PAT-12345",
        "name": "John Doe"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    language_hint: ['en'],
    model: 'pro',
    templates: ['clinical_notes_template'],
    upload_type: 'single',
    additional_data: {source: 'mobile_app', app_version: '1.0.0'},
    patient_details: {oid: 'PAT-12345', name: 'John Doe'}
  })
};

fetch('https://api.eka.care/voice/v1/sessions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

HttpResponse<String> response = Unirest.post("https://api.eka.care/voice/v1/sessions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"language_hint\": [\n    \"en\"\n  ],\n  \"model\": \"pro\",\n  \"templates\": [\n    \"clinical_notes_template\"\n  ],\n  \"upload_type\": \"single\",\n  \"additional_data\": {\n    \"source\": \"mobile_app\",\n    \"app_version\": \"1.0.0\"\n  },\n  \"patient_details\": {\n    \"oid\": \"PAT-12345\",\n    \"name\": \"John Doe\"\n  }\n}")
  .asString();

using RestSharp;


var options = new RestClientOptions("https://api.eka.care/voice/v1/sessions");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"language_hint\": [\n    \"en\"\n  ],\n  \"model\": \"pro\",\n  \"templates\": [\n    \"clinical_notes_template\"\n  ],\n  \"upload_type\": \"single\",\n  \"additional_data\": {\n    \"source\": \"mobile_app\",\n    \"app_version\": \"1.0.0\"\n  },\n  \"patient_details\": {\n    \"oid\": \"PAT-12345\",\n    \"name\": \"John Doe\"\n  }\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

require 'uri'
require 'net/http'

url = URI("https://api.eka.care/voice/v1/sessions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"language_hint\": [\n    \"en\"\n  ],\n  \"model\": \"pro\",\n  \"templates\": [\n    \"clinical_notes_template\"\n  ],\n  \"upload_type\": \"single\",\n  \"additional_data\": {\n    \"source\": \"mobile_app\",\n    \"app_version\": \"1.0.0\"\n  },\n  \"patient_details\": {\n    \"oid\": \"PAT-12345\",\n    \"name\": \"John Doe\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "session_id": "ses_abc123def456",
  "status": "created",
  "created_at": "2025-01-19T10:30:00Z",
  "expires_at": "2025-01-19T11:30:00Z",
  "upload_url": "https://api.eka.care/voice/v1/sessions/ses_abc123def456/audio",
  "patient_details": {
    "oid": "PAT-12345",
    "name": "John Doe"
  }
}

{
  "error": {
    "code": "invalid_audio_format",
    "message": "Audio format 'audio/mp3' is not supported",
    "details": {}
  }
}

{
  "error": {
    "code": "invalid_audio_format",
    "message": "Audio format 'audio/mp3' is not supported",
    "details": {}
  }
}

{
  "error": {
    "code": "invalid_audio_format",
    "message": "Audio format 'audio/mp3' is not supported",
    "details": {}
  }
}

Create a scribing session. Only upload_type is required — use single for the simplest flow (one audio file). Save the returned session_id for all subsequent calls.

single uploads are capped at 10 MB — for larger recordings use chunked or an SDK. The communication protocol is derived automatically: single/chunked → http, stream → websocket (returns a wss:// upload_url).

Next: Upload Audio → End Session → Get Session.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

upload_type

enum<string>

default:single

required

Audio upload method. single — one complete audio file up to 10 MB; chunked — sequential HTTP chunks for longer recordings; stream — real-time WebSocket. The communication protocol is derived automatically (single/chunked → http, stream → websocket).

Available options:

single,

chunked,

stream

language_hint

string[]

ISO 639-1 language code(s) hinting the audio input language. If your UI doesn't offer a language picker, use ["auto_detect"] for the best results.

Example:

["en"]

model

enum<string>

default:pro

Model ID from the discovery document.

Available options:

pro,

lite

templates

string[]

Optional template IDs to extract (max 2). See List Templates for valid IDs.

Maximum array length: 2

Example:

["clinical_notes_template"]

session_id

string

Optional client-supplied session id (16–32 chars). If omitted, the server generates one.

Required string length: 16 - 32

Example:

"ses_abc123def456"

additional_data

object

Optional pass-through metadata returned in webhooks and status responses (≤4KB recommended).

patient_details

object

Optional patient demographic / identifier metadata. oid is promoted to patient_oid for indexing.

Response

Session created

session_id

string

Unique session identifier. Use in all subsequent calls.

status

string

Example:

"created"

created_at

string<date-time>

expires_at

string<date-time>

upload_url

string

Endpoint for uploading audio to this session.

patient_details

object