Skip to main content
Submit a human input response for a durable input request.

Tool details

FieldValue
Namesubmit_input_request_response
GroupConversations

Playground

Input schema

Input schema
{
  "type": "object",
  "properties": {
    "conversation_id": {
      "type": "string",
      "format": "uuid",
      "description": "Conversation identifier that scopes the request."
    },
    "input_request_id": {
      "type": "string",
      "format": "uuid",
      "description": "Provide the input request id."
    },
    "values": {
      "type": "object",
      "additionalProperties": {
        "type": [
          "string",
          "boolean",
          "number",
          "null"
        ],
        "description": "Additional structured values supplied to the tool."
      },
      "description": "Structured values submitted to the tool."
    }
  },
  "required": [
    "conversation_id",
    "input_request_id",
    "values"
  ],
  "additionalProperties": false,
  "description": "Input schema for the submit_input_request_response tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Output schema

Output schema
{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "const": true,
      "description": "Always true when the response was accepted by the API layer."
    },
    "input_request": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "Input request identifier."
        },
        "conversation_id": {
          "type": "string",
          "format": "uuid",
          "description": "Conversation identifier that owns the request."
        },
        "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": {
                  "type": "string",
                  "format": "uuid",
                  "description": "Conversation identifier associated with the request and response."
                },
                "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": "Input request after applying the submitted response."
    },
    "input_response": {
      "type": "object",
      "properties": {
        "id": {
          "$ref": "#/properties/input_request/properties/latest_response/anyOf/0/properties/id",
          "description": "Unique identifier for the returned record."
        },
        "input_request_id": {
          "$ref": "#/properties/input_request/properties/latest_response/anyOf/0/properties/input_request_id",
          "description": "The input request id returned by the tool."
        },
        "conversation_id": {
          "$ref": "#/properties/input_request/properties/latest_response/anyOf/0/properties/conversation_id",
          "description": "Conversation identifier associated with this result."
        },
        "run_id": {
          "$ref": "#/properties/input_request/properties/latest_response/anyOf/0/properties/run_id",
          "description": "Run identifier associated with this result."
        },
        "actor_type": {
          "$ref": "#/properties/input_request/properties/latest_response/anyOf/0/properties/actor_type",
          "description": "Type of actor associated with this result."
        },
        "actor_id": {
          "$ref": "#/properties/input_request/properties/latest_response/anyOf/0/properties/actor_id",
          "description": "Identifier for the actor associated with this result."
        },
        "values": {
          "$ref": "#/properties/input_request/properties/latest_response/anyOf/0/properties/values",
          "description": "Structured values returned by the tool."
        },
        "created_at": {
          "$ref": "#/properties/input_request/properties/latest_response/anyOf/0/properties/created_at",
          "description": "Creation timestamp in ISO 8601 format."
        }
      },
      "required": [
        "id",
        "input_request_id",
        "conversation_id",
        "run_id",
        "actor_type",
        "actor_id",
        "values",
        "created_at"
      ],
      "additionalProperties": false,
      "description": "Submitted response record that was persisted."
    },
    "accepted": {
      "type": "boolean",
      "description": "Whether the response was accepted for processing."
    },
    "duplicate": {
      "type": "boolean",
      "description": "Whether the submitted payload duplicated an existing response."
    }
  },
  "required": [
    "success",
    "input_request",
    "input_response",
    "accepted"
  ],
  "additionalProperties": false,
  "description": "Result returned after submitting a response to an input request.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}