{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://raw.githubusercontent.com/api-evangelist/beam-ai/main/json-schema/beam-ai-minimal-agent-task-dto-schema.json", "title": "MinimalAgentTaskDto", "x-generated": "2026-10-14", "x-method": "derived", "x-generator": "derive-json-schema.py", "x-source": "openapi/beam-ai-openapi.json#/components/schemas/MinimalAgentTaskDto", "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" } } }, "required": [ "id", "agentGraphId", "customId", "tokensUsed", "totalCost", "taskSummary", "taskObjective", "graphState", "isViewed", "canRerunTaskNode", "status", "averageEvaluationScore", "createdAt", "updatedAt", "agentTaskNodes", "contextFiles", "agentGraph", "initiationDetail" ], "$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", "starts_with", "ends_with", "is_empty", "is_not_empty" ], "type": "string", "description": "Comparison operator for the rule." }, "comparisonValueType": { "enum": [ "static", "output_param" ], "type": "string", "description": "Type of the comparison value." }, "comparisonValue": { "type": [ "string", "null" ], "description": "Value to compare against." }, "nextRuleOperator": { "enum": [ "AND", "OR" ], "type": "string", "description": "Logical operator linking to the next rule." } }, "required": [ "elementKey", "operator", "comparisonValueType" ] }, "LinkedOutputParamRules": { "type": "object", "properties": { "elementKey": { "type": "string" }, "agentToolConfigurationInputParamsId": { "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" }, "nextRuleOperator": { "enum": [ "AND", "OR" ], "type": "string" }, "id": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "elementKey", "agentToolConfigurationInputParamsId", "operator", "comparisonValueType", "id", "createdAt", "updatedAt" ] }, "LinkedOutputParamRulesDto": { "type": "object", "properties": { "rules": { "description": "Array of linked output param rules.", "type": "array", "items": { "$ref": "#/$defs/LinkedOutputParamRuleDto" } }, "linkedParamRulePrompt": { "type": "string", "description": "Prompt for the linked param rule." }, "linkedParamConfigurations": { "description": "Configuration for linked param nodes.", "allOf": [ { "$ref": "#/$defs/ParamRuleConditionConfig" } ] } }, "required": [ "linkedParamConfigurations" ] }, "MinimalAgentCategoryDto": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" } }, "required": [ "id", "title" ] }, "MinimalAgentDto": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "themeIconUrl": { "type": "string" }, "agentCategoryId": { "type": "string" }, "category": { "$ref": "#/$defs/MinimalAgentCategoryDto" }, "type": { "enum": [ "beam-os", "user-agent", "pre-configured-agent" ], "type": "string" }, "workspaceId": { "type": "string" }, "creatorId": { "type": "string" }, "order": { "type": "number" } }, "required": [ "id", "name", "type", "creatorId", "order" ] }, "MinimalAgentGraphEdgeDto": { "type": "object", "properties": { "id": { "type": "string" }, "sourceAgentGraphNodeId": { "type": "string" }, "targetAgentGraphNodeId": { "type": "string" }, "condition": { "type": "string" }, "isAttachmentDataPulledIn": { "type": "boolean" }, "conditionGroups": { "type": "array", "items": { "$ref": "#/$defs/AgentGraphEdgeConditionGroup" } } }, "required": [ "id", "sourceAgentGraphNodeId", "targetAgentGraphNodeId", "isAttachmentDataPulledIn", "conditionGroups" ] }, "MinimalAgentGraphNodeDto": { "type": "object", "properties": { "id": { "type": "string" }, "customId": { "type": "string" }, "objective": { "type": "string" }, "evaluationCriteria": { "type": "array", "items": { "type": "string" } }, "isEntryNode": { "type": "boolean" }, "isExitNode": { "type": "boolean" }, "xCoordinate": { "type": "number" }, "yCoordinate": { "type": "number" }, "isEvaluationEnabled": { "type": "boolean" }, "autoRetryWhenAccuracyLessThan": { "type": "number" }, "autoRetryLimitWhenAccuracyIsLow": { "type": "number" }, "enableAutoRetryWhenAccuracyIsLow": { "type": "boolean" }, "enableAutoRetryWhenFailure": { "type": "boolean" }, "autoRetryDescription": { "type": "string", "default": null }, "enableAutoRetryDescription": { "type": "boolean", "default": false }, "autoRetryCountWhenFailure": { "type": "number" }, "autoRetryWaitTimeWhenFailureInMs": { "type": "number" }, "isAttachmentDataPulledIn": { "type": "boolean" }, "isEdited": { "type": "boolean" }, "createdAt": { "format": "date-time", "type": "string" }, "onError": { "type": "string", "enum": [ "CONTINUE", "STOP" ] }, "nodeType": { "enum": [ "executionNode", "conditionNode", "waitingNode", "entryNode", "exitNode" ], "type": "string" }, "nodeConfigurations": { "$ref": "#/$defs/NodeConfigurations" }, "toolConfiguration": { "$ref": "#/$defs/MinimalToolConfigurationDto" }, "childEdges": { "type": "array", "items": { "$ref": "#/$defs/MinimalAgentGraphEdgeDto" } }, "parentEdges": { "type": "array", "items": { "$ref": "#/$defs/MinimalAgentGraphEdgeDto" } } }, "required": [ "id", "customId", "objective", "evaluationCriteria", "isEntryNode", "isExitNode", "isEvaluationEnabled", "autoRetryWhenAccuracyLessThan", "autoRetryLimitWhenAccuracyIsLow", "enableAutoRetryWhenAccuracyIsLow", "enableAutoRetryWhenFailure", "autoRetryDescription", "enableAutoRetryDescription", "autoRetryCountWhenFailure", "autoRetryWaitTimeWhenFailureInMs", "isAttachmentDataPulledIn", "isEdited", "createdAt", "toolConfiguration", "childEdges", "parentEdges" ] }, "MinimalAgentTaskNodeDto": { "type": "object", "properties": { "id": { "type": "string" }, "agentGraphNodeId": { "type": "string" }, "status": { "enum": [ "QUEUED", "IN_PROGRESS", "USER_INPUT_REQUIRED", "COMPLETED", "USER_CONSENT_REQUIRED", "FAILED", "INSUFFICIENT_CREDITS", "WAITING" ], "type": "string" }, "retriedCountWhenFailure": { "type": "number" }, "retriedCountWhenAccuracyIsLow": { "type": "number" }, "manualRetryCount": { "type": "number" }, "isEverConsentRequired": { "type": "boolean" }, "userFeedback": { "type": "string" }, "evaluationScore": { "type": [ "number", "null" ] }, "userQuestions": { "type": [ "array", "null" ], "items": { "$ref": "#/$defs/TaskStepUserInput" } }, "output": { "nullable": true, "allOf": [ { "$ref": "#/$defs/TaskNodeOutput" } ] }, "input": { "type": [ "array", "null" ], "items": { "$ref": "#/$defs/TaskNodeInput" } }, "toolData": { "nullable": true, "allOf": [ { "$ref": "#/$defs/ToolDataDto" } ] }, "agentGraphNode": { "$ref": "#/$defs/MinimalAgentGraphNodeDto" }, "edgeEvaluations": { "type": [ "array", "null" ], "items": { "$ref": "#/$defs/EdgeEvaluationDto" } }, "nodeEvaluation": { "type": [ "array", "null" ], "items": { "type": "array" } }, "rating": { "enum": [ "positive", "negative" ], "type": "string" } }, "required": [ "id", "agentGraphNodeId", "status", "retriedCountWhenFailure", "retriedCountWhenAccuracyIsLow", "manualRetryCount", "isEverConsentRequired", "agentGraphNode", "edgeEvaluations", "nodeEvaluation" ] }, "MinimalIntegrationDto": { "type": "object", "properties": { "systemIntegrationProvider": { "type": "string" }, "systemIntegrationIdentifier": { "type": "string" }, "customAuthParameters": { "type": "object" } } }, "MinimalOriginalToolDto": { "type": "object", "properties": { "toolName": { "type": "string" }, "toolFunctionName": { "type": "string" }, "iconSrc": { "type": "string" }, "type": { "type": "string" }, "prompt": { "type": "string" }, "description": { "type": "string" }, "preferredModel": { "type": "string" }, "meta": { "type": "object" }, "integrationId": { "type": "string" }, "isIntegrationRequired": { "type": "boolean" }, "isIntegrationConnected": { "type": "boolean" }, "allowWaiting": { "type": "boolean" }, "integration": { "$ref": "#/$defs/MinimalIntegrationDto" }, "inputParams": { "type": "array", "items": { "$ref": "#/$defs/UserInputParamConfigDto" } }, "outputParams": { "type": "array", "items": { "$ref": "#/$defs/CustomToolOutput" } } }, "required": [ "toolName", "toolFunctionName", "allowWaiting" ] }, "MinimalToolConfigurationDto": { "type": "object", "properties": { "id": { "type": "string" }, "toolFunctionName": { "type": "string" }, "toolName": { "type": "string" }, "iconSrc": { "type": "string" }, "description": { "type": "string" }, "requiresConsent": { "type": "boolean" }, "isMemoryTool": { "type": "boolean" }, "memoryLookupInstruction": { "type": "string" }, "isBackgroundTool": { "type": "boolean" }, "isBatchExecutionEnabled": { "type": "boolean" }, "accuracyScore": { "type": "number" }, "integrationProviderId": { "type": "string" }, "dynamicPropsId": { "type": [ "string", "null" ] }, "fallbackModels": { "type": [ "string", "null" ] }, "preferredModel": { "type": [ "string", "null" ] }, "code": { "type": [ "string", "null" ] }, "codeLanguage": { "type": [ "string", "null" ] }, "inputParams": { "type": "array", "items": { "$ref": "#/$defs/AgentToolConfigurationInputParams" } }, "outputParams": { "type": "array", "items": { "$ref": "#/$defs/AgentToolConfigurationOutputParams" } }, "originalTool": { "$ref": "#/$defs/MinimalOriginalToolDto" } }, "required": [ "id", "toolFunctionName", "toolName", "requiresConsent", "isMemoryTool", "isBackgroundTool", "isBatchExecutionEnabled", "inputParams", "outputParams" ] }, "NodeConfigurations": { "type": "object", "properties": { "conditionType": { "enum": [ "llm_based", "rule_based" ], "type": "string" }, "llmModel": { "type": "string" }, "fallbackModels": { "type": "string" }, "waitType": { "enum": [ "time_based", "condition_based" ], "type": "string" }, "timeToWaitValue": { "type": "number" }, "timeToWaitUnit": { "enum": [ "minutes", "hours", "days", "months" ], "type": "string" }, "linkedAgentGraphNodeId": { "type": "string" }, "rule": { "type": "string" }, "conditions": { "type": "array", "items": { "$ref": "#/$defs/AgentTriggerConfigurationFiltersGroup" } }, "timeoutType": { "enum": [ "no_timeout", "set_timeout" ], "type": "string" }, "timeoutValue": { "type": "number" }, "timeoutUnit": { "enum": [ "minutes", "hours", "days", "months" ], "type": "string" }, "onTimeout": { "enum": [ "continue", "fail" ], "type": "string" } } }, "NodeSelection": { "type": "object", "properties": { "edgeId": { "type": "string" }, "condition": { "type": "string" }, "selected": { "type": "boolean" }, "reasoning": { "type": "string" }, "otherEdges": { "type": "array", "items": { "$ref": "#/$defs/NodeSelection" } } }, "required": [ "edgeId", "condition", "selected", "reasoning", "otherEdges" ] }, "OptimizedAgentGraphDto": { "type": "object", "properties": { "id": { "type": "string" }, "agentId": { "type": "string" }, "isActive": { "type": "boolean" }, "isDraft": { "type": "boolean" }, "isPublished": { "type": "boolean" }, "isEdited": { "type": "boolean" }, "publishedAt": { "type": "object" }, "isEverExecuted": { "type": "boolean" }, "isEverUsedForTemplate": { "type": "boolean" }, "nodes": { "type": "array", "items": { "$ref": "#/$defs/MinimalAgentGraphNodeDto" } }, "agent": { "$ref": "#/$defs/MinimalAgentDto" } }, "required": [ "id", "agentId", "isActive", "isDraft", "isPublished", "isEdited", "isEverExecuted", "isEverUsedForTemplate", "nodes", "agent" ] }, "ParamRuleConditionConfig": { "type": "object", "properties": { "conditionType": { "type": "string", "enum": [ "llm_based", "rule_based" ] } } }, "TaskCreditTransactionResponseDto": { "type": "object", "properties": { "id": { "type": "string" }, "transactionType": { "enum": [ "subscription_purchase", "one_time_purchase", "subscription_renewal", "credit_usage", "credit_reset", "credit_suspension", "refund" ], "type": "string" }, "creditsAmount": { "type": "number" }, "tokensUsed": { "type": "number" }, "costAmount": { "type": "number" }, "usageCategory": { "type": "string" }, "agentGraphNodeId": { "type": "string" }, "toolType": { "type": "string" }, "modelName": { "type": "string" } }, "required": [ "id", "transactionType", "creditsAmount" ] }, "TaskExecutionState": { "type": "object", "properties": { "nodeSelections": { "type": "array", "items": { "$ref": "#/$defs/NodeSelection" } } } }, "TaskNodeInput": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "value": { "type": "string" }, "answer": { "type": "string" }, "question": { "type": [ "string", "null" ] }, "reasoning": { "type": [ "string", "null" ] }, "found": { "type": "boolean" }, "required": { "type": "boolean" } }, "required": [ "id", "name", "value", "question", "reasoning", "found", "required" ] }, "TaskNodeOutput": { "type": "object", "properties": { "value": { "type": "object" } }, "required": [ "value" ] }, "TaskNodeTokenUsage": { "type": "object", "properties": { "agentTaskId": { "type": "string" }, "agentGraphNodeId": { "type": [ "string", "null" ] }, "creditTransactionId": { "type": [ "string", "null" ] }, "promptSlug": { "type": [ "string", "null" ] }, "executionStage": { "enum": [ "QUERY_REFORMULATION", "NODE_SELECTION", "NODE_GENERATION", "TOOL_SELECTION", "NODE_RETRIEVAL", "PARAMETER_EXTRACTION", "TOOL_EXECUTION", "NODE_EVALUATION" ], "type": "string" }, "iteration": { "type": "number" }, "model": { "type": "string" }, "operation": { "enum": [ "NORMAL", "PROVIDER_ERROR", "PARSER_ERROR", "TIMEOUT", "HIGH_TOKEN_FALLBACK", "MODEL_FALLBACK", "AUTO_FIX", "RATE_LIMIT" ], "type": "string" }, "inputToken": { "type": "number" }, "outputToken": { "type": "number" }, "reasoningToken": { "type": [ "number", "null" ] }, "totalToken": { "type": "number" }, "isLatest": { "type": "boolean" }, "agentTask": { "$ref": "#/$defs/AgentTask" }, "id": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "agentTaskId", "agentGraphNodeId", "creditTransactionId", "promptSlug", "executionStage", "iteration", "model", "operation", "inputToken", "outputToken", "reasoningToken", "totalToken", "isLatest", "agentTask", "id", "createdAt", "updatedAt" ] }, "TaskStepUserInput": { "type": "object", "properties": { "question": { "type": "string" }, "answer": { "type": "string" }, "parameter": { "type": "string" }, "memoryAnswer": { "type": "boolean" }, "foodForThought": { "type": "array", "items": { "$ref": "#/$defs/FoodForThought" } } }, "required": [ "question", "answer" ] }, "ToolDataDto": { "type": "object", "properties": { "tool_id": { "type": "string" }, "tool_parameters": { "type": "array", "items": { "type": "object" } }, "tool_output": { "type": "array", "items": { "type": "object" } }, "required_parameters": { "type": "object", "additionalProperties": true }, "optional_parameters": { "type": "object", "additionalProperties": true }, "reasoning": { "type": "object", "additionalProperties": true }, "filled_prompt": { "type": "string" }, "skip_param_extraction": { "type": "array", "items": { "type": "string" } }, "integration_identifier": { "type": "string" }, "integration_error": { "type": "boolean", "default": false } }, "required": [ "tool_id", "tool_parameters" ] }, "User": { "type": "object", "properties": { "name": { "type": "string", "description": "Full name of the user." }, "avatarSrc": { "type": "string", "description": "URL to the user profile avatar image." }, "email": { "type": "string" }, "cognitoUserId": { "type": "string" }, "socialProvider": { "type": "string" }, "socialProviderId": { "type": "string" }, "password": { "type": "string" }, "paymentProviderCustomerId": { "type": "string" }, "rememberToken": { "type": "string" }, "emailVerified": { "type": "boolean" }, "referralCode": { "type": "string" }, "role_name": { "type": "string" }, "isInternalUser": { "type": "boolean" }, "id": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "name", "email", "cognitoUserId", "role_name", "isInternalUser", "id", "createdAt", "updatedAt" ] }, "UserInputParamConfigDto": { "type": "object", "properties": { "position": { "type": "number", "description": "Position/order of the parameter in the input list." }, "paramName": { "type": "string", "description": "Name of the input parameter." }, "fillType": { "default": "ai_fill", "enum": [ "ai_fill", "static", "user_fill", "from_memory", "from_task_attachment", "linked" ], "type": "string", "description": "How the parameter value should be filled." }, "question": { "type": [ "string", "null" ], "description": "Question to ask the user when fillType is USER_FILL." }, "linkParams": { "description": "Configuration for linking this parameter to another tool output.", "allOf": [ { "$ref": "#/$defs/LinkParamsDto" } ] }, "linkParamOutputId": { "type": [ "string", "null" ], "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", "null" ], "description": "Static value to use when fillType is STATIC." }, "required": { "type": "boolean", "default": true, "description": "Whether this parameter is required." }, "dataType": { "type": "string", "default": "string", "description": "Data type of the parameter." }, "isArray": { "type": "boolean", "default": false, "description": "Whether this parameter accepts an array of values." }, "typeOptions": { "type": [ "object", "null" ], "additionalProperties": true, "description": "Additional type-specific configuration options." }, "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." }, "linkedOutputParamRulesData": { "description": "Rules for linked output parameters.", "allOf": [ { "$ref": "#/$defs/LinkedOutputParamRulesDto" } ] } }, "required": [ "paramName", "fillType" ] } } }