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 unique ID of the Account that created this Assistant.

dateCreated
date_time<iso8601> Not PII

The date that this resource was created

dateUpdated
date_time<iso8601> Not PII

The date that this resource was last updated

friendlyName
string Not PII

A text description for the Assistant. It is non-unique and can be up to 255 characters long.

latestModelBuildSid
sid<UG> Not PII

links
uri_map Not PII

logQueries
boolean Not PII

A boolean that specifies whether queries should be logged for 30 days past training. If false, no queries will be stored. If true, queries will be stored for 30 days and deleted thereafter.

sid
sid<UA> Not PII

A 34-character string that uniquely identifies this resource.

uniqueName
string Not PII

A user-provided string that uniquely identifies this resource as an alternative to the sid. You can use the unique name in the URL path when addressing this resource. Unique up to 64 characters long.

url
url Not PII

callbackUrl
url Not PII

callbackEvents
string Not PII

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 text description for the Assistant. It is non-unique and can be up to 255 characters long.

log_queries
Optional
post boolean Not PII

A boolean that specifies whether queries should be logged for 30 days past training. If false, no queries will be stored. If true, queries will be stored for 30 days and deleted thereafter. Defaults to true if no value is provided.

unique_name
Optional
post string Not PII

A user-provided string that uniquely identifies this resource as an alternative to the sid. You can use the unique name in the URL path when addressing this resource. Unique up to 64 characters long.

callback_events
Optional
post string Not PII

A space-separated list of callback events that will trigger callbacks

style_sheet
Optional
post object Not PII

A JSON object that defines the assistant style sheet

defaults
Optional
post object Not PII

A JSON object that defines the assistant's default tasks for various scenarios, including initation 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

                    A 34-character string that uniquely identifies this resource.

                    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
                                friendly_name
                                Optional
                                post string Not PII

                                A text description for the Assistant. It is non-unique and can be up to 255 characters long.

                                log_queries
                                Optional
                                post boolean Not PII

                                A boolean that specifies whether queries should be logged for 30 days past training. If false, no queries will be stored. If true, queries will be stored for 30 days and deleted thereafter. Defaults to true if no value is provided.

                                unique_name
                                Optional
                                post string Not PII

                                A user-provided string that uniquely identifies this resource as an alternative to the sid. You can use the unique name in the URL path when addressing this resource. Unique up to 64 characters long.

                                callback_events
                                Optional
                                post string Not PII

                                A space-separated list of callback events that will trigger callbacks

                                style_sheet
                                Optional
                                post object Not PII

                                A JSON object that defines the assistant style sheet

                                defaults
                                Optional
                                post object Not PII

                                A JSON object that defines the assistant's default tasks for various scenarios, including initation 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

                                            A 34-character string that uniquely identifies this resource.

                                            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.