Cancel input request

veryfront__cancel_input_request

Access

No external-service connection is required. Use a Veryfront credential with access to the requested resources.

Call type: Can change resources.

Arguments

FieldTypeRequiredDescription and constraints
input_request_idstringYesInput request to cancel. A fresh cancellation of an already-resolved request returns 409; only an open request can be cancelled. Requires project.runs.write on the run’s project and, for a request in a conversation, editor access on that conversation. An authorized retry of the identical request with the same idempotency key returns its stored result. Format: uuid.
idempotency_keystringNoRetry key for this operation, 1-128 characters. Overrides the HTTP header. If both are omitted, a new key is generated for each call; supply a key to retry safely. Minimum length: 1. Maximum length: 128.

Example request

Send this JSON-RPC request through an initialized MCP client. Replace sample identifiers and values before calling the tool. See MCP client setup.

json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "veryfront__cancel_input_request",
    "arguments": {
      "input_request_id": "00000000-0000-4000-8000-000000000000"
    }
  }
}

Result

The published output shape is summarized below. Inspect both the MCP response content and isError when handling a call.

FieldTypeRequiredDescription and constraints
input_request_idstringYesUnique input request ID. Format: uuid.
project_idstringYesProject inherited from the run. Format: uuid.
run_idstringYesRun waiting for this input. Format: uuid.
titlestringYesQuestion or decision shown to the responder. Minimum length: 1. Maximum length: 1000.
fieldsobject or object or object or object or object[]YesFields the responder can fill in.
statusstringYesCurrent resolution state. Values: "open", "submitted", "cancelled", "expired".
requested_responder_typestringYesRequired responder role; the authenticated actor identifies who actually responded. Values: "human", "agent", "system".
responseobject or nullYesSubmitted response, or null before submission or after cancellation or expiry.
created_atstringYesWhen the request was created. Format: date-time.
expires_atstringNoWhen the request expires. Format: date-time.
resolved_atstringNoWhen the request was submitted, cancelled or expired. Format: date-time.
tool_call_idstringNoTool invocation waiting for the response. Minimum length: 1. Maximum length: 128.
conversation_idstringNoConversation inherited from the run. Format: uuid.
descriptionstringNoAdditional instructions for the responder.
metadataobjectNoAdditional resource metadata.

Full schemas

json
{
  "type": "object",
  "properties": {
    "input_request_id": {
      "type": "string",
      "format": "uuid",
      "description": "Input request to cancel. A fresh cancellation of an already-resolved request returns 409; only an open request can be cancelled. Requires project.runs.write on the run’s project and, for a request in a conversation, editor access on that conversation. An authorized retry of the identical request with the same idempotency key returns its stored result."
    },
    "idempotency_key": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "description": "Retry key for this operation, 1-128 characters. Overrides the HTTP header. If both are omitted, a new key is generated for each call; supply a key to retry safely."
    }
  },
  "required": [
    "input_request_id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "Arguments for the cancel_input_request tool."
}
json
{
  "type": "object",
  "properties": {
    "input_request_id": {
      "type": "string",
      "format": "uuid",
      "description": "Unique input request ID."
    },
    "project_id": {
      "type": "string",
      "format": "uuid",
      "description": "Project inherited from the run."
    },
    "run_id": {
      "type": "string",
      "format": "uuid",
      "description": "Run waiting for this input."
    },
    "title": {
      "type": "string",
      "minLength": 1,
      "maxLength": 1000,
      "description": "Question or decision shown to the responder."
    },
    "fields": {
      "type": "array",
      "items": {
        "anyOf": [
          {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "minLength": 1,
                "maxLength": 128,
                "description": "Human-readable name for the returned record."
              },
              "label": {
                "type": "string",
                "maxLength": 1000,
                "description": "The label returned by the tool."
              },
              "description": {
                "type": "string",
                "maxLength": 4000,
                "description": "Human-readable description returned by the tool."
              },
              "required": {
                "type": "boolean",
                "default": false,
                "description": "The required returned by the tool."
              },
              "type": {
                "type": "string",
                "enum": [
                  "password"
                ],
                "description": "The type returned by the tool."
              }
            },
            "required": [
              "name",
              "type"
            ],
            "additionalProperties": false,
            "description": "One field item returned by the tool."
          },
          {
            "type": "object",
            "properties": {
              "name": {
                "$ref": "#/properties/fields/items/anyOf/0/properties/name",
                "description": "Human-readable name for the returned record."
              },
              "label": {
                "$ref": "#/properties/fields/items/anyOf/0/properties/label",
                "description": "The label returned by the tool."
              },
              "description": {
                "$ref": "#/properties/fields/items/anyOf/0/properties/description",
                "description": "Human-readable description returned by the tool."
              },
              "required": {
                "$ref": "#/properties/fields/items/anyOf/0/properties/required",
                "description": "The required returned by the tool."
              },
              "type": {
                "type": "string",
                "enum": [
                  "text",
                  "textarea",
                  "email",
                  "url"
                ],
                "description": "The type returned by the tool."
              },
              "default": {
                "type": "string",
                "description": "The default returned by the tool."
              }
            },
            "required": [
              "name",
              "type"
            ],
            "additionalProperties": false,
            "description": "One field item returned by the tool."
          },
          {
            "type": "object",
            "properties": {
              "name": {
                "$ref": "#/properties/fields/items/anyOf/0/properties/name",
                "description": "Human-readable name for the returned record."
              },
              "label": {
                "$ref": "#/properties/fields/items/anyOf/0/properties/label",
                "description": "The label returned by the tool."
              },
              "description": {
                "$ref": "#/properties/fields/items/anyOf/0/properties/description",
                "description": "Human-readable description returned by the tool."
              },
              "required": {
                "$ref": "#/properties/fields/items/anyOf/0/properties/required",
                "description": "The required returned by the tool."
              },
              "type": {
                "type": "string",
                "enum": [
                  "number"
                ],
                "description": "The type returned by the tool."
              },
              "default": {
                "type": "number",
                "description": "The default returned by the tool."
              }
            },
            "required": [
              "name",
              "type"
            ],
            "additionalProperties": false,
            "description": "One field item returned by the tool."
          },
          {
            "type": "object",
            "properties": {
              "name": {
                "$ref": "#/properties/fields/items/anyOf/0/properties/name",
                "description": "Human-readable name for the returned record."
              },
              "label": {
                "$ref": "#/properties/fields/items/anyOf/0/properties/label",
                "description": "The label returned by the tool."
              },
              "description": {
                "$ref": "#/properties/fields/items/anyOf/0/properties/description",
                "description": "Human-readable description returned by the tool."
              },
              "required": {
                "$ref": "#/properties/fields/items/anyOf/0/properties/required",
                "description": "The required returned by the tool."
              },
              "type": {
                "type": "string",
                "enum": [
                  "checkbox",
                  "confirm"
                ],
                "description": "The type returned by the tool."
              },
              "default": {
                "type": "boolean",
                "description": "The default returned by the tool."
              }
            },
            "required": [
              "name",
              "type"
            ],
            "additionalProperties": false,
            "description": "One field item returned by the tool."
          },
          {
            "type": "object",
            "properties": {
              "name": {
                "$ref": "#/properties/fields/items/anyOf/0/properties/name",
                "description": "Human-readable name for the returned record."
              },
              "label": {
                "$ref": "#/properties/fields/items/anyOf/0/properties/label",
                "description": "The label returned by the tool."
              },
              "description": {
                "$ref": "#/properties/fields/items/anyOf/0/properties/description",
                "description": "Human-readable description returned by the tool."
              },
              "required": {
                "$ref": "#/properties/fields/items/anyOf/0/properties/required",
                "description": "The required returned by the tool."
              },
              "type": {
                "type": "string",
                "enum": [
                  "select",
                  "radio"
                ],
                "description": "The type returned by the tool."
              },
              "options": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "value": {
                      "type": "string",
                      "minLength": 1,
                      "description": "The value returned by the tool."
                    },
                    "label": {
                      "type": "string",
                      "minLength": 1,
                      "description": "The label returned by the tool."
                    },
                    "description": {
                      "type": "string",
                      "description": "Human-readable description returned by the tool."
                    },
                    "recommended": {
                      "type": "boolean",
                      "description": "The recommended returned by the tool."
                    }
                  },
                  "required": [
                    "value",
                    "label"
                  ],
                  "additionalProperties": false,
                  "description": "One option item returned by the tool."
                },
                "minItems": 1,
                "maxItems": 100,
                "description": "List of options returned by the tool."
              },
              "default": {
                "type": "string",
                "description": "The default returned by the tool."
              }
            },
            "required": [
              "name",
              "type",
              "options"
            ],
            "additionalProperties": false,
            "description": "One field item returned by the tool."
          }
        ],
        "description": "One field item returned by the tool."
      },
      "description": "Fields the responder can fill in."
    },
    "status": {
      "type": "string",
      "enum": [
        "open",
        "submitted",
        "cancelled",
        "expired"
      ],
      "description": "Current resolution state."
    },
    "requested_responder_type": {
      "type": "string",
      "enum": [
        "human",
        "agent",
        "system"
      ],
      "description": "Required responder role; the authenticated actor identifies who actually responded."
    },
    "response": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "response_id": {
              "type": "string",
              "format": "uuid",
              "description": "Unique response ID."
            },
            "values": {
              "type": "object",
              "additionalProperties": {
                "type": [
                  "string",
                  "number",
                  "boolean",
                  "null"
                ],
                "description": "Additional structured values returned by the tool."
              },
              "description": "Submitted values keyed by field name; password values are omitted from reads."
            },
            "actor": {
              "anyOf": [
                {
                  "type": "object",
                  "properties": {
                    "type": {
                      "type": "string",
                      "enum": [
                        "user",
                        "api_key",
                        "service_account",
                        "system"
                      ],
                      "description": "The type returned by the tool."
                    },
                    "id": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 128,
                      "description": "Unique identifier for the returned record."
                    }
                  },
                  "required": [
                    "type",
                    "id"
                  ],
                  "additionalProperties": false,
                  "description": "Immediate authenticated initiator, recorded by the server; execution credentials identify their issuing service account, not the original caller."
                },
                {
                  "type": "object",
                  "properties": {
                    "type": {
                      "type": "string",
                      "enum": [
                        "unavailable"
                      ],
                      "description": "The type returned by the tool."
                    },
                    "reason": {
                      "type": "string",
                      "enum": [
                        "not_recorded",
                        "identity_removed"
                      ],
                      "description": "`not_recorded`: the server never stored the submitting credential. `identity_removed`: the recorded identity was later revoked or deleted."
                    },
                    "legacy_role": {
                      "type": "string",
                      "enum": [
                        "human",
                        "agent",
                        "integration",
                        "system",
                        "user",
                        "api_key",
                        "service_account"
                      ],
                      "description": "Role tag stored with the response. It is not an authenticated actor type."
                    },
                    "legacy_id": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 255,
                      "description": "Actor ID stored with the response. It is not promoted to an authenticated actor."
                    }
                  },
                  "required": [
                    "type",
                    "reason"
                  ],
                  "additionalProperties": false,
                  "description": "A historical response without authoritative submitting-credential provenance. The server never infers or looks up a replacement actor."
                }
              ],
              "description": "Authenticated principal that submitted the response, or `unavailable` for a historical response without authoritative provenance."
            },
            "redacted_fields": {
              "type": "array",
              "items": {
                "type": "string",
                "minLength": 1,
                "maxLength": 128,
                "description": "One redacted field item returned by the tool."
              },
              "description": "Names of submitted secret fields omitted from values."
            },
            "created_at": {
              "type": "string",
              "format": "date-time",
              "description": "When the response was submitted."
            }
          },
          "required": [
            "response_id",
            "values",
            "actor",
            "created_at"
          ],
          "additionalProperties": false,
          "description": "Structured response details returned by the tool."
        },
        {
          "type": "null",
          "description": "The response returned by the tool."
        }
      ],
      "description": "Submitted response, or null before submission or after cancellation or expiry."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the request was created."
    },
    "expires_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the request expires."
    },
    "resolved_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the request was submitted, cancelled or expired."
    },
    "tool_call_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "description": "Tool invocation waiting for the response."
    },
    "conversation_id": {
      "type": "string",
      "format": "uuid",
      "description": "Conversation inherited from the run."
    },
    "description": {
      "type": "string",
      "description": "Additional instructions for the responder."
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {
        "description": "A JSON value."
      },
      "description": "Additional resource metadata."
    }
  },
  "required": [
    "input_request_id",
    "project_id",
    "run_id",
    "title",
    "fields",
    "status",
    "requested_responder_type",
    "response",
    "created_at"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "Structured result returned by the cancel_input_request tool."
}