For the complete documentation index, see llms.txt. This page is also available as Markdown.

Transcripts

Read and edit the transcripts Shade creates for audio and video.

  • GET /assets/{asset_id}/transcription/utterances returns the transcript grouped by speaker, including any edits made in Shade.

  • GET /assets/{asset_id}/transcription/file exports the transcript as srt, vtt, txt, or scriptsync (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

get

Get the transcription utterances for an asset if it exists

Authorizations
AuthorizationstringRequired

Your Shade API key, sent as-is with no Bearer prefix. Create one under Settings → Integrate → API keys.

Path parameters
asset_idstring · uuidRequired

The asset to get the transcription for

Example: c2d9e8f1-3b4a-4c5d-8e6f-7a8b9c0d1e2f
Query parameters
drive_idstring · uuidRequired

The id of the drive this asset is in

Example: 7b1e4d2c-5a6f-4e8b-9c3d-2f1a0b9c8d7e
Responses
200

Successful Response

application/json
get/assets/{asset_id}/transcription/utterances
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": {}
}

Bulk upsert or remove transcription utterance edits for an asset

put
Authorizations
AuthorizationstringRequired

Your Shade API key, sent as-is with no Bearer prefix. Create one under Settings → Integrate → API keys.

Path parameters
asset_idstring · uuidRequired

The asset to update transcription utterance edits for

Example: c2d9e8f1-3b4a-4c5d-8e6f-7a8b9c0d1e2f
Query parameters
drive_idstring · uuidRequired

The id of the drive this asset is in

Example: 7b1e4d2c-5a6f-4e8b-9c3d-2f1a0b9c8d7e
Body
removeinteger[]OptionalDefault: []
Responses
200

Successful Response

application/json
put/assets/{asset_id}/transcription/utterances/edits
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

get

Get the transcription segments for an asset if it exists

Authorizations
AuthorizationstringRequired

Your Shade API key, sent as-is with no Bearer prefix. Create one under Settings → Integrate → API keys.

Path parameters
asset_idstring · uuidRequired

The asset to get the transcription for

Example: c2d9e8f1-3b4a-4c5d-8e6f-7a8b9c0d1e2f
Query parameters
drive_idstring · uuidRequired

The id of the drive this asset is in

Example: 7b1e4d2c-5a6f-4e8b-9c3d-2f1a0b9c8d7e
Responses
200

Successful Response

application/json
startnumberRequired
endnumberRequired
textstringRequired
get/assets/{asset_id}/transcription/segments
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"
  }
]

Export the transcription as a file for an asset if it exists

get
Authorizations
AuthorizationstringRequired

Your Shade API key, sent as-is with no Bearer prefix. Create one under Settings → Integrate → API keys.

Path parameters
asset_idstring · uuidRequired

The asset to get the transcription for

Example: c2d9e8f1-3b4a-4c5d-8e6f-7a8b9c0d1e2f
Query parameters
drive_idstring · uuidRequired

The id of the drive this asset is in

Example: 7b1e4d2c-5a6f-4e8b-9c3d-2f1a0b9c8d7e
typestring · enumOptional

The type of transcription to get

Default: vttPossible values:
authorizationstring · nullableOptional

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.

Responses
200

Successful Response

application/octet-stream
stringOptional
get/assets/{asset_id}/transcription/file
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: */*
text

Rerun transcription for an asset

post

Rerun transcription for an asset. If the asset was previously completed with no dialogue, it will skip the dialogue classifier.

Authorizations
AuthorizationstringRequired

Your Shade API key, sent as-is with no Bearer prefix. Create one under Settings → Integrate → API keys.

Path parameters
asset_idstring · uuidRequired

The id of the asset to rerun transcription for

Example: c2d9e8f1-3b4a-4c5d-8e6f-7a8b9c0d1e2f
Query parameters
drive_idstring · uuidRequired

The id of the drive this asset is in

Example: 7b1e4d2c-5a6f-4e8b-9c3d-2f1a0b9c8d7e
Responses
200

Success status

application/json
Other propertiesstringOptional
post/assets/{asset_id}/transcription-override
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"
}

List transcription dictionary terms for a workspace

get
Authorizations
AuthorizationstringRequired

Your Shade API key, sent as-is with no Bearer prefix. Create one under Settings → Integrate → API keys.

Path parameters
workspace_idstring · uuidRequired

ID of the workspace. List yours with GET /workspaces.

Example: 3f6c2a1e-8d4b-4c2f-9a7e-1b5d6e7f8a90
Responses
200

Successful Response

application/json
idstring · uuidRequired
termstringRequired
get/workspaces/{workspace_id}/transcription-dictionary
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"
  }
]

Create or update a transcription dictionary term

put
Authorizations
AuthorizationstringRequired

Your Shade API key, sent as-is with no Bearer prefix. Create one under Settings → Integrate → API keys.

Path parameters
workspace_idstring · uuidRequired

ID of the workspace. List yours with GET /workspaces.

Example: 3f6c2a1e-8d4b-4c2f-9a7e-1b5d6e7f8a90
Body
idstring · uuid · nullableOptional
termstring · min: 1Required
Responses
200

Successful Response

application/json
idstring · uuidRequired
termstringRequired
put/workspaces/{workspace_id}/transcription-dictionary
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"
}

Delete a transcription dictionary term

delete
Authorizations
AuthorizationstringRequired

Your Shade API key, sent as-is with no Bearer prefix. Create one under Settings → Integrate → API keys.

Path parameters
workspace_idstring · uuidRequired

ID of the workspace. List yours with GET /workspaces.

Example: 3f6c2a1e-8d4b-4c2f-9a7e-1b5d6e7f8a90
term_idstring · uuidRequired
Responses
204

Successful Response

No content

delete/workspaces/{workspace_id}/transcription-dictionary/{term_id}
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?