> ## Documentation Index
> Fetch the complete documentation index at: https://developer.eka.care/llms.txt
> Use this file to discover all available pages before exploring further.
# Transcription Result
> Retrieve the status and results of a transcription session using the session ID. This endpoint provides comprehensive information about the transcription process including:
- Current processing status
- Structured output data when available
- Template-specific results and status
- Error and warning details
The API implements intelligent polling to wait for completion and returns different HTTP status codes based on the processing outcome.
This API is deprecated. Please use the new [EkaScribe Protocol APIs](/api-reference/health-ai/ekascribe/protocol/overview) (Create Session → Upload Audio → End Session) or the [SDKs](/api-reference/health-ai/ekascribe/quick-start) instead.
## 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 |
## OpenAPI
````yaml GET /voice/api/v3/status/{txn_id}
openapi: 3.0.1
info:
title: EkaScribe Voice API v2
version: '2024-12-01T12:09:09Z'
description: >-
EkaScribe Voice-to-Prescription API for medical transcription and structured
data generation
servers:
- url: https://api.eka.care
description: Production server
- url: https://api.dev.eka.care
description: Development server
security: []
paths:
/voice/api/v3/status/{txn_id}:
get:
summary: Transaction Result
description: >
Retrieve the status and results of a transcription session using the
session ID. This endpoint provides comprehensive information about the
transcription process including:
- Current processing status
- Structured output data when available
- Template-specific results and status
- Error and warning details
The API implements intelligent polling to wait for completion and
returns different HTTP status codes based on the processing outcome.
parameters:
- name: txn_id
in: path
required: true
description: Unique Transaction ID - same as passed in presigned URL request
schema:
type: string
example: test_1234
responses:
'200':
description: All templates processed successfully
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
output:
type: array
description: Array of processed template results
items:
type: object
properties:
template_id:
type: string
description: Unique identifier for the template
example: eka_emr_template
value:
type: string
description: Structured output data from the template
additionalProperties: true
example: >-
eyJwcmVzY3JpcHRpb24iOiB7Im1lZGljYXRpb25zIjogW3sibmFtZSI6ICJkb2xvIiwgImZyZXF1ZW5jeSI6IHsicGF0dGVybl9pZCI6ICJmcC0xIiwgImRvc2UiOiBbIjEiLCAiMCIsICIxIl0sICJwZXJpb2QiOiAxLCAicGVyaW9kX3VuaXQiOiAiZGF5IiwgImZyZXF1ZW5jeSI6ICIzIiwgImN1c3RvbSI6ICIxLTAtMSJ9LCAiaW5zdHJ1Y3Rpb24iOiAiVGFrZSB0d2ljZSBhIGRheSIsICJpZCI6ICJsb2NhbGUtMmFiMWU5OGIxMzU4NzFhZjZjYjAxYjQ3MjE5NWNmZjQifV0sICJsYW5ndWFnZSI6ICJFTiJ9fQ==
type:
type: string
description: Type of template output
example: eka_emr
name:
type: string
description: Human-readable name of the template
example: EKA EMR Template
status:
type: string
enum:
- success
- partial_success
- failure
description: Processing status of the template
example: success
errors:
type: array
description: Array of error messages if any
items:
type: string
example: []
warnings:
type: array
description: Array of warning messages if any
items:
type: string
example: []
additional_data:
type: object
description: Additional contextual data from the transaction
additionalProperties: true
example:
mode: dictation
doctor:
_id: '174097180967921'
visitid: 09e4f00f-d665-4212-b77c-b2dd5f22bd92_1742560488782
'202':
description: Transaction is still in progress - continue polling
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
output:
type: array
description: Empty array when processing is in progress
items: {}
example: []
additional_data:
type: object
description: Additional contextual data from the transaction
additionalProperties: true
'206':
description: >-
Partial success - some templates succeeded, others failed or
partially succeeded
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
output:
type: array
description: >-
Array of processed template results with mixed
statuses
items:
type: object
properties:
template_id:
type: string
example: eka_emr_template
value:
type: string
example: ''
type:
type: string
example: eka_emr
name:
type: string
example: EKA EMR Template
status:
type: string
enum:
- success
- partial_success
- failure
example: partial_success
errors:
type: array
items:
type: string
example:
- Unable to extract medication dosage
warnings:
type: array
items:
type: string
example:
- Low confidence in diagnosis section
additional_data:
type: object
additionalProperties: true
'400':
description: Bad Request - Transaction not found or request failure
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
enum:
- missing_business_id
- transaction_not_found
example: transaction_not_found
msg:
type: string
example: Transaction doesn't exist
'401':
description: Unauthorized - Invalid or missing authentication token
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: Unauthorized
message:
type: string
example: Invalid or missing authentication token
'500':
description: Internal Server Error - System failure or all templates failed
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
enum:
- system_error
- output_not_available
example: system_error
msg:
type: string
example: Error in generating output file
security:
- auth: []
components:
securitySchemes:
auth:
type: http
scheme: bearer
bearerFormat: JWT
description: >-
Bearer authentication header of the form `Bearer `, where
`` is your auth token.
````