fn list_videos(status?: string, creator?: string, type?: string, asc?: string, video_name?: string, search?: string, start?: string, end?: string, include_counts?: string, id?: string, name?: string, live_input_id?: string, before?: string, after?: string, limit?: number)
List videos
| Argument | Type | Required | Description |
|---|
| status? | string | no | |
| creator? | string | no | |
| type? | string | no | |
| asc? | string | no | |
| video_name? | string | no | |
| search? | string | no | |
| start? | string | no | |
| end? | string | no | |
| include_counts? | string | no | |
| id? | string | no | Filter by video ID(s). Can be a single ID or a comma-separated list of IDs. |
| name? | string | no | Filter by video name/UID(s). Can be a single name or a comma-separated list. |
| live_input_id? | string | no | Filter by live input ID to find videos associated with a specific live stream. |
| before? | string | no | Alias for 'end'. Returns videos created before this date/time (RFC 3339 format). |
| after? | string | no | Alias for 'start'. Returns videos created after this date/time (RFC 3339 format). |
| limit? | number | no | Maximum number of videos to return (default 1000, max 1000). |
fn stream_videos_initiate_video_uploads_using_tus(direct_user?: string)
Initiate video uploads using TUS
| Argument | Type | Required | Description |
|---|
| direct_user? | string | no | |
fn create_stream_video_clipping_clip_videos_given_a_start_and_end_time(allowedOrigins?: unknown, clippedFromVideoUID: unknown, creator?: unknown, endTimeSeconds: unknown, input?: string, meta?: unknown, name?: string, requireSignedURLs?: unknown, scheduledDeletion?: unknown, startTimeSeconds: unknown, thumbnailTimestampPct?: unknown, url?: string, watermark?: unknown)
Clip videos given a start and end time
| Argument | Type | Required | Description |
|---|
| allowedOrigins? | unknown | no | |
| clippedFromVideoUID | unknown | yes | |
| creator? | unknown | no | |
| endTimeSeconds | unknown | yes | |
| input? | string | no | A video's URL. Preferred over 'url'. |
| meta? | unknown | no | |
| name? | string | no | A name for the video. |
| requireSignedURLs? | unknown | no | |
| scheduledDeletion? | unknown | no | |
| startTimeSeconds | unknown | yes | |
| thumbnailTimestampPct? | unknown | no | |
| url? | string | no | A video's URL (legacy field, use 'input' instead). |
| watermark? | unknown | no | |
fn create_stream_videos_upload_videos_from_a_url(allowedOrigins?: unknown, creator?: unknown, input?: string, meta?: unknown, name?: string, requireSignedURLs?: unknown, scheduledDeletion?: unknown, thumbnailTimestampPct?: unknown, url?: string, watermark?: unknown)
Upload videos from a URL
| Argument | Type | Required | Description |
|---|
| allowedOrigins? | unknown | no | |
| creator? | unknown | no | |
| input? | string | no | A video's URL. The server must be publicly routable and support `HTTP HEAD` r... |
| meta? | unknown | no | |
| name? | string | no | A video's name. Used for legacy compatibility. |
| requireSignedURLs? | unknown | no | |
| scheduledDeletion? | unknown | no | |
| thumbnailTimestampPct? | unknown | no | |
| url? | string | no | A video's URL. The server must be publicly routable and support `HTTP HEAD` r... |
| watermark? | unknown | no | |
fn create_stream_videos_upload_videos_via_direct_upload_ur_ls(allowedOrigins?: unknown, creator?: unknown, expiry?: string, maxDurationSeconds: unknown, meta?: unknown, requireSignedURLs?: unknown, scheduledDeletion?: unknown, thumbnailTimestampPct?: unknown, watermark?: unknown)
Upload videos via direct upload URLs
| Argument | Type | Required | Description |
|---|
| allowedOrigins? | unknown | no | |
| creator? | unknown | no | |
| expiry? | string | no | The date and time after upload when videos will not be accepted. |
| maxDurationSeconds | unknown | yes | |
| meta? | unknown | no | |
| requireSignedURLs? | unknown | no | |
| scheduledDeletion? | unknown | no | |
| thumbnailTimestampPct? | unknown | no | |
| watermark? | unknown | no | |
fn list_signing_keys()
List signing keys
fn create_signing_keys()
Create signing keys
fn delete_signing_keys(identifier: string)
Delete signing keys
| Argument | Type | Required | Description |
|---|
| identifier | string | yes | |
fn list_live_inputs(include_counts?: string)
List live inputs
| Argument | Type | Required | Description |
|---|
| include_counts? | string | no | |
fn create_a_live_input(defaultCreator?: unknown, deleteRecordingAfterDays?: unknown, enabled?: unknown, meta?: unknown, preferLowLatency?: unknown, recording?: unknown)
Create a live input
| Argument | Type | Required | Description |
|---|
| defaultCreator? | unknown | no | |
| deleteRecordingAfterDays? | unknown | no | |
| enabled? | unknown | no | |
| meta? | unknown | no | |
| preferLowLatency? | unknown | no | |
| recording? | unknown | no | |
fn get_stream_live_inputs_retrieve_a_live_input(live_input_identifier: string)
Retrieve a live input
| Argument | Type | Required | Description |
|---|
| live_input_identifier | string | yes | |
fn update_a_live_input(live_input_identifier: string, defaultCreator?: unknown, deleteRecordingAfterDays?: unknown, enabled?: unknown, meta?: unknown, preferLowLatency?: unknown, recording?: unknown)
Update a live input
| Argument | Type | Required | Description |
|---|
| live_input_identifier | string | yes | |
| defaultCreator? | unknown | no | |
| deleteRecordingAfterDays? | unknown | no | |
| enabled? | unknown | no | |
| meta? | unknown | no | |
| preferLowLatency? | unknown | no | |
| recording? | unknown | no | |
fn delete_a_live_input(live_input_identifier: string)
Delete a live input
| Argument | Type | Required | Description |
|---|
| live_input_identifier | string | yes | |
fn stream_live_inputs_disable_a_live_input(live_input_identifier: string)
Disable a live input
| Argument | Type | Required | Description |
|---|
| live_input_identifier | string | yes | |
fn stream_live_inputs_enable_a_live_input(live_input_identifier: string)
Enable a live input
| Argument | Type | Required | Description |
|---|
| live_input_identifier | string | yes | |
fn list_all_outputs_associated_with_a_specified_live_input(live_input_identifier: string)
List all outputs associated with a specified live input
| Argument | Type | Required | Description |
|---|
| live_input_identifier | string | yes | |
fn create_a_new_output_connected_to_a_live_input(live_input_identifier: string, enabled?: unknown, streamKey: unknown, url: unknown)
Create a new output, connected to a live input
| Argument | Type | Required | Description |
|---|
| live_input_identifier | string | yes | |
| enabled? | unknown | no | |
| streamKey | unknown | yes | |
| url | unknown | yes | |
fn update_an_output(output_identifier: string, live_input_identifier: string, enabled: unknown)
Update an output
| Argument | Type | Required | Description |
|---|
| output_identifier | string | yes | |
| live_input_identifier | string | yes | |
| enabled | unknown | yes | |
fn delete_an_output(output_identifier: string, live_input_identifier: string)
Delete an output
| Argument | Type | Required | Description |
|---|
| output_identifier | string | yes | |
| live_input_identifier | string | yes | |
fn stream_live_inputs_rotate_keys_for_a_live_input(live_input_identifier: string)
Rotate keys for a live input
| Argument | Type | Required | Description |
|---|
| live_input_identifier | string | yes | |
fn get_stream_videos_storage_usage(creator?: string)
Storage use
| Argument | Type | Required | Description |
|---|
| creator? | string | no | |
fn get_account_stream_usage()
Get account Stream usage
fn list_watermark_profiles()
List watermark profiles
fn create_watermark_profiles_via_basic_upload(name?: unknown, opacity?: unknown, padding?: unknown, position?: unknown, scale?: unknown, url?: string)
Create watermark profiles via basic upload
| Argument | Type | Required | Description |
|---|
| name? | unknown | no | |
| opacity? | unknown | no | |
| padding? | unknown | no | |
| position? | unknown | no | |
| scale? | unknown | no | |
| url? | string | no | URL of the watermark image to copy. |
fn get_stream_watermark_profile_watermark_profile_details(identifier: string)
Watermark profile details
| Argument | Type | Required | Description |
|---|
| identifier | string | yes | |
fn delete_watermark_profiles(identifier: string)
Delete watermark profiles
| Argument | Type | Required | Description |
|---|
| identifier | string | yes | |
fn get_stream_webhook_view_webhooks()
View webhooks
fn create_webhooks(notificationUrl?: unknown, notification_url?: string)
Create webhooks
| Argument | Type | Required | Description |
|---|
| notificationUrl? | unknown | no | |
| notification_url? | string | no | The URL where webhooks will be sent. |
fn delete_webhooks()
Delete webhooks
fn get_stream_videos_retrieve_video_details(identifier: string)
Retrieve video details
| Argument | Type | Required | Description |
|---|
| identifier | string | yes | |
fn update_video_details(identifier: string, allowedOrigins?: unknown, creator?: unknown, maxDurationSeconds?: unknown, meta?: unknown, publicDetails?: object, requireSignedURLs?: unknown, scheduledDeletion?: unknown, thumbnailTimestampPct?: unknown, uid?: string, uploadExpiry?: unknown)
Edit video details
| Argument | Type | Required | Description |
|---|
| identifier | string | yes | |
| allowedOrigins? | unknown | no | |
| creator? | unknown | no | |
| maxDurationSeconds? | unknown | no | |
| meta? | unknown | no | |
| publicDetails? | object | no | Public details for the video including title, share link, channel link, and l... |
| requireSignedURLs? | unknown | no | |
| scheduledDeletion? | unknown | no | |
| thumbnailTimestampPct? | unknown | no | |
| uid? | string | no | The unique identifier for the video. Can be used to verify the video being up... |
| uploadExpiry? | unknown | no | |
fn delete_video(identifier: string)
Delete video
| Argument | Type | Required | Description |
|---|
| identifier | string | yes | |
fn list_audio_tracks(identifier: string)
List additional audio tracks on a video
| Argument | Type | Required | Description |
|---|
| identifier | string | yes | |
fn create_add_audio_track(identifier: string, label: unknown, url?: string)
Add audio tracks to a video
| Argument | Type | Required | Description |
|---|
| identifier | string | yes | |
| label | unknown | yes | |
| url? | string | no | An audio track URL. The server must be publicly routable and support `HTTP HE... |
fn update_edit_audio_tracks(identifier: string, audio_identifier: string, default?: unknown, label?: unknown)
Edit additional audio tracks on a video
| Argument | Type | Required | Description |
|---|
| identifier | string | yes | |
| audio_identifier | string | yes | |
| default? | unknown | no | |
| label? | unknown | no | |
fn delete_audio_tracks(identifier: string, audio_identifier: string)
Delete additional audio tracks on a video
| Argument | Type | Required | Description |
|---|
| identifier | string | yes | |
| audio_identifier | string | yes | |
fn list_captions_or_subtitles(identifier: string)
List captions or subtitles
| Argument | Type | Required | Description |
|---|
| identifier | string | yes | |
fn get_caption_or_subtitle_for_language(language: string, identifier: string)
List captions or subtitles for a provided language
| Argument | Type | Required | Description |
|---|
| language | string | yes | |
| identifier | string | yes | |
fn update_stream_subtitles_captions_upload_captions_or_subtitles(language: string, identifier: string)
Upload captions or subtitles
| Argument | Type | Required | Description |
|---|
| language | string | yes | |
| identifier | string | yes | |
fn delete_captions_or_subtitles(language: string, identifier: string)
Delete captions or subtitles
| Argument | Type | Required | Description |
|---|
| language | string | yes | |
| identifier | string | yes | |
fn stream_subtitles_captions_generate_caption_or_subtitle_for_language(language: string, identifier: string)
Generate captions or subtitles for a provided language via AI
| Argument | Type | Required | Description |
|---|
| language | string | yes | |
| identifier | string | yes | |
fn list_downloads(identifier: string)
List downloads
| Argument | Type | Required | Description |
|---|
| identifier | string | yes | |
fn create_downloads(identifier: string)
Create downloads
| Argument | Type | Required | Description |
|---|
| identifier | string | yes | |
fn delete_downloads(identifier: string)
Delete downloads
| Argument | Type | Required | Description |
|---|
| identifier | string | yes | |
fn create_type_specific_downloads(identifier: string, download_type: string)
Create download
| Argument | Type | Required | Description |
|---|
| identifier | string | yes | |
| download_type | string | yes | |
fn delete_type_specific_downloads(identifier: string, download_type: string)
Delete download
| Argument | Type | Required | Description |
|---|
| identifier | string | yes | |
| download_type | string | yes | |
fn create_signed_url_tokens_for_videos(identifier: string, accessRules?: array, downloadable?: boolean, exp?: number, flags?: object, nbf?: number, pem?: string)
Create signed URL tokens for videos
| Argument | Type | Required | Description |
|---|
| identifier | string | yes | |
| accessRules? | array | no | The optional list of access rule constraints on the token. Access can be bloc... |
| downloadable? | boolean | no | The optional boolean value that enables using signed tokens to access MP4 dow... |
| exp? | number | no | The optional unix epoch timestamp that specficies the time after a token is n... |
| flags? | object | no | Optional flags for the signed token. |
| nbf? | number | no | The optional unix epoch timestamp that specifies the time before a the token ... |
| pem? | string | no | The optional base64 encoded private key in PEM format associated with a Strea... |