Skip to main content
POST
/
api
/
createTranscription
Create a new transcription job
curl --request POST \
  --url https://app.xosum.am/api/api/createTranscription \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "single_voice",
  "metadata": {
    "phonenumber": "+37400000000",
    "agent": "King Ruzi"
  },
  "checklistId": "a1B2c3D4e5F6g7H8i9J0"
}
'
{
  "docId": "<string>",
  "uploadUrl": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
type
enum<string>
required

The type of audio to be transcribed. Use single_voice for monologues, phone_call for conversations.

Available options:
single_voice,
phone_call
​
metadata
object

Optional metadata to attach to the transcription (e.g., user IDs, external info).

Example:
{
  "phonenumber": "+37400000000",
  "agent": "King Ruzi"
}
​
checklistId
string

Optional. The ID of a QA Checklist to run an automated analysis on the transcript. You can find the Checklist ID in the "QA Ստուգացուցակներ" (QA Checklists) section of the Xosum.am web app. The results of the analysis will be available in the "History" page of the web app after the transcription is complete.

Example:

"a1B2c3D4e5F6g7H8i9J0"

Response

Successfully created transcription job and received an upload URL.

​
docId
string

Unique ID for the created transcription job.

​
uploadUrl
string<uri>

A pre-signed URL for uploading the .mp3 audio file using a PUT request. This URL is valid for 1 hour.