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 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 Webhook 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: ^UM[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Webhook 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. events: type: string nullable: true description: >- The list of space-separated events that this Webhook is subscribed to. webhook_url: type: string format: uri nullable: true description: The URL associated with this Webhook. webhook_method: type: string nullable: true description: The method used when calling the webhook's URL. ListAssistantResponse: type: object properties: assistants: type: array items: $ref: '#/components/schemas/autopilot.v1.assistant' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string ListFieldResponse: type: object properties: fields: type: array items: $ref: '#/components/schemas/autopilot.v1.assistant.task.field' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string ListFieldTypeResponse: type: object properties: field_types: type: array items: $ref: '#/components/schemas/autopilot.v1.assistant.field_type' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string ListFieldValueResponse: type: object properties: field_values: type: array items: $ref: '#/components/schemas/autopilot.v1.assistant.field_type.field_value' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string ListModelBuildResponse: type: object properties: model_builds: type: array items: $ref: '#/components/schemas/autopilot.v1.assistant.model_build' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string ListQueryResponse: type: object properties: queries: type: array items: $ref: '#/components/schemas/autopilot.v1.assistant.query' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string ListSampleResponse: type: object properties: samples: type: array items: $ref: '#/components/schemas/autopilot.v1.assistant.task.sample' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string ListTaskResponse: type: object properties: tasks: type: array items: $ref: '#/components/schemas/autopilot.v1.assistant.task' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string ListWebhookResponse: type: object properties: webhooks: type: array items: $ref: '#/components/schemas/autopilot.v1.assistant.webhook' meta: type: object properties: first_page_url: type: string format: uri next_page_url: type: string format: uri nullable: true page: type: integer page_size: type: integer previous_page_url: type: string format: uri nullable: true url: type: string format: uri key: type: string UpdateAssistantRequest: type: object properties: FriendlyName: type: string description: >- A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long. LogQueries: type: boolean 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. UniqueName: type: string 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. The first 64 characters must be unique. CallbackUrl: type: string format: uri description: Reserved. CallbackEvents: type: string description: Reserved. StyleSheet: description: >- The JSON string that defines the Assistant's [style sheet](https://www.twilio.com/docs/autopilot/api/assistant/stylesheet) Defaults: description: >- A JSON object that defines the Assistant's [default tasks](https://www.twilio.com/docs/autopilot/api/assistant/defaults) for various scenarios, including initiation actions and fallback tasks. DevelopmentStage: type: string description: A string describing the state of the assistant. CreateAssistantRequest: type: object properties: FriendlyName: type: string description: >- A descriptive string that you create to describe the new resource. It is not unique and can be up to 255 characters long. LogQueries: type: boolean 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. UniqueName: type: string description: >- 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. CallbackUrl: type: string format: uri description: Reserved. CallbackEvents: type: string description: Reserved. StyleSheet: description: >- The JSON string that defines the Assistant's [style sheet](https://www.twilio.com/docs/autopilot/api/assistant/stylesheet) Defaults: description: >- A JSON object that defines the Assistant's [default tasks](https://www.twilio.com/docs/autopilot/api/assistant/defaults) for various scenarios, including initiation actions and fallback tasks. UpdateDefaultsRequest: type: object properties: Defaults: description: >- A JSON string that describes the default task links for the `assistant_initiation`, `collect`, and `fallback` situations. CreateFieldRequest: type: object properties: FieldType: type: string description: >- The Field Type of the new 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. UniqueName: type: string description: >- An application-defined string that uniquely identifies the new resource. This value must be a unique string of no more than 64 characters. It can be used as an alternative to the `sid` in the URL path to address the resource. UpdateFieldTypeRequest: type: object properties: FriendlyName: type: string description: >- A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long. UniqueName: type: string 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. The first 64 characters must be unique. CreateFieldTypeRequest: type: object properties: UniqueName: type: string description: >- 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. FriendlyName: type: string description: >- A descriptive string that you create to describe the new resource. It is not unique and can be up to 255 characters long. CreateFieldValueRequest: type: object properties: Language: type: string 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` Value: type: string description: The Field Value data. SynonymOf: type: string description: >- The string value that indicates which word the field value is a synonym of. UpdateModelBuildRequest: type: object properties: UniqueName: type: string description: >- An application-defined string that uniquely identifies the resource. This value must be a unique string of no more than 64 characters. It can be used as an alternative to the `sid` in the URL path to address the resource. CreateModelBuildRequest: type: object properties: StatusCallback: type: string format: uri description: >- The URL we should call using a POST method to send status information to your application. UniqueName: type: string description: >- An application-defined string that uniquely identifies the new resource. This value must be a unique string of no more than 64 characters. It can be used as an alternative to the `sid` in the URL path to address the resource. UpdateQueryRequest: type: object properties: SampleSid: type: string minLength: 34 maxLength: 34 pattern: ^UF[0-9a-fA-F]{32}$ description: >- The SID of an optional reference to the [Sample](https://www.twilio.com/docs/autopilot/api/task-sample) created from the query. Status: type: string description: >- The new status of the resource. Can be: `pending-review`, `reviewed`, or `discarded` CreateQueryRequest: type: object properties: Language: type: string 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 new query. For example: `en-US`. Query: type: string description: >- The end-user's natural language input. It can be up to 2048 characters long. Tasks: type: string description: >- The list of tasks to limit the new query to. Tasks are expressed as a comma-separated list of task `unique_name` values. For example, `task-unique_name-1, task-unique_name-2`. Listing specific tasks is useful to constrain the paths that a user can take. ModelBuild: type: string description: >- The SID or unique name of the [Model Build](https://www.twilio.com/docs/autopilot/api/model-build) to be queried. UpdateRestoreAssistantRequest: type: object properties: Assistant: type: string description: >- The Twilio-provided string that uniquely identifies the Assistant resource to restore. UpdateSampleRequest: type: object properties: Language: type: string 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`. TaggedText: type: string 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). SourceChannel: type: string description: >- The communication channel from which the sample was captured. Can be: `voice`, `sms`, `chat`, `alexa`, `google-assistant`, `slack`, or null if not included. CreateSampleRequest: type: object properties: Language: type: string 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 new sample. For example: `en-US`. TaggedText: type: string 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). SourceChannel: type: string description: >- The communication channel from which the new sample was captured. Can be: `voice`, `sms`, `chat`, `alexa`, `google-assistant`, `slack`, or null if not included. UpdateStyleSheetRequest: type: object properties: StyleSheet: description: The JSON string that describes the style sheet object. UpdateTaskRequest: type: object properties: FriendlyName: type: string description: >- A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long. UniqueName: type: string description: >- An application-defined string that uniquely identifies the resource. This value must be 64 characters or less in length and be unique. It can be used as an alternative to the `sid` in the URL path to address the resource. Actions: 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. ActionsUrl: type: string format: uri description: The URL from which the Assistant can fetch actions. CreateTaskRequest: type: object properties: UniqueName: type: string description: >- 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. This value must be unique and 64 characters or less in length. FriendlyName: type: string description: >- A descriptive string that you create to describe the new resource. It is not unique and can be up to 255 characters long. Actions: 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. It is optional and not unique. ActionsUrl: type: string format: uri description: The URL from which the Assistant can fetch actions. UpdateTaskActionsRequest: type: object properties: Actions: 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. UpdateWebhookRequest: type: object properties: UniqueName: type: string description: >- 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. This value must be unique and 64 characters or less in length. Events: type: string description: >- The list of space-separated events that this Webhook will subscribe to. WebhookUrl: type: string format: uri description: The URL associated with this Webhook. WebhookMethod: type: string description: The method to be used when calling the webhook's URL. CreateWebhookRequest: type: object properties: UniqueName: type: string description: >- 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. This value must be unique and 64 characters or less in length. Events: type: string description: >- The list of space-separated events that this Webhook will subscribe to. WebhookUrl: type: string format: uri description: The URL associated with this Webhook. WebhookMethod: type: string description: The method to be used when calling the webhook's URL. securitySchemes: accountSid_authToken: type: http scheme: basic info: title: Twilio - Autopilot description: >- Intelligent virtual assistants (IVA) are incredibly sophisticated applications with the potential to revolutionize the way modern businesses service customers. termsOfService: https://www.twilio.com/legal/tos contact: name: Twilio Support url: https://support.twilio.com email: support@twilio.com license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html version: 1.52.0 openapi: 3.0.1 paths: /v1/Assistants/{Sid}: servers: - url: https://autopilot.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name pathType: instance dependentProperties: field_types: mapping: assistant_sid: sid resource_url: /v1/Assistants/{assistant_sid}/FieldTypes tasks: mapping: assistant_sid: sid resource_url: /v1/Assistants/{assistant_sid}/Tasks model_builds: mapping: assistant_sid: sid resource_url: /v1/Assistants/{assistant_sid}/ModelBuilds queries: mapping: assistant_sid: sid resource_url: /v1/Assistants/{assistant_sid}/Queries style_sheet: mapping: assistant_sid: sid resource_url: /v1None defaults: mapping: assistant_sid: sid resource_url: /v1None dialogues: mapping: assistant_sid: sid resource_url: /v1/Assistants/{assistant_sid}/Dialogues webhooks: mapping: assistant_sid: sid resource_url: /v1/Assistants/{assistant_sid}/Webhooks get: description: '' tags: - Assistants parameters: - name: Sid in: path description: >- The Twilio-provided string that uniquely identifies the Assistant resource to fetch. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant' description: OK security: - accountSid_authToken: [] operationId: FetchAssistant x-maturity: - Preview post: description: '' tags: - Assistants parameters: - name: Sid in: path description: >- The Twilio-provided string that uniquely identifies the Assistant resource to update. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant' description: OK security: - accountSid_authToken: [] operationId: UpdateAssistant x-maturity: - Preview requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateAssistantRequest' delete: description: '' tags: - Assistants parameters: - name: Sid in: path description: >- The Twilio-provided string that uniquely identifies the Assistant resource to delete. schema: type: string required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteAssistant x-maturity: - Preview /v1/Assistants: servers: - url: https://autopilot.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name pathType: list dependentProperties: field_types: mapping: assistant_sid: sid resource_url: /v1/Assistants/{assistant_sid}/FieldTypes tasks: mapping: assistant_sid: sid resource_url: /v1/Assistants/{assistant_sid}/Tasks model_builds: mapping: assistant_sid: sid resource_url: /v1/Assistants/{assistant_sid}/ModelBuilds queries: mapping: assistant_sid: sid resource_url: /v1/Assistants/{assistant_sid}/Queries style_sheet: mapping: assistant_sid: sid resource_url: /v1None defaults: mapping: assistant_sid: sid resource_url: /v1None dialogues: mapping: assistant_sid: sid resource_url: /v1/Assistants/{assistant_sid}/Dialogues webhooks: mapping: assistant_sid: sid resource_url: /v1/Assistants/{assistant_sid}/Webhooks get: description: '' tags: - Assistants parameters: - name: PageSize in: query description: >- How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListAssistantResponse' description: OK security: - accountSid_authToken: [] operationId: ListAssistant x-maturity: - Preview post: description: '' tags: - Assistants responses: '201': content: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant' description: Created security: - accountSid_authToken: [] operationId: CreateAssistant x-maturity: - Preview requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateAssistantRequest' /v1/Assistants/{AssistantSid}/Defaults: servers: - url: https://autopilot.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - data pathType: instance parent: /Assistants/{Sid} className: defaults get: description: '' tags: - Assistants parameters: - name: AssistantSid in: path description: >- The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to fetch. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.defaults' description: OK security: - accountSid_authToken: [] operationId: FetchDefaults x-maturity: - Preview post: description: '' tags: - Assistants parameters: - name: AssistantSid in: path description: >- The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to update. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.defaults' description: OK security: - accountSid_authToken: [] operationId: UpdateDefaults x-maturity: - Preview requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateDefaultsRequest' /v1/Assistants/{AssistantSid}/Dialogues/{Sid}: servers: - url: https://autopilot.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - data pathType: instance parent: /Assistants/{Sid} get: description: '' tags: - Assistants parameters: - name: AssistantSid in: path description: >- The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to fetch. schema: type: string required: true - name: Sid in: path description: >- The Twilio-provided string that uniquely identifies the Dialogue resource to fetch. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.dialogue' description: OK security: - accountSid_authToken: [] operationId: FetchDialogue x-maturity: - Preview /v1/Assistants/{AssistantSid}/Dialogues: servers: - url: https://autopilot.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - data pathType: list parent: /Assistants/{Sid} /v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields/{Sid}: servers: - url: https://autopilot.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - unique_name - field_type pathType: instance parent: /Assistants/{AssistantSid}/Tasks/{Sid} get: description: '' tags: - Assistants parameters: - name: AssistantSid in: path 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 to fetch. schema: type: string required: true - name: TaskSid in: path description: >- The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) resource associated with the Field resource to fetch. schema: type: string required: true - name: Sid in: path description: >- The Twilio-provided string that uniquely identifies the Field resource to fetch. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.task.field' description: OK security: - accountSid_authToken: [] operationId: FetchField x-maturity: - Preview delete: description: '' tags: - Assistants parameters: - name: AssistantSid in: path description: >- The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the Task associated with the resources to delete. schema: type: string required: true - name: TaskSid in: path description: >- The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) resource associated with the Field resource to delete. schema: type: string required: true - name: Sid in: path description: >- The Twilio-provided string that uniquely identifies the Field resource to delete. schema: type: string required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteField x-maturity: - Preview /v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields: servers: - url: https://autopilot.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - unique_name - field_type pathType: list parent: /Assistants/{AssistantSid}/Tasks/{Sid} get: description: '' tags: - Assistants parameters: - name: AssistantSid in: path description: >- The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the Task associated with the resources to read. schema: type: string required: true - name: TaskSid in: path description: >- The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) resource associated with the Field resources to read. schema: type: string required: true - name: PageSize in: query description: >- How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListFieldResponse' description: OK security: - accountSid_authToken: [] operationId: ListField x-maturity: - Preview post: description: '' tags: - Assistants parameters: - name: AssistantSid in: path description: >- The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the Task associated with the new resource. schema: type: string required: true - name: TaskSid in: path description: >- The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) resource associated with the new Field resource. schema: type: string required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.task.field' description: Created security: - accountSid_authToken: [] operationId: CreateField x-maturity: - Preview requestBody: content: application/x-www-form-urlencoded: schema: required: - FieldType - UniqueName $ref: '#/components/schemas/CreateFieldRequest' /v1/Assistants/{AssistantSid}/FieldTypes/{Sid}: servers: - url: https://autopilot.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name pathType: instance dependentProperties: field_values: mapping: assistant_sid: assistant_sid field_type_sid: sid resource_url: >- /v1/Assistants/{assistant_sid}/FieldTypes/{field_type_sid}/FieldValues parent: /Assistants/{Sid} get: description: '' tags: - Assistants parameters: - name: AssistantSid in: path description: >- The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to fetch. schema: type: string required: true - name: Sid in: path description: >- The Twilio-provided string that uniquely identifies the FieldType resource to fetch. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.field_type' description: OK security: - accountSid_authToken: [] operationId: FetchFieldType x-maturity: - Preview post: description: '' tags: - Assistants parameters: - name: AssistantSid in: path description: >- The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the to update. schema: type: string required: true - name: Sid in: path description: >- The Twilio-provided string that uniquely identifies the FieldType resource to update. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.field_type' description: OK security: - accountSid_authToken: [] operationId: UpdateFieldType x-maturity: - Preview requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateFieldTypeRequest' delete: description: '' tags: - Assistants parameters: - name: AssistantSid in: path description: >- The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resources to delete. schema: type: string required: true - name: Sid in: path description: >- The Twilio-provided string that uniquely identifies the FieldType resource to delete. schema: type: string required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteFieldType x-maturity: - Preview /v1/Assistants/{AssistantSid}/FieldTypes: servers: - url: https://autopilot.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name pathType: list dependentProperties: field_values: mapping: assistant_sid: assistant_sid field_type_sid: sid resource_url: >- /v1/Assistants/{assistant_sid}/FieldTypes/{field_type_sid}/FieldValues parent: /Assistants/{Sid} get: description: '' tags: - Assistants parameters: - name: AssistantSid in: path description: >- The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resources to read. schema: type: string required: true - name: PageSize in: query description: >- How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListFieldTypeResponse' description: OK security: - accountSid_authToken: [] operationId: ListFieldType x-maturity: - Preview post: description: '' tags: - Assistants parameters: - name: AssistantSid in: path description: >- The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the new resource. schema: type: string required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.field_type' description: Created security: - accountSid_authToken: [] operationId: CreateFieldType x-maturity: - Preview requestBody: content: application/x-www-form-urlencoded: schema: required: - UniqueName $ref: '#/components/schemas/CreateFieldTypeRequest' /v1/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues/{Sid}: servers: - url: https://autopilot.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - value - language pathType: instance parent: /Assistants/{AssistantSid}/FieldTypes/{Sid} get: description: '' tags: - Assistants parameters: - name: AssistantSid in: path 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 to fetch. schema: type: string required: true - name: FieldTypeSid in: path description: The SID of the Field Type associated with the Field Value to fetch. schema: type: string required: true - name: Sid in: path description: >- The Twilio-provided string that uniquely identifies the FieldValue resource to fetch. schema: type: string required: true responses: '200': content: application/json: schema: $ref: >- #/components/schemas/autopilot.v1.assistant.field_type.field_value description: OK security: - accountSid_authToken: [] operationId: FetchFieldValue x-maturity: - Preview delete: description: '' tags: - Assistants parameters: - name: AssistantSid in: path description: >- The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the FieldType associated with the resources to delete. schema: type: string required: true - name: FieldTypeSid in: path description: The SID of the Field Type associated with the Field Value to delete. schema: type: string required: true - name: Sid in: path description: >- The Twilio-provided string that uniquely identifies the FieldValue resource to delete. schema: type: string required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteFieldValue x-maturity: - Preview /v1/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues: servers: - url: https://autopilot.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - value - language pathType: list parent: /Assistants/{AssistantSid}/FieldTypes/{Sid} get: description: '' tags: - Assistants parameters: - name: AssistantSid in: path description: >- The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the FieldType associated with the resources to read. schema: type: string required: true - name: FieldTypeSid in: path description: The SID of the Field Type associated with the Field Value to read. schema: type: string required: true - name: Language in: query 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` schema: type: string - name: PageSize in: query description: >- How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListFieldValueResponse' description: OK security: - accountSid_authToken: [] operationId: ListFieldValue x-maturity: - Preview post: description: '' tags: - Assistants parameters: - name: AssistantSid in: path description: >- The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the FieldType associated with the new resource. schema: type: string required: true - name: FieldTypeSid in: path description: The SID of the Field Type associated with the Field Value. schema: type: string required: true responses: '201': content: application/json: schema: $ref: >- #/components/schemas/autopilot.v1.assistant.field_type.field_value description: Created security: - accountSid_authToken: [] operationId: CreateFieldValue x-maturity: - Preview requestBody: content: application/x-www-form-urlencoded: schema: required: - Language - Value $ref: '#/components/schemas/CreateFieldValueRequest' /v1/Assistants/{AssistantSid}/ModelBuilds/{Sid}: servers: - url: https://autopilot.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - unique_name - status - date_created pathType: instance parent: /Assistants/{Sid} get: description: '' tags: - Assistants parameters: - name: AssistantSid in: path description: >- The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to fetch. schema: type: string required: true - name: Sid in: path description: >- The Twilio-provided string that uniquely identifies the ModelBuild resource to fetch. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.model_build' description: OK security: - accountSid_authToken: [] operationId: FetchModelBuild x-maturity: - Preview post: description: '' tags: - Assistants parameters: - name: AssistantSid in: path description: >- The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to update. schema: type: string required: true - name: Sid in: path description: >- The Twilio-provided string that uniquely identifies the ModelBuild resource to update. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.model_build' description: OK security: - accountSid_authToken: [] operationId: UpdateModelBuild x-maturity: - Preview requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateModelBuildRequest' delete: description: '' tags: - Assistants parameters: - name: AssistantSid in: path description: >- The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resources to delete. schema: type: string required: true - name: Sid in: path description: >- The Twilio-provided string that uniquely identifies the ModelBuild resource to delete. schema: type: string required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteModelBuild x-maturity: - Preview /v1/Assistants/{AssistantSid}/ModelBuilds: servers: - url: https://autopilot.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - unique_name - status - date_created pathType: list parent: /Assistants/{Sid} get: description: '' tags: - Assistants parameters: - name: AssistantSid in: path description: >- The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resources to read. schema: type: string required: true - name: PageSize in: query description: >- How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListModelBuildResponse' description: OK security: - accountSid_authToken: [] operationId: ListModelBuild x-maturity: - Preview post: description: '' tags: - Assistants parameters: - name: AssistantSid in: path description: >- The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the new resource. schema: type: string required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.model_build' description: Created security: - accountSid_authToken: [] operationId: CreateModelBuild x-maturity: - Preview requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CreateModelBuildRequest' /v1/Assistants/{AssistantSid}/Queries/{Sid}: servers: - url: https://autopilot.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - query - status - language pathType: instance parent: /Assistants/{Sid} get: description: '' tags: - Assistants parameters: - name: AssistantSid in: path description: >- The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to fetch. schema: type: string required: true - name: Sid in: path description: >- The Twilio-provided string that uniquely identifies the Query resource to fetch. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.query' description: OK security: - accountSid_authToken: [] operationId: FetchQuery x-maturity: - Preview post: description: '' tags: - Assistants parameters: - name: AssistantSid in: path description: >- The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to update. schema: type: string required: true - name: Sid in: path description: >- The Twilio-provided string that uniquely identifies the Query resource to update. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.query' description: OK security: - accountSid_authToken: [] operationId: UpdateQuery x-maturity: - Preview requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateQueryRequest' delete: description: '' tags: - Assistants parameters: - name: AssistantSid in: path description: >- The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resources to delete. schema: type: string required: true - name: Sid in: path description: >- The Twilio-provided string that uniquely identifies the Query resource to delete. schema: type: string required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteQuery x-maturity: - Preview /v1/Assistants/{AssistantSid}/Queries: servers: - url: https://autopilot.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - query - status - language pathType: list parent: /Assistants/{Sid} get: description: '' tags: - Assistants parameters: - name: AssistantSid in: path description: >- The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resources to read. schema: type: string required: true - name: Language in: query 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 resources to read. For example: `en-US`. schema: type: string - name: ModelBuild in: query description: >- The SID or unique name of the [Model Build](https://www.twilio.com/docs/autopilot/api/model-build) to be queried. schema: type: string - name: Status in: query description: >- The status of the resources to read. Can be: `pending-review`, `reviewed`, or `discarded` schema: type: string - name: DialogueSid in: query description: >- The SID of the [Dialogue](https://www.twilio.com/docs/autopilot/api/dialogue). schema: type: string minLength: 34 maxLength: 34 pattern: ^UK[0-9a-fA-F]{32}$ - name: PageSize in: query description: >- How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListQueryResponse' description: OK security: - accountSid_authToken: [] operationId: ListQuery x-maturity: - Preview post: description: '' tags: - Assistants parameters: - name: AssistantSid in: path description: >- The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the new resource. schema: type: string required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.query' description: Created security: - accountSid_authToken: [] operationId: CreateQuery x-maturity: - Preview requestBody: content: application/x-www-form-urlencoded: schema: required: - Language - Query $ref: '#/components/schemas/CreateQueryRequest' /v1/Assistants/Restore: servers: - url: https://autopilot.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - account_sid - sid - unique_name - friendly_name pathType: list mountName: restore_assistant post: description: '' tags: - Assistants responses: '200': content: application/json: schema: $ref: '#/components/schemas/autopilot.v1.restore_assistant' description: OK security: - accountSid_authToken: [] operationId: UpdateRestoreAssistant x-maturity: - Preview requestBody: content: application/x-www-form-urlencoded: schema: required: - Assistant $ref: '#/components/schemas/UpdateRestoreAssistantRequest' /v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples/{Sid}: servers: - url: https://autopilot.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - tagged_text - language - source_channel pathType: instance parent: /Assistants/{AssistantSid}/Tasks/{Sid} get: description: '' tags: - Assistants parameters: - name: AssistantSid in: path 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 to fetch. schema: type: string required: true - name: TaskSid in: path description: >- The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) associated with the Sample resource to create. schema: type: string required: true - name: Sid in: path description: >- The Twilio-provided string that uniquely identifies the Sample resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^UF[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.task.sample' description: OK security: - accountSid_authToken: [] operationId: FetchSample x-maturity: - Preview post: description: '' tags: - Assistants parameters: - name: AssistantSid in: path 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 to update. schema: type: string required: true - name: TaskSid in: path description: >- The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) associated with the Sample resource to update. schema: type: string required: true - name: Sid in: path description: >- The Twilio-provided string that uniquely identifies the Sample resource to update. schema: type: string minLength: 34 maxLength: 34 pattern: ^UF[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.task.sample' description: OK security: - accountSid_authToken: [] operationId: UpdateSample x-maturity: - Preview requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateSampleRequest' delete: description: '' tags: - Assistants parameters: - name: AssistantSid in: path description: >- The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the Task associated with the resources to delete. schema: type: string required: true - name: TaskSid in: path description: >- The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) associated with the Sample resource to delete. schema: type: string required: true - name: Sid in: path description: >- The Twilio-provided string that uniquely identifies the Sample resource to delete. schema: type: string minLength: 34 maxLength: 34 pattern: ^UF[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteSample x-maturity: - Preview /v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples: servers: - url: https://autopilot.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - tagged_text - language - source_channel pathType: list parent: /Assistants/{AssistantSid}/Tasks/{Sid} get: description: '' tags: - Assistants parameters: - name: AssistantSid in: path description: >- The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the Task associated with the resources to read. schema: type: string required: true - name: TaskSid in: path description: >- The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) associated with the Sample resources to read. schema: type: string required: true - name: Language in: query 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`. schema: type: string - name: PageSize in: query description: >- How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListSampleResponse' description: OK security: - accountSid_authToken: [] operationId: ListSample x-maturity: - Preview post: description: '' tags: - Assistants parameters: - name: AssistantSid in: path description: >- The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the Task associated with the new resource. schema: type: string required: true - name: TaskSid in: path description: >- The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) associated with the Sample resource to create. schema: type: string required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.task.sample' description: Created security: - accountSid_authToken: [] operationId: CreateSample x-maturity: - Preview requestBody: content: application/x-www-form-urlencoded: schema: required: - Language - TaggedText $ref: '#/components/schemas/CreateSampleRequest' /v1/Assistants/{AssistantSid}/StyleSheet: servers: - url: https://autopilot.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - data pathType: instance parent: /Assistants/{Sid} get: description: Returns Style sheet JSON object for the Assistant tags: - Assistants parameters: - name: AssistantSid in: path description: >- The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to fetch. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.style_sheet' description: OK security: - accountSid_authToken: [] operationId: FetchStyleSheet x-maturity: - Preview post: description: Updates the style sheet for an Assistant identified by `assistant_sid`. tags: - Assistants parameters: - name: AssistantSid in: path description: >- The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to update. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.style_sheet' description: OK security: - accountSid_authToken: [] operationId: UpdateStyleSheet x-maturity: - Preview requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateStyleSheetRequest' /v1/Assistants/{AssistantSid}/Tasks/{Sid}: servers: - url: https://autopilot.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name pathType: instance dependentProperties: fields: mapping: assistant_sid: assistant_sid task_sid: sid resource_url: /v1/Assistants/{assistant_sid}/Tasks/{task_sid}/Fields samples: mapping: assistant_sid: assistant_sid task_sid: sid resource_url: /v1/Assistants/{assistant_sid}/Tasks/{task_sid}/Samples task_actions: mapping: assistant_sid: assistant_sid task_sid: sid resource_url: /v1None statistics: mapping: assistant_sid: assistant_sid task_sid: sid resource_url: /v1None parent: /Assistants/{Sid} get: description: '' tags: - Assistants parameters: - name: AssistantSid in: path description: >- The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to fetch. schema: type: string required: true - name: Sid in: path description: >- The Twilio-provided string that uniquely identifies the Task resource to fetch. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.task' description: OK security: - accountSid_authToken: [] operationId: FetchTask x-maturity: - Preview post: description: '' tags: - Assistants parameters: - name: AssistantSid in: path description: >- The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to update. schema: type: string required: true - name: Sid in: path description: >- The Twilio-provided string that uniquely identifies the Task resource to update. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.task' description: OK security: - accountSid_authToken: [] operationId: UpdateTask x-maturity: - Preview requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateTaskRequest' delete: description: '' tags: - Assistants parameters: - name: AssistantSid in: path description: >- The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resources to delete. schema: type: string required: true - name: Sid in: path description: >- The Twilio-provided string that uniquely identifies the Task resource to delete. schema: type: string required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteTask x-maturity: - Preview /v1/Assistants/{AssistantSid}/Tasks: servers: - url: https://autopilot.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name pathType: list dependentProperties: fields: mapping: assistant_sid: assistant_sid task_sid: sid resource_url: /v1/Assistants/{assistant_sid}/Tasks/{task_sid}/Fields samples: mapping: assistant_sid: assistant_sid task_sid: sid resource_url: /v1/Assistants/{assistant_sid}/Tasks/{task_sid}/Samples task_actions: mapping: assistant_sid: assistant_sid task_sid: sid resource_url: /v1None statistics: mapping: assistant_sid: assistant_sid task_sid: sid resource_url: /v1None parent: /Assistants/{Sid} get: description: '' tags: - Assistants parameters: - name: AssistantSid in: path description: >- The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resources to read. schema: type: string required: true - name: PageSize in: query description: >- How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListTaskResponse' description: OK security: - accountSid_authToken: [] operationId: ListTask x-maturity: - Preview post: description: '' tags: - Assistants parameters: - name: AssistantSid in: path description: >- The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the new resource. schema: type: string required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.task' description: Created security: - accountSid_authToken: [] operationId: CreateTask x-maturity: - Preview requestBody: content: application/x-www-form-urlencoded: schema: required: - UniqueName $ref: '#/components/schemas/CreateTaskRequest' /v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Actions: servers: - url: https://autopilot.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - data pathType: instance parent: /Assistants/{AssistantSid}/Tasks/{Sid} mountName: task_actions className: task_actions get: description: Returns JSON actions for the Task. tags: - Assistants parameters: - name: AssistantSid in: path description: >- The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the Task for which the task actions to fetch were defined. schema: type: string required: true - name: TaskSid in: path description: >- The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) for which the task actions to fetch were defined. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.task.task_actions' description: OK security: - accountSid_authToken: [] operationId: FetchTaskActions x-maturity: - Preview post: description: >- Updates the actions of an Task identified by {TaskSid} or {TaskUniqueName}. tags: - Assistants parameters: - name: AssistantSid in: path description: >- The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the Task for which the task actions to update were defined. schema: type: string required: true - name: TaskSid in: path description: >- The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) for which the task actions to update were defined. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.task.task_actions' description: OK security: - accountSid_authToken: [] operationId: UpdateTaskActions x-maturity: - Preview requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateTaskActionsRequest' /v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Statistics: servers: - url: https://autopilot.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - samples_count - fields_count pathType: instance parent: /Assistants/{AssistantSid}/Tasks/{Sid} className: task_statistics get: description: '' tags: - Assistants parameters: - name: AssistantSid in: path description: >- The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to fetch. schema: type: string required: true - name: TaskSid in: path description: >- The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) that is associated with the resource to fetch. schema: type: string required: true responses: '200': content: application/json: schema: $ref: >- #/components/schemas/autopilot.v1.assistant.task.task_statistics description: OK security: - accountSid_authToken: [] operationId: FetchTaskStatistics x-maturity: - Preview /v1/Assistants/{AssistantSid}/Webhooks/{Sid}: servers: - url: https://autopilot.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - unique_name - events - wehbook_url - webhook_method pathType: instance parent: /Assistants/{Sid} get: description: '' tags: - Assistants parameters: - name: AssistantSid in: path description: >- The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to fetch. schema: type: string required: true - name: Sid in: path description: >- The Twilio-provided string that uniquely identifies the Webhook resource to fetch. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.webhook' description: OK security: - accountSid_authToken: [] operationId: FetchWebhook x-maturity: - Preview post: description: '' tags: - Assistants parameters: - name: AssistantSid in: path description: >- The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to update. schema: type: string required: true - name: Sid in: path description: >- The Twilio-provided string that uniquely identifies the Webhook resource to update. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.webhook' description: OK security: - accountSid_authToken: [] operationId: UpdateWebhook x-maturity: - Preview requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateWebhookRequest' delete: description: '' tags: - Assistants parameters: - name: AssistantSid in: path description: >- The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resources to delete. schema: type: string required: true - name: Sid in: path description: >- The Twilio-provided string that uniquely identifies the Webhook resource to delete. schema: type: string required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteWebhook x-maturity: - Preview /v1/Assistants/{AssistantSid}/Webhooks: servers: - url: https://autopilot.twilio.com description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - sid - unique_name - events - wehbook_url - webhook_method pathType: list parent: /Assistants/{Sid} get: description: '' tags: - Assistants parameters: - name: AssistantSid in: path description: >- The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resources to read. schema: type: string required: true - name: PageSize in: query description: >- How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListWebhookResponse' description: OK security: - accountSid_authToken: [] operationId: ListWebhook x-maturity: - Preview post: description: '' tags: - Assistants parameters: - name: AssistantSid in: path description: >- The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the new resource. schema: type: string required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/autopilot.v1.assistant.webhook' description: Created security: - accountSid_authToken: [] operationId: CreateWebhook x-maturity: - Preview requestBody: content: application/x-www-form-urlencoded: schema: required: - UniqueName - Events - WebhookUrl $ref: '#/components/schemas/CreateWebhookRequest' servers: - url: https://autopilot.twilio.com tags: - name: Assistants x-maturity: - name: Preview description: >- PLEASE NOTE that this is a Preview product that is subject to change. Use it with caution. If you currently do not have developer preview access, please contact https://www.twilio.com/help/contact.