Fetch assistant

GET /v1/Assistants/{Sid}

TODO: Resource-level docs

Path parameters

  • Sid string Required

    The Twilio-provided string that uniquely identifies the Assistant resource to fetch.

Responses

  • OK

    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

    • Reserved

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

    • 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

GET /v1/Assistants/{Sid}
curl \
 -X GET https://autopilot.twilio.com/v1/Assistants/{Sid} \
 --user "username:password"
Response examples (200)
{
  "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 (200)
{
  "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"
}