Menu

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?

Assistant

An Assistant is a conversational application or bot that you can deploy across different channels with Twilio's Autopilot.

Each Assistant is independent of other Assistants – you can create multiple Assistants that serve different purposes. For example, you may wish to create an Assistant for a lead-qualification-bot and a different one for support-bot.

All Autopilot REST API resources use the following base URL:

https://autopilot.twilio.com/v1/

Assistant properties

Names in PHP format
accountSid
sid<AC> Not PII

The SID of the Account that created the Assistant resource.

dateCreated
date_time<iso8601> Not PII

The date and time in GMT when the resource was created specified in RFC 2822 format.

dateUpdated
date_time<iso8601> Not PII

The date and time in GMT when the resource was last updated specified in RFC 2822 format.

friendlyName
string Not PII

The string that you assigned to describe the resource. It is not unique and can be up to 255 characters long.

latestModelBuildSid
sid<UG> Not PII

Reserved.

links
uri_map Not PII

A list of the URLs of the Assistant's related resources.

logQueries
boolean Not PII

Whether queries should be logged and kept after training. Can be: true or false and defaults to true. If true, queries are stored for 30 days, and then deleted. If false, no queries are stored.

sid
sid<UA> Not PII

The unique string that we created to identify the Assistant resource.

uniqueName
string Not PII

An application-defined string that uniquely identifies the resource. It can be used in place of the resource's sid in the URL to address the resource.

url
url Not PII

The absolute URL of the Assistant resource.

callbackUrl
url Not PII

Reserved.

callbackEvents
string Not PII

Reserved.

Create an Assistant resource

post
https://autopilot.twilio.com/v1/Assistants

Creates a new Assistant resource.

Parameters
Names in None format
friendly_name
Optional
post string Not PII

A descriptive string that you create to describe the new resource. It is not unique and can be up to 255 characters long.

log_queries
Optional
post boolean Not PII

Whether queries should be logged and kept after training. Can be: true or false and defaults to true. If true, queries are stored for 30 days, and then deleted. If false, no queries are stored.

unique_name
Optional
post string Not PII

An application-defined string that uniquely identifies the new resource. It can be used as an alternative to the sid in the URL path to address the resource. The first 64 characters must be unique.

callback_url
Optional
post url Not PII

Reserved.

callback_events
Optional
post string Not PII

Reserved.

style_sheet
Optional
post object Not PII

The JSON string that defines the Assistant's style sheet

defaults
Optional
post object Not PII

A JSON object that defines the Assistant's default tasks for various scenarios, including initiation actions and fallback tasks.

Example 1
        
        
        
        
        Example 2
              
              
              
              
              Example 3
                    
                    
                    
                    

                    Fetch an Assistant resource

                    get
                    https://autopilot.twilio.com/v1/Assistants/{Sid}

                    Returns the Assistant instance identified by {AssistantSid} or {AssistantUniqueName}.

                    Parameters
                    Names in None format
                    sid
                    Required
                    get sid_like<UA> Not PII

                    The Twilio-provided string that uniquely identifies the Assistant resource to fetch.

                    Example 1
                          
                          
                          
                          

                          Read multiple Assistant resources

                          get
                          https://autopilot.twilio.com/v1/Assistants

                          Returns a list of Assistants within an Account. The list includes paging information.

                          Example 1
                                
                                
                                
                                

                                Update an Assistant resource

                                post
                                https://autopilot.twilio.com/v1/Assistants/{Sid}

                                Updates the Assistant instance identified by {AssistantSid} or {AssistantUniqueName}.

                                Parameters
                                Names in None format
                                sid
                                Required
                                post sid_like<UA> Not PII

                                The Twilio-provided string that uniquely identifies the Assistant resource to update.

                                friendly_name
                                Optional
                                post string Not PII

                                A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long.

                                log_queries
                                Optional
                                post boolean Not PII

                                Whether queries should be logged and kept after training. Can be: true or false and defaults to true. If true, queries are stored for 30 days, and then deleted. If false, no queries are stored.

                                unique_name
                                Optional
                                post string Not PII

                                An application-defined string that uniquely identifies the resource. It can be used as an alternative to the sid in the URL path to address the resource. The first 64 characters must be unique.

                                callback_url
                                Optional
                                post url Not PII

                                Reserved.

                                callback_events
                                Optional
                                post string Not PII

                                Reserved.

                                style_sheet
                                Optional
                                post object Not PII

                                The JSON string that defines the Assistant's style sheet

                                defaults
                                Optional
                                post object Not PII

                                A JSON object that defines the Assistant's default tasks for various scenarios, including initiation actions and fallback tasks.

                                Example 1
                                      
                                      
                                      
                                      
                                      Example 2
                                            
                                            
                                            
                                            

                                            Delete an Assistant resource

                                            delete
                                            https://autopilot.twilio.com/v1/Assistants/{Sid}

                                            Deletes an Assistant.

                                            Deleting an Assistant is potentially a very destructive action. Before it can be deleted, an Assistant cannot have any Intents, Fields, Samples, Field Types, Queries, or Model Builds associated with it. You must delete those first, then delete the Assistant.

                                            Parameters
                                            Names in None format
                                            sid
                                            Required
                                            delete sid_like<UA> Not PII

                                            The Twilio-provided string that uniquely identifies the Assistant resource to delete.

                                            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.