List assistant

GET /v1/Assistants

TODO: Resource-level docs

Query parameters

  • PageSize integer

    How many resources to return in each list page. The default is 50, and the maximum is 1000.

    Minimum value is 1, maximum value is 1000.

Responses

  • • 200

    OK

    Hide response attributes Show response attributes object
    • assistants array[object]
      Hide assistants attributes Show assistants attributes
      • 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

    • meta object
      Hide meta attributes Show meta attributes
GET /v1/Assistants 
curl \
 -X GET https://autopilot.twilio.com/v1/Assistants \
 --user "username:password"
Response examples (200) 
{
  "assistants": [
    {
      "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"
    }
  ],
  "meta": {
    "first_page_url": "https://example.com",
    "key": "string",
    "next_page_url": "https://example.com",
    "page": 42,
    "page_size": 42,
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  }
}