Share a Document
Use correct API token
Ensure that the correct API token is used for generating a share link. Only the token associated with the specific TranscriptSession can be used.
Generate a shareable link for a document, allowing others to access it without direct authentication.
URL: POST https://api.scriptix.io/api/v3/speech-to-text/session/${sessionId}/document/${documentId}/share
Request Headers
| 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 Get Document or Create Document |
Response Codes
| Status Code | Description |
|---|---|
| 201 | Share link created successfully |
| 400 | Bad request, e.g., document is already marked finished |
| 401 | Unauthorized, invalid authentication |
| 403 | Forbidden, access not allowed for the token provided |
| 404 | Document not found or does not belong to the session |
Responses
HTTP 201 Created
The share link is returned in the response body under the link key.
```json { "result": { "link": "https://scriptix.app/shared/x/y/z" } }