--- sourceDocument: Australia Conversational Interfaces sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/conversational-interfaces Release : - australia ft:locale : - pt-BR ft:publication_title : - Australia Conversational Interfaces ft:clusterId : - convint bundleId : - convint workflow : - Platform --- # Controls in Virtual Agent API # Controls in Virtual Agent API {#ariaid-title1} * Versão de lançamento: Australia * * Atualizado 12 de mar. de 2026 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 6 min. de leitura Virtual Agent API provides you various controls to manage the responses in your conversation. The available controls in Virtual Agent API are: ## Output Text {#va-api-controls__section_qxy_lv5_d3c} { "uiType": "OutputText", "group": "DefaultText", "value": "**bold**\n*italic*\n***bold italic***\n[Google](https://empcygiraffe6.service-now.com/va_link.do?token=77ee77ef77eSZGFlMTc3OWU5NzY2MTExMDUyNjFiMzQ3MTE1M2FmYjTvt6zvt5Qx77es77etWE1nS0ZLOElhU1FQYzhIajh2dmNmZz09WHdPTDYzV3ZpUWF1MGJwRlB0ZktUY29wVWt1UGVueUNIS1FkRHRyUW9idHlmVFZlRWJOODZyRjZYN0VQamxnWUV5WkhZSDRJaWFGWmJRZU1CaXZLYWhudnkwbDdvNFZsMlMzUUw4Q3VRTUJWMHhvTWlRLXZOQnh5M0hveVBuellNVmJCbGlka0RqNTAzVFVUQml0MTZzSnlUTVJoakdZektldXdoYXlM77eu77ev&target_url=https%3A%2F%2Fwww.google.co.in)\n\n- ***ul1***\n- ***ul2***\n\n\n1. ol1\n2. ol2\n\n", "maskType": "NONE | SECURE" } {#va-api-controls__table_nb3_2w5_d3c__entry__2} | Field | Description | |-|-| | value | Contains the output text value. | | maskType | 'NONE' indicates normal text and 'SECURE' indicates secure output text. | [ ] {#va-api-controls__table_nb3_2w5_d3c} ## Output Html {#va-api-controls__section_m53_3w5_d3c} { "uiType": "OutputHtml", "group": "DefaultOutputHtml", "style": "inline", "height": 0, "width": 0, "value": "

Company	Contact	Country
Alfreds Futterkiste	Maria Anders	Germany
Centro comercial Moctezuma	Francisco Chang	Mexico
Ernest Handel	Roland Mendel	Austria
Island Trading	Helen Bennett	UK
Laughing Bacchus Winecellars	Yoshi Tannamuri	Canada
Magazzini Alimentari Riuniti	Giovanni Rovelli	Italy

", "imageUrl": "https://empcygiraffe6.service-now.com//api/now/v1/cs/media/zKFqUx0NJyVaFRJqzeRhFgeMsMo9211mCvrMgKzrRpTWqFJDrXLOadoYGC5CQnwr", "imageHeight": 217, "imageWidth": 501, "links": [ { "link": "https://www.google.co.in", "label": "Alfreds Futterkiste" }, { "link": "https://www.google.co.in", "label": "Ernest Handel" }, { "link": "https://www.google.co.in", "label": "Canada" } ] } {#va-api-controls__table_sfd_mw5_d3c__entry__2} | Field | Description | |-|-| | value | Contains the html value. | | imageUrl | Contains the image of html if 'Html to image conversion required' is enabled on sys_cs_provider. | | imageHeight | Contains the image height if 'Html to image conversion required' is enabled on sys_cs_provider. | | imageWidth | Contains the image width if 'Html to image conversion required' is enabled on sys_cs_provider. | | links | Contains links in the given html if 'Html to image conversion required' is enabled on sys_cs_provider. | [ ] {#va-api-controls__table_sfd_mw5_d3c} ## Output Image {#va-api-controls__section_as4_yw5_d3c} { "uiType": "OutputImage", "group": "DefaultOutputImage", "value": "https://adaptivecards.io/content/cats/1.png", "altText": "Image alt text" } {#va-api-controls__table_qfk_1x5_d3c__entry__2} | Field | Description | |-|-| | value | Contains the image url. | | altText | Contains the alt text for the image (not mandatory). | [ ] {#va-api-controls__table_qfk_1x5_d3c} ## Output Link {#va-api-controls__section_xns_dx5_d3c} { "uiType": "OutputLink", "group": "DefaultOutputLink", "label": "ServiceNow", "header": "The world works with ServiceNow", "type": "link", "value": { "action": "https://empcygiraffe6.service-now.com/va_link.do?token=&target_url=https%3A%2F%2Fwww.servicenow.com", "target": "_blank" } } {#va-api-controls__table_shl_rx5_d3c__entry__2} | Field | Description | |-|-| | header | Link Header | | label | Link label | | value-\>action | Link url | [ ] {#va-api-controls__table_shl_rx5_d3c} ## Multi Link {#va-api-controls__section_o4h_5x5_d3c} { "uiType": "GroupedPartsOutputControl", "group": "DefaultGroupedPartsOutputControl", "groupPartType": "Link", "header": "Multilink Header", "values": [ { "action": "https://empcygiraffe6.service-now.com/va_link.do?token=&target_url=https%3A%2F%2Fwww.link1.com", "description": "a short desc", "label": "link 1 label", "context": "KB", "target": "_blank" }, { "action": "https://empcygiraffe6.service-now.com/va_link.do?token=&target_url=https%3A%2F%2Fwww.link2.com", "description": "a short desc", "label": "link 2 label", "context": "ITSM", "target": "_blank" } ] } {#va-api-controls__table_bsk_xx5_d3c__entry__2} | Field | Description | |-|-| | header | MultiLink control header | | values | Links array | [ ] {#va-api-controls__table_bsk_xx5_d3c} **Link structure in links array:** {#va-api-controls__table_us4_x3v_d3c__entry__2} | Field | Description | |-|-| | label | Link label | | action | Link url | | description | Link Description | | context | Context or Taxonomy | [ ] {#va-api-controls__table_us4_x3v_d3c} ## Output Card {#va-api-controls__section_ljw_bjv_d3c} { "uiType": "OutputCard", "group": "DefaultOutputCard", "templateName": "", "data": "", } {#va-api-controls__table_oxm_4jv_d3c__entry__2} | Field | Description | |-|-| | templateName | Card type or Card name | | data | json representing card data. Nota: The data field will be of type string. You need to parse it to use the data. | [ ] {#va-api-controls__table_oxm_4jv_d3c} **Large Image With Text** { "uiType": "OutputCard", "group": "DefaultOutputCard", "templateName": "Large image with text", "data": "{\"image\":\"https://adaptivecards.io/content/cats/1.png\",\"description\":\"Large image description\", \"dataNowSmartLink\":\"W9F4Ld8z\",\"title\":\"Large image\",\"imageAlt\":\"large image alt text\",\"url\":\"\",\"target\":\"_blank\"}", "smartLinksMetadata": { "W9F4Ld8z": { "type": "standard", "source": "", "target": "_blank" } } } **Small Image With Text** { "uiType": "OutputCard", "group": "DefaultOutputCard", "templateName": "Small image with text", "data": "{\"image\":\"https://adaptivecards.io/content/cats/1.png\",\"description\":\"Small image with text description\",\"dataNowSmartLink\":\"i6CL61tN\",\"title\":\"Small image with text\",\"imageAlt\":\"small image alt text\",\"url\":\"\",\"target\":\"_blank\"}", "smartLinksMetadata": { "i6CL61tN": { "type": "standard", "source": "", "target": "_blank" } } } **Youtube** { "uiType": "OutputCard", "group": "DefaultOutputCard", "templateName": "Youtube Video Card", "data": "{\"link\":\"https://empcygiraffe6.service-now.com/va_link.do?token=&target_url=servicenow.com\",\"description\":\"The world works with ServiceNow\",\"id\":\"IWsGk-Kh5ko\",\"title\":\"ServiceNow\",\"url\":\"\",\"target\":\"_blank\"}" } **Record** { "uiType": "OutputCard", "group": "DefaultOutputCard", "templateName": "Card", "data": "{\"sys_id\":\"0c5f3cece1b12010f877971dea0b1449\",\"subtitle\":\"INC0008001\",\"dataNowSmartLink\":\"VLzQTN88\",\"title\":\"Incident\",\"fields\":[{\"fieldLabel\":\"Number\",\"fieldValue\":\"INC0008001\"},{\"fieldLabel\":\"Short description\",\"fieldValue\":\"ATF:TEST2\"},{\"fieldLabel\":\"Caller\",\"fieldValue\":\"survey user\"}],\"table_name\":\"incident\",\"url\":\"https://empcygiraffe6.service-now.com/va_link.do?token=target_url=https%3A%2F%2Fempcygiraffe6.service-now.com%2Fsp%3Fsys_id%3D0c5f3cece1b12010f877971dea0b1449%26id%3Dticket%26table%3Dincident\",\"target\":\"_blank\"}", "smartLinksMetadata": { "VLzQTN88": { "type": "standard", "source": "https://empcygiraffe6.service-now.com/sp?sys_id=0c5f3cece1b12010f877971dea0b1449&id=ticket&table=incident", "target": "_blank" } } } ## Multipart Output {#va-api-controls__section_vlf_qkv_d3c} { "uiType": "MultiPartOutput", "group": "DefaultMultiPartOutput", "navigationBtnLabel": "Click for more", "content": { "uiType": "OutputText", "value": "multipart text output", "maskType": "NONE" } } {#va-api-controls__table_rvm_bmv_d3c__entry__2} | Field | Description | |-|-| | navigationBtnLabel | Navigation Button label | | content | Represents the control defined with multipart. Nota: * Content can be OutputText or OutputImage or OutputHtml or OutputLink or OutputCard. * You must send 'click_for_more' as response to move to the next part. {#va-api-controls__ul_njh_hmv_d3c} | [ ] {#va-api-controls__table_rvm_bmv_d3c} ## InputText {#va-api-controls__section_zrn_lmv_d3c} { "uiType": "InputText", "group": "DefaultText", "required": true, "nluTextEnabled": false, "entityType": "Text", "label": "enter something", "maskType": "NONE" } {#va-api-controls__table_wj5_nmv_d3c__entry__2} | Field | Description | |-|-| | label | Input text label | | required | True or false that indicates whether the control can be skipped or not. | | maskType | NONE or SECURE. * NONE indicates normal input. * SECURE indicates secure input. {#va-api-controls__ul_p22_wmv_d3c} | | entityType | The input is text or email or IP address. | | nluTextEnabled | Whether nlu is enabled at this node or not. | [ ] {#va-api-controls__table_wj5_nmv_d3c} ## Boolean {#va-api-controls__section_tsw_dnv_d3c} { "uiType": "Boolean", "group": "DefaultPicker", "required": true, "nluTextEnabled": false, "entityType": "Boolean", "label": "select yes/no", "options": [ { "label": "Yes", "value": "yes", "renderStyle": "data" }, { "label": "No", "value": "no", "renderStyle": "data" } ] } {#va-api-controls__table_g2w_fnv_d3c__entry__2} | Field | Description | |-|-| | label | Boolean control prompt | | required | True or false that indicates whether the control can be skipped or not. | | maskType | NONE or SECURE. * NONE indicates normal input. * SECURE indicates secure input. {#va-api-controls__ul_mnn_lnv_d3c} | | entityType | Boolean | | nluTextEnabled | Whether NLU is enabled at this node or not. | | options | Boolean options | [ ] {#va-api-controls__table_g2w_fnv_d3c} **Option structure in options array:** {#va-api-controls__table_xjn_wnv_d3c__entry__2} | Field | Description | |-|-| | label | Option label | | value | Option value | | renderStyle | Data or button | [ ] {#va-api-controls__table_xjn_wnv_d3c} ## Picker {#va-api-controls__section_nrq_14v_d3c} { "uiType": "Picker", "group": "DefaultPicker", "required": true, "nluTextEnabled": false, "label": "Select an option", "itemType": "List", "style": "list", "multiSelect": false, "options": [ { "label": "option 1", "value": "option 1", "renderStyle": "data", "enabled": false }, { "label": "option 2", "value": "option 2", "renderStyle": "data", "enabled": false }, { "label": "option 3", "value": "option 3", "renderStyle": "data", "enabled": false } ], "scriptedData": { "cardData": "{\"title\":\"Choice - Large image with text\",\"description\":\"Choice - Large image with text description\",\"image\":\"https://adaptivecards.io/content/cats/1.png\",\"imageAlt\":\"alt text\"}", "cardName": "Large image with text", "cardTemplate": "", "renderStyle": "card" } } {#va-api-controls__table_cgz_d4v_d3c__entry__2} | Field | Description | |-|-| | label | Picker control prompt | | style | List or carousel. Carousel indicates carousel control. | | required | True or false that indicates whether the control can be skipped or not. | | maskType | NONE or SECURE. * NONE indicates normal input. * SECURE indicates secure input. {#va-api-controls__ul_ds3_j4v_d3c} | | entityType | Boolean | | nluTextEnabled | Whether NLU is enabled at this node or not. | | options | Boolean options | | scriptedData | Represents a card to be displayed along with picker. | [ ] {#va-api-controls__table_cgz_d4v_d3c} **Option structure in options array:** {#va-api-controls__table_ib4_q4v_d3c__entry__2} | Field | Description | |-|-| | label | Option label | | value | Option value | | renderStyle | data or button | [ ] {#va-api-controls__table_ib4_q4v_d3c} **scriptedData structure:** {#va-api-controls__table_jkd_w4v_d3c__entry__2} | Field | Description | |-|-| | cardName | Template name | | cardData | Card data as json string. | [ ] {#va-api-controls__table_jkd_w4v_d3c} ## Carousel {#va-api-controls__section_jbm_2pv_d3c} { "uiType": "Picker", "group": "DefaultPicker", "required": true, "nluTextEnabled": false, "label": "select an image", "itemType": "Picture", "style": "carousel", "multiSelect": false, "options": [ { "label": "name1", "description": "a description of value_1 item", "attachment": "https://adaptivecards.io/content/cats/1.png", "value": "value_1", "renderStyle": "data", "enabled": false }, { "label": "name2", "description": "a description of value_2 item", "attachment": "https://adaptivecards.io/content/cats/1.png", "value": "value_2", "renderStyle": "data", "enabled": false }, { "label": "name3", "description": "a description of value_3 item", "attachment": "https://adaptivecards.io/content/cats/1.png", "value": "value_3", "renderStyle": "data", "enabled": false } ], "scriptedData": null } {#va-api-controls__table_rq3_gpv_d3c__entry__2} | Field | Description | |-|-| | label | Picker control prompt | | style | List or Carousel. Carousel indicates carousel control. | | required | True or false that indicates whether the control can be skipped or not. | | maskType | NONE or SECURE. * NONE indicates normal input. * SECURE indicates secure input. {#va-api-controls__ul_pyn_mpv_d3c} | | entityType | Boolean | | nluTextEnabled | Whether NLU is enabled at this node or not. | | options | Boolean options | [ ] {#va-api-controls__table_rq3_gpv_d3c} **Option structure in options array:** {#va-api-controls__table_ttk_spv_d3c__entry__2} | Field | Description | |-|-| | label | Option label | | value | Option value | | description | description for the option | | attachment | Picture or image for the option | [ ] {#va-api-controls__table_ttk_spv_d3c} ## Date {#va-api-controls__section_c4c_cqv_d3c} { "uiType": "Date", "group": "DefaultDate", "required": true, "nluTextEnabled": false, "entityType": "Date", "label": "test date" } {#va-api-controls__table_rgt_3qv_d3c__entry__2} | Field | Description | |-|-| | label | Date control prompt | | required | True or false that indicates whether the control can be skipped or not. | | entityType | Date | | nluTextEnabled | Whether NLU is enabled at this node or not. | [ ] {#va-api-controls__table_rgt_3qv_d3c} ## Time {#va-api-controls__section_vqc_5qv_d3c} { "uiType": "Time", "group": "DefaultDate", "required": true, "nluTextEnabled": false, "entityType": "Time", "label": "Select time" } {#va-api-controls__table_lvw_vqv_d3c__entry__2} | Field | Description | |-|-| | label | Time control prompt | | required | True or false that indicates whether the control can be skipped or not. | | entityType | Time | | nluTextEnabled | Whether NLU is enabled at this node or not. | [ ] {#va-api-controls__table_lvw_vqv_d3c} ## DateTime {#va-api-controls__section_b4l_xqv_d3c} { "uiType": "DateTime", "group": "DefaultDate", "required": true, "nluTextEnabled": false, "entityType": "Time", "label": "Select time" } {#va-api-controls__table_xxj_zqv_d3c__entry__2} | Field | Description | |-|-| | label | Date and Time control prompt | | required | True or false that indicates whether the control can be skipped or not. | | entityType | Time | | nluTextEnabled | Whether NLU is enabled at this node or not. | [ ] {#va-api-controls__table_xxj_zqv_d3c} ## StartConversation {#va-api-controls__section_clp_brv_d3c} { "uiType": "ActionMsg", "actionType": "StartConversation", "conversationId": "e0494b2187332550326d0d05dabb350d" } {#va-api-controls__table_yld_2rv_d3c__entry__2} | Field | Description | |-|-| | uiType | ActionMsg | | actionType | StartConversation | [ ] {#va-api-controls__table_yld_2rv_d3c} Indicates that the conversation has started in Virtual Agent API.