Create a new assistant

POST /v1/Assistants
Account sid auth token

create an assistant

application/json

Body Required

  • customer_ai object

    The Personalization and Perception Engine settings.

    Hide customer_ai attributes Show customer_ai attributes object
    • perception_engine_enabled boolean Required

      True if the perception engine is enabled.

    • personalization_engine_enabled boolean Required

      True if the personalization engine is enabled.

  • name string Required

    The name of the assistant.

  • owner string

    The owner/company of the assistant.

  • personality_prompt string

    The personality prompt to be used for assistant.

  • segment_credential object

    The Segment Credentials to be used for the assistant.

    Hide segment_credential attributes Show segment_credential attributes object
    • profile_api_key string

      The profile API key.

    • space_id string

      The space ID.

    • write_key string

      The write key.

Responses

  • 201 application/json

    OK

    Hide response attributes Show response attributes object
    • account_sid string Required

      The SID of the Account that created the Assistant resource.

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

    • customer_ai object Required

      The Personalization and Perception Engine settings.

    • id string Required

      The Assistant ID.

      Format should match the following pattern: ^aia_asst_.+$.

    • model string Required

      The default model used by the assistant.

    • name string Required

      The name of the assistant.

    • owner string Required

      The owner/company of the assistant.

    • url string

      The url of the assistant resource.

    • personality_prompt string Required

      The personality prompt to be used for assistant.

    • date_created string(date-time) Required

      The date and time in GMT when the Assistant was created specified in ISO 8601 format.

    • date_updated string(date-time) Required

      The date and time in GMT when the Assistant was last updated specified in ISO 8601 format.
POST /v1/Assistants 
curl \
 --request POST 'https://assistants.twilio.com/v1/Assistants' \
 --user "username:password" \
 --header "Content-Type: application/json" \
 --data '{"customer_ai":{"perception_engine_enabled":true,"personalization_engine_enabled":true},"name":"string","owner":"string","personality_prompt":"string","segment_credential":{"profile_api_key":"string","space_id":"string","write_key":"string"}}'
Request examples 
{
  "customer_ai": {
    "perception_engine_enabled": true,
    "personalization_engine_enabled": true
  },
  "name": "string",
  "owner": "string",
  "personality_prompt": "string",
  "segment_credential": {
    "profile_api_key": "string",
    "space_id": "string",
    "write_key": "string"
  }
}
Response examples (201) 
{
  "account_sid": "string",
  "customer_ai": {},
  "id": "string",
  "model": "string",
  "name": "string",
  "owner": "string",
  "url": "string",
  "personality_prompt": "string",
  "date_created": "2025-05-04T09:42:00Z",
  "date_updated": "2025-05-04T09:42:00Z"
}