Menu

Expand
Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

Asset Version

Asset Versions are specific instances of static files that you can host at a particular domain in an Environment.

The steps to create Assets are as follows:

  1. Create an Asset
  2. Create an Asset Version (this resource)

You will need the Asset Version SID that the create request returns to include this Asset in a Build.

Asset Version properties

Resource Properties in REST API format
sid
sid<ZN> Not PII

The unique string that we created to identify the Asset Version resource.

account_sid
sid<AC> Not PII

The SID of the Account that created the Asset Version resource.

service_sid
sid<ZS> Not PII

The SID of the Service that the Asset Version resource is associated with.

asset_sid
sid<ZH> Not PII

The SID of the Asset resource that is the parent of the Asset Version.

path

The URL-friendly string by which the Asset Version can be referenced. It can be a maximum of 255 characters. All paths begin with a forward slash ('/'). If an Asset Version creation request is submitted with a path not containing a leading slash, the path will automatically be prepended with one.

visibility
enum:visibility Not PII

The access control that determines how the Asset Version resource can be accessed. Can be: public, protected, or private.

date_created
date_time<iso8601> Not PII

The date and time in GMT when the Asset Version resource was created specified in ISO 8601 format.

url
url Not PII

The absolute URL of the Asset Version resource.

Create an Asset Version resource

Create an Asset Version resource to upload a file to an Asset resource. The Asset Version resource is created by making a POST request to a dedicated URL—a URL that is different from the URL used to read and fetch the resource.

https://serverless-upload.twilio.com/v1/Services/ {ServiceSid}/Assets/{AssetSid}/Versions

The following example creates an Asset Version resource using curl and an external file, asset_name.png, which contains the asset to upload.

curl -X POST "https://serverless-upload.twilio.com/v1/Services/ZSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Assets/ZHXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Versions" \
-F "Content=@asset_file.png; type=image/png" \
-F "Path=/asset1" \
-F "Visibility=public" \
-u "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:your_auth_token"

The create action is not supported by the helper libraries.

The create action accepts these parameters:

Parameter Description
Content The asset to upload.
AssetSid The SID of the Asset resource to upload this asset to.
Path The path to assign the asset. Must be URL Friendly, without fragments, and ;,?:@+&$()' " are disallowed).
ServiceSid The SID of the Asset's Service.
Visibility The visibility of the asset. Can be public, protected, or private.

Fetch an AssetVersion resource

get
https://serverless.twilio.com/v1/Services/{ServiceSid}/Assets/{AssetSid}/Versions/{Sid}
Parameters
Parameters in REST API format
service_sid
Path
get sid_like<ZS> Not PII

The SID of the Service to fetch the Asset Version resource from.

asset_sid
Path
get sid<ZH> Not PII

The SID of the Asset resource that is the parent of the Asset Version resource to fetch.

sid
Path
get sid<ZN> Not PII

The SID of the Asset Version resource to fetch.

Example 1
        
        
        
        

        Read multiple AssetVersion resources

        get
        https://serverless.twilio.com/v1/Services/{ServiceSid}/Assets/{AssetSid}/Versions
        Parameters
        Parameters in REST API format
        service_sid
        Path
        get sid_like<ZS> Not PII

        The SID of the Service to read the Asset Version resource from.

        asset_sid
        Path
        get sid<ZH> Not PII

        The SID of the Asset resource that is the parent of the Asset Version resources to read.

        Example 1
              
              
              
              
              Rate this page:

              Need some help?

              We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.