Skip to content

Retrieving results

Having an active session vs creating one automatically

You can use V1 if you want control over creating session id and sending it as metadata key session_id when uploading the file. Otherwise, if you just upload the file session id is going to be created automatically.

Retrieving results has not been changed

Retrieving results has not been changed from the previous version of the API.

Use correct API token

It is impodent that the correct API token is used for retrieval of results. And only the token which was used for creating and uploading can be used for retrieval.

From the response you get in the Location header from TUS upload you can make a get request and it will return the metadata along with the session_id

URL: GET https://api.scriptix.io/api/v3/files/${fileId} #This comes from tus upload complete, and it is used to get the metadata for the file

You then make a new request with the response from metadata read:

URL: GET https://api.scriptix.io/api/v3/speech-to-text/session/${sessionId}/result

Request headers

The following headers need to be present

Parameter Value Description
x-zoom-s2t-key Scriptix Batch API Token API key of type batch needed for authorization

Response codes

Status code Description Payload
200 New session initialized
400 Bad parameter
401 Unauthorized
415 Content Invalid
422 Body Invalid
500 Server Error

Responses

application/json from reading metadata to get session_id

{
  "count": 1,
  "total_results": 1,
  "result": {
    "session_id": "1b8a70f1000001000002d1a37b",
    "metadata": {
      "language": "en",
      "document_type": "caption",
      "filetype": "video/mp4",
      "filename": "test3.mp4",
      "folder_id": "null"
    }
  }
}

application/json querying session information after getting session id

{
    "count": 1,
    "total_results": 1,
    "result": {
        "duration": 592,
        "error": null or "error",
        "filename": "media.mp3",
        "media_type": "audio" or "video",
        "media_url": null or "https://example.com/media.mp3",
        "session_id": "49b5b257000004000006ccdfc8",
        "status": "done",
        "results": [
            {
                "result": [
                    [
                        "word",
                        time_start,
                        time_end,
                        confidence
                    ]
                ],
                "speaker": "unk",
                "text": "word",
                "sconf": 0.85,
                "channel": 0
            }
        ]
    }
}