This documentation is for reference only. We are no longer onboarding new customers to Programmable Video. Existing customers can continue to use the product until December 5, 2026.
We recommend migrating your application to the API provided by our preferred video partner, Zoom. We've prepared this migration guide to assist you in minimizing any service disruption.
These are the URI schemes for the Composition Settings REST API and the supported methods:
/v1/CompositionSettings/Default
GET
: Retrieves current Composition Settings.
POST
: Updates the Composition Settings.
The Default
CompositionSettings
resource holds the default composition settings for the given Twilio account (or project). Its configuration will be applied to all Recording Compositions created in such account (or project).
The Compositions Settings default resource is located at the following Base URL:
1https://video.twilio.com/v1/CompositionSettings/Default2
A CompositionSettings resource has the following properties:
The SID of the Account that created the CompositionSettings resource.
^AC[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
The string that you assigned to describe the resource and that will be shown in the console
The SID of the stored Credential resource.
^CR[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
The URL of the AWS S3 bucket where the compositions are 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 described in the RFC 3986.
Whether all compositions are written to the aws_s3_url
. When false
, all compositions are stored in our cloud.
The SID of the Public Key resource used for encryption.
^CR[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
Whether all compositions are stored in an encrypted form. The default is false
.
The absolute URL of the resource.
The Twilio Composition Settings REST API lets you configure Twilio to store your compositions in an external AWS S3 bucket. Composition Settings work per-account (i.e. project). If you activate external S3 storage, all Video Compositions in your account (or project) will be stored in the specified external bucket.
This document contains reference information about the Composition Settings REST API for external S3 storage. For a step-by-step guide you can also read the Storing into AWS S3 developer guide
In the table above, the following properties are reserved for the feature called Encrypted Compositions:
encryption_key_sid
encryption_enabled
If you have an interest in activating Encrypted Compositions in you account, please contact the Twilio Support Service.
Retrieves your account's default Composition Settings.
For example:
1// Download the helper library from https://www.twilio.com/docs/node/install2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";34// Find your Account SID and Auth Token at twilio.com/console5// and set the environment variables. See http://twil.io/secure6const accountSid = process.env.TWILIO_ACCOUNT_SID;7const authToken = process.env.TWILIO_AUTH_TOKEN;8const client = twilio(accountSid, authToken);910async function fetchCompositionSettings() {11const compositionSetting = await client.video.compositionSettings().fetch();1213console.log(compositionSetting.accountSid);14}1516fetchCompositionSettings();
1{2"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",3"friendly_name": "string",4"aws_credentials_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",5"encryption_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",6"aws_s3_url": "https://my-super-duper-bucket.s3.amazonaws.com/my/path/",7"aws_storage_enabled": true,8"encryption_enabled": true,9"url": "https://video.twilio.com/v1/CompositionSettings/Default"10}
Sets your account's default Composition Settings. POST
requests support the
following parameters:
application/x-www-form-urlencoded
A descriptive string that you create to describe the resource and show to the user in the console
The SID of the stored Credential resource.
^CR[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
The SID of the Public Key resource to use for encryption.
^CR[0-9a-fA-F]{32}$
Min length: 34
Max length: 34
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 described in the RFC 3986.
Whether all compositions should be written to the aws_s3_url
. When false
, all compositions are stored in our cloud.
Whether all compositions should be stored in an encrypted form. The default is false
.
In the table above, the following parameters are reserved for the feature called Encrypted Compositions:
EncryptionKeySid
EncryptionEnabled
If you have an interest in activating Encrypted Compositions and enable the use of these parameters in your account, please contact the Twilio Support Service.
The following code snippet illustrate how you can set your Compositions to be stored in an external S3 bucket:
1// Download the helper library from https://www.twilio.com/docs/node/install2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";34// Find your Account SID and Auth Token at twilio.com/console5// and set the environment variables. See http://twil.io/secure6const accountSid = process.env.TWILIO_ACCOUNT_SID;7const authToken = process.env.TWILIO_AUTH_TOKEN;8const client = twilio(accountSid, authToken);910async function createCompositionSettings() {11const compositionSetting = await client.video.compositionSettings().create({12awsCredentialsSid: "CRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",13awsS3Url: "https://my-bucket.s3.amazonaws.com/recordings",14awsStorageEnabled: true,15friendlyName: "Upload to external bucket",16});1718console.log(compositionSetting.accountSid);19}2021createCompositionSettings();
1{2"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",3"friendly_name": "Upload to external bucket",4"aws_credentials_sid": "CRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",5"encryption_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",6"aws_s3_url": "https://my-bucket.s3.amazonaws.com/recordings",7"aws_storage_enabled": true,8"encryption_enabled": true,9"url": "https://video.twilio.com/v1/CompositionSettings/Default"10}
To stop storing compositions in an AWS S3 Bucket by default, you can create a new default configuration with AWS storage disabled. If you disable external AWS S3 storage, compositions will be stored in the Twilio cloud.
1// Download the helper library from https://www.twilio.com/docs/node/install2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";34// Find your Account SID and Auth Token at twilio.com/console5// and set the environment variables. See http://twil.io/secure6const accountSid = process.env.TWILIO_ACCOUNT_SID;7const authToken = process.env.TWILIO_AUTH_TOKEN;8const client = twilio(accountSid, authToken);910async function createCompositionSettings() {11const compositionSetting = await client.video.compositionSettings().create({12awsStorageEnabled: false,13friendlyName: "Resetting default configuration",14});1516console.log(compositionSetting.accountSid);17}1819createCompositionSettings();
1{2"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",3"friendly_name": "Resetting default configuration",4"aws_credentials_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",5"encryption_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",6"aws_s3_url": "https://my-super-duper-bucket.s3.amazonaws.com/my/path/",7"aws_storage_enabled": false,8"encryption_enabled": true,9"url": "https://video.twilio.com/v1/CompositionSettings/Default"10}