Skip to content

Commit

Permalink
Add delete transcription doc (#560)
Browse files Browse the repository at this point in the history
  • Loading branch information
yaziine authored May 14, 2024
2 parents 51881e0 + 87db9a5 commit 3a920cd
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -90,9 +90,7 @@ curl "https://video.stream-io-api.com/api/v2/video/call/${CALL_TYPE}/${CALL_ID}/
This endpoint allows to delete call recording.
Please note that recordings will be deleted only if they are stored on Stream side (default).

An error will be returned if:
- the recording doesn't exist
- the recording is not stored on Stream S3 bucket
An error will be returned if the recording doesn't exist.

<Tabs groupId="examples">
<TabItem value="js" label="JavaScript">
Expand All @@ -112,8 +110,8 @@ call.delete_recording(sessionID, filename)
<TabItem value="curl" label="cURL">

```bash
curl -X DELETE "https://video.stream-io-api.com/video/call/${CALL_TYPE}/${CALL_ID}/${SESSION_ID}/${FILENAME}?api_key=${API_KEY}" \
-H "Authorization: ${TOKEN}" \
curl -X DELETE "https://video.stream-io-api.com/video/call/${CALL_TYPE}/${CALL_ID}/${SESSION_ID}/recordings/${FILENAME}?api_key=${API_KEY}" \
-H "Authorization: ${JWT_TOKEN}" \
-H "stream-auth-type: jwt"
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,39 @@ curl "https://video.stream-io-api.com/api/v2/video/call/default/${CALL_ID}/trans
</TabItem>
</Tabs>

## Delete call transcription

This endpoint allows to delete call transcription.
Please note that transcriptions will be deleted only if they are stored on Stream side (default).

An error will be returned if the transcription doesn't exist.

<Tabs groupId="examples">
<TabItem value="js" label="JavaScript">

```js
call.deleteTranscription(sessionID, filename);
```

</TabItem>
<TabItem value="py" label="Python">

```py
call.delete_transcription(sessionID, filename)
```

</TabItem>
<TabItem value="curl" label="cURL">

```bash
curl -X DELETE "https://video.stream-io-api.com/video/call/${CALL_TYPE}/${CALL_ID}/${SESSION_ID}/transcriptions/${FILENAME}?api_key=${API_KEY}" \
-H "Authorization: ${JWT_TOKEN}" \
-H "stream-auth-type: jwt"
```

</TabItem>
</Tabs>

## Events

These events are sent to users connected to the call and your webhook/SQS:
Expand Down

0 comments on commit 3a920cd

Please sign in to comment.