End Session
EkaScribe APIs
End Session
Finalize the session and start asynchronous processing. After this call no further audio uploads are accepted. The server collects and orders all uploaded chunks, commits the session, and queues it for transcription and template extraction. Poll GET /voice/v1/sessions/{session_id} (or use a webhook) to retrieve results once processing completes.
POST
End Session
Finalize the session and start asynchronous processing. After this call, no further audio uploads are accepted for the session.
What happens server-side
Collect & order chunks
The server lists every audio file uploaded to the session and sorts them by sequence number (
0.webm, 1.webm, …).Commit the session
The session is committed (
user_status: commit) so it can no longer receive uploads.Queue for processing
A processing event is queued; transcription and template extraction run asynchronously.
Path parameters
| Parameter | Description |
|---|---|
session_id | The session_id returned by Create Session. |
Request fields
| Field | Type | Required | Description |
|---|---|---|---|
audio_files_sent | integer | Yes | Number of audio chunks/files the client sent. Used for validation against what the server received. |
Response fields
| Field | Type | Description |
|---|---|---|
session_id | string | The session identifier. |
status | string | Session status after ending — typically processing. |
message | string | Human-readable status message. |
audio_files_received | integer | Count of audio files the server received and stored. |
audio_files | string[] | Ordered list of stored audio files. |
Retrieving results
Processing is asynchronous. After receiving202 Accepted:
- Poll
GET /voice/v1/sessions/{session_id}untilstatusiscompleted. Status codes mirror processing state —202(in progress),200(completed),206(partial),410(expired). - Or register a webhook to be notified automatically when processing completes.
transcript and the structured templates results for the template IDs requested at session creation.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Session ID returned by Create Session
Example:
"ses_abc123def456"
Body
application/json
Number of audio chunks/files the client sent, used for validation.
Required range:
x >= 0Example:
3

