Get modal | Moveworks

curl https://api.moveworks.ai/rest/v1/conversations/conv_32bt7BMLhLyVzTUjfi35N/responses/resp_32bt7rXXugeJjvE3pQzOk/messages/msg_32bt8vagXAoRwRLIdI2Oj/modals/eyJtb2RhbF9pZCI6Imluc2lkZW50X2Zvcm0ifQ \
     -H "Assistant-Name: acmecorp-conversations-rest-api" \
     -H "Authorization: Bearer <token>"

{
  "modal_id": "eyJtb2RhbF9pZCI6Imluc2lkZW50X2Zvcm0ifQ",
  "title": "File an IT ticket",
  "fields": [
    {
      "type": "DISPLAY",
      "visible": true,
      "display": {
        "text": {
          "text": "We will route this to the IT service desk.",
          "style": "SUBTLE"
        }
      }
    },
    {
      "type": "TEXT",
      "name": "short_description",
      "label": "Short description",
      "description": "One line summarizing the problem.",
      "required": true,
      "visible": true,
      "read_only": false,
      "triggers_refresh": false,
      "text": {
        "multiline": false,
        "prefill": "Laptop will not connect to the VPN"
      }
    },
    {
      "type": "CHOICE",
      "name": "priority",
      "label": "Priority",
      "required": true,
      "visible": true,
      "read_only": false,
      "triggers_refresh": true,
      "choice": {
        "multi": false,
        "options": [
          {
            "value": "low",
            "display_value": "Low"
          },
          {
            "value": "high",
            "display_value": "High"
          }
        ],
        "allows_free_input": false,
        "prefill": [
          {
            "value": "low",
            "display_value": "Low"
          }
        ]
      }
    },
    {
      "type": "TEXT",
      "name": "business_impact",
      "label": "Business impact",
      "description": "Required for high priority tickets.",
      "required": false,
      "visible": false,
      "read_only": false,
      "triggers_refresh": false,
      "text": {
        "multiline": true
      }
    },
    {
      "type": "FILE",
      "name": "screenshots",
      "label": "Screenshots",
      "required": false,
      "visible": true,
      "read_only": false,
      "triggers_refresh": false,
      "file": {
        "max_files": 3
      }
    }
  ]
}

Retrieves the definition of a modal surfaced by a MODAL_ACTION on an assistant message, so that your application can render it natively.

Every path parameter comes from that message. An entry in its actions array whose type is MODAL_ACTION carries the modal_id as modal_action.modal_id, and the message itself supplies conversation_id, response_id, and message_id. Assistant messages arrive from the list-messages endpoints, the get-response endpoint, and the RESPONSE_OUTPUT_DELTA and RESPONSE_COMPLETED streaming events.

Conditional field rules are evaluated server-side, so every field arrives with its initial visible, required, and read_only state already resolved. Render the fields in the order they are returned. Fields whose value can change another field’s state are flagged with triggers_refresh; call the refresh endpoint after one of those values changes.

Keep the options list of every choice field in your own state. It is returned here and is not repeated on the refresh response.

Retrieves the definition of a modal surfaced by a `MODAL_ACTION` on an assistant message, so that your application can render it natively. Every path parameter comes from that message. An entry in its `actions` array whose `type` is `MODAL_ACTION` carries the `modal_id` as `modal_action.modal_id`, and the message itself supplies `conversation_id`, `response_id`, and `message_id`. Assistant messages arrive from the list-messages endpoints, the get-response endpoint, and the `RESPONSE_OUTPUT_DELTA` and `RESPONSE_COMPLETED` streaming events. Conditional field rules are evaluated server-side, so every field arrives with its initial `visible`, `required`, and `read_only` state already resolved. Render the fields in the order they are returned. Fields whose value can change another field's state are flagged with `triggers_refresh`; call the refresh endpoint after one of those values changes. Keep the `options` list of every choice field in your own state. It is returned here and is not repeated on the refresh response.

Authentication

AuthorizationBearer

JWT bearer token authentication. Obtain an access token from the Moveworks auth endpoint and include it in the Authorization header as ‘Bearer <token>’.

Path parameters

conversation_idstringRequired

A base-62 identifier prefixed by a short resource type

response_idstringRequired

A base-62 identifier prefixed by a short resource type

message_idstringRequired

A base-62 identifier prefixed by a short resource type

modal_idstringRequired

Opaque modal identifier, taken from the modal_action.modal_id of the action that surfaced this modal. Pass it back exactly as received.

Response headers

x-trace-idstringOptional

A unique identifier used to trace your request within the Moveworks system

Response

Modal retrieved successfully

modal_idstring

Opaque modal identifier, echoed from the MODAL_ACTION that surfaced this modal.

titlestring

Modal title to display.

fieldslist of objects

Fields in display order. Render them in the order returned.

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error

Retrieves the definition of a modal surfaced by a MODAL_ACTION on an assistant message, so that your application can render it natively.

Keep the options list of every choice field in your own state. It is returned here and is not repeated on the refresh response.

Authentication

Path parameters

Headers

Response headers

Response

Errors