Twilio Autopilot API is a conversational AI platform that allows developers to build automated messaging, voice, and chatbot interactions. It provides tools and pre-built components for creating interactive and intelligent conversational experiences for customers. With Autopilot, developers can easily design and deploy chatbots that can understand natural language input, carry out complex interactions, and provide personalized responses.
components:
schemas:
autopilot.v1.assistant:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the Assistant resource.
date_created:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was created specified in
[RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
date_updated:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was last updated
specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt)
format.
friendly_name:
type: string
nullable: true
description: >-
The string that you assigned to describe the resource. It is not
unique and can be up to 255 characters long.
latest_model_build_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^UG[0-9a-fA-F]{32}$
nullable: true
description: Reserved.
links:
type: object
format: uri-map
nullable: true
description: A list of the URLs of the Assistant's related resources.
log_queries:
type: boolean
nullable: true
description: >-
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.
development_stage:
type: string
nullable: true
description: A string describing the state of the assistant.
needs_model_build:
type: boolean
nullable: true
description: Whether model needs to be rebuilt.
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^UA[0-9a-fA-F]{32}$
nullable: true
description: >-
The unique string that we created to identify the Assistant
resource.
unique_name:
type: string
nullable: true
description: >-
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. It can be up to 64 characters long.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the Assistant resource.
callback_url:
type: string
format: uri
nullable: true
description: Reserved.
callback_events:
type: string
nullable: true
description: Reserved.
autopilot.v1.assistant.defaults:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the Defaults resource.
assistant_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^UA[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Assistant](https://www.twilio.com/docs/autopilot/api/assistant)
that is the parent of the resource.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the Defaults resource.
data:
nullable: true
description: >-
The JSON string that describes the default task links for the
`assistant_initiation`, `collect`, and `fallback` situations.
autopilot.v1.assistant.dialogue:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the Dialogue resource.
assistant_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^UA[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Assistant](https://www.twilio.com/docs/autopilot/api/assistant)
that is the parent of the resource.
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^UK[0-9a-fA-F]{32}$
nullable: true
description: The unique string that we created to identify the Dialogue resource.
data:
nullable: true
description: The JSON string that describes the dialogue session object.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the Dialogue resource.
autopilot.v1.assistant.task.field:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the Field resource.
date_created:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was created specified in
[RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
date_updated:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was last updated
specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt)
format.
field_type:
type: string
nullable: true
description: >-
The Field Type of the field. Can be: a [Built-in Field
Type](https://www.twilio.com/docs/autopilot/built-in-field-types),
the unique_name, or the SID of a custom Field Type.
task_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^UD[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Task](https://www.twilio.com/docs/autopilot/api/task) resource
associated with this Field.
assistant_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^UA[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Assistant](https://www.twilio.com/docs/autopilot/api/assistant)
that is the parent of the Task associated with the resource.
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^UE[0-9a-fA-F]{32}$
nullable: true
description: The unique string that we created to identify the Field resource.
unique_name:
type: string
nullable: true
description: >-
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:
type: string
format: uri
nullable: true
description: The absolute URL of the Field resource.
autopilot.v1.assistant.field_type:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the FieldType resource.
date_created:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was created specified in
[RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
date_updated:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was last updated
specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt)
format.
friendly_name:
type: string
nullable: true
description: >-
The string that you assigned to describe the resource. It is not
unique and can be up to 255 characters long.
links:
type: object
format: uri-map
nullable: true
description: A list of the URLs of related resources.
assistant_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^UA[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Assistant](https://www.twilio.com/docs/autopilot/api/assistant)
that is the parent of the resource.
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^UB[0-9a-fA-F]{32}$
nullable: true
description: >-
The unique string that we created to identify the FieldType
resource.
unique_name:
type: string
nullable: true
description: >-
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:
type: string
format: uri
nullable: true
description: The absolute URL of the FieldType resource.
autopilot.v1.assistant.field_type.field_value:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the FieldValue resource.
date_created:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was created specified in
[RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
date_updated:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was last updated
specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt)
format.
field_type_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^UB[0-9a-fA-F]{32}$
nullable: true
description: The SID of the Field Type associated with the Field Value.
language:
type: string
nullable: true
description: >-
The [ISO
language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html)
tag that specifies the language of the value. Currently supported
tags: `en-US`
assistant_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^UA[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Assistant](https://www.twilio.com/docs/autopilot/api/assistant)
that is the parent of the FieldType associated with the resource.
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^UC[0-9a-fA-F]{32}$
nullable: true
description: >-
The unique string that we created to identify the FieldValue
resource.
value:
type: string
nullable: true
description: The Field Value data.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the FieldValue resource.
synonym_of:
type: string
minLength: 34
maxLength: 34
pattern: ^UC[0-9a-fA-F]{32}$
nullable: true
description: The word for which the field value is a synonym of.
autopilot.v1.assistant.model_build:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the ModelBuild resource.
date_created:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was created specified in
[RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
date_updated:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was last updated
specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt)
format.
assistant_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^UA[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Assistant](https://www.twilio.com/docs/autopilot/api/assistant)
that is the parent of the resource.
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^UG[0-9a-fA-F]{32}$
nullable: true
description: >-
The unique string that we created to identify the ModelBuild
resource.
status:
type: string
$ref: '#/components/schemas/model_build_enum_status'
nullable: true
description: >-
The status of the model build process. Can be: `enqueued`,
`building`, `completed`, or `failed`
unique_name:
type: string
nullable: true
description: >-
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.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the ModelBuild resource.
build_duration:
type: integer
nullable: true
description: The time in seconds it took to build the model.
error_code:
type: integer
nullable: true
description: >-
If the `status` for the model build is `failed`, this value is a
code to more information about the failure. This value will be null
for all other statuses. See [error code
dictionary](https://www.twilio.com/docs/api/errors) for a
description of the error.
model_build_enum_status:
type: string
enum:
- enqueued
- building
- completed
- failed
- canceled
autopilot.v1.assistant.query:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the Query resource.
date_created:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was created specified in
[RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
date_updated:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was last updated
specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt)
format.
results:
nullable: true
description: >-
The natural language analysis results that include the
[Task](https://www.twilio.com/docs/autopilot/api/task) recognized
and a list of identified
[Fields](https://www.twilio.com/docs/autopilot/api/task-field).
language:
type: string
nullable: true
description: >-
The [ISO
language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html)
string that specifies the language used by the Query. For example:
`en-US`.
model_build_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^UG[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the [Model
Build](https://www.twilio.com/docs/autopilot/api/model-build)
queried.
query:
type: string
nullable: true
description: The end-user's natural language input.
x-twilio:
pii:
handling: standard
deleteSla: 30
sample_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^UF[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of an optional reference to the
[Sample](https://www.twilio.com/docs/autopilot/api/task-sample)
created from the query.
assistant_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^UA[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Assistant](https://www.twilio.com/docs/autopilot/api/assistant)
that is the parent of the resource.
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^UH[0-9a-fA-F]{32}$
nullable: true
description: The unique string that we created to identify the Query resource.
status:
type: string
nullable: true
description: >-
The status of the Query. Can be: `pending-review`, `reviewed`, or
`discarded`
url:
type: string
format: uri
nullable: true
description: The absolute URL of the Query resource.
source_channel:
type: string
nullable: true
description: The communication channel from where the end-user input came.
dialogue_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^UK[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Dialogue](https://www.twilio.com/docs/autopilot/api/dialogue).
autopilot.v1.restore_assistant:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the Assistant resource.
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^UA[0-9a-fA-F]{32}$
nullable: true
description: >-
The unique string that we created to identify the Assistant
resource.
date_created:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was created specified in
[RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
date_updated:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was last updated
specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt)
format.
unique_name:
type: string
nullable: true
description: >-
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.
friendly_name:
type: string
nullable: true
description: >-
The string that you assigned to describe the resource. It is not
unique and can be up to 255 characters long.
needs_model_build:
type: boolean
nullable: true
description: Whether model needs to be rebuilt.
latest_model_build_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^UG[0-9a-fA-F]{32}$
nullable: true
description: Reserved.
log_queries:
type: boolean
nullable: true
description: >-
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.
development_stage:
type: string
nullable: true
description: A string describing the state of the assistant.
callback_url:
type: string
format: uri
nullable: true
description: Reserved.
callback_events:
type: string
nullable: true
description: Reserved.
autopilot.v1.assistant.task.sample:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the Sample resource.
date_created:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was created specified in
[RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
date_updated:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was last updated
specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt)
format.
task_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^UD[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Task](https://www.twilio.com/docs/autopilot/api/task) associated
with the resource.
language:
type: string
nullable: true
description: >-
The [ISO
language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html)
string that specifies the language used for the sample. For example:
`en-US`.
assistant_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^UA[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Assistant](https://www.twilio.com/docs/autopilot/api/assistant)
that is the parent of the Task associated with the resource.
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^UF[0-9a-fA-F]{32}$
nullable: true
description: The unique string that we created to identify the Sample resource.
tagged_text:
type: string
nullable: true
description: >-
The text example of how end users might express the task. The sample
can contain [Field tag
blocks](https://www.twilio.com/docs/autopilot/api/task-sample#field-tagging).
url:
type: string
format: uri
nullable: true
description: The absolute URL of the Sample resource.
source_channel:
type: string
nullable: true
description: >-
The communication channel from which the sample was captured. Can
be: `voice`, `sms`, `chat`, `alexa`, `google-assistant`, `slack`, or
null if not included.
autopilot.v1.assistant.style_sheet:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the StyleSheet resource.
assistant_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^UA[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Assistant](https://www.twilio.com/docs/autopilot/api/assistant)
that is the parent of the resource.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the StyleSheet resource.
data:
nullable: true
description: The JSON string that describes the style sheet object.
autopilot.v1.assistant.task:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the Task resource.
date_created:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was created specified in
[RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
date_updated:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was last updated
specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt)
format.
friendly_name:
type: string
nullable: true
description: >-
The string that you assigned to describe the resource. It is not
unique and can be up to 255 characters long.
links:
type: object
format: uri-map
nullable: true
description: A list of the URLs of related resources.
assistant_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^UA[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Assistant](https://www.twilio.com/docs/autopilot/api/assistant)
that is the parent of the resource.
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^UD[0-9a-fA-F]{32}$
nullable: true
description: The unique string that we created to identify the Task resource.
unique_name:
type: string
nullable: true
description: >-
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.
actions_url:
type: string
format: uri
nullable: true
description: The URL from which the Assistant can fetch actions.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the Task resource.
autopilot.v1.assistant.task.task_actions:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the TaskActions resource.
assistant_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^UA[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Assistant](https://www.twilio.com/docs/autopilot/api/assistant)
that is the parent of the Task associated with the resource.
task_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^UD[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Task](https://www.twilio.com/docs/autopilot/api/task) associated
with the resource.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the TaskActions resource.
data:
nullable: true
description: >-
The JSON string that specifies the
[actions](https://www.twilio.com/docs/autopilot/actions) that
instruct the Assistant on how to perform the task.
autopilot.v1.assistant.task.task_statistics:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the TaskStatistics resource.
assistant_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^UA[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Assistant](https://www.twilio.com/docs/autopilot/api/assistant)
that is the parent of the Task associated with the resource.
task_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^UD[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Task](https://www.twilio.com/docs/autopilot/api/task) for which the
statistics were collected.
samples_count:
type: integer
nullable: true
description: >-
The total number of
[Samples](https://www.twilio.com/docs/autopilot/api/task-sample)
associated with the Task.
fields_count:
type: integer
nullable: true
description: >-
The total number of
[Fields](https://www.twilio.com/docs/autopilot/api/task-field)
associated with the Task.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the TaskStatistics resource.
autopilot.v1.assistant.webhook:
type: object
properties:
url:
type: string
format: uri
nullable: true
description: The absolute URL of the Webhook resource.
account_sid:
type: string
minLength: 34
# --- truncated at 32 KB (123 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/twilio/refs/heads/main/openapi/autopilot-openapi-original.yml