Transcription Result

Transaction Result

curl --request GET \
  --url https://api.eka.care/voice/api/v3/status/{txn_id} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "output": [
      {
        "template_id": "eka_emr_template",
        "value": "eyJwcmVzY3JpcHRpb24iOiB7Im1lZGljYXRpb25zIjogW3sibmFtZSI6ICJkb2xvIiwgImZyZXF1ZW5jeSI6IHsicGF0dGVybl9pZCI6ICJmcC0xIiwgImRvc2UiOiBbIjEiLCAiMCIsICIxIl0sICJwZXJpb2QiOiAxLCAicGVyaW9kX3VuaXQiOiAiZGF5IiwgImZyZXF1ZW5jeSI6ICIzIiwgImN1c3RvbSI6ICIxLTAtMSJ9LCAiaW5zdHJ1Y3Rpb24iOiAiVGFrZSB0d2ljZSBhIGRheSIsICJpZCI6ICJsb2NhbGUtMmFiMWU5OGIxMzU4NzFhZjZjYjAxYjQ3MjE5NWNmZjQifV0sICJsYW5ndWFnZSI6ICJFTiJ9fQ==",
        "type": "eka_emr",
        "name": "EKA EMR Template",
        "status": "success",
        "errors": [],
        "warnings": []
      }
    ],
    "additional_data": {
      "mode": "dictation",
      "doctor": {
        "_id": "174097180967921"
      },
      "visitid": "09e4f00f-d665-4212-b77c-b2dd5f22bd92_1742560488782"
    }
  }
}

GET

voice

api

status

{txn_id}

Transaction Result

curl --request GET \
  --url https://api.eka.care/voice/api/v3/status/{txn_id} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "output": [
      {
        "template_id": "eka_emr_template",
        "value": "eyJwcmVzY3JpcHRpb24iOiB7Im1lZGljYXRpb25zIjogW3sibmFtZSI6ICJkb2xvIiwgImZyZXF1ZW5jeSI6IHsicGF0dGVybl9pZCI6ICJmcC0xIiwgImRvc2UiOiBbIjEiLCAiMCIsICIxIl0sICJwZXJpb2QiOiAxLCAicGVyaW9kX3VuaXQiOiAiZGF5IiwgImZyZXF1ZW5jeSI6ICIzIiwgImN1c3RvbSI6ICIxLTAtMSJ9LCAiaW5zdHJ1Y3Rpb24iOiAiVGFrZSB0d2ljZSBhIGRheSIsICJpZCI6ICJsb2NhbGUtMmFiMWU5OGIxMzU4NzFhZjZjYjAxYjQ3MjE5NWNmZjQifV0sICJsYW5ndWFnZSI6ICJFTiJ9fQ==",
        "type": "eka_emr",
        "name": "EKA EMR Template",
        "status": "success",
        "errors": [],
        "warnings": []
      }
    ],
    "additional_data": {
      "mode": "dictation",
      "doctor": {
        "_id": "174097180967921"
      },
      "visitid": "09e4f00f-d665-4212-b77c-b2dd5f22bd92_1742560488782"
    }
  }
}

HTTP Status Codes

The API returns different HTTP status codes based on the processing outcome:

Status Code	Description	Scenario
200	Success	All templates processed successfully
202	Accepted	Transaction in progress
206	Partial Content	Some templates succeeded, others failed/partial
400	Bad Request	Invalid request or transaction not found
500	Internal Server Error	System failure or all templates failed

Authorizations

Authorization

string

header

required

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

Path Parameters

txn_id

string

required

Unique Transaction ID - same as passed in presigned URL request

Example:

"test_1234"

Response

All templates processed successfully

data

object

Show child attributes

data.output

object[]

Array of processed template results

Show child attributes

data.output.template_id

string

Unique identifier for the template

Example:

"eka_emr_template"

data.output.value

string

Structured output data from the template

Example:

"eyJwcmVzY3JpcHRpb24iOiB7Im1lZGljYXRpb25zIjogW3sibmFtZSI6ICJkb2xvIiwgImZyZXF1ZW5jeSI6IHsicGF0dGVybl9pZCI6ICJmcC0xIiwgImRvc2UiOiBbIjEiLCAiMCIsICIxIl0sICJwZXJpb2QiOiAxLCAicGVyaW9kX3VuaXQiOiAiZGF5IiwgImZyZXF1ZW5jeSI6ICIzIiwgImN1c3RvbSI6ICIxLTAtMSJ9LCAiaW5zdHJ1Y3Rpb24iOiAiVGFrZSB0d2ljZSBhIGRheSIsICJpZCI6ICJsb2NhbGUtMmFiMWU5OGIxMzU4NzFhZjZjYjAxYjQ3MjE5NWNmZjQifV0sICJsYW5ndWFnZSI6ICJFTiJ9fQ=="

data.output.type

string

Type of template output

Example:

"eka_emr"

data.output.name

string

Human-readable name of the template

Example:

"EKA EMR Template"

data.output.status

enum<string>

Processing status of the template

Available options:

success,

partial_success,

failure

Example:

"success"

data.output.errors

string[]

Array of error messages if any

Example:

[]

data.output.warnings

string[]

Array of warning messages if any

Example:

[]

data.additional_data

object

Additional contextual data from the transaction

Example:

{
  "mode": "dictation",
  "doctor": { "_id": "174097180967921" },
  "visitid": "09e4f00f-d665-4212-b77c-b2dd5f22bd92_1742560488782"
}

Start Transcription Python sdk

⌘I

Authorization

End-to-End Encryption

Connect

HealthAI

Medical Database

General Tools

Doctor Tool

ABDM Connect

Medical Knowledge-bases

Medical Records

User App

HTTP Status Codes

Authorizations

Path Parameters

Response

Authorization

End-to-End Encryption

Connect

HealthAI

Medical Database

General Tools

Doctor Tool

ABDM Connect

Medical Knowledge-bases

Medical Records

User App

​HTTP Status Codes

Authorizations

Path Parameters

Response

HTTP Status Codes