Create assistant

POST /v1/Assistants

TODO: Resource-level docs

Body

  • CallbackEvents string

    Reserved.

  • CallbackUrl string(uri)

    Reserved.

  • Defaults

    A JSON object that defines the Assistant's default tasks for various scenarios, including initiation actions and fallback tasks.

  • FriendlyName string

    A descriptive string that you create to describe the new resource. It is not unique and can be up to 255 characters long.

  • LogQueries boolean

    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.

  • StyleSheet

    The JSON string that defines the Assistant's style sheet

  • UniqueName string

    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.

Responses

  • 201

    Created

    Hide response attributes Show response attributes object
    • account_sid string | null

      The SID of the Account that created the resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • callback_events string | null

      Reserved

    • callback_url string(uri) | null

      Reserved

    • date_created string(date-time) | null

      The RFC 2822 date and time in GMT when the resource was created

    • date_updated string(date-time) | null

      The RFC 2822 date and time in GMT when the resource was last updated

    • development_stage string | null

      A string describing the state of the assistant.

    • friendly_name string | null

      The string that you assigned to describe the resource

    • latest_model_build_sid string | null

      Reserved

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^UG[0-9a-fA-F]{32}$.

    • links object(uri-map) | null

      A list of the URLs of the Assistant's related resources

    • log_queries boolean | null

      Whether queries should be logged and kept after training

    • needs_model_build boolean | null

      Whether model needs to be rebuilt

    • sid string | null

      The unique string that identifies the resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^UA[0-9a-fA-F]{32}$.

    • unique_name string | null

      An application-defined string that uniquely identifies the resource

    • url string(uri) | null

      The absolute URL of the Assistant resource
POST /v1/Assistants 
curl \
 -X POST https://autopilot.twilio.com/v1/Assistants \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'CallbackEvents=string&CallbackUrl=https%3A%2F%2Fexample.com&FriendlyName=string&LogQueries=true&UniqueName=string'
Request example 
{
  "CallbackEvents": "string",
  "CallbackUrl": "https://example.com",
  "FriendlyName": "string",
  "LogQueries": true,
  "UniqueName": "string"
}
Request examples 
{
  "CallbackEvents": "string",
  "CallbackUrl": "https://example.com",
  "FriendlyName": "string",
  "LogQueries": true,
  "UniqueName": "string"
}
Response examples (201) 
{
  "account_sid": "string",
  "callback_events": "string",
  "callback_url": "https://example.com",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "development_stage": "string",
  "friendly_name": "string",
  "latest_model_build_sid": "string",
  "links": {},
  "log_queries": true,
  "needs_model_build": true,
  "sid": "string",
  "unique_name": "string",
  "url": "https://example.com"
}
Response examples (201) 
{
  "account_sid": "string",
  "callback_events": "string",
  "callback_url": "https://example.com",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "development_stage": "string",
  "friendly_name": "string",
  "latest_model_build_sid": "string",
  "links": {},
  "log_queries": true,
  "needs_model_build": true,
  "sid": "string",
  "unique_name": "string",
  "url": "https://example.com"
}