Skip to content

RunInput

All wire models

Model aliases: RunInput.

Type: object.

Fields

Required means the key must be present. Nullable means its value may be null; it does not make a required key optional. “Not specified” means the schema declares no default.

Field Type Required Default
attachment_ids Array of string No Not specified
agent_id string Yes Not specified
message string Yes Not specified
scope KnowledgeScope or null No null
client_request_id string Yes Not specified

Model constraints

  • Additional properties: not permitted

Field constraints

attachment_ids

  • Maximum items: 10

Exact JSON Schema

This is a schema definition, not an example request. It preserves all declared keywords, including constraints not summarized above.

Complete JSON Schema
JSON
{
  "additionalProperties": false,
  "properties": {
    "attachment_ids": {
      "items": {
        "type": "string"
      },
      "maxItems": 10,
      "title": "Attachment Ids",
      "type": "array"
    },
    "agent_id": {
      "title": "Agent Id",
      "type": "string"
    },
    "message": {
      "title": "Message",
      "type": "string"
    },
    "scope": {
      "anyOf": [
        {
          "$ref": "#/$defs/KnowledgeScope"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    },
    "client_request_id": {
      "title": "Client Request Id",
      "type": "string"
    }
  },
  "required": [
    "agent_id",
    "message",
    "client_request_id"
  ],
  "title": "RunInput",
  "type": "object"
}