CRUD Operations
This page covers how to create ✏️, update 🔄, and remove 🗑️ transcription documents using the Scriptix API. All document operations are currently in BETA and may change without notice.
✏️ Create a New Document
Documents are currently in BETA and the API interface may change when this is deemed necessary.
Create a new document from a TranscriptSession result.
Use Correct API Token
Only the token linked to the TranscriptSession can be used for document creation.
Endpoint
POST
https://api.scriptix.io/api/v3/speech-to-text/session/${sessionId}/document/
Request Headers
| Parameter | Value | Description |
|---|---|---|
| X-Zoom-S2T-Key | Scriptix Batch API Token | API key belonging to the TranscriptSession |
Request Path Arguments
| Argument | Description |
|---|---|
| sessionId | Scriptix Transcript Session ID from a Batch Session |
Realtime sessions do not store results, so documents cannot be created for them.
JSON Body Schema
| Key | Type / Enum | Description |
|---|---|---|
| document_type | "caption" | "document" | Document type. See Document Types. |
| filename | string[200] | Name for the document. |
| max_line_length | integer / null | Max characters per line (caption only). |
| max_line_words | integer / null | Max words per line (caption only). |
| max_segment_duration | integer / null | Max segment duration in ms (caption only). |
| max_segment_lines | integer / null | Max lines per segment (caption only). |
| max_segment_words | integer / null | Max words per segment (caption only). |
| max_silence_between_words | integer / null | Max silence between words in ms (caption only). |
| min_segment_gap | integer | Min gap between segments in ms (caption only). |
| webhook_headers | string[] | Extra callback headers. Requires webhook_url. |
| webhook_method | POST | PUT | Callback HTTP method. Defaults to POST. |
| webhook_url | string | Callback URL after processing. |
Response Codes
| Status | Description |
|---|---|
| 201 | Document created |
| 400 | Bad request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Session not found or invalid token |
🔄 Update a Document
Documents are currently in BETA and the API interface may change when this is deemed necessary.
Update an existing document with corrected transcripts from your own editor. This can be used for custom model enhancement.
Use Correct API Token
Only the token linked to the TranscriptSession can be used for document updates.
Endpoint
PUT
https://api.scriptix.io/api/v3/speech-to-text/session/${sessionId}/document/${documentId}
Request Headers
| Parameter | Value | Description |
|---|---|---|
| X-Zoom-S2T-Key | Scriptix Batch API Token | API key belonging to the TranscriptSession |
Request Path Arguments
| Argument | Description |
|---|---|
| sessionId | Scriptix Transcript Session ID from a Batch Session |
| documentId | Scriptix Document ID returned when creating the document |
JSON Body Schema
| Key | Type | Description |
|---|---|---|
| document_type | DocumentSegment[] | Updated document content |
| filename | string[200] | New document name |
Response Codes
| Status | Description |
|---|---|
| 201 | Document updated |
| 400 | Bad request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Session not found or invalid token |
Example Response
{
"result": {
"id": "12780b54-5575-44e4-bbca-0a410b432183",
"created": "2021-01-25T10:31:46.960411+00:00",
"last_modified": "2021-01-25T16:31:46.960411+00:00",
"filename": "Example document",
"type": "caption"
}
}
🗑️ Remove a Document
Documents are currently in BETA and the API interface may change when this is deemed necessary.
Removes a document file from our systems. Note: This does not delete the transcript session.
Use Correct API Token
Only the token used for creating and uploading the document can be used for removal.
Endpoint
DELETE
https://api.scriptix.io/api/v3/speech-to-text/session/${sessionId}/document/${documentId}
Request Headers
| Parameter | Value | Description |
|---|---|---|
| X-Zoom-S2T-Key | Scriptix Batch API Token | API key belonging to the TranscriptSession |
Response Codes
| Status Code | Description |
|---|---|
| 204 | Document removed |
| 400 | Bad request |
| 401 | Unauthorized, no valid authentication |
| 403 | Forbidden, access not allowed |
| 404 | Transcript session not found or does not belong to provided API token |