> For the complete documentation index, see [llms.txt](https://academy.shade.inc/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://academy.shade.inc/developers/files-and-assets/transcripts.md).

# 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 the transcription utterances for an asset if it exists

```json
{"openapi":"3.1.0","info":{"title":"Shade API","version":"dev"},"tags":[{"name":"transcripts","description":"Read and edit the transcripts Shade creates for audio and video.\n\n* `GET /assets/{asset_id}/transcription/utterances` returns the transcript\n  grouped by speaker, including any edits made in Shade.\n* `GET /assets/{asset_id}/transcription/file` exports the transcript as\n  `srt`, `vtt`, `txt`, or `scriptsync` (for Avid ScriptSync).\n* The workspace transcription dictionary teaches transcription the names and\n  terms your team uses."}],"servers":[{"url":"https://api.shade.inc","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Your Shade API key, sent as-is with no `Bearer` prefix. Create one under\n**Settings → Integrate → API keys**.\n"}},"schemas":{"TranscriptionUtteranceWithEditsDTO":{"properties":{"base_utterances":{"items":{"$ref":"#/components/schemas/TranscriptionUtteranceDTO"},"type":"array","title":"Base Utterances"},"edits":{"$ref":"#/components/schemas/UtteranceEdits-Output"}},"type":"object","required":["base_utterances","edits"],"title":"TranscriptionUtteranceWithEditsDTO"},"TranscriptionUtteranceDTO":{"properties":{"speaker":{"type":"string","title":"Speaker"},"start":{"type":"number","title":"Start"},"end":{"type":"number","title":"End"},"text":{"type":"string","title":"Text"},"words":{"items":{"$ref":"#/components/schemas/TranscriptionSegmentDTO"},"type":"array","title":"Words"}},"type":"object","required":["speaker","start","end","text","words"],"title":"TranscriptionUtteranceDTO"},"TranscriptionSegmentDTO":{"properties":{"start":{"type":"number","title":"Start"},"end":{"type":"number","title":"End"},"text":{"type":"string","title":"Text"}},"type":"object","required":["start","end","text"],"title":"TranscriptionSegmentDTO"},"UtteranceEdits-Output":{"additionalProperties":{"$ref":"#/components/schemas/TranscriptionUtteranceDTO"},"type":"object"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/assets/{asset_id}/transcription/utterances":{"get":{"tags":["transcripts"],"summary":"Get the transcription utterances for an asset if it exists","description":"Get the transcription utterances for an asset if it exists","operationId":"getTranscriptionUtterancesWithEdits","parameters":[{"name":"asset_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The asset id","description":"The asset to get the transcription for"},"description":"The asset to get the transcription for"},{"name":"drive_id","in":"query","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id","description":"The id of the drive this asset is in"},"description":"The id of the drive this asset is in"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/TranscriptionUtteranceWithEditsDTO"},{"type":"null"}]}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## PUT /assets/{asset\_id}/transcription/utterances/edits

> Bulk upsert or remove transcription utterance edits for an asset

```json
{"openapi":"3.1.0","info":{"title":"Shade API","version":"dev"},"tags":[{"name":"transcripts","description":"Read and edit the transcripts Shade creates for audio and video.\n\n* `GET /assets/{asset_id}/transcription/utterances` returns the transcript\n  grouped by speaker, including any edits made in Shade.\n* `GET /assets/{asset_id}/transcription/file` exports the transcript as\n  `srt`, `vtt`, `txt`, or `scriptsync` (for Avid ScriptSync).\n* The workspace transcription dictionary teaches transcription the names and\n  terms your team uses."}],"servers":[{"url":"https://api.shade.inc","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Your Shade API key, sent as-is with no `Bearer` prefix. Create one under\n**Settings → Integrate → API keys**.\n"}},"schemas":{"TranscriptionUtteranceEditsUpdateDTO":{"properties":{"upsert":{"$ref":"#/components/schemas/UtteranceEdits-Input","default":{}},"remove":{"items":{"type":"integer"},"type":"array","title":"Remove","default":[]}},"type":"object","title":"TranscriptionUtteranceEditsUpdateDTO"},"UtteranceEdits-Input":{"additionalProperties":{"$ref":"#/components/schemas/TranscriptionUtteranceDTO"},"type":"object"},"TranscriptionUtteranceDTO":{"properties":{"speaker":{"type":"string","title":"Speaker"},"start":{"type":"number","title":"Start"},"end":{"type":"number","title":"End"},"text":{"type":"string","title":"Text"},"words":{"items":{"$ref":"#/components/schemas/TranscriptionSegmentDTO"},"type":"array","title":"Words"}},"type":"object","required":["speaker","start","end","text","words"],"title":"TranscriptionUtteranceDTO"},"TranscriptionSegmentDTO":{"properties":{"start":{"type":"number","title":"Start"},"end":{"type":"number","title":"End"},"text":{"type":"string","title":"Text"}},"type":"object","required":["start","end","text"],"title":"TranscriptionSegmentDTO"},"TranscriptionUtteranceEditsDTO":{"properties":{"edits":{"$ref":"#/components/schemas/UtteranceEdits-Output"}},"type":"object","required":["edits"],"title":"TranscriptionUtteranceEditsDTO"},"UtteranceEdits-Output":{"additionalProperties":{"$ref":"#/components/schemas/TranscriptionUtteranceDTO"},"type":"object"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/assets/{asset_id}/transcription/utterances/edits":{"put":{"tags":["transcripts"],"summary":"Bulk upsert or remove transcription utterance edits for an asset","operationId":"updateTranscriptionUtteranceEdits","parameters":[{"name":"asset_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The asset id","description":"The asset to update transcription utterance edits for"},"description":"The asset to update transcription utterance edits for"},{"name":"drive_id","in":"query","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id","description":"The id of the drive this asset is in"},"description":"The id of the drive this asset is in"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranscriptionUtteranceEditsUpdateDTO"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranscriptionUtteranceEditsDTO"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## Get the transcription segments for an asset if it exists

> Get the transcription segments for an asset if it exists

```json
{"openapi":"3.1.0","info":{"title":"Shade API","version":"dev"},"tags":[{"name":"transcripts","description":"Read and edit the transcripts Shade creates for audio and video.\n\n* `GET /assets/{asset_id}/transcription/utterances` returns the transcript\n  grouped by speaker, including any edits made in Shade.\n* `GET /assets/{asset_id}/transcription/file` exports the transcript as\n  `srt`, `vtt`, `txt`, or `scriptsync` (for Avid ScriptSync).\n* The workspace transcription dictionary teaches transcription the names and\n  terms your team uses."}],"servers":[{"url":"https://api.shade.inc","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Your Shade API key, sent as-is with no `Bearer` prefix. Create one under\n**Settings → Integrate → API keys**.\n"}},"schemas":{"TranscriptionSegmentDTO":{"properties":{"start":{"type":"number","title":"Start"},"end":{"type":"number","title":"End"},"text":{"type":"string","title":"Text"}},"type":"object","required":["start","end","text"],"title":"TranscriptionSegmentDTO"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/assets/{asset_id}/transcription/segments":{"get":{"tags":["transcripts"],"summary":"Get the transcription segments for an asset if it exists","description":"Get the transcription segments for an asset if it exists","operationId":"getTranscriptionSegments","parameters":[{"name":"asset_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The asset id","description":"The asset to get the transcription for"},"description":"The asset to get the transcription for"},{"name":"drive_id","in":"query","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id","description":"The id of the drive this asset is in"},"description":"The id of the drive this asset is in"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/TranscriptionSegmentDTO"}},{"type":"null"}]}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## GET /assets/{asset\_id}/transcription/file

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

```json
{"openapi":"3.1.0","info":{"title":"Shade API","version":"dev"},"tags":[{"name":"transcripts","description":"Read and edit the transcripts Shade creates for audio and video.\n\n* `GET /assets/{asset_id}/transcription/utterances` returns the transcript\n  grouped by speaker, including any edits made in Shade.\n* `GET /assets/{asset_id}/transcription/file` exports the transcript as\n  `srt`, `vtt`, `txt`, or `scriptsync` (for Avid ScriptSync).\n* The workspace transcription dictionary teaches transcription the names and\n  terms your team uses."}],"servers":[{"url":"https://api.shade.inc","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Your Shade API key, sent as-is with no `Bearer` prefix. Create one under\n**Settings → Integrate → API keys**.\n"}},"schemas":{"TranscriptionOutput":{"type":"string","enum":["srt","scriptsync","vtt","txt"],"title":"TranscriptionOutput"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/assets/{asset_id}/transcription/file":{"get":{"tags":["transcripts"],"summary":"Export the transcription as a file for an asset if it exists","operationId":"exportTranscription","parameters":[{"name":"asset_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The asset id","description":"The asset to get the transcription for"},"description":"The asset to get the transcription for"},{"name":"drive_id","in":"query","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id","description":"The id of the drive this asset is in"},"description":"The id of the drive this asset is in"},{"name":"type","in":"query","required":false,"schema":{"$ref":"#/components/schemas/TranscriptionOutput","title":"Type","description":"The type of transcription to get","default":"vtt"},"description":"The type of transcription to get"},{"name":"authorization","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The authorization token"},"description":"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":{"description":"Successful Response","content":{"application/octet-stream":{"schema":{"type":"string"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## Rerun transcription for an asset

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

```json
{"openapi":"3.1.0","info":{"title":"Shade API","version":"dev"},"tags":[{"name":"transcripts","description":"Read and edit the transcripts Shade creates for audio and video.\n\n* `GET /assets/{asset_id}/transcription/utterances` returns the transcript\n  grouped by speaker, including any edits made in Shade.\n* `GET /assets/{asset_id}/transcription/file` exports the transcript as\n  `srt`, `vtt`, `txt`, or `scriptsync` (for Avid ScriptSync).\n* The workspace transcription dictionary teaches transcription the names and\n  terms your team uses."}],"servers":[{"url":"https://api.shade.inc","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Your Shade API key, sent as-is with no `Bearer` prefix. Create one under\n**Settings → Integrate → API keys**.\n"}},"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/assets/{asset_id}/transcription-override":{"post":{"tags":["transcripts"],"summary":"Rerun transcription for an asset","description":"Rerun transcription for an asset. If the asset was previously completed with no dialogue, it will skip the dialogue classifier.","operationId":"rerunTranscription","parameters":[{"name":"asset_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The asset id","description":"The id of the asset to rerun transcription for"},"description":"The id of the asset to rerun transcription for"},{"name":"drive_id","in":"query","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id","description":"The id of the drive this asset is in"},"description":"The id of the drive this asset is in"}],"responses":{"200":{"description":"Success status","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"string"}}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## GET /workspaces/{workspace\_id}/transcription-dictionary

> List transcription dictionary terms for a workspace

```json
{"openapi":"3.1.0","info":{"title":"Shade API","version":"dev"},"tags":[{"name":"transcripts","description":"Read and edit the transcripts Shade creates for audio and video.\n\n* `GET /assets/{asset_id}/transcription/utterances` returns the transcript\n  grouped by speaker, including any edits made in Shade.\n* `GET /assets/{asset_id}/transcription/file` exports the transcript as\n  `srt`, `vtt`, `txt`, or `scriptsync` (for Avid ScriptSync).\n* The workspace transcription dictionary teaches transcription the names and\n  terms your team uses."}],"servers":[{"url":"https://api.shade.inc","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Your Shade API key, sent as-is with no `Bearer` prefix. Create one under\n**Settings → Integrate → API keys**.\n"}},"schemas":{"TranscriptionDictionaryTermDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"term":{"type":"string","title":"Term"}},"type":"object","required":["id","term"],"title":"TranscriptionDictionaryTermDTO"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/workspaces/{workspace_id}/transcription-dictionary":{"get":{"tags":["transcripts"],"summary":"List transcription dictionary terms for a workspace","operationId":"listTranscriptionDictionaryTerms","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The workspace id"},"description":"ID of the workspace. List yours with `GET /workspaces`."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TranscriptionDictionaryTermDTO"}}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## PUT /workspaces/{workspace\_id}/transcription-dictionary

> Create or update a transcription dictionary term

```json
{"openapi":"3.1.0","info":{"title":"Shade API","version":"dev"},"tags":[{"name":"transcripts","description":"Read and edit the transcripts Shade creates for audio and video.\n\n* `GET /assets/{asset_id}/transcription/utterances` returns the transcript\n  grouped by speaker, including any edits made in Shade.\n* `GET /assets/{asset_id}/transcription/file` exports the transcript as\n  `srt`, `vtt`, `txt`, or `scriptsync` (for Avid ScriptSync).\n* The workspace transcription dictionary teaches transcription the names and\n  terms your team uses."}],"servers":[{"url":"https://api.shade.inc","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Your Shade API key, sent as-is with no `Bearer` prefix. Create one under\n**Settings → Integrate → API keys**.\n"}},"schemas":{"UpsertTranscriptionDictionaryTermRequest":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id"},"term":{"type":"string","minLength":1,"title":"Term"}},"type":"object","required":["term"],"title":"UpsertTranscriptionDictionaryTermRequest"},"TranscriptionDictionaryTermDTO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"term":{"type":"string","title":"Term"}},"type":"object","required":["id","term"],"title":"TranscriptionDictionaryTermDTO"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/workspaces/{workspace_id}/transcription-dictionary":{"put":{"tags":["transcripts"],"summary":"Create or update a transcription dictionary term","operationId":"upsertTranscriptionDictionaryTerm","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The workspace id"},"description":"ID of the workspace. List yours with `GET /workspaces`."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertTranscriptionDictionaryTermRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranscriptionDictionaryTermDTO"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## DELETE /workspaces/{workspace\_id}/transcription-dictionary/{term\_id}

> Delete a transcription dictionary term

```json
{"openapi":"3.1.0","info":{"title":"Shade API","version":"dev"},"tags":[{"name":"transcripts","description":"Read and edit the transcripts Shade creates for audio and video.\n\n* `GET /assets/{asset_id}/transcription/utterances` returns the transcript\n  grouped by speaker, including any edits made in Shade.\n* `GET /assets/{asset_id}/transcription/file` exports the transcript as\n  `srt`, `vtt`, `txt`, or `scriptsync` (for Avid ScriptSync).\n* The workspace transcription dictionary teaches transcription the names and\n  terms your team uses."}],"servers":[{"url":"https://api.shade.inc","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Your Shade API key, sent as-is with no `Bearer` prefix. Create one under\n**Settings → Integrate → API keys**.\n"}},"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/workspaces/{workspace_id}/transcription-dictionary/{term_id}":{"delete":{"tags":["transcripts"],"summary":"Delete a transcription dictionary term","operationId":"removeTranscriptionDictionaryTerm","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The workspace id"},"description":"ID of the workspace. List yours with `GET /workspaces`."},{"name":"term_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The dictionary term id"}}],"responses":{"204":{"description":"Successful Response"},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://academy.shade.inc/developers/files-and-assets/transcripts.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
