interaction-request

Generated reference page for spec/v1/schemas/resources/interaction-request.json.

Metadata

• Type: JSON Schema
• Source: spec/v1/schemas/resources/interaction-request.json
• Raw: View Raw

Summary

• Schema ID: https://agent-service.spec/v1/schemas/resources/interaction-request.json
• Defs: 4
• Properties: 21
• Required: 13

Source

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://agent-service.spec/v1/schemas/resources/interaction-request.json",
  "$defs": {
    "InteractionPrompt": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "title": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "content": {
          "type": "array",
          "items": {
            "$ref": "./message-record.json#/$defs/TaskContent"
          }
        },
        "metadata": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "InteractionOption": {
      "type": "object",
      "additionalProperties": false,
      "required": ["id", "label", "kind"],
      "properties": {
        "id": {
          "type": "string",
          "minLength": 1
        },
        "label": {
          "type": "string",
          "minLength": 1
        },
        "kind": {
          "$ref": "../common/enums.json#/$defs/interactionOptionKind"
        },
        "description": {
          "type": "string"
        },
        "metadata": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "InteractionResponse": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "decision": {
          "$ref": "../common/enums.json#/$defs/interactionDecision"
        },
        "selectedOptionId": {
          "type": "string"
        },
        "payload": {},
        "submittedBy": {
          "type": "string"
        },
        "submittedAt": {
          "$ref": "../common/identity.json#/$defs/timestamp"
        },
        "metadata": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "InteractionOrigin": {
      "type": "object",
      "additionalProperties": false,
      "required": ["type"],
      "properties": {
        "type": {
          "$ref": "../common/enums.json#/$defs/interactionOrigin"
        },
        "reference": {
          "type": "string"
        },
        "metadata": {
          "type": "object",
          "additionalProperties": true
        }
      }
    }
  },
  "type": "object",
  "additionalProperties": false,
  "required": [
    "interactionId",
    "orgId",
    "runId",
    "attemptId",
    "kind",
    "status",
    "prompt",
    "origin",
    "blocking",
    "scope",
    "resolutionPolicy",
    "createdAt",
    "updatedAt"
  ],
  "properties": {
    "interactionId": {
      "$ref": "../common/identity.json#/$defs/interactionId"
    },
    "orgId": {
      "$ref": "../common/identity.json#/$defs/orgId"
    },
    "runId": {
      "$ref": "../common/identity.json#/$defs/runId"
    },
    "attemptId": {
      "$ref": "../common/identity.json#/$defs/attemptId"
    },
    "threadId": {
      "$ref": "../common/identity.json#/$defs/threadId"
    },
    "kind": {
      "$ref": "../common/enums.json#/$defs/interactionKind"
    },
    "status": {
      "$ref": "../common/enums.json#/$defs/interactionStatus"
    },
    "prompt": {
      "$ref": "#/$defs/InteractionPrompt"
    },
    "payloadSchema": {
      "type": "object",
      "additionalProperties": true
    },
    "blocking": {
      "type": "boolean"
    },
    "scope": {
      "$ref": "../common/enums.json#/$defs/interactionScope"
    },
    "resolutionPolicy": {
      "$ref": "../common/enums.json#/$defs/interactionResolutionPolicy"
    },
    "options": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/InteractionOption"
      }
    },
    "response": {
      "$ref": "#/$defs/InteractionResponse"
    },
    "deadlineAt": {
      "$ref": "../common/identity.json#/$defs/timestamp"
    },
    "origin": {
      "$ref": "#/$defs/InteractionOrigin"
    },
    "metadata": {
      "type": "object",
      "additionalProperties": true
    },
    "createdAt": {
      "$ref": "../common/identity.json#/$defs/timestamp"
    },
    "updatedAt": {
      "$ref": "../common/identity.json#/$defs/timestamp"
    },
    "resolvedAt": {
      "$ref": "../common/identity.json#/$defs/timestamp"
    },
    "version": {
      "$ref": "../common/identity.json#/$defs/version"
    }
  }
}