Transcripts
Read and edit the transcripts Shade creates for audio and video.
GET /assets/{asset_id}/transcription/utterancesreturns the transcript grouped by speaker, including any edits made in Shade.GET /assets/{asset_id}/transcription/fileexports the transcript assrt,vtt,txt, orscriptsync(for Avid ScriptSync).The workspace transcription dictionary teaches transcription the names and terms your team uses.
Get the transcription utterances for an asset if it exists
Your Shade API key, sent as-is with no Bearer prefix. Create one under
Settings → Integrate → API keys.
The asset to get the transcription for
c2d9e8f1-3b4a-4c5d-8e6f-7a8b9c0d1e2fThe id of the drive this asset is in
7b1e4d2c-5a6f-4e8b-9c3d-2f1a0b9c8d7eSuccessful Response
Not found
Validation Error
GET /assets/{asset_id}/transcription/utterances?drive_id=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: api.shade.inc
Authorization: YOUR_API_KEY
Accept: */*
{
"base_utterances": [
{
"speaker": "A",
"start": 0.48,
"end": 4.12,
"text": "We started Northwind because the gear we wanted didn't exist.",
"words": [
{
"start": 0.48,
"end": 0.66,
"text": "We"
},
{
"start": 0.66,
"end": 1.02,
"text": "started"
}
]
},
{
"speaker": "B",
"start": 4.9,
"end": 6.35,
"text": "And what made you choose this coastline?",
"words": [
{
"start": 4.9,
"end": 5.04,
"text": "And"
}
]
}
],
"edits": {}
}Your Shade API key, sent as-is with no Bearer prefix. Create one under
Settings → Integrate → API keys.
The asset to update transcription utterance edits for
c2d9e8f1-3b4a-4c5d-8e6f-7a8b9c0d1e2fThe id of the drive this asset is in
7b1e4d2c-5a6f-4e8b-9c3d-2f1a0b9c8d7e[]Successful Response
Not found
Validation Error
PUT /assets/{asset_id}/transcription/utterances/edits?drive_id=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: api.shade.inc
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 146
{
"upsert": {
"ANY_ADDITIONAL_PROPERTY": {
"speaker": "text",
"start": 1,
"end": 1,
"text": "text",
"words": [
{
"start": 1,
"end": 1,
"text": "text"
}
]
}
},
"remove": [
1
]
}{
"edits": {
"ANY_ADDITIONAL_PROPERTY": {
"speaker": "text",
"start": 1,
"end": 1,
"text": "text",
"words": [
{
"start": 1,
"end": 1,
"text": "text"
}
]
}
}
}Get the transcription segments for an asset if it exists
Your Shade API key, sent as-is with no Bearer prefix. Create one under
Settings → Integrate → API keys.
The asset to get the transcription for
c2d9e8f1-3b4a-4c5d-8e6f-7a8b9c0d1e2fThe id of the drive this asset is in
7b1e4d2c-5a6f-4e8b-9c3d-2f1a0b9c8d7eSuccessful Response
Not found
Validation Error
GET /assets/{asset_id}/transcription/segments?drive_id=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: api.shade.inc
Authorization: YOUR_API_KEY
Accept: */*
[
{
"start": 1,
"end": 1,
"text": "text"
}
]Your Shade API key, sent as-is with no Bearer prefix. Create one under
Settings → Integrate → API keys.
The asset to get the transcription for
c2d9e8f1-3b4a-4c5d-8e6f-7a8b9c0d1e2fThe id of the drive this asset is in
7b1e4d2c-5a6f-4e8b-9c3d-2f1a0b9c8d7eThe type of transcription to get
vttPossible values: Your API key, for clients that can't set headers, such as an <img> or <video> tag. Prefer the Authorization header, since URLs end up in logs and browser history.
Successful Response
Not found
Validation Error
GET /assets/{asset_id}/transcription/file?drive_id=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: api.shade.inc
Authorization: YOUR_API_KEY
Accept: */*
textRerun transcription for an asset. If the asset was previously completed with no dialogue, it will skip the dialogue classifier.
Your Shade API key, sent as-is with no Bearer prefix. Create one under
Settings → Integrate → API keys.
The id of the asset to rerun transcription for
c2d9e8f1-3b4a-4c5d-8e6f-7a8b9c0d1e2fThe id of the drive this asset is in
7b1e4d2c-5a6f-4e8b-9c3d-2f1a0b9c8d7eSuccess status
Not found
Validation Error
POST /assets/{asset_id}/transcription-override?drive_id=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: api.shade.inc
Authorization: YOUR_API_KEY
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "text"
}Your Shade API key, sent as-is with no Bearer prefix. Create one under
Settings → Integrate → API keys.
ID of the workspace. List yours with GET /workspaces.
3f6c2a1e-8d4b-4c2f-9a7e-1b5d6e7f8a90Successful Response
Not found
Validation Error
GET /workspaces/{workspace_id}/transcription-dictionary HTTP/1.1
Host: api.shade.inc
Authorization: YOUR_API_KEY
Accept: */*
[
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"term": "text"
}
]Your Shade API key, sent as-is with no Bearer prefix. Create one under
Settings → Integrate → API keys.
ID of the workspace. List yours with GET /workspaces.
3f6c2a1e-8d4b-4c2f-9a7e-1b5d6e7f8a90Successful Response
Not found
Validation Error
PUT /workspaces/{workspace_id}/transcription-dictionary HTTP/1.1
Host: api.shade.inc
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 59
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"term": "text"
}{
"id": "123e4567-e89b-12d3-a456-426614174000",
"term": "text"
}Your Shade API key, sent as-is with no Bearer prefix. Create one under
Settings → Integrate → API keys.
ID of the workspace. List yours with GET /workspaces.
3f6c2a1e-8d4b-4c2f-9a7e-1b5d6e7f8a90Successful Response
No content
Not found
Validation Error
DELETE /workspaces/{workspace_id}/transcription-dictionary/{term_id} HTTP/1.1
Host: api.shade.inc
Authorization: YOUR_API_KEY
Accept: */*
No content
Last updated
Was this helpful?

