Create input request

veryfront__create_input_request

Returns resource-already-exists when an open request already exists for the same run and tool call.

Access

No external-service connection is required. Use a Veryfront credential with access to the requested resources. Call type: Can change resources.

Arguments

Field	Type	Required	Description and constraints
`conversation_id`	`string`	Yes	Conversation ID that should receive the new structured input request. Format: `uuid`.
`run_id`	`string`	Yes	Agent run ID that is waiting for structured input. Minimum length: `1`. Maximum length: `255`.
`tool_call_id`	`string`	Yes	Tool call ID that triggered the need for structured input. Minimum length: `1`. Maximum length: `255`.
`kind`	`string`	No	Input request interaction type. Omit to use the default form flow. Value: `"form"`.
`requested_responder_type`	`string`	Yes	Who is expected to answer this request: a human, another agent, or a system actor. Values: `"human"`, `"agent"`, `"system"`.
`title`	`string`	Yes	Short prompt shown to the responder when asking for input. Minimum length: `1`. Maximum length: `1000`.
`description`	`string`	No	Long-form guidance that explains what information the responder should provide. Minimum length: `1`. Maximum length: `20000`.
`fields`	`object[]`	Yes	Structured fields the responder must complete.
`recommendations`	`object`	No	Suggested values, defaults, or recommended choices for the responder.
`expires_at`	`string`	No	Expiration timestamp after which the request should no longer accept responses. Format: `date-time`.
`metadata`	`object`	No	Additional machine-readable metadata for downstream orchestration or UI rendering.

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.

request.json

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "veryfront__create_input_request",
    "arguments": {
      "conversation_id": "00000000-0000-4000-8000-000000000000",
      "run_id": "example",
      "tool_call_id": "example",
      "requested_responder_type": "human",
      "title": "example",
      "fields": [
        {
          "name": "example",
          "type": "example"
        }
      ]
    }
  }
}

Result

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

Field	Type	Required	Description and constraints
`id`	`string`	Yes	Input request identifier. Format: `uuid`.
`conversation_id`	`string or null`	Yes	Conversation identifier that owns the request, or null when the request belongs only to a run.
`run_id`	`string`	Yes	Agent run identifier waiting on this request.
`tool_call_id`	`string`	Yes	Tool call identifier that triggered the request.
`kind`	`string`	Yes	Input request interaction type.
`status`	`string`	Yes	Lifecycle status of the request.
`requested_responder_type`	`string`	Yes	Responder type expected to answer the request.
`title`	`string`	Yes	Short prompt shown to the responder.
`description`	`string or null`	Yes	Long-form guidance explaining the requested input.
`fields`	`object[]`	Yes	Field definitions that the responder must complete.
`recommendations`	`object or null`	Yes	Suggested values or defaults for the responder.
`metadata`	`object or null`	Yes	Additional machine-readable metadata for rendering or orchestration.
`created_at`	`string`	Yes	Timestamp when the request was created.
`expires_at`	`string or null`	Yes	Timestamp when the request expires, or null when it does not expire.
`submitted_at`	`string or null`	Yes	Timestamp when a response was submitted.
`cancelled_at`	`string or null`	Yes	Timestamp when the request was cancelled.
`expired_at`	`string or null`	Yes	Timestamp when the request expired.
`latest_response`	`object or null`	Yes	Most recent submitted response, or null when unanswered.

Full schemas

{
  "type": "object",
  "properties": {
    "conversation_id": {
      "type": "string",
      "format": "uuid",
      "description": "Conversation ID that should receive the new structured input request."
    },
    "run_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "description": "Agent run ID that is waiting for structured input."
    },
    "tool_call_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "description": "Tool call ID that triggered the need for structured input."
    },
    "kind": {
      "type": "string",
      "const": "form",
      "description": "Input request interaction type. Omit to use the default form flow."
    },
    "requested_responder_type": {
      "type": "string",
      "enum": [
        "human",
        "agent",
        "system"
      ],
      "description": "Who is expected to answer this request: a human, another agent, or a system actor."
    },
    "title": {
      "type": "string",
      "minLength": 1,
      "maxLength": 1000,
      "description": "Short prompt shown to the responder when asking for input."
    },
    "description": {
      "type": "string",
      "minLength": 1,
      "maxLength": 20000,
      "description": "Long-form guidance that explains what information the responder should provide."
    },
    "fields": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 255,
            "description": "Human-readable name for the target record."
          },
          "type": {
            "type": "string",
            "minLength": 1,
            "maxLength": 64,
            "description": "Provide the type."
          },
          "label": {
            "type": "string",
            "minLength": 1,
            "maxLength": 1000,
            "description": "Provide the label."
          },
          "required": {
            "type": "boolean",
            "description": "Provide the required."
          },
          "options": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": {
                "description": "Additional structured values supplied to the tool."
              },
              "description": "One option item supplied to the tool."
            },
            "description": "Provide the options."
          }
        },
        "required": [
          "name",
          "type"
        ],
        "additionalProperties": true,
        "description": "One field item supplied to the tool."
      },
      "minItems": 1,
      "maxItems": 100,
      "description": "Structured fields the responder must complete."
    },
    "recommendations": {
      "type": "object",
      "additionalProperties": {
        "description": "Additional structured values supplied to the tool."
      },
      "description": "Suggested values, defaults, or recommended choices for the responder."
    },
    "expires_at": {
      "type": "string",
      "format": "date-time",
      "description": "Expiration timestamp after which the request should no longer accept responses."
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {
        "description": "Additional structured values supplied to the tool."
      },
      "description": "Additional machine-readable metadata for downstream orchestration or UI rendering."
    }
  },
  "required": [
    "conversation_id",
    "run_id",
    "tool_call_id",
    "requested_responder_type",
    "title",
    "fields"
  ],
  "additionalProperties": false,
  "description": "Arguments for creating a structured input request inside a conversation.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Input request identifier."
    },
    "conversation_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "description": "Conversation identifier associated with the record."
        },
        {
          "type": "null",
          "description": "Conversation identifier associated with this result."
        }
      ],
      "description": "Conversation identifier that owns the request, or null when the request belongs only to a run."
    },
    "run_id": {
      "type": "string",
      "description": "Agent run identifier waiting on this request."
    },
    "tool_call_id": {
      "type": "string",
      "description": "Tool call identifier that triggered the request."
    },
    "kind": {
      "type": "string",
      "description": "Input request interaction type."
    },
    "status": {
      "type": "string",
      "description": "Lifecycle status of the request."
    },
    "requested_responder_type": {
      "type": "string",
      "description": "Responder type expected to answer the request."
    },
    "title": {
      "type": "string",
      "description": "Short prompt shown to the responder."
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "Long-form guidance explaining the requested input."
    },
    "fields": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": {
          "description": "Additional structured values associated with this result."
        },
        "description": "One field item associated with this record."
      },
      "description": "Field definitions that the responder must complete."
    },
    "recommendations": {
      "anyOf": [
        {
          "type": "object",
          "additionalProperties": {
            "description": "Additional structured values associated with this result."
          },
          "description": "Suggested values or defaults associated with the record."
        },
        {
          "type": "null",
          "description": "Suggested values or defaults returned by the tool."
        }
      ],
      "description": "Suggested values or defaults for the responder."
    },
    "metadata": {
      "anyOf": [
        {
          "type": "object",
          "additionalProperties": {
            "description": "Additional structured values associated with this result."
          },
          "description": "Additional structured metadata for the record."
        },
        {
          "type": "null",
          "description": "Additional structured metadata returned by the tool."
        }
      ],
      "description": "Additional machine-readable metadata for rendering or orchestration."
    },
    "created_at": {
      "type": "string",
      "description": "Timestamp when the request was created."
    },
    "expires_at": {
      "type": [
        "string",
        "null"
      ],
      "description": "Timestamp when the request expires, or null when it does not expire."
    },
    "submitted_at": {
      "type": [
        "string",
        "null"
      ],
      "description": "Timestamp when a response was submitted."
    },
    "cancelled_at": {
      "type": [
        "string",
        "null"
      ],
      "description": "Timestamp when the request was cancelled."
    },
    "expired_at": {
      "type": [
        "string",
        "null"
      ],
      "description": "Timestamp when the request expired."
    },
    "latest_response": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "format": "uuid",
              "description": "Input response identifier."
            },
            "input_request_id": {
              "type": "string",
              "format": "uuid",
              "description": "Input request identifier that this response answers."
            },
            "conversation_id": {
              "anyOf": [
                {
                  "type": "string",
                  "format": "uuid",
                  "description": "Conversation identifier associated with the record."
                },
                {
                  "type": "null",
                  "description": "Conversation identifier associated with this result."
                }
              ],
              "description": "Conversation identifier associated with the request and response, or null for a headless run."
            },
            "run_id": {
              "type": "string",
              "description": "Agent run identifier that is waiting for or consumed this response."
            },
            "actor_type": {
              "type": "string",
              "description": "Actor type that submitted the response, such as human or agent."
            },
            "actor_id": {
              "type": "string",
              "description": "Actor identifier that submitted the response."
            },
            "values": {
              "type": "object",
              "additionalProperties": {
                "type": [
                  "string",
                  "number",
                  "boolean",
                  "null"
                ],
                "description": "Additional structured values associated with this result."
              },
              "description": "Submitted field values keyed by input request field name."
            },
            "created_at": {
              "type": "string",
              "description": "Timestamp when the response was created."
            }
          },
          "required": [
            "id",
            "input_request_id",
            "conversation_id",
            "run_id",
            "actor_type",
            "actor_id",
            "values",
            "created_at"
          ],
          "additionalProperties": false,
          "description": "Submitted response to a structured input request."
        },
        {
          "type": "null",
          "description": "The latest response returned by the tool."
        }
      ],
      "description": "Most recent submitted response, or null when unanswered."
    }
  },
  "required": [
    "id",
    "conversation_id",
    "run_id",
    "tool_call_id",
    "kind",
    "status",
    "requested_responder_type",
    "title",
    "description",
    "fields",
    "recommendations",
    "metadata",
    "created_at",
    "expires_at",
    "submitted_at",
    "cancelled_at",
    "expired_at",
    "latest_response"
  ],
  "additionalProperties": false,
  "description": "Created input request record.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Get started

APIs

REST API

GraphQL API

MCP API

Create input request

Access

Arguments

Example request

Result

Full schemas

​Access

​Arguments

​Example request

​Result

​Full schemas

Access

Arguments

Example request

Result

Full schemas