Update a document
Info
Documents are currently in BETA and the API interface may change when this is deemed necessary.
It is possible to update the document from your own systems. This makes it possible to create your own editor while providing us with corrected transcripts which can be used for custom model enhancement.
Use correct API token
It is impodent that the correct API token is used for document creation. Only the token linked to the TranscriptSession can be used.
URL: PUT https://api.scriptix.io/api/v3/speech-to-text/session/${sessionId}/document/${documentId}
Request headers
The following headers need to be present
| Parameter | Value | Description |
|---|---|---|
| Content-Type | application/json | |
| X-Zoom-S2T-Key | Scriptix Batch API Token | API key belonging to TranscriptSession |
Request path arguments
| Argument | Description |
|---|---|
| sessionId | Scriptix Transcript Session ID returned from a Batch Session |
| documentId | Scriptix Document ID returned from creating a document |
JSON Body Schema
| Key | Type | Description |
|---|---|---|
| document_type | DocumentSegment[] | Update the document content with supplied data |
| filename | string[200] |
Rename the document |
Responses codes
| Description | |
|---|---|
| 201 | Document updated |
| 400 | Bad request, JSON payload may be invalid |
| 401 | Unauthorized, no valid authentication found |
| 403 | Forbidden, access to resource is not allowed |
| 404 | Not found, the transcript session is not found or does not belong to the provided API token |
Responses
HTTP 201 Updated
Content-type: application/json
Response: APIResultResponse<DocumentModel>
JSON 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"
}
}