🔗 Magic Links
Generate a secure, shareable link to allow others to view a transcription document—without requiring direct API authentication.
⚠️ Use the same API token that was used to create the original transcript session. Magic links are bound to the session-level authentication.
🔐 Required Authentication
| Header | Type | Required | Description |
|---|---|---|---|
Content-Type | string | ✅ | Must be application/json |
X-Zoom-S2T-Key | string | ✅ | Batch API token tied to the original session |
📥 Path Parameters
| Parameter | Description |
|---|---|
sessionId | The Transcript Session ID from the original batch job |
documentId | The Document ID from a Create or Get Document response |
🚀 Create a Magic Link
Endpoint
POST /api/v3/speech-to-text/session/{sessionId}/document/{documentId}/share
Example Response
{
"result": {
"link": "https://scriptix.app/shared/x/y/z"
}
}
✅ Response Codes
| Status Code | Description |
|---|---|
201 | Share link created successfully |
400 | Bad request – e.g., document already marked as finished |
401 | Unauthorized – invalid or missing API token |
403 | Forbidden – token does not have access to this document |
404 | Not found – the document doesn't exist or doesn't belong to the session |
🧠 Use Cases
- Share transcript results with collaborators
- Enable one-click viewing for clients or reviewers
- Provide external access without exposing API credentials
📘 Next Steps
- Overview – General document handling
- Translate – Translate transcripts into other languages
- CRUD Operations – Create, update, or delete documents
- Webhook Callback – Automate result processing