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
|
The SID of the Account that created the Assistant resource. |
dateCreated
|
The date and time in GMT when the resource was created specified in RFC 2822 format. |
dateUpdated
|
The date and time in GMT when the resource was last updated specified in RFC 2822 format. |
friendlyName
|
The string that you assigned to describe the resource. It is not unique and can be up to 255 characters long. |
latestModelBuildSid
|
Reserved. |
links
|
A list of the URLs of the Assistant's related resources. |
logQueries
|
Whether queries should be logged and kept after training. Can be: |
developmentStage
|
A string describing the state of the assistant. |
needsModelBuild
|
Whether model needs to be rebuilt. |
sid
|
The unique string that we created to identify the Assistant resource. |
uniqueName
|
An application-defined string that uniquely identifies the resource. It can be used in place of the resource's |
url
|
The absolute URL of the Assistant resource. |
callbackUrl
|
Reserved. |
callbackEvents
|
Reserved. |
Create an Assistant resource
https://autopilot.twilio.com/v1/Assistants
Creates a new Assistant resource.
Parameters
| Names in None format | |
|---|---|
friendly_name
Optional
|
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
|
Whether queries should be logged and kept after training. Can be: |
unique_name
Optional
|
An application-defined string that uniquely identifies the new resource. It can be used as an alternative to the |
callback_url
Optional
|
Reserved. |
callback_events
Optional
|
Reserved. |
style_sheet
Optional
|
The JSON string that defines the Assistant's style sheet |
defaults
Optional
|
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
https://autopilot.twilio.com/v1/Assistants/{Sid}
Returns the Assistant instance identified by {AssistantSid} or {AssistantUniqueName}.
Parameters
| Names in None format | |
|---|---|
sid
Required
|
The Twilio-provided string that uniquely identifies the Assistant resource to fetch. |
Example 1
Read multiple Assistant resources
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
https://autopilot.twilio.com/v1/Assistants/{Sid}
Updates the Assistant instance identified by {AssistantSid} or {AssistantUniqueName}.
Parameters
| Names in None format | |
|---|---|
sid
Required
|
The Twilio-provided string that uniquely identifies the Assistant resource to update. |
friendly_name
Optional
|
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
|
Whether queries should be logged and kept after training. Can be: |
unique_name
Optional
|
An application-defined string that uniquely identifies the resource. It can be used as an alternative to the |
callback_url
Optional
|
Reserved. |
callback_events
Optional
|
Reserved. |
style_sheet
Optional
|
The JSON string that defines the Assistant's style sheet |
defaults
Optional
|
A JSON object that defines the Assistant's default tasks for various scenarios, including initiation actions and fallback tasks. |
development_stage
Optional
|
A string describing the state of the assistant. |
Example 1
Example 2
Delete an Assistant resource
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
|
The Twilio-provided string that uniquely identifies the Assistant resource to delete. |
Example 1
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.