app.ramp.com

get_form_schema

Read the schema of a form open on the user's screen: fields with labels, kinds, current values, validation errors, and selectable options (option tokens). A form is open ONLY when it is listed as a `form` surface in the current page context (the page_capabilities hint sent with the message, or get_current_page_context). If no `form` surface is listed, no form is open — there is nothing to read, so do not call this. Call it before filling a listed form. Omit form_id only for initial discovery when exactly one form is open and no intended form_id is already known. Keep using the intended form_id after failures; never omit or replace it to recover from a closed-form error.

Page: /sign-in

Input schema

{
  "type": "object",
  "properties": {
    "form_id": {
      "type": "string",
      "description": "The open form to target, from get_current_page_context form capabilities. Optional only for initial discovery when exactly one form is open and no intended form_id is already known. Keep using the intended form_id once known; never omit or replace it to recover from a closed-form error."
    }
  },
  "additionalProperties": false
}