Twilio/video

@keeb/twilio/videov2026.08.25.2· 16d agoMODELS

01README

Twilio video API models

02Release Notes

Updated: composition_hook, composition, participant, published_track, recording_rule, recording, room_recording, room, subscribe_rule, subscribed_track, transcription

03Models14

@keeb/twilio/video/anonymizev2026.08.25.1anonymize.ts

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
room_sid	string	yes	Path scope for the anonymize: room_sid
sid	string	yes	Path scope for the anonymize: sid
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn update()

Update anonymize attributes

Resources

state(infinite)— Anonymize resource state

@keeb/twilio/video/compositionv2026.08.25.2composition.ts

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
room_sid	string	yes	The SID of the Group Room with the media tracks to be used as composition sources.
video_layout?	string	no	An object that describes the video layout of the composition in terms of regions. See [Specifying Video Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info. Please, be aware that either video_layout or audio_sources have to be provided to get
audio_sources?	array	no	An array of track names from the same group room to merge into the new composition. Can include zero or more track names. The new composition includes all audio sources specified in `audio_sources` except for those specified in `audio_sources_excluded`. The track names in this parameter can include
audio_sources_excluded?	array	no	An array of track names to exclude. The new composition includes all audio sources specified in `audio_sources` except for those specified in `audio_sources_excluded`. The track names in this parameter can include an asterisk as a wild card character, which will match zero or more characters in a tr
resolution?	string	no	A string that describes the columns (width) and rows (height) of the generated composed video in pixels. Defaults to `640x480`. The string's format is `{width}x{height}` where: * 16 <= `{width}` <= 1280 * 16 <= `{height}` <= 1280 * `{width}` * `{height}` <= 921,600 Typical values are: * HD = `1280x7
format?	enum	no	The container format of the composition's media files as specified in the POST request that created the Composition resource. See [POST Parameters](https://www.twilio.com/docs/video/api/compositions-resource#http-post-parameters) for more information.
status_callback?	string	no	The URL we should call using the `status_callback_method` to send status information to your application on every composition event. If not provided, status callback events will not be dispatched.
status_callback_method?	enum	no	The HTTP method we should use to call `status_callback`. Can be: `POST` or `GET` and the default is `POST`.
trim?	boolean	no	Whether to clip the intervals where there is no active media in the composition. The default is `true`. Compositions with `trim` enabled are shorter when the Room is created and no Participant joins for a while as well as if all the Participants leave the room and join later, because those gaps will
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a composition

fn get(id: string)

Get a composition

Argument	Type	Required	Description
id	string	yes	The sid of the composition

fn lookup(status?: enum, date_created_after?: string, date_created_before?: string, room_sid?: string, max_items?: number)

List compositions and record each as a data artifact (capped at 200 by default; writes a composition_lookup record with the coverage of the walk)

Argument	Type	Required	Description
status?	enum	no	Read only Composition resources with this status. Can be: `enqueued`, `processing`, `completed`, `deleted`, or `failed`.
date_created_after?	string	no	Read only Composition resources created on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time with time zone.
date_created_before?	string	no	Read only Composition resources created before this ISO 8601 date-time with time zone.
room_sid?	string	no	Read only Composition resources with this Room SID.
max_items?	number	no	Stop after this many results (default 200, ceiling 100000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the composition_lookup record reports truncated: true.

fn delete(id: string)

Delete the composition

Argument	Type	Required	Description
id	string	yes	The sid of the composition

fn sync()

Sync composition state from Twilio

Resources

state(infinite)— Composition resource state

composition_lookup(infinite)— Composition lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/video/composition-hookv2026.08.25.2composition_hook.ts

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
friendly_name	string	yes	A descriptive string that you create to describe the resource. It can be up to 100 characters long and it must be unique within the account.
enabled?	boolean	no	Whether the composition hook is active. When `true`, the composition hook will be triggered for every completed Group Room in the account. When `false`, the composition hook will never be triggered.
video_layout?	string	no	An object that describes the video layout of the composition hook in terms of regions. See [Specifying Video Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info.
audio_sources?	array	no	An array of track names from the same group room to merge into the compositions created by the composition hook. Can include zero or more track names. A composition triggered by the composition hook includes all audio sources specified in `audio_sources` except those specified in `audio_sources_excl
audio_sources_excluded?	array	no	An array of track names to exclude. A composition triggered by the composition hook includes all audio sources specified in `audio_sources` except for those specified in `audio_sources_excluded`. The track names in this parameter can include an asterisk as a wild card character, which matches zero o
trim?	boolean	no	Whether to clip the intervals where there is no active media in the Compositions triggered by the composition hook. The default is `true`. Compositions with `trim` enabled are shorter when the Room is created and no Participant joins for a while as well as if all the Participants leave the room and
format?	enum	no	The container format of the media files used by the compositions created by the composition hook. If `mp4` or `webm`, `audio_sources` must have one or more tracks and/or a `video_layout` element must contain a valid `video_sources` list, otherwise an error occurs.
resolution?	string	no	A string that describes the columns (width) and rows (height) of the generated composed video in pixels. Defaults to `640x480`. The string's format is `{width}x{height}` where: * 16 <= `{width}` <= 1280 * 16 <= `{height}` <= 1280 * `{width}` * `{height}` <= 921,600 Typical values are: * HD = `1280x7
status_callback?	string	no	The URL we should call using the `status_callback_method` to send status information to your application on every composition event. If not provided, status callback events will not be dispatched.
status_callback_method?	enum	no	The HTTP method we should use to call `status_callback`. Can be: `POST` or `GET` and the default is `POST`.
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a composition hook

fn get(id: string)

Get a composition hook

Argument	Type	Required	Description
id	string	yes	The sid of the composition hook

fn lookup(enabled?: boolean, date_created_after?: string, date_created_before?: string, friendly_name?: string, max_items?: number)

List composition hooks and record each as a data artifact (capped at 200 by default; writes a composition_hook_lookup record with the coverage of the walk)

Argument	Type	Required	Description
enabled?	boolean	no	Read only CompositionHook resources with an `enabled` value that matches this parameter.
date_created_after?	string	no	Read only CompositionHook resources created on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime with time zone.
date_created_before?	string	no	Read only CompositionHook resources created before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime with time zone.
friendly_name?	string	no	Read only CompositionHook resources with friendly names that match this string. The match is not case sensitive and can include asterisk `*` characters as wildcard match.
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the composition_hook_lookup record reports truncated: true.

fn update()

Update composition hook attributes

fn delete(id: string)

Delete the composition hook

Argument	Type	Required	Description
id	string	yes	The sid of the composition hook

fn sync()

Sync composition hook state from Twilio

Resources

state(infinite)— Composition hook resource state

composition_hook_lookup(infinite)— Composition hook lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/video/composition-settingv2026.08.25.1composition_setting.ts

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
friendly_name	string	yes	A descriptive string that you create to describe the resource and show to the user in the console
aws_credentials_sid?	string	no	The SID of the stored Credential resource.
encryption_key_sid?	string	no	The SID of the Public Key resource to use for encryption.
aws_s3_url?	string	no	The URL of the AWS S3 bucket where the compositions should be stored. We only support DNS-compliant URLs like `https://documentation-example-twilio-bucket/compositions`, where `compositions` is the path in which you want the compositions to be stored. This URL accepts only URI-valid characters, as d
aws_storage_enabled?	boolean	no	Whether all compositions should be written to the `aws_s3_url`. When `false`, all compositions are stored in our cloud.
encryption_enabled?	boolean	no	Whether all compositions should be stored in an encrypted form. The default is `false`.
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn get()

Get a composition setting

fn update()

Update composition setting attributes

fn sync()

Sync composition setting state from Twilio

Resources

state(infinite)— Composition setting resource state

@keeb/twilio/video/participantv2026.08.25.2participant.ts

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
room_sid	string	yes	Path scope for the participant: room_sid
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
status?	enum	no	The status of the Participant. Can be: `connected` or `disconnected`.
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn get(id: string)

Get a participant

Argument	Type	Required	Description
id	string	yes	The sid of the participant

fn lookup(status?: enum, identity?: string, date_created_after?: string, date_created_before?: string, max_items?: number)

List participants and record each as a data artifact (capped at 200 by default; writes a participant_lookup record with the coverage of the walk)

Argument	Type	Required	Description
status?	enum	no	Read only the participants with this status. Can be: `connected` or `disconnected`. For `in-progress` Rooms the default Status is `connected`, for `completed` Rooms only `disconnected` Participants are returned.
identity?	string	no	Read only the Participants with this [User](https://www.twilio.com/docs/chat/rest/user-resource) `identity` value.
date_created_after?	string	no	Read only Participants that started after this date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#UTC) format.
date_created_before?	string	no	Read only Participants that started before this date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#UTC) format.
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the participant_lookup record reports truncated: true.

fn update()

Update participant attributes

fn sync()

Sync participant state from Twilio

Resources

state(infinite)— Participant resource state

participant_lookup(infinite)— Participant lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/video/published-trackv2026.08.25.2published_track.ts

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
room_sid	string	yes	Path scope for the published track: room_sid
participant_sid	string	yes	Path scope for the published track: participant_sid
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn get(id: string)

Get a published track

Argument	Type	Required	Description
id	string	yes	The sid of the published track

fn lookup(max_items?: number)

List published tracks and record each as a data artifact (capped at 200 by default; writes a published_track_lookup record with the coverage of the walk)

Argument	Type	Required	Description
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the published_track_lookup record reports truncated: true.

fn sync()

Sync published track state from Twilio

Resources

state(infinite)— Published track resource state

published_track_lookup(infinite)— Published track lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/video/recordingv2026.08.25.2recording.ts

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn get(id: string)

Get a recording

Argument	Type	Required	Description
id	string	yes	The sid of the recording

fn lookup(status?: enum, source_sid?: string, grouping_sid?: string, date_created_after?: string, date_created_before?: string, media_type?: enum, max_items?: number)

List recordings and record each as a data artifact (capped at 200 by default; writes a recording_lookup record with the coverage of the walk)

Argument	Type	Required	Description
status?	enum	no	Read only the recordings that have this status. Can be: `processing`, `completed`, or `deleted`.
source_sid?	string	no	Read only the recordings that have this `source_sid`.
grouping_sid?	string	no	Read only recordings with this `grouping_sid`, which may include a `participant_sid` and/or a `room_sid`.
date_created_after?	string	no	Read only recordings that started on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time with time zone.
date_created_before?	string	no	Read only recordings that started before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time with time zone, given as `YYYY-MM-DDThh:mm:ss+\|-hh:mm` or `YYYY-MM-DDThh:mm:ssZ`.
media_type?	enum	no	Read only recordings that have this media type. Can be either `audio` or `video`.
max_items?	number	no	Stop after this many results (default 200, ceiling 100000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the recording_lookup record reports truncated: true.

fn delete(id: string)

Delete the recording

Argument	Type	Required	Description
id	string	yes	The sid of the recording

fn sync()

Sync recording state from Twilio

Resources

state(infinite)— Recording resource state

recording_lookup(infinite)— Recording lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/video/recording-rulev2026.08.25.2recording_rule.ts

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
room_sid	string	yes	Path scope for the recording rule: room_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
rules?	string	no	A JSON-encoded array of recording rules.
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a recording rule

fn lookup(max_items?: number)

List recording rules and record each as a data artifact (capped at 200 by default; writes a recording_rule_lookup record with the coverage of the walk)

Argument	Type	Required	Description
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the recording_rule_lookup record reports truncated: true.

Resources

state(infinite)— Recording rule resource state

recording_rule_lookup(infinite)— Recording rule lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/video/recording-settingv2026.08.25.1recording_setting.ts

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
friendly_name	string	yes	A descriptive string that you create to describe the resource and be shown to users in the console
aws_credentials_sid?	string	no	The SID of the stored Credential resource.
encryption_key_sid?	string	no	The SID of the Public Key resource to use for encryption.
aws_s3_url?	string	no	The URL of the AWS S3 bucket where the recordings should be stored. We only support DNS-compliant URLs like `https://documentation-example-twilio-bucket/recordings`, where `recordings` is the path in which you want the recordings to be stored. This URL accepts only URI-valid characters, as described
aws_storage_enabled?	boolean	no	Whether all recordings should be written to the `aws_s3_url`. When `false`, all recordings are stored in our cloud.
encryption_enabled?	boolean	no	Whether all recordings should be stored in an encrypted form. The default is `false`.
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn get()

Get a recording setting

fn update()

Update recording setting attributes

fn sync()

Sync recording setting state from Twilio

Resources

state(infinite)— Recording setting resource state

@keeb/twilio/video/roomv2026.08.25.2room.ts

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
status?	enum	no
enable_turn?	boolean	no	Deprecated, now always considered to be true.
type?	enum	no	Type of room. Use `group` for new implementations. `go`, `peer-to-peer`, and `group-small` are deprecated.
unique_name?	string	no	An application-defined string that uniquely identifies the resource. It can be used as a `room_sid` in place of the resource's `sid` in the URL to address the resource, assuming it does not contain any [reserved characters](https://tools.ietf.org/html/rfc3986#section-2.2) that would need to be URL e
status_callback?	string	no	The URL Twilio should call using the `status_callback_method` to send status information to your application on every room event. See [Status Callbacks](https://www.twilio.com/docs/video/api/status-callbacks) for more info.
status_callback_method?	enum	no	The HTTP method Twilio should use to call `status_callback`. Can be `POST` or `GET`.
max_participants?	number	no	The maximum number of concurrent Participants allowed in the room. The maximum allowed value is 50.
record_participants_on_connect?	boolean	no	Whether to start recording when Participants connect.
transcribe_participants_on_connect?	boolean	no	Whether to start transcriptions when Participants connect. If TranscriptionsConfiguration is not provided, default settings will be used.
video_codecs?	array	no	An array of the video codecs that are supported when publishing a track in the room. Can be: `VP8` and `H264`.
media_region?	string	no	The region for the Room's media server. Can be one of the [available Media Regions](https://www.twilio.com/docs/video/ip-addresses#group-rooms-media-servers).
recording_rules?	string	no	A collection of Recording Rules that describe how to include or exclude matching tracks for recording
transcriptions_configuration?	record	no	A collection of properties that describe transcription behaviour. If TranscribeParticipantsOnConnect is set to true and TranscriptionsConfiguration is not provided, default settings will be used.
audio_only?	boolean	no	When set to true, indicates that the participants in the room will only publish audio. No video tracks will be allowed.
max_participant_duration?	number	no	The maximum number of seconds a Participant can be connected to the room. The maximum possible value is 86400 seconds (24 hours). The default is 14400 seconds (4 hours).
empty_room_timeout?	number	no	Configures how long (in minutes) a room will remain active after last participant leaves. Valid values range from 1 to 60 minutes (no fractions).
unused_room_timeout?	number	no	Configures how long (in minutes) a room will remain active if no one joins. Valid values range from 1 to 60 minutes (no fractions).
large_room?	boolean	no	When set to true, indicated that this is the large room.
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a room

fn get(id: string)

Get a room

Argument	Type	Required	Description
id	string	yes	The sid of the room

fn lookup(status?: enum, unique_name?: string, date_created_after?: string, date_created_before?: string, max_items?: number)

List rooms and record each as a data artifact (capped at 200 by default; writes a room_lookup record with the coverage of the walk)

Argument	Type	Required	Description
status?	enum	no	Read only the rooms with this status. Can be: `in-progress` (default) or `completed`
unique_name?	string	no	Read only rooms with the this `unique_name`.
date_created_after?	string	no	Read only rooms that started on or after this date, given as `YYYY-MM-DD`.
date_created_before?	string	no	Read only rooms that started before this date, given as `YYYY-MM-DD`.
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the room_lookup record reports truncated: true.

fn update()

Update room attributes

fn sync()

Sync room state from Twilio

Resources

state(infinite)— Room resource state

room_lookup(infinite)— Room lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/video/room-recordingv2026.08.25.2room_recording.ts

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
room_sid	string	yes	Path scope for the room recording: room_sid
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn get(id: string)

Get a room recording

Argument	Type	Required	Description
id	string	yes	The sid of the room recording

fn lookup(status?: enum, source_sid?: string, date_created_after?: string, date_created_before?: string, max_items?: number)

List room recordings and record each as a data artifact (capped at 200 by default; writes a room_recording_lookup record with the coverage of the walk)

Argument	Type	Required	Description
status?	enum	no	Read only the recordings with this status. Can be: `processing`, `completed`, or `deleted`.
source_sid?	string	no	Read only the recordings that have this `source_sid`.
date_created_after?	string	no	Read only recordings that started on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime with time zone.
date_created_before?	string	no	Read only Recordings that started before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime with time zone.
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the room_recording_lookup record reports truncated: true.

fn delete(id: string)

Delete the room recording

Argument	Type	Required	Description
id	string	yes	The sid of the room recording

fn sync()

Sync room recording state from Twilio

Resources

state(infinite)— Room recording resource state

room_recording_lookup(infinite)— Room recording lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/video/subscribe-rulev2026.08.25.2subscribe_rule.ts

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
room_sid	string	yes	Path scope for the subscribe rule: room_sid
participant_sid	string	yes	Path scope for the subscribe rule: participant_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
rules?	string	no	A JSON-encoded array of subscribe rules. See the [Specifying Subscribe Rules](https://www.twilio.com/docs/video/api/track-subscriptions#specifying-sr) section for further information.
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a subscribe rule

fn lookup(max_items?: number)

List subscribe rules and record each as a data artifact (capped at 200 by default; writes a subscribe_rule_lookup record with the coverage of the walk)

Argument	Type	Required	Description
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the subscribe_rule_lookup record reports truncated: true.

Resources

state(infinite)— Subscribe rule resource state

subscribe_rule_lookup(infinite)— Subscribe rule lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/video/subscribed-trackv2026.08.25.2subscribed_track.ts

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
room_sid	string	yes	Path scope for the subscribed track: room_sid
participant_sid	string	yes	Path scope for the subscribed track: participant_sid
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn get(id: string)

Get a subscribed track

Argument	Type	Required	Description
id	string	yes	The sid of the subscribed track

fn lookup(max_items?: number)

List subscribed tracks and record each as a data artifact (capped at 200 by default; writes a subscribed_track_lookup record with the coverage of the walk)

Argument	Type	Required	Description
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the subscribed_track_lookup record reports truncated: true.

fn sync()

Sync subscribed track state from Twilio

Resources

state(infinite)— Subscribed track resource state

subscribed_track_lookup(infinite)— Subscribed track lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/video/transcriptionv2026.08.25.2transcription.ts

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
room_sid	string	yes	Path scope for the transcription: room_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
status?	enum	no	The status of the transcriptions resource.
configuration?	record	no	A collection of properties that describe transcription behaviour.
auth_token?	string	no	Twilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?	string	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	Twilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a transcription

fn get(id: string)

Get a transcription

Argument	Type	Required	Description
id	string	yes	The ttid of the transcription

fn lookup(max_items?: number)

List transcriptions and record each as a data artifact (capped at 200 by default; writes a transcription_lookup record with the coverage of the walk)

Argument	Type	Required	Description
max_items?	number	no	Stop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the transcription_lookup record reports truncated: true.

fn update()

Update transcription attributes

fn sync()

Sync transcription state from Twilio

Resources

state(infinite)— Transcription resource state

transcription_lookup(infinite)— Transcription lookup coverage — whether the page walk exhausted the collection

04Stats

85 / 100

Downloads

Archive size

65.7 KB

Has README or module doc2/2earned
README has a code example1/1earned
README is substantive1/1earned
Most symbols documented1/1earned
No slow types (deprecated)1/1earned
Dependencies pass trust audit2/2earned
Has description1/1earned
Platform support declared (or universal)2/2earned
License declared1/1earned
Verified public repository0/2missing

05Platforms

linux · x86_64 linux · aarch64 macOS · x86_64 macOS · aarch64

06Labels

#twilio #video #communications #saas