List query

GET /v1/Assistants/{AssistantSid}/Queries

TODO: Resource-level docs

Path parameters

Query parameters

  • Language string

    The ISO language-country string that specifies the language used by the Query resources to read. For example: en-US.

  • ModelBuild string

    The SID or unique name of the Model Build to be queried.

  • Status string

    The status of the resources to read. Can be: pending-review, reviewed, or discarded

  • DialogueSid string

    The SID of the Dialogue.

  • 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
    • meta object
      Hide meta attributes Show meta attributes
    • queries array[object]
      Hide queries attributes Show queries 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}$.

      • assistant_sid string | null

        The SID of the Assistant that is the parent of the resource

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

      • 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

      • dialogue_sid string | null

        The SID of the Dialogue.

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

      • language string | null

        The ISO language-country string that specifies the language used by the Query

      • model_build_sid string | null

        The SID of the Model Build queried

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

      • query string | null

        The end-user's natural language input

      • results

        The natural language analysis results that include the Task recognized and a list of identified Fields

      • sample_sid string | null

        The SID of an optional reference to the Sample created from the query

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

      • sid string | null

        The unique string that identifies the resource

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

      • source_channel string | null

        The communication channel from where the end-user input came

      • status string | null

        The status of the Query

      • url string(uri) | null

        The absolute URL of the Query resource
GET /v1/Assistants/{AssistantSid}/Queries 
curl \
 -X GET https://autopilot.twilio.com/v1/Assistants/{AssistantSid}/Queries \
 --user "username:password"
Response examples (200) 
{
  "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"
  },
  "queries": [
    {
      "account_sid": "string",
      "assistant_sid": "string",
      "date_created": "2023-05-04T09:42:00+00:00",
      "date_updated": "2023-05-04T09:42:00+00:00",
      "dialogue_sid": "string",
      "language": "string",
      "model_build_sid": "string",
      "query": "string",
      "sample_sid": "string",
      "sid": "string",
      "source_channel": "string",
      "status": "string",
      "url": "https://example.com"
    }
  ]
}