APIHub
Back to Explore

Twilio - Autopilot

The Twilio Autopilot API is a RESTful interface for creating, configuring, and managing conversational assistants, providing endpoints to list, retrieve, create, update, and delete assistants, their tasks, fields, actions, model builds, queries, dialogues, style sheets, defaults, and associated field types and values.

Telecom
basic
HTTPS
CORS: Unknown
Description enriched …
Visit official documentation

Latency

496ms p95

Uptime

100.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
GET

/v1/Assistants

  • PageSize (query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
  • Page (query, page) — The page index. This value is simply for client state.
  • PageToken (query) — The page token. This is provided by the API.
POST

/v1/Assistants

POST

/v1/Assistants/Restore

GET

/v1/Assistants/{AssistantSid}/Defaults

  • AssistantSid (path, required) — The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to fetch.
POST

/v1/Assistants/{AssistantSid}/Defaults

  • AssistantSid (path, required) — The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to update.
GET

/v1/Assistants/{AssistantSid}/Dialogues/{Sid}

  • AssistantSid (path, required) — The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to fetch.
  • Sid (path, required) — The Twilio-provided string that uniquely identifies the Dialogue resource to fetch.
GET

/v1/Assistants/{AssistantSid}/FieldTypes

  • AssistantSid (path, required) — The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resources to read.
  • PageSize (query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
  • Page (query, page) — The page index. This value is simply for client state.
  • PageToken (query) — The page token. This is provided by the API.
POST

/v1/Assistants/{AssistantSid}/FieldTypes

  • AssistantSid (path, required) — The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the new resource.
POST

/v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Actions

Updates the actions of an Task identified by {TaskSid} or {TaskUniqueName}.

  • AssistantSid (path, required) — 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.
  • TaskSid (path, required) — The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) for which the task actions to update were defined.
GET

/v1/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues

  • AssistantSid (path, required) — 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.
  • FieldTypeSid (path, required) — The SID of the Field Type associated with the Field Value to read.
  • Language (query) — 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`
  • PageSize (query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
  • Page (query, page) — The page index. This value is simply for client state.
  • PageToken (query) — The page token. This is provided by the API.
POST

/v1/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues

  • AssistantSid (path, required) — 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.
  • FieldTypeSid (path, required) — The SID of the Field Type associated with the Field Value.
DELETE

/v1/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues/{Sid}

  • AssistantSid (path, required) — 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.
  • FieldTypeSid (path, required) — The SID of the Field Type associated with the Field Value to delete.
  • Sid (path, required) — The Twilio-provided string that uniquely identifies the FieldValue resource to delete.
GET

/v1/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues/{Sid}

  • AssistantSid (path, required) — 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.
  • FieldTypeSid (path, required) — The SID of the Field Type associated with the Field Value to fetch.
  • Sid (path, required) — The Twilio-provided string that uniquely identifies the FieldValue resource to fetch.
DELETE

/v1/Assistants/{AssistantSid}/FieldTypes/{Sid}

  • AssistantSid (path, required) — The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resources to delete.
  • Sid (path, required) — The Twilio-provided string that uniquely identifies the FieldType resource to delete.
GET

/v1/Assistants/{AssistantSid}/FieldTypes/{Sid}

  • AssistantSid (path, required) — The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to fetch.
  • Sid (path, required) — The Twilio-provided string that uniquely identifies the FieldType resource to fetch.
POST

/v1/Assistants/{AssistantSid}/FieldTypes/{Sid}

  • AssistantSid (path, required) — The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the to update.
  • Sid (path, required) — The Twilio-provided string that uniquely identifies the FieldType resource to update.
GET

/v1/Assistants/{AssistantSid}/ModelBuilds

  • AssistantSid (path, required) — The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resources to read.
  • PageSize (query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
  • Page (query, page) — The page index. This value is simply for client state.
  • PageToken (query) — The page token. This is provided by the API.
POST

/v1/Assistants/{AssistantSid}/ModelBuilds

  • AssistantSid (path, required) — The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the new resource.
DELETE

/v1/Assistants/{AssistantSid}/ModelBuilds/{Sid}

  • AssistantSid (path, required) — The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resources to delete.
  • Sid (path, required) — The Twilio-provided string that uniquely identifies the ModelBuild resource to delete.
GET

/v1/Assistants/{AssistantSid}/ModelBuilds/{Sid}

  • AssistantSid (path, required) — The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to fetch.
  • Sid (path, required) — The Twilio-provided string that uniquely identifies the ModelBuild resource to fetch.
POST

/v1/Assistants/{AssistantSid}/ModelBuilds/{Sid}

  • AssistantSid (path, required) — The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to update.
  • Sid (path, required) — The Twilio-provided string that uniquely identifies the ModelBuild resource to update.
GET

/v1/Assistants/{AssistantSid}/Queries

  • AssistantSid (path, required) — The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resources to read.
  • Language (query) — 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`.
  • ModelBuild (query) — The SID or unique name of the [Model Build](https://www.twilio.com/docs/autopilot/api/model-build) to be queried.
  • Status (query) — The status of the resources to read. Can be: `pending-review`, `reviewed`, or `discarded`
  • DialogueSid (query) — The SID of the [Dialogue](https://www.twilio.com/docs/autopilot/api/dialogue).
  • PageSize (query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
  • Page (query, page) — The page index. This value is simply for client state.
  • PageToken (query) — The page token. This is provided by the API.
POST

/v1/Assistants/{AssistantSid}/Queries

  • AssistantSid (path, required) — The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the new resource.
DELETE

/v1/Assistants/{AssistantSid}/Queries/{Sid}

  • AssistantSid (path, required) — The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resources to delete.
  • Sid (path, required) — The Twilio-provided string that uniquely identifies the Query resource to delete.
GET

/v1/Assistants/{AssistantSid}/Queries/{Sid}

  • AssistantSid (path, required) — The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to fetch.
  • Sid (path, required) — The Twilio-provided string that uniquely identifies the Query resource to fetch.
POST

/v1/Assistants/{AssistantSid}/Queries/{Sid}

  • AssistantSid (path, required) — The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to update.
  • Sid (path, required) — The Twilio-provided string that uniquely identifies the Query resource to update.
GET

/v1/Assistants/{AssistantSid}/StyleSheet

Returns Style sheet JSON object for the Assistant

  • AssistantSid (path, required) — The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to fetch.
POST

/v1/Assistants/{AssistantSid}/StyleSheet

Updates the style sheet for an Assistant identified by `assistant_sid`.

  • AssistantSid (path, required) — The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to update.
GET

/v1/Assistants/{AssistantSid}/Tasks

  • AssistantSid (path, required) — The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resources to read.
  • PageSize (query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
  • Page (query, page) — The page index. This value is simply for client state.
  • PageToken (query) — The page token. This is provided by the API.
POST

/v1/Assistants/{AssistantSid}/Tasks

  • AssistantSid (path, required) — The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the new resource.
DELETE

/v1/Assistants/{AssistantSid}/Tasks/{Sid}

  • AssistantSid (path, required) — The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resources to delete.
  • Sid (path, required) — The Twilio-provided string that uniquely identifies the Task resource to delete.
GET

/v1/Assistants/{AssistantSid}/Tasks/{Sid}

  • AssistantSid (path, required) — The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to fetch.
  • Sid (path, required) — The Twilio-provided string that uniquely identifies the Task resource to fetch.
POST

/v1/Assistants/{AssistantSid}/Tasks/{Sid}

  • AssistantSid (path, required) — The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to update.
  • Sid (path, required) — The Twilio-provided string that uniquely identifies the Task resource to update.
GET

/v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Actions

Returns JSON actions for the Task.

  • AssistantSid (path, required) — 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.
  • TaskSid (path, required) — The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) for which the task actions to fetch were defined.
GET

/v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields

  • AssistantSid (path, required) — 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.
  • TaskSid (path, required) — The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) resource associated with the Field resources to read.
  • PageSize (query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
  • Page (query, page) — The page index. This value is simply for client state.
  • PageToken (query) — The page token. This is provided by the API.
POST

/v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields

  • AssistantSid (path, required) — 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.
  • TaskSid (path, required) — The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) resource associated with the new Field resource.
DELETE

/v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields/{Sid}

  • AssistantSid (path, required) — 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.
  • TaskSid (path, required) — The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) resource associated with the Field resource to delete.
  • Sid (path, required) — The Twilio-provided string that uniquely identifies the Field resource to delete.
GET

/v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields/{Sid}

  • AssistantSid (path, required) — 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.
  • TaskSid (path, required) — The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) resource associated with the Field resource to fetch.
  • Sid (path, required) — The Twilio-provided string that uniquely identifies the Field resource to fetch.
GET

/v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples

  • AssistantSid (path, required) — 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.
  • TaskSid (path, required) — The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) associated with the Sample resources to read.
  • Language (query) — 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`.
  • PageSize (query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
  • Page (query, page) — The page index. This value is simply for client state.
  • PageToken (query) — The page token. This is provided by the API.
POST

/v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples

  • AssistantSid (path, required) — 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.
  • TaskSid (path, required) — The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) associated with the Sample resource to create.
DELETE

/v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples/{Sid}

  • AssistantSid (path, required) — 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.
  • TaskSid (path, required) — The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) associated with the Sample resource to delete.
  • Sid (path, required) — The Twilio-provided string that uniquely identifies the Sample resource to delete.
GET

/v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples/{Sid}

  • AssistantSid (path, required) — 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.
  • TaskSid (path, required) — The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) associated with the Sample resource to create.
  • Sid (path, required) — The Twilio-provided string that uniquely identifies the Sample resource to fetch.
POST

/v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples/{Sid}

  • AssistantSid (path, required) — 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.
  • TaskSid (path, required) — The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) associated with the Sample resource to update.
  • Sid (path, required) — The Twilio-provided string that uniquely identifies the Sample resource to update.
GET

/v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Statistics

  • AssistantSid (path, required) — The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to fetch.
  • TaskSid (path, required) — The SID of the [Task](https://www.twilio.com/docs/autopilot/api/task) that is associated with the resource to fetch.
GET

/v1/Assistants/{AssistantSid}/Webhooks

  • AssistantSid (path, required) — The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resources to read.
  • PageSize (query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
  • Page (query, page) — The page index. This value is simply for client state.
  • PageToken (query) — The page token. This is provided by the API.
POST

/v1/Assistants/{AssistantSid}/Webhooks

  • AssistantSid (path, required) — The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the new resource.
DELETE

/v1/Assistants/{AssistantSid}/Webhooks/{Sid}

  • AssistantSid (path, required) — The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resources to delete.
  • Sid (path, required) — The Twilio-provided string that uniquely identifies the Webhook resource to delete.
GET

/v1/Assistants/{AssistantSid}/Webhooks/{Sid}

  • AssistantSid (path, required) — The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to fetch.
  • Sid (path, required) — The Twilio-provided string that uniquely identifies the Webhook resource to fetch.
POST

/v1/Assistants/{AssistantSid}/Webhooks/{Sid}

  • AssistantSid (path, required) — The SID of the [Assistant](https://www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource to update.
  • Sid (path, required) — The Twilio-provided string that uniquely identifies the Webhook resource to update.
DELETE

/v1/Assistants/{Sid}

  • Sid (path, required) — The Twilio-provided string that uniquely identifies the Assistant resource to delete.
GET

/v1/Assistants/{Sid}

  • Sid (path, required) — The Twilio-provided string that uniquely identifies the Assistant resource to fetch.
POST

/v1/Assistants/{Sid}

  • Sid (path, required) — The Twilio-provided string that uniquely identifies the Assistant resource to update.

52 endpoints auto-detected

Authentication

This API uses Basic authentication (a username and password).

curl -X GET \
  "https://autopilot.twilio.com/v1/Assistants"

autopilot.twilio.com · HTTPS only