Create sample

POST /v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples

TODO: Resource-level docs

Path parameters

  • AssistantSid string Required

    The SID of the Assistant that is the parent of the Task associated with the new resource.

  • TaskSid string Required

    The SID of the Task associated with the Sample resource to create.

Body

  • Language string Required

    The ISO language-country string that specifies the language used for the new sample. For example: en-US.

  • SourceChannel string

    The communication channel from which the new sample was captured. Can be: voice, sms, chat, alexa, google-assistant, slack, or null if not included.

  • TaggedText string Required

    The text example of how end users might express the task. The sample can contain Field tag blocks.

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}$.

    • assistant_sid string | null

      The SID of the Assistant that is the parent of the Task associated with 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

    • language string | null

      An ISO language-country string that specifies the language used for the sample

    • sid string | null

      The unique string that identifies the resource

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

    • source_channel string | null

      The communication channel from which the sample was captured

    • tagged_text string | null

      The text example of how end users might express the task

    • task_sid string | null

      The SID of the Task associated with the resource

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

    • url string(uri) | null

      The absolute URL of the Sample resource
POST /v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples 
curl \
 -X POST https://autopilot.twilio.com/v1/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'Language=string&SourceChannel=string&TaggedText=string'
Request example 
{
  "Language": "string",
  "SourceChannel": "string",
  "TaggedText": "string"
}
Request examples 
{
  "Language": "string",
  "SourceChannel": "string",
  "TaggedText": "string"
}
Response examples (201) 
{
  "account_sid": "string",
  "assistant_sid": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "language": "string",
  "sid": "string",
  "source_channel": "string",
  "tagged_text": "string",
  "task_sid": "string",
  "url": "https://example.com"
}
Response examples (201) 
{
  "account_sid": "string",
  "assistant_sid": "string",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "language": "string",
  "sid": "string",
  "source_channel": "string",
  "tagged_text": "string",
  "task_sid": "string",
  "url": "https://example.com"
}