Beam AI · Schema

AgentTaskWithUrlDto

CompanyArtificial IntelligenceAutomationEnterprisePlatform

Properties

Name Type Description
id string
agentGraphId string
customId string
tokensUsed number
totalCost number
taskSummary stringnull
originalTaskQuery stringnull
taskObjective string
taskQuery stringnull
taskState object
userFeedback string
graphState objectnull
isViewed boolean
canRerunTaskNode boolean
status string
rating string
averageEvaluationScore numbernull
createdAt string
updatedAt string
agentTaskNodes array
contextFiles array
agentGraph object
initiationDetail objectnull
creditTransactions array
updatesUrl string
View JSON Schema on GitHub

JSON Schema

beam-ai-agent-task-with-url-dto-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/beam-ai/main/json-schema/beam-ai-agent-task-with-url-dto-schema.json",
  "title": "AgentTaskWithUrlDto",
  "x-generated": "2026-10-14",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/beam-ai-openapi.json#/components/schemas/AgentTaskWithUrlDto",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "agentGraphId": {
      "type": "string"
    },
    "customId": {
      "type": "string"
    },
    "tokensUsed": {
      "type": "number"
    },
    "totalCost": {
      "type": "number"
    },
    "taskSummary": {
      "type": [
        "string",
        "null"
      ]
    },
    "originalTaskQuery": {
      "type": [
        "string",
        "null"
      ]
    },
    "taskObjective": {
      "type": "string"
    },
    "taskQuery": {
      "type": [
        "string",
        "null"
      ]
    },
    "taskState": {
      "nullable": true,
      "allOf": [
        {
          "$ref": "#/$defs/TaskExecutionState"
        }
      ]
    },
    "userFeedback": {
      "type": "string"
    },
    "graphState": {
      "type": [
        "object",
        "null"
      ]
    },
    "isViewed": {
      "type": "boolean"
    },
    "canRerunTaskNode": {
      "type": "boolean"
    },
    "status": {
      "enum": [
        "QUEUED",
        "IN_PROGRESS",
        "COMPLETED",
        "FAILED",
        "USER_INPUT_REQUIRED",
        "USER_CONSENT_REQUIRED",
        "STOPPED",
        "AUTHENTICATION_REQUIRED",
        "INSUFFICIENT_CREDITS",
        "WAITING"
      ],
      "type": "string"
    },
    "rating": {
      "enum": [
        "positive",
        "negative"
      ],
      "type": "string"
    },
    "averageEvaluationScore": {
      "type": [
        "number",
        "null"
      ]
    },
    "createdAt": {
      "format": "date-time",
      "type": "string"
    },
    "updatedAt": {
      "format": "date-time",
      "type": "string"
    },
    "agentTaskNodes": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/MinimalAgentTaskNodeDto"
      }
    },
    "contextFiles": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/ContextFile"
      }
    },
    "agentGraph": {
      "$ref": "#/$defs/OptimizedAgentGraphDto"
    },
    "initiationDetail": {
      "type": [
        "object",
        "null"
      ]
    },
    "creditTransactions": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/TaskCreditTransactionResponseDto"
      }
    },
    "updatesUrl": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "agentGraphId",
    "customId",
    "tokensUsed",
    "totalCost",
    "taskSummary",
    "taskObjective",
    "graphState",
    "isViewed",
    "canRerunTaskNode",
    "status",
    "averageEvaluationScore",
    "createdAt",
    "updatedAt",
    "agentTaskNodes",
    "contextFiles",
    "agentGraph",
    "initiationDetail",
    "updatesUrl"
  ],
  "$defs": {
    "Agent": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique identifier for the agent."
        },
        "name": {
          "type": "string",
          "description": "Name of the agent."
        },
        "description": {
          "type": "string",
          "description": "Description of the agent."
        },
        "settings": {
          "description": "Agent settings.",
          "allOf": [
            {
              "$ref": "#/$defs/AgentSettingDto"
            }
          ]
        },
        "config": {
          "description": "Agent configuration.",
          "allOf": [
            {
              "$ref": "#/$defs/AgentConfig"
            }
          ]
        },
        "workspaceId": {
          "type": "string",
          "description": "UUID of the workspace."
        },
        "creatorId": {
          "type": "string",
          "description": "UUID of the creator."
        },
        "type": {
          "enum": [
            "beam-os",
            "user-agent",
            "pre-configured-agent"
          ],
          "type": "string",
          "description": "Type of the agent."
        },
        "vectorDbId": {
          "type": "string",
          "description": "UUID of the vector database."
        },
        "defaultTaskId": {
          "type": "string",
          "description": "Default task ID."
        },
        "themeIconUrl": {
          "type": "string",
          "description": "URL of the theme icon for the agent."
        },
        "agentCategoryId": {
          "type": "string",
          "description": "UUID of the agent category."
        },
        "userAccessTokenId": {
          "type": "string",
          "description": "UUID of the user access token."
        },
        "agentSetupSessionId": {
          "type": "string",
          "description": "UUID of the agent setup session."
        },
        "agentIntroMessage": {
          "type": "string",
          "description": "Agent introduction message."
        },
        "agentSetupMessage": {
          "type": "string",
          "description": "Agent setup message."
        },
        "skipAgentSetupSop": {
          "type": "boolean",
          "description": "Whether to skip agent setup SOP."
        },
        "isAttachmentDataPulledIn": {
          "type": "boolean",
          "description": "Whether attachment data from tasks should be pulled into the agent context."
        },
        "creditUsage": {
          "type": "number",
          "description": "Total credit usage for this agent."
        },
        "order": {
          "type": "number",
          "description": "Display order of the agent."
        },
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "updatedAt": {
          "format": "date-time",
          "type": "string"
        }
      },
      "required": [
        "id",
        "name",
        "creatorId",
        "type",
        "vectorDbId",
        "creditUsage",
        "order",
        "createdAt",
        "updatedAt"
      ]
    },
    "AgentConfig": {
      "type": "object",
      "properties": {
        "restrictions": {
          "type": "string"
        },
        "taskTemplates": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/AgentTaskTemplate"
          }
        },
        "tools": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "llmTools": {
          "type": "array",
          "items": {
            "type": "object"
          }
        },
        "sop": {
          "type": "object"
        },
        "defaultTaskId": {
          "type": "string"
        },
        "workspaceId": {
          "type": "string"
        }
      }
    },
    "AgentGraphEdge": {
      "type": "object",
      "properties": {
        "sourceAgentGraphNodeId": {
          "type": "string"
        },
        "targetAgentGraphNodeId": {
          "type": "string"
        },
        "condition": {
          "type": "string"
        },
        "isAttachmentDataPulledIn": {
          "type": "boolean"
        },
        "conditionGroups": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/AgentGraphEdgeConditionGroup"
          }
        },
        "id": {
          "type": "string"
        },
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "updatedAt": {
          "format": "date-time",
          "type": "string"
        }
      },
      "required": [
        "sourceAgentGraphNodeId",
        "targetAgentGraphNodeId",
        "isAttachmentDataPulledIn",
        "conditionGroups",
        "id",
        "createdAt",
        "updatedAt"
      ]
    },
    "AgentGraphEdgeConditionGroup": {
      "type": "object",
      "properties": {
        "agentGraphEdgeId": {
          "type": "string"
        },
        "nextGroupOperator": {
          "enum": [
            "AND",
            "OR"
          ],
          "type": "string"
        },
        "edge": {
          "$ref": "#/$defs/AgentGraphEdge"
        },
        "rules": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/AgentGraphEdgeConditionRule"
          }
        },
        "id": {
          "type": "string"
        },
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "updatedAt": {
          "format": "date-time",
          "type": "string"
        }
      },
      "required": [
        "agentGraphEdgeId",
        "edge",
        "rules",
        "id",
        "createdAt",
        "updatedAt"
      ]
    },
    "AgentGraphEdgeConditionRule": {
      "type": "object",
      "properties": {
        "agentGraphEdgeConditionGroupId": {
          "type": "string"
        },
        "sourceAgentToolConfigurationOutputParamsId": {
          "type": "string"
        },
        "operator": {
          "enum": [
            "equals",
            "not_equals",
            "greater_than",
            "less_than",
            "contains",
            "does_not_contain",
            "starts_with",
            "ends_with",
            "is_empty",
            "is_not_empty"
          ],
          "type": "string"
        },
        "comparisonValueType": {
          "enum": [
            "static",
            "output_param"
          ],
          "type": "string"
        },
        "comparisonValue": {
          "type": "string"
        },
        "comparisonAgentToolConfigurationOutputParamsId": {
          "type": "string"
        },
        "nextRuleOperator": {
          "enum": [
            "AND",
            "OR"
          ],
          "type": "string"
        },
        "group": {
          "$ref": "#/$defs/AgentGraphEdgeConditionGroup"
        },
        "sourceOutputParam": {
          "$ref": "#/$defs/AgentToolConfigurationOutputParams"
        },
        "comparisonOutputParam": {
          "$ref": "#/$defs/AgentToolConfigurationOutputParams"
        },
        "id": {
          "type": "string"
        },
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "updatedAt": {
          "format": "date-time",
          "type": "string"
        }
      },
      "required": [
        "agentGraphEdgeConditionGroupId",
        "sourceAgentToolConfigurationOutputParamsId",
        "operator",
        "comparisonValueType",
        "group",
        "sourceOutputParam",
        "id",
        "createdAt",
        "updatedAt"
      ]
    },
    "AgentSettingDto": {
      "type": "object",
      "properties": {
        "prompts": {
          "description": "Array of prompt templates used to guide the agent behavior.",
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "preferredModel": {
          "type": "string",
          "description": "Preferred AI model for this agent."
        },
        "instructions": {
          "type": "string",
          "description": "Additional instructions for agent behavior."
        }
      },
      "required": [
        "prompts"
      ]
    },
    "AgentTask": {
      "type": "object",
      "properties": {
        "agentGraphId": {
          "type": "string",
          "description": "UUID of the agent graph this task is associated with."
        },
        "customId": {
          "type": "string",
          "description": "Custom identifier for external reference or tracking."
        },
        "originalTaskQuery": {
          "type": [
            "string",
            "null"
          ],
          "description": "The original query or request that initiated this task."
        },
        "taskObjective": {
          "type": "string",
          "description": "The main objective or goal of this task."
        },
        "taskInstructions": {
          "type": [
            "string",
            "null"
          ],
          "description": "Detailed instructions for executing this task."
        },
        "taskContext": {
          "type": "object",
          "description": "Additional context data for task execution."
        },
        "taskSuccessCriteria": {
          "type": [
            "string",
            "null"
          ],
          "description": "Criteria that define successful completion of this task."
        },
        "taskQuery": {
          "type": [
            "string",
            "null"
          ],
          "description": "The processed query used for task execution."
        },
        "taskSummary": {
          "type": [
            "string",
            "null"
          ],
          "description": "Summary of the task results after completion."
        },
        "initiationDetail": {
          "type": [
            "object",
            "null"
          ],
          "description": "Details about how this task was initiated."
        },
        "triggerRecordId": {
          "type": [
            "string",
            "null"
          ],
          "description": "Record ID from the trigger source (e.g., Nango sync record ID) used for deduplication."
        },
        "manualRetryCount": {
          "type": "number",
          "description": "Number of times this task has been manually retried."
        },
        "isSuccess": {
          "type": "boolean",
          "description": "Whether the task completed successfully."
        },
        "isViewed": {
          "type": "boolean",
          "description": "Whether the task results have been viewed by the user."
        },
        "canRerunTaskNode": {
          "type": "boolean",
          "description": "Whether nodes in this task can be re-run."
        },
        "startedAt": {
          "format": "date-time",
          "type": [
            "string",
            "null"
          ],
          "description": "Timestamp when task execution started."
        },
        "endedAt": {
          "format": "date-time",
          "type": [
            "string",
            "null"
          ],
          "description": "Timestamp when task execution completed."
        },
        "mode": {
          "type": "string",
          "enum": [
            "AUTO"
          ],
          "description": "Execution mode for the task."
        },
        "status": {
          "enum": [
            "QUEUED",
            "IN_PROGRESS",
            "COMPLETED",
            "FAILED",
            "USER_INPUT_REQUIRED",
            "USER_CONSENT_REQUIRED",
            "STOPPED",
            "AUTHENTICATION_REQUIRED",
            "INSUFFICIENT_CREDITS",
            "WAITING"
          ],
          "type": "string",
          "description": "Current status of the task."
        },
        "userFeedback": {
          "type": "string",
          "description": "Feedback provided by the user about task results."
        },
        "rating": {
          "enum": [
            "positive",
            "negative"
          ],
          "type": "string",
          "description": "User rating for the task results."
        },
        "averageEvaluationScore": {
          "type": [
            "number",
            "null"
          ],
          "description": "Average evaluation score across all task nodes."
        },
        "taskState": {
          "nullable": true,
          "description": "Current execution state of the task.",
          "allOf": [
            {
              "$ref": "#/$defs/TaskExecutionState"
            }
          ]
        },
        "graphState": {
          "type": [
            "object",
            "null"
          ],
          "description": "State of the graph during task execution."
        },
        "totalExecutionTime": {
          "type": [
            "number",
            "null"
          ],
          "description": "Total time taken to execute the task in seconds."
        },
        "tokensUsed": {
          "type": [
            "number",
            "null"
          ],
          "description": "Total number of tokens consumed during task execution."
        },
        "totalCost": {
          "type": [
            "number",
            "null"
          ],
          "description": "Total cost incurred for executing this task."
        },
        "taskReceiveAt": {
          "type": [
            "number",
            "null"
          ]
        },
        "tokenUsages": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/TaskNodeTokenUsage"
          }
        },
        "id": {
          "type": "string"
        },
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "updatedAt": {
          "format": "date-time",
          "type": "string"
        }
      },
      "required": [
        "agentGraphId",
        "manualRetryCount",
        "isSuccess",
        "isViewed",
        "canRerunTaskNode",
        "mode",
        "status",
        "taskReceiveAt",
        "id",
        "createdAt",
        "updatedAt"
      ]
    },
    "AgentTaskTemplate": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Template ID."
        },
        "objective": {
          "type": "string",
          "description": "Task objective."
        },
        "description": {
          "type": "string",
          "description": "Task description."
        },
        "steps": {
          "description": "Steps in this task template.",
          "type": "array",
          "items": {
            "$ref": "#/$defs/AgentTaskTemplateStep"
          }
        },
        "default": {
          "type": "boolean",
          "description": "Whether this is the default template."
        },
        "category": {
          "$ref": "#/$defs/AgentTaskTemplateCategory"
        },
        "lastUpdatedAt": {
          "format": "date-time",
          "type": "string",
          "description": "Last updated timestamp."
        }
      },
      "required": [
        "id",
        "objective",
        "description",
        "steps"
      ]
    },
    "AgentTaskTemplateCategory": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "title": {
          "type": "string"
        }
      }
    },
    "AgentTaskTemplateStep": {
      "type": "object",
      "properties": {
        "step": {
          "type": "string",
          "description": "Step description."
        },
        "toolId": {
          "type": "string",
          "description": "Tool ID."
        },
        "iconSrc": {
          "type": "string",
          "description": "Icon source URL."
        },
        "iconUrl": {
          "type": "string",
          "description": "Icon URL."
        },
        "beamTool": {
          "type": "boolean",
          "description": "Whether this is a Beam tool."
        },
        "gptTool": {
          "type": "boolean",
          "description": "Whether this is a GPT tool."
        },
        "consentRequired": {
          "type": "boolean",
          "description": "Whether consent is required."
        },
        "integrationId": {
          "type": "string",
          "description": "Integration ID."
        },
        "isIntegrationRequired": {
          "type": "boolean",
          "description": "Whether integration is required."
        },
        "isIntegrationConnected": {
          "type": "boolean",
          "description": "Whether integration is connected."
        },
        "integrationProvider": {
          "type": "string",
          "description": "Integration provider."
        },
        "integrationIdentifier": {
          "type": "string",
          "description": "Integration identifier."
        },
        "toolDetail": {
          "type": "object"
        },
        "integrationCustomAuthParameters": {
          "type": "object"
        }
      },
      "required": [
        "step"
      ]
    },
    "AgentToolConfigurationInputParams": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique identifier for the input parameter."
        },
        "paramName": {
          "type": "string",
          "description": "Name of the input parameter."
        },
        "position": {
          "type": "number",
          "description": "Position/order of the parameter in the input list."
        },
        "fillType": {
          "enum": [
            "ai_fill",
            "static",
            "user_fill",
            "from_memory",
            "from_task_attachment",
            "linked"
          ],
          "type": "string",
          "description": "How the parameter value should be filled."
        },
        "agentToolConfigurationId": {
          "type": "string",
          "description": "UUID of the parent tool configuration."
        },
        "question": {
          "type": "string",
          "description": "Question to ask the user when fillType is USER_FILL."
        },
        "linkParamOutputId": {
          "type": "string",
          "description": "ID of the linked output parameter for data flow."
        },
        "paramDescription": {
          "type": "string",
          "description": "Human-readable description of what this parameter represents."
        },
        "paramTip": {
          "type": [
            "string",
            "null"
          ],
          "description": "Helpful tip or hint for providing this parameter value."
        },
        "staticValue": {
          "type": "string",
          "description": "Static value to use when fillType is STATIC."
        },
        "required": {
          "type": "boolean",
          "description": "Whether this parameter is required."
        },
        "dataType": {
          "type": "string",
          "description": "Data type of the parameter."
        },
        "outputExample": {
          "type": "string",
          "description": "Example value demonstrating the expected input format."
        },
        "reloadProps": {
          "type": "boolean",
          "description": "Whether to reload dynamic properties when this parameter changes."
        },
        "remoteOptions": {
          "type": "boolean",
          "description": "Whether options are loaded from a remote source."
        },
        "options": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "object",
            "properties": {
              "label": {
                "type": "string"
              },
              "value": {
                "type": "string"
              }
            }
          },
          "description": "Available options for selection-type parameters."
        },
        "createdAt": {
          "format": "date-time",
          "type": "string",
          "description": "Timestamp when the parameter was created."
        },
        "updatedAt": {
          "format": "date-time",
          "type": "string",
          "description": "Timestamp when the parameter was last updated."
        },
        "linkOutputParam": {
          "$ref": "#/$defs/AgentToolConfigurationOutputParams"
        },
        "linkedOutputParamRules": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/LinkedOutputParamRules"
          }
        },
        "linkedParamRulePrompt": {
          "type": "string"
        },
        "ruleConditionConfig": {
          "$ref": "#/$defs/ParamRuleConditionConfig"
        }
      },
      "required": [
        "id",
        "paramName",
        "fillType",
        "agentToolConfigurationId",
        "createdAt",
        "updatedAt",
        "linkOutputParam",
        "linkedOutputParamRules"
      ]
    },
    "AgentToolConfigurationOutputParams": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique identifier for the output parameter."
        },
        "paramName": {
          "type": "string",
          "description": "Name of the output parameter."
        },
        "position": {
          "type": "number",
          "description": "Position/order of the parameter in the output list."
        },
        "paramDescription": {
          "type": "string",
          "description": "Human-readable description of what this output parameter represents."
        },
        "agentToolConfigurationId": {
          "type": "string",
          "description": "UUID of the parent tool configuration."
        },
        "parentId": {
          "type": "string",
          "description": "UUID of the parent parameter for nested structures."
        },
        "paramPath": {
          "type": "string",
          "description": "JSON path to this parameter in the output structure."
        },
        "outputExample": {
          "type": "string",
          "description": "Example value demonstrating the expected output format."
        },
        "dataType": {
          "enum": [
            "string",
            "number",
            "boolean",
            "object",
            "enum"
          ],
          "type": [
            "string",
            "null"
          ],
          "description": "Data type of the output parameter."
        },
        "isArray": {
          "type": "boolean",
          "default": false,
          "description": "Whether this parameter returns an array of values."
        },
        "typeOptions": {
          "type": [
            "object",
            "null"
          ],
          "description": "Additional type-specific configuration options."
        },
        "createdAt": {
          "format": "date-time",
          "type": "string",
          "description": "Timestamp when the parameter was created."
        },
        "updatedAt": {
          "format": "date-time",
          "type": "string",
          "description": "Timestamp when the parameter was last updated."
        }
      },
      "required": [
        "id",
        "agentToolConfigurationId",
        "isArray",
        "createdAt",
        "updatedAt"
      ]
    },
    "AgentTriggerConfigurationFiltersConditions": {
      "type": "object",
      "properties": {
        "condition": {
          "enum": [
            "is",
            "is_not",
            "contain",
            "does_not_contain",
            "any",
            "all",
            "less_than",
            "GREATER_than",
            "count",
            "exist",
            "does_not_exist"
          ],
          "type": "string"
        },
        "operator": {
          "enum": [
            "AND",
            "OR"
          ],
          "type": "string"
        },
        "property": {
          "type": "string"
        },
        "value": {
          "type": "string"
        }
      },
      "required": [
        "condition",
        "operator",
        "property",
        "value"
      ]
    },
    "AgentTriggerConfigurationFiltersGroup": {
      "type": "object",
      "properties": {
        "operator": {
          "enum": [
            "AND",
            "OR"
          ],
          "type": "string"
        },
        "conditions": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/AgentTriggerConfigurationFiltersConditions"
          }
        }
      },
      "required": [
        "operator",
        "conditions"
      ]
    },
    "ContextFile": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "userId": {
          "type": "string",
          "description": "UUID of the user."
        },
        "src": {
          "type": "string",
          "description": "Source path of the file."
        },
        "fileKey": {
          "type": "string"
        },
        "uploadStatus": {
          "enum": [
            "processing",
            "uploaded",
            "failed"
          ],
          "type": "string"
        },
        "uploadSource": {
          "enum": [
            "file_upload",
            "text_snippet",
            "url_upload"
          ],
          "type": "string"
        },
        "isForAgentDatabase": {
          "type": "boolean",
          "description": "Whether the file is for the agent database."
        },
        "agentId": {
          "type": "string",
          "description": "UUID of the agent."
        },
        "mimeType": {
          "type": "string",
          "description": "MIME type of the file."
        },
        "taskId": {
          "type": "string",
          "description": "UUID of the task."
        },
        "agentTaskId": {
          "type": "string",
          "description": "UUID of the agent task."
        },
        "url": {
          "type": "string"
        },
        "datasourceConnectionId": {
          "type": "string",
          "description": "Datasource connection identifier."
        },
        "externalFileId": {
          "type": "string",
          "description": "External file identifier."
        },
        "agent": {
          "$ref": "#/$defs/Agent"
        },
        "user": {
          "$ref": "#/$defs/User"
        },
        "agentTask": {
          "$ref": "#/$defs/AgentTask"
        },
        "id": {
          "type": "string"
        },
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "updatedAt": {
          "format": "date-time",
          "type": "string"
        }
      },
      "required": [
        "name",
        "userId",
        "uploadStatus",
        "uploadSource",
        "isForAgentDatabase",
        "agentId",
        "agent",
        "user",
        "agentTask",
        "id",
        "createdAt",
        "updatedAt"
      ]
    },
    "CustomToolOutput": {
      "type": "object",
      "properties": {
        "position": {
          "type": "number"
        },
        "paramName": {
          "type": "string"
        },
        "paramDescription": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "agentToolConfigurationId": {
          "type": "string"
        },
        "dataType": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "string",
            "number",
            "boolean",
            "object",
            "enum"
          ]
        },
        "isArray": {
          "type": "boolean"
        },
        "typeOptions": {
          "type": [
            "object",
            "null"
          ],
          "additionalProperties": true
        },
        "parentId": {
          "type": "string"
        },
        "paramPath": {
          "type": "string"
        },
        "outputExample": {
          "type": "string"
        }
      }
    },
    "EdgeEvaluationDto": {
      "type": "object",
      "properties": {
        "target_node_id": {
          "type": "string",
          "description": "Target Node Id"
        },
        "eval_criteria": {
          "type": "string",
          "description": "Evaluation Criteria"
        },
        "branch_name": {
          "type": "string",
          "description": "branch name"
        },
        "reason": {
          "type": "string",
          "description": "Evaluation Reasoning"
        },
        "selected": {
          "type": "boolean",
          "description": "Is the edge selected"
        }
      },
      "required": [
        "target_node_id",
        "eval_criteria",
        "branch_name",
        "reason",
        "selected"
      ]
    },
    "FoodForThought": {
      "type": "object",
      "properties": {
        "question": {
          "type": "string"
        },
        "answer": {
          "type": "string"
        }
      },
      "required": [
        "question",
        "answer"
      ]
    },
    "LinkParamsDto": {
      "type": "object",
      "properties": {
        "toolId": {
          "type": "string"
        },
        "toolFunctionName": {
          "type": "string"
        },
        "outputParam": {
          "type": "string"
        },
        "outputId": {
          "type": "string"
        }
      }
    },
    "LinkedOutputParamRuleDto": {
      "type": "object",
      "properties": {
        "elementKey": {
          "type": "string",
          "description": "Element key for the rule."
        },
        "operator": {
          "enum": [
            "equals",
            "not_equals",
            "greater_than",
            "less_than",
            "contains",
            "does_not_contain",
    

# --- truncated at 32 KB (60 KB total) ---
# Full source: https://artifacts.apis.io/beam-ai/json-schema/beam-ai-agent-task-with-url-dto-schema.json

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/beam-ai-agent-task-with-url-dto"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.