Rate Task Output
curl --request PATCH \
--url https://api.beamstudio.ai/agent-tasks/execution/{taskId}/output-rating \
--header 'Content-Type: application/json' \
--header 'current-workspace-id: <current-workspace-id>' \
--header 'x-api-key: <api-key>' \
--data '
{
"taskNodeId": "<string>",
"userFeedback": "<string>",
"expectedOutput": "<string>"
}
'import requests
url = "https://api.beamstudio.ai/agent-tasks/execution/{taskId}/output-rating"
payload = {
"taskNodeId": "<string>",
"userFeedback": "<string>",
"expectedOutput": "<string>"
}
headers = {
"current-workspace-id": "<current-workspace-id>",
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'current-workspace-id': '<current-workspace-id>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({taskNodeId: '<string>', userFeedback: '<string>', expectedOutput: '<string>'})
};
fetch('https://api.beamstudio.ai/agent-tasks/execution/{taskId}/output-rating', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.beamstudio.ai/agent-tasks/execution/{taskId}/output-rating",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'taskNodeId' => '<string>',
'userFeedback' => '<string>',
'expectedOutput' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"current-workspace-id: <current-workspace-id>",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.beamstudio.ai/agent-tasks/execution/{taskId}/output-rating"
payload := strings.NewReader("{\n \"taskNodeId\": \"<string>\",\n \"userFeedback\": \"<string>\",\n \"expectedOutput\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("current-workspace-id", "<current-workspace-id>")
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.beamstudio.ai/agent-tasks/execution/{taskId}/output-rating")
.header("current-workspace-id", "<current-workspace-id>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"taskNodeId\": \"<string>\",\n \"userFeedback\": \"<string>\",\n \"expectedOutput\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.beamstudio.ai/agent-tasks/execution/{taskId}/output-rating")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["current-workspace-id"] = '<current-workspace-id>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"taskNodeId\": \"<string>\",\n \"userFeedback\": \"<string>\",\n \"expectedOutput\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"agentGraphId": "<string>",
"customId": "<string>",
"tokensUsed": 123,
"totalCost": 123,
"taskSummary": "<string>",
"taskObjective": "<string>",
"graphState": {},
"isViewed": true,
"canRerunTaskNode": true,
"averageEvaluationScore": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"agentTaskNodes": [
{
"id": "<string>",
"agentGraphNodeId": "<string>",
"retriedCountWhenFailure": 123,
"retriedCountWhenAccuracyIsLow": 123,
"manualRetryCount": 123,
"isEverConsentRequired": true,
"agentGraphNode": {
"id": "<string>",
"customId": "<string>",
"objective": "<string>",
"evaluationCriteria": [
"<string>"
],
"isEntryNode": true,
"isExitNode": true,
"isEvaluationEnabled": true,
"autoRetryWhenAccuracyLessThan": 123,
"autoRetryLimitWhenAccuracyIsLow": 123,
"enableAutoRetryWhenAccuracyIsLow": true,
"enableAutoRetryWhenFailure": true,
"autoRetryDescription": null,
"enableAutoRetryDescription": false,
"autoRetryCountWhenFailure": 123,
"autoRetryWaitTimeWhenFailureInMs": 123,
"isAttachmentDataPulledIn": true,
"isEdited": true,
"createdAt": "2023-11-07T05:31:56Z",
"toolConfiguration": {
"id": "<string>",
"toolFunctionName": "<string>",
"toolName": "<string>",
"requiresConsent": true,
"isMemoryTool": true,
"isBackgroundTool": true,
"isBatchExecutionEnabled": true,
"inputParams": [
{
"id": "param-123e4567-e89b-12d3-a456-426614174000",
"paramName": "customerId",
"fillType": "ai_fill",
"agentToolConfigurationId": "config-123e4567-e89b-12d3-a456-426614174000",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"linkOutputParam": {
"id": "param-123e4567-e89b-12d3-a456-426614174000",
"agentToolConfigurationId": "config-123e4567-e89b-12d3-a456-426614174000",
"isArray": false,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"paramName": "customerData",
"position": 1,
"paramDescription": "The customer data retrieved from the database.",
"parentId": "<string>",
"paramPath": "response.data.customer",
"outputExample": "{\"name\": \"John Doe\", \"email\": \"john@example.com\"}",
"dataType": "string",
"typeOptions": {}
},
"linkedOutputParamRules": [
{
"elementKey": "<string>",
"agentToolConfigurationInputParamsId": "<string>",
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"comparisonValue": "<string>"
}
],
"position": 1,
"question": "What is the customer ID?",
"linkParamOutputId": "<string>",
"paramDescription": "The unique identifier for the customer record.",
"paramTip": "Enter the 8-digit customer ID from their account.",
"staticValue": "default_value",
"required": true,
"dataType": "string",
"outputExample": "CUST-12345678",
"reloadProps": false,
"remoteOptions": false,
"options": [
{
"label": "<string>",
"value": "<string>"
}
],
"linkedParamRulePrompt": "<string>",
"ruleConditionConfig": {}
}
],
"outputParams": [
{
"id": "param-123e4567-e89b-12d3-a456-426614174000",
"agentToolConfigurationId": "config-123e4567-e89b-12d3-a456-426614174000",
"isArray": false,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"paramName": "customerData",
"position": 1,
"paramDescription": "The customer data retrieved from the database.",
"parentId": "<string>",
"paramPath": "response.data.customer",
"outputExample": "{\"name\": \"John Doe\", \"email\": \"john@example.com\"}",
"dataType": "string",
"typeOptions": {}
}
],
"iconSrc": "<string>",
"description": "<string>",
"memoryLookupInstruction": "<string>",
"accuracyScore": 123,
"integrationProviderId": "<string>",
"dynamicPropsId": "<string>",
"fallbackModels": "<string>",
"code": "<string>",
"codeLanguage": "<string>",
"originalTool": {
"toolName": "<string>",
"toolFunctionName": "<string>",
"allowWaiting": true,
"iconSrc": "<string>",
"type": "<string>",
"prompt": "<string>",
"description": "<string>",
"preferredModel": "<string>",
"meta": {},
"integrationId": "<string>",
"isIntegrationRequired": true,
"isIntegrationConnected": true,
"integration": {
"systemIntegrationProvider": "<string>",
"systemIntegrationIdentifier": "<string>",
"customAuthParameters": {}
},
"inputParams": [
{
"paramName": "customerId",
"fillType": "ai_fill",
"position": 1,
"question": "What is the customer ID?",
"linkParams": {
"toolId": "<string>",
"toolFunctionName": "<string>",
"outputParam": "<string>",
"outputId": "<string>"
},
"linkParamOutputId": "<string>",
"paramDescription": "The unique identifier for the customer record.",
"paramTip": "Enter the 8-digit customer ID from their account.",
"staticValue": "default_value",
"required": true,
"dataType": "string",
"isArray": false,
"typeOptions": {},
"outputExample": "CUST-12345678",
"reloadProps": false,
"remoteOptions": false,
"options": [
{
"label": "<string>",
"value": "<string>"
}
],
"linkedOutputParamRulesData": {
"linkedParamConfigurations": {},
"rules": [
{
"elementKey": "<string>",
"comparisonValue": "<string>"
}
],
"linkedParamRulePrompt": "<string>"
}
}
],
"outputParams": [
{
"position": 123,
"paramName": "<string>",
"paramDescription": "<string>",
"id": "<string>",
"agentToolConfigurationId": "<string>",
"isArray": true,
"typeOptions": {},
"parentId": "<string>",
"paramPath": "<string>",
"outputExample": "<string>"
}
]
},
"preferredModel": "<string>"
},
"childEdges": [
{
"id": "<string>",
"sourceAgentGraphNodeId": "<string>",
"targetAgentGraphNodeId": "<string>",
"isAttachmentDataPulledIn": true,
"conditionGroups": [
{
"agentGraphEdgeId": "<string>",
"edge": {
"sourceAgentGraphNodeId": "<string>",
"targetAgentGraphNodeId": "<string>",
"isAttachmentDataPulledIn": true,
"conditionGroups": "<array>",
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"condition": "<string>"
},
"rules": [
{
"agentGraphEdgeConditionGroupId": "<string>",
"sourceAgentToolConfigurationOutputParamsId": "<string>",
"group": "<unknown>",
"sourceOutputParam": {
"id": "param-123e4567-e89b-12d3-a456-426614174000",
"agentToolConfigurationId": "config-123e4567-e89b-12d3-a456-426614174000",
"isArray": false,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"paramName": "customerData",
"position": 1,
"paramDescription": "The customer data retrieved from the database.",
"parentId": "<string>",
"paramPath": "response.data.customer",
"outputExample": "{\"name\": \"John Doe\", \"email\": \"john@example.com\"}",
"dataType": "string",
"typeOptions": {}
},
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"comparisonValue": "<string>",
"comparisonAgentToolConfigurationOutputParamsId": "<string>",
"comparisonOutputParam": {
"id": "param-123e4567-e89b-12d3-a456-426614174000",
"agentToolConfigurationId": "config-123e4567-e89b-12d3-a456-426614174000",
"isArray": false,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"paramName": "customerData",
"position": 1,
"paramDescription": "The customer data retrieved from the database.",
"parentId": "<string>",
"paramPath": "response.data.customer",
"outputExample": "{\"name\": \"John Doe\", \"email\": \"john@example.com\"}",
"dataType": "string",
"typeOptions": {}
}
}
],
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"condition": "<string>"
}
],
"parentEdges": [
{
"id": "<string>",
"sourceAgentGraphNodeId": "<string>",
"targetAgentGraphNodeId": "<string>",
"isAttachmentDataPulledIn": true,
"conditionGroups": [
{
"agentGraphEdgeId": "<string>",
"edge": {
"sourceAgentGraphNodeId": "<string>",
"targetAgentGraphNodeId": "<string>",
"isAttachmentDataPulledIn": true,
"conditionGroups": "<array>",
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"condition": "<string>"
},
"rules": [
{
"agentGraphEdgeConditionGroupId": "<string>",
"sourceAgentToolConfigurationOutputParamsId": "<string>",
"group": "<unknown>",
"sourceOutputParam": {
"id": "param-123e4567-e89b-12d3-a456-426614174000",
"agentToolConfigurationId": "config-123e4567-e89b-12d3-a456-426614174000",
"isArray": false,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"paramName": "customerData",
"position": 1,
"paramDescription": "The customer data retrieved from the database.",
"parentId": "<string>",
"paramPath": "response.data.customer",
"outputExample": "{\"name\": \"John Doe\", \"email\": \"john@example.com\"}",
"dataType": "string",
"typeOptions": {}
},
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"comparisonValue": "<string>",
"comparisonAgentToolConfigurationOutputParamsId": "<string>",
"comparisonOutputParam": {
"id": "param-123e4567-e89b-12d3-a456-426614174000",
"agentToolConfigurationId": "config-123e4567-e89b-12d3-a456-426614174000",
"isArray": false,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"paramName": "customerData",
"position": 1,
"paramDescription": "The customer data retrieved from the database.",
"parentId": "<string>",
"paramPath": "response.data.customer",
"outputExample": "{\"name\": \"John Doe\", \"email\": \"john@example.com\"}",
"dataType": "string",
"typeOptions": {}
}
}
],
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"condition": "<string>"
}
],
"xCoordinate": 123,
"yCoordinate": 123,
"nodeConfigurations": {
"llmModel": "<string>",
"fallbackModels": "<string>",
"timeToWaitValue": 123,
"linkedAgentGraphNodeId": "<string>",
"rule": "<string>",
"conditions": [
{
"conditions": [
{
"property": "<string>",
"value": "<string>"
}
]
}
],
"timeoutValue": 123
}
},
"edgeEvaluations": [
{
"target_node_id": "<string>",
"eval_criteria": "<string>",
"branch_name": "<string>",
"reason": "<string>",
"selected": true
}
],
"nodeEvaluation": [
"<array>"
],
"userFeedback": "<string>",
"evaluationScore": 123,
"userQuestions": [
{
"question": "<string>",
"answer": "<string>",
"parameter": "<string>",
"memoryAnswer": true,
"foodForThought": [
{
"question": "<string>",
"answer": "<string>"
}
]
}
],
"output": {
"value": {}
},
"input": [
{
"id": "<string>",
"name": "<string>",
"value": "<string>",
"question": "<string>",
"reasoning": "<string>",
"found": true,
"required": true,
"answer": "<string>"
}
],
"toolData": {
"tool_id": "<string>",
"tool_parameters": [
{}
],
"tool_output": [
{}
],
"required_parameters": {},
"optional_parameters": {},
"reasoning": {},
"filled_prompt": "<string>",
"skip_param_extraction": [
"<string>"
],
"integration_identifier": "<string>",
"integration_error": false
}
}
],
"contextFiles": [
{
"name": "<string>",
"userId": "<string>",
"isForAgentDatabase": true,
"agentId": "<string>",
"agent": {
"id": "agent-123e4567-e89b-12d3-a456-426614174000",
"name": "Customer Support Agent",
"creatorId": "<string>",
"vectorDbId": "<string>",
"creditUsage": 12.5,
"order": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"settings": {
"prompts": [
"You are a helpful customer support agent.",
"Always be polite and professional."
],
"preferredModel": "gpt-4",
"instructions": "Focus on providing concise answers."
},
"config": {
"restrictions": "<string>",
"taskTemplates": [
{
"id": "<string>",
"objective": "<string>",
"description": "<string>",
"steps": [
{
"step": "<string>",
"toolId": "<string>",
"iconSrc": "<string>",
"iconUrl": "<string>",
"beamTool": true,
"gptTool": true,
"consentRequired": true,
"integrationId": "<string>",
"isIntegrationRequired": true,
"isIntegrationConnected": true,
"integrationProvider": "<string>",
"integrationIdentifier": "<string>",
"toolDetail": {},
"integrationCustomAuthParameters": {}
}
],
"default": true,
"category": {
"id": "<string>",
"title": "<string>"
},
"lastUpdatedAt": "2023-11-07T05:31:56Z"
}
],
"tools": [
"<string>"
],
"llmTools": [
{}
],
"sop": {},
"defaultTaskId": "<string>",
"workspaceId": "<string>"
},
"workspaceId": "<string>",
"defaultTaskId": "<string>",
"themeIconUrl": "https://example.com/icons/support-agent.png",
"agentCategoryId": "<string>",
"userAccessTokenId": "<string>",
"agentSetupSessionId": "<string>",
"agentIntroMessage": "<string>",
"agentSetupMessage": "<string>",
"skipAgentSetupSop": true,
"isAttachmentDataPulledIn": true
},
"user": {
"name": "John Doe",
"email": "<string>",
"cognitoUserId": "<string>",
"role_name": "<string>",
"isInternalUser": true,
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"avatarSrc": "https://example.com/avatars/user123.png",
"socialProvider": "<string>",
"socialProviderId": "<string>",
"password": "<string>",
"paymentProviderCustomerId": "<string>",
"rememberToken": "<string>",
"emailVerified": true,
"referralCode": "<string>"
},
"agentTask": {
"agentGraphId": "graph-123e4567-e89b-12d3-a456-426614174000",
"manualRetryCount": 0,
"isSuccess": false,
"isViewed": false,
"canRerunTaskNode": true,
"mode": "AUTO",
"status": "QUEUED",
"taskReceiveAt": 123,
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"customId": "TASK-2024-001",
"originalTaskQuery": "Generate a quarterly sales report for Q4 2024",
"taskObjective": "Analyze sales data and create comprehensive report",
"taskInstructions": "Include revenue breakdown by region and product category",
"taskContext": {},
"taskSuccessCriteria": "Report must include all regions and be formatted as PDF",
"taskQuery": "Generate sales report for Q4 2024 with regional breakdown",
"taskSummary": "Successfully generated Q4 sales report with 15 pages",
"initiationDetail": {},
"triggerRecordId": "msg-abc123",
"startedAt": "2024-01-15T10:00:00Z",
"endedAt": "2024-01-15T10:05:30Z",
"userFeedback": "The report was accurate and well-formatted",
"averageEvaluationScore": 0.85,
"taskState": {
"nodeSelections": [
{
"edgeId": "<string>",
"condition": "<string>",
"selected": true,
"reasoning": "<string>",
"otherEdges": "<array>"
}
]
},
"graphState": {},
"totalExecutionTime": 330.5,
"tokensUsed": 15000,
"totalCost": 0.0225,
"tokenUsages": [
{
"agentTaskId": "<string>",
"agentGraphNodeId": "<string>",
"creditTransactionId": "<string>",
"promptSlug": "<string>",
"iteration": 123,
"model": "<string>",
"inputToken": 123,
"outputToken": 123,
"reasoningToken": 123,
"totalToken": 123,
"isLatest": true,
"agentTask": "<unknown>",
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
},
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"src": "<string>",
"fileKey": "<string>",
"mimeType": "<string>",
"taskId": "<string>",
"agentTaskId": "<string>",
"url": "<string>",
"datasourceConnectionId": "<string>",
"externalFileId": "<string>"
}
],
"agentGraph": {
"id": "<string>",
"agentId": "<string>",
"isActive": true,
"isDraft": true,
"isPublished": true,
"isEdited": true,
"isEverExecuted": true,
"isEverUsedForTemplate": true,
"nodes": [
{
"id": "<string>",
"customId": "<string>",
"objective": "<string>",
"evaluationCriteria": [
"<string>"
],
"isEntryNode": true,
"isExitNode": true,
"isEvaluationEnabled": true,
"autoRetryWhenAccuracyLessThan": 123,
"autoRetryLimitWhenAccuracyIsLow": 123,
"enableAutoRetryWhenAccuracyIsLow": true,
"enableAutoRetryWhenFailure": true,
"autoRetryDescription": null,
"enableAutoRetryDescription": false,
"autoRetryCountWhenFailure": 123,
"autoRetryWaitTimeWhenFailureInMs": 123,
"isAttachmentDataPulledIn": true,
"isEdited": true,
"createdAt": "2023-11-07T05:31:56Z",
"toolConfiguration": {
"id": "<string>",
"toolFunctionName": "<string>",
"toolName": "<string>",
"requiresConsent": true,
"isMemoryTool": true,
"isBackgroundTool": true,
"isBatchExecutionEnabled": true,
"inputParams": [
{
"id": "param-123e4567-e89b-12d3-a456-426614174000",
"paramName": "customerId",
"fillType": "ai_fill",
"agentToolConfigurationId": "config-123e4567-e89b-12d3-a456-426614174000",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"linkOutputParam": {
"id": "param-123e4567-e89b-12d3-a456-426614174000",
"agentToolConfigurationId": "config-123e4567-e89b-12d3-a456-426614174000",
"isArray": false,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"paramName": "customerData",
"position": 1,
"paramDescription": "The customer data retrieved from the database.",
"parentId": "<string>",
"paramPath": "response.data.customer",
"outputExample": "{\"name\": \"John Doe\", \"email\": \"john@example.com\"}",
"dataType": "string",
"typeOptions": {}
},
"linkedOutputParamRules": [
{
"elementKey": "<string>",
"agentToolConfigurationInputParamsId": "<string>",
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"comparisonValue": "<string>"
}
],
"position": 1,
"question": "What is the customer ID?",
"linkParamOutputId": "<string>",
"paramDescription": "The unique identifier for the customer record.",
"paramTip": "Enter the 8-digit customer ID from their account.",
"staticValue": "default_value",
"required": true,
"dataType": "string",
"outputExample": "CUST-12345678",
"reloadProps": false,
"remoteOptions": false,
"options": [
{
"label": "<string>",
"value": "<string>"
}
],
"linkedParamRulePrompt": "<string>",
"ruleConditionConfig": {}
}
],
"outputParams": [
{
"id": "param-123e4567-e89b-12d3-a456-426614174000",
"agentToolConfigurationId": "config-123e4567-e89b-12d3-a456-426614174000",
"isArray": false,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"paramName": "customerData",
"position": 1,
"paramDescription": "The customer data retrieved from the database.",
"parentId": "<string>",
"paramPath": "response.data.customer",
"outputExample": "{\"name\": \"John Doe\", \"email\": \"john@example.com\"}",
"dataType": "string",
"typeOptions": {}
}
],
"iconSrc": "<string>",
"description": "<string>",
"memoryLookupInstruction": "<string>",
"accuracyScore": 123,
"integrationProviderId": "<string>",
"dynamicPropsId": "<string>",
"fallbackModels": "<string>",
"code": "<string>",
"codeLanguage": "<string>",
"originalTool": {
"toolName": "<string>",
"toolFunctionName": "<string>",
"allowWaiting": true,
"iconSrc": "<string>",
"type": "<string>",
"prompt": "<string>",
"description": "<string>",
"preferredModel": "<string>",
"meta": {},
"integrationId": "<string>",
"isIntegrationRequired": true,
"isIntegrationConnected": true,
"integration": {
"systemIntegrationProvider": "<string>",
"systemIntegrationIdentifier": "<string>",
"customAuthParameters": {}
},
"inputParams": [
{
"paramName": "customerId",
"fillType": "ai_fill",
"position": 1,
"question": "What is the customer ID?",
"linkParams": {
"toolId": "<string>",
"toolFunctionName": "<string>",
"outputParam": "<string>",
"outputId": "<string>"
},
"linkParamOutputId": "<string>",
"paramDescription": "The unique identifier for the customer record.",
"paramTip": "Enter the 8-digit customer ID from their account.",
"staticValue": "default_value",
"required": true,
"dataType": "string",
"isArray": false,
"typeOptions": {},
"outputExample": "CUST-12345678",
"reloadProps": false,
"remoteOptions": false,
"options": [
{
"label": "<string>",
"value": "<string>"
}
],
"linkedOutputParamRulesData": {
"linkedParamConfigurations": {},
"rules": [
{
"elementKey": "<string>",
"comparisonValue": "<string>"
}
],
"linkedParamRulePrompt": "<string>"
}
}
],
"outputParams": [
{
"position": 123,
"paramName": "<string>",
"paramDescription": "<string>",
"id": "<string>",
"agentToolConfigurationId": "<string>",
"isArray": true,
"typeOptions": {},
"parentId": "<string>",
"paramPath": "<string>",
"outputExample": "<string>"
}
]
},
"preferredModel": "<string>"
},
"childEdges": [
{
"id": "<string>",
"sourceAgentGraphNodeId": "<string>",
"targetAgentGraphNodeId": "<string>",
"isAttachmentDataPulledIn": true,
"conditionGroups": [
{
"agentGraphEdgeId": "<string>",
"edge": {
"sourceAgentGraphNodeId": "<string>",
"targetAgentGraphNodeId": "<string>",
"isAttachmentDataPulledIn": true,
"conditionGroups": "<array>",
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"condition": "<string>"
},
"rules": [
{
"agentGraphEdgeConditionGroupId": "<string>",
"sourceAgentToolConfigurationOutputParamsId": "<string>",
"group": "<unknown>",
"sourceOutputParam": {
"id": "param-123e4567-e89b-12d3-a456-426614174000",
"agentToolConfigurationId": "config-123e4567-e89b-12d3-a456-426614174000",
"isArray": false,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"paramName": "customerData",
"position": 1,
"paramDescription": "The customer data retrieved from the database.",
"parentId": "<string>",
"paramPath": "response.data.customer",
"outputExample": "{\"name\": \"John Doe\", \"email\": \"john@example.com\"}",
"dataType": "string",
"typeOptions": {}
},
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"comparisonValue": "<string>",
"comparisonAgentToolConfigurationOutputParamsId": "<string>",
"comparisonOutputParam": {
"id": "param-123e4567-e89b-12d3-a456-426614174000",
"agentToolConfigurationId": "config-123e4567-e89b-12d3-a456-426614174000",
"isArray": false,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"paramName": "customerData",
"position": 1,
"paramDescription": "The customer data retrieved from the database.",
"parentId": "<string>",
"paramPath": "response.data.customer",
"outputExample": "{\"name\": \"John Doe\", \"email\": \"john@example.com\"}",
"dataType": "string",
"typeOptions": {}
}
}
],
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"condition": "<string>"
}
],
"parentEdges": [
{
"id": "<string>",
"sourceAgentGraphNodeId": "<string>",
"targetAgentGraphNodeId": "<string>",
"isAttachmentDataPulledIn": true,
"conditionGroups": [
{
"agentGraphEdgeId": "<string>",
"edge": {
"sourceAgentGraphNodeId": "<string>",
"targetAgentGraphNodeId": "<string>",
"isAttachmentDataPulledIn": true,
"conditionGroups": "<array>",
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"condition": "<string>"
},
"rules": [
{
"agentGraphEdgeConditionGroupId": "<string>",
"sourceAgentToolConfigurationOutputParamsId": "<string>",
"group": "<unknown>",
"sourceOutputParam": {
"id": "param-123e4567-e89b-12d3-a456-426614174000",
"agentToolConfigurationId": "config-123e4567-e89b-12d3-a456-426614174000",
"isArray": false,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"paramName": "customerData",
"position": 1,
"paramDescription": "The customer data retrieved from the database.",
"parentId": "<string>",
"paramPath": "response.data.customer",
"outputExample": "{\"name\": \"John Doe\", \"email\": \"john@example.com\"}",
"dataType": "string",
"typeOptions": {}
},
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"comparisonValue": "<string>",
"comparisonAgentToolConfigurationOutputParamsId": "<string>",
"comparisonOutputParam": {
"id": "param-123e4567-e89b-12d3-a456-426614174000",
"agentToolConfigurationId": "config-123e4567-e89b-12d3-a456-426614174000",
"isArray": false,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"paramName": "customerData",
"position": 1,
"paramDescription": "The customer data retrieved from the database.",
"parentId": "<string>",
"paramPath": "response.data.customer",
"outputExample": "{\"name\": \"John Doe\", \"email\": \"john@example.com\"}",
"dataType": "string",
"typeOptions": {}
}
}
],
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"condition": "<string>"
}
],
"xCoordinate": 123,
"yCoordinate": 123,
"nodeConfigurations": {
"llmModel": "<string>",
"fallbackModels": "<string>",
"timeToWaitValue": 123,
"linkedAgentGraphNodeId": "<string>",
"rule": "<string>",
"conditions": [
{
"conditions": [
{
"property": "<string>",
"value": "<string>"
}
]
}
],
"timeoutValue": 123
}
}
],
"agent": {
"id": "<string>",
"name": "<string>",
"creatorId": "<string>",
"order": 123,
"description": "<string>",
"themeIconUrl": "<string>",
"agentCategoryId": "<string>",
"category": {
"id": "<string>",
"title": "<string>"
},
"workspaceId": "<string>"
},
"publishedAt": {}
},
"initiationDetail": {},
"originalTaskQuery": "<string>",
"taskQuery": "<string>",
"taskState": {
"nodeSelections": [
{
"edgeId": "<string>",
"condition": "<string>",
"selected": true,
"reasoning": "<string>",
"otherEdges": "<array>"
}
]
},
"userFeedback": "<string>",
"creditTransactions": [
{
"id": "<string>",
"creditsAmount": 123,
"tokensUsed": 123,
"costAmount": 123,
"usageCategory": "<string>",
"agentGraphNodeId": "<string>",
"toolType": "<string>",
"modelName": "<string>"
}
]
}Agent Task
Rate Task Output
Submit a rating for task execution output to improve agent performance.
PATCH
/
agent-tasks
/
execution
/
{taskId}
/
output-rating
Rate Task Output
curl --request PATCH \
--url https://api.beamstudio.ai/agent-tasks/execution/{taskId}/output-rating \
--header 'Content-Type: application/json' \
--header 'current-workspace-id: <current-workspace-id>' \
--header 'x-api-key: <api-key>' \
--data '
{
"taskNodeId": "<string>",
"userFeedback": "<string>",
"expectedOutput": "<string>"
}
'import requests
url = "https://api.beamstudio.ai/agent-tasks/execution/{taskId}/output-rating"
payload = {
"taskNodeId": "<string>",
"userFeedback": "<string>",
"expectedOutput": "<string>"
}
headers = {
"current-workspace-id": "<current-workspace-id>",
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'current-workspace-id': '<current-workspace-id>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({taskNodeId: '<string>', userFeedback: '<string>', expectedOutput: '<string>'})
};
fetch('https://api.beamstudio.ai/agent-tasks/execution/{taskId}/output-rating', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.beamstudio.ai/agent-tasks/execution/{taskId}/output-rating",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'taskNodeId' => '<string>',
'userFeedback' => '<string>',
'expectedOutput' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"current-workspace-id: <current-workspace-id>",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.beamstudio.ai/agent-tasks/execution/{taskId}/output-rating"
payload := strings.NewReader("{\n \"taskNodeId\": \"<string>\",\n \"userFeedback\": \"<string>\",\n \"expectedOutput\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("current-workspace-id", "<current-workspace-id>")
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.beamstudio.ai/agent-tasks/execution/{taskId}/output-rating")
.header("current-workspace-id", "<current-workspace-id>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"taskNodeId\": \"<string>\",\n \"userFeedback\": \"<string>\",\n \"expectedOutput\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.beamstudio.ai/agent-tasks/execution/{taskId}/output-rating")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["current-workspace-id"] = '<current-workspace-id>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"taskNodeId\": \"<string>\",\n \"userFeedback\": \"<string>\",\n \"expectedOutput\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"agentGraphId": "<string>",
"customId": "<string>",
"tokensUsed": 123,
"totalCost": 123,
"taskSummary": "<string>",
"taskObjective": "<string>",
"graphState": {},
"isViewed": true,
"canRerunTaskNode": true,
"averageEvaluationScore": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"agentTaskNodes": [
{
"id": "<string>",
"agentGraphNodeId": "<string>",
"retriedCountWhenFailure": 123,
"retriedCountWhenAccuracyIsLow": 123,
"manualRetryCount": 123,
"isEverConsentRequired": true,
"agentGraphNode": {
"id": "<string>",
"customId": "<string>",
"objective": "<string>",
"evaluationCriteria": [
"<string>"
],
"isEntryNode": true,
"isExitNode": true,
"isEvaluationEnabled": true,
"autoRetryWhenAccuracyLessThan": 123,
"autoRetryLimitWhenAccuracyIsLow": 123,
"enableAutoRetryWhenAccuracyIsLow": true,
"enableAutoRetryWhenFailure": true,
"autoRetryDescription": null,
"enableAutoRetryDescription": false,
"autoRetryCountWhenFailure": 123,
"autoRetryWaitTimeWhenFailureInMs": 123,
"isAttachmentDataPulledIn": true,
"isEdited": true,
"createdAt": "2023-11-07T05:31:56Z",
"toolConfiguration": {
"id": "<string>",
"toolFunctionName": "<string>",
"toolName": "<string>",
"requiresConsent": true,
"isMemoryTool": true,
"isBackgroundTool": true,
"isBatchExecutionEnabled": true,
"inputParams": [
{
"id": "param-123e4567-e89b-12d3-a456-426614174000",
"paramName": "customerId",
"fillType": "ai_fill",
"agentToolConfigurationId": "config-123e4567-e89b-12d3-a456-426614174000",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"linkOutputParam": {
"id": "param-123e4567-e89b-12d3-a456-426614174000",
"agentToolConfigurationId": "config-123e4567-e89b-12d3-a456-426614174000",
"isArray": false,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"paramName": "customerData",
"position": 1,
"paramDescription": "The customer data retrieved from the database.",
"parentId": "<string>",
"paramPath": "response.data.customer",
"outputExample": "{\"name\": \"John Doe\", \"email\": \"john@example.com\"}",
"dataType": "string",
"typeOptions": {}
},
"linkedOutputParamRules": [
{
"elementKey": "<string>",
"agentToolConfigurationInputParamsId": "<string>",
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"comparisonValue": "<string>"
}
],
"position": 1,
"question": "What is the customer ID?",
"linkParamOutputId": "<string>",
"paramDescription": "The unique identifier for the customer record.",
"paramTip": "Enter the 8-digit customer ID from their account.",
"staticValue": "default_value",
"required": true,
"dataType": "string",
"outputExample": "CUST-12345678",
"reloadProps": false,
"remoteOptions": false,
"options": [
{
"label": "<string>",
"value": "<string>"
}
],
"linkedParamRulePrompt": "<string>",
"ruleConditionConfig": {}
}
],
"outputParams": [
{
"id": "param-123e4567-e89b-12d3-a456-426614174000",
"agentToolConfigurationId": "config-123e4567-e89b-12d3-a456-426614174000",
"isArray": false,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"paramName": "customerData",
"position": 1,
"paramDescription": "The customer data retrieved from the database.",
"parentId": "<string>",
"paramPath": "response.data.customer",
"outputExample": "{\"name\": \"John Doe\", \"email\": \"john@example.com\"}",
"dataType": "string",
"typeOptions": {}
}
],
"iconSrc": "<string>",
"description": "<string>",
"memoryLookupInstruction": "<string>",
"accuracyScore": 123,
"integrationProviderId": "<string>",
"dynamicPropsId": "<string>",
"fallbackModels": "<string>",
"code": "<string>",
"codeLanguage": "<string>",
"originalTool": {
"toolName": "<string>",
"toolFunctionName": "<string>",
"allowWaiting": true,
"iconSrc": "<string>",
"type": "<string>",
"prompt": "<string>",
"description": "<string>",
"preferredModel": "<string>",
"meta": {},
"integrationId": "<string>",
"isIntegrationRequired": true,
"isIntegrationConnected": true,
"integration": {
"systemIntegrationProvider": "<string>",
"systemIntegrationIdentifier": "<string>",
"customAuthParameters": {}
},
"inputParams": [
{
"paramName": "customerId",
"fillType": "ai_fill",
"position": 1,
"question": "What is the customer ID?",
"linkParams": {
"toolId": "<string>",
"toolFunctionName": "<string>",
"outputParam": "<string>",
"outputId": "<string>"
},
"linkParamOutputId": "<string>",
"paramDescription": "The unique identifier for the customer record.",
"paramTip": "Enter the 8-digit customer ID from their account.",
"staticValue": "default_value",
"required": true,
"dataType": "string",
"isArray": false,
"typeOptions": {},
"outputExample": "CUST-12345678",
"reloadProps": false,
"remoteOptions": false,
"options": [
{
"label": "<string>",
"value": "<string>"
}
],
"linkedOutputParamRulesData": {
"linkedParamConfigurations": {},
"rules": [
{
"elementKey": "<string>",
"comparisonValue": "<string>"
}
],
"linkedParamRulePrompt": "<string>"
}
}
],
"outputParams": [
{
"position": 123,
"paramName": "<string>",
"paramDescription": "<string>",
"id": "<string>",
"agentToolConfigurationId": "<string>",
"isArray": true,
"typeOptions": {},
"parentId": "<string>",
"paramPath": "<string>",
"outputExample": "<string>"
}
]
},
"preferredModel": "<string>"
},
"childEdges": [
{
"id": "<string>",
"sourceAgentGraphNodeId": "<string>",
"targetAgentGraphNodeId": "<string>",
"isAttachmentDataPulledIn": true,
"conditionGroups": [
{
"agentGraphEdgeId": "<string>",
"edge": {
"sourceAgentGraphNodeId": "<string>",
"targetAgentGraphNodeId": "<string>",
"isAttachmentDataPulledIn": true,
"conditionGroups": "<array>",
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"condition": "<string>"
},
"rules": [
{
"agentGraphEdgeConditionGroupId": "<string>",
"sourceAgentToolConfigurationOutputParamsId": "<string>",
"group": "<unknown>",
"sourceOutputParam": {
"id": "param-123e4567-e89b-12d3-a456-426614174000",
"agentToolConfigurationId": "config-123e4567-e89b-12d3-a456-426614174000",
"isArray": false,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"paramName": "customerData",
"position": 1,
"paramDescription": "The customer data retrieved from the database.",
"parentId": "<string>",
"paramPath": "response.data.customer",
"outputExample": "{\"name\": \"John Doe\", \"email\": \"john@example.com\"}",
"dataType": "string",
"typeOptions": {}
},
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"comparisonValue": "<string>",
"comparisonAgentToolConfigurationOutputParamsId": "<string>",
"comparisonOutputParam": {
"id": "param-123e4567-e89b-12d3-a456-426614174000",
"agentToolConfigurationId": "config-123e4567-e89b-12d3-a456-426614174000",
"isArray": false,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"paramName": "customerData",
"position": 1,
"paramDescription": "The customer data retrieved from the database.",
"parentId": "<string>",
"paramPath": "response.data.customer",
"outputExample": "{\"name\": \"John Doe\", \"email\": \"john@example.com\"}",
"dataType": "string",
"typeOptions": {}
}
}
],
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"condition": "<string>"
}
],
"parentEdges": [
{
"id": "<string>",
"sourceAgentGraphNodeId": "<string>",
"targetAgentGraphNodeId": "<string>",
"isAttachmentDataPulledIn": true,
"conditionGroups": [
{
"agentGraphEdgeId": "<string>",
"edge": {
"sourceAgentGraphNodeId": "<string>",
"targetAgentGraphNodeId": "<string>",
"isAttachmentDataPulledIn": true,
"conditionGroups": "<array>",
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"condition": "<string>"
},
"rules": [
{
"agentGraphEdgeConditionGroupId": "<string>",
"sourceAgentToolConfigurationOutputParamsId": "<string>",
"group": "<unknown>",
"sourceOutputParam": {
"id": "param-123e4567-e89b-12d3-a456-426614174000",
"agentToolConfigurationId": "config-123e4567-e89b-12d3-a456-426614174000",
"isArray": false,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"paramName": "customerData",
"position": 1,
"paramDescription": "The customer data retrieved from the database.",
"parentId": "<string>",
"paramPath": "response.data.customer",
"outputExample": "{\"name\": \"John Doe\", \"email\": \"john@example.com\"}",
"dataType": "string",
"typeOptions": {}
},
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"comparisonValue": "<string>",
"comparisonAgentToolConfigurationOutputParamsId": "<string>",
"comparisonOutputParam": {
"id": "param-123e4567-e89b-12d3-a456-426614174000",
"agentToolConfigurationId": "config-123e4567-e89b-12d3-a456-426614174000",
"isArray": false,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"paramName": "customerData",
"position": 1,
"paramDescription": "The customer data retrieved from the database.",
"parentId": "<string>",
"paramPath": "response.data.customer",
"outputExample": "{\"name\": \"John Doe\", \"email\": \"john@example.com\"}",
"dataType": "string",
"typeOptions": {}
}
}
],
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"condition": "<string>"
}
],
"xCoordinate": 123,
"yCoordinate": 123,
"nodeConfigurations": {
"llmModel": "<string>",
"fallbackModels": "<string>",
"timeToWaitValue": 123,
"linkedAgentGraphNodeId": "<string>",
"rule": "<string>",
"conditions": [
{
"conditions": [
{
"property": "<string>",
"value": "<string>"
}
]
}
],
"timeoutValue": 123
}
},
"edgeEvaluations": [
{
"target_node_id": "<string>",
"eval_criteria": "<string>",
"branch_name": "<string>",
"reason": "<string>",
"selected": true
}
],
"nodeEvaluation": [
"<array>"
],
"userFeedback": "<string>",
"evaluationScore": 123,
"userQuestions": [
{
"question": "<string>",
"answer": "<string>",
"parameter": "<string>",
"memoryAnswer": true,
"foodForThought": [
{
"question": "<string>",
"answer": "<string>"
}
]
}
],
"output": {
"value": {}
},
"input": [
{
"id": "<string>",
"name": "<string>",
"value": "<string>",
"question": "<string>",
"reasoning": "<string>",
"found": true,
"required": true,
"answer": "<string>"
}
],
"toolData": {
"tool_id": "<string>",
"tool_parameters": [
{}
],
"tool_output": [
{}
],
"required_parameters": {},
"optional_parameters": {},
"reasoning": {},
"filled_prompt": "<string>",
"skip_param_extraction": [
"<string>"
],
"integration_identifier": "<string>",
"integration_error": false
}
}
],
"contextFiles": [
{
"name": "<string>",
"userId": "<string>",
"isForAgentDatabase": true,
"agentId": "<string>",
"agent": {
"id": "agent-123e4567-e89b-12d3-a456-426614174000",
"name": "Customer Support Agent",
"creatorId": "<string>",
"vectorDbId": "<string>",
"creditUsage": 12.5,
"order": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"settings": {
"prompts": [
"You are a helpful customer support agent.",
"Always be polite and professional."
],
"preferredModel": "gpt-4",
"instructions": "Focus on providing concise answers."
},
"config": {
"restrictions": "<string>",
"taskTemplates": [
{
"id": "<string>",
"objective": "<string>",
"description": "<string>",
"steps": [
{
"step": "<string>",
"toolId": "<string>",
"iconSrc": "<string>",
"iconUrl": "<string>",
"beamTool": true,
"gptTool": true,
"consentRequired": true,
"integrationId": "<string>",
"isIntegrationRequired": true,
"isIntegrationConnected": true,
"integrationProvider": "<string>",
"integrationIdentifier": "<string>",
"toolDetail": {},
"integrationCustomAuthParameters": {}
}
],
"default": true,
"category": {
"id": "<string>",
"title": "<string>"
},
"lastUpdatedAt": "2023-11-07T05:31:56Z"
}
],
"tools": [
"<string>"
],
"llmTools": [
{}
],
"sop": {},
"defaultTaskId": "<string>",
"workspaceId": "<string>"
},
"workspaceId": "<string>",
"defaultTaskId": "<string>",
"themeIconUrl": "https://example.com/icons/support-agent.png",
"agentCategoryId": "<string>",
"userAccessTokenId": "<string>",
"agentSetupSessionId": "<string>",
"agentIntroMessage": "<string>",
"agentSetupMessage": "<string>",
"skipAgentSetupSop": true,
"isAttachmentDataPulledIn": true
},
"user": {
"name": "John Doe",
"email": "<string>",
"cognitoUserId": "<string>",
"role_name": "<string>",
"isInternalUser": true,
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"avatarSrc": "https://example.com/avatars/user123.png",
"socialProvider": "<string>",
"socialProviderId": "<string>",
"password": "<string>",
"paymentProviderCustomerId": "<string>",
"rememberToken": "<string>",
"emailVerified": true,
"referralCode": "<string>"
},
"agentTask": {
"agentGraphId": "graph-123e4567-e89b-12d3-a456-426614174000",
"manualRetryCount": 0,
"isSuccess": false,
"isViewed": false,
"canRerunTaskNode": true,
"mode": "AUTO",
"status": "QUEUED",
"taskReceiveAt": 123,
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"customId": "TASK-2024-001",
"originalTaskQuery": "Generate a quarterly sales report for Q4 2024",
"taskObjective": "Analyze sales data and create comprehensive report",
"taskInstructions": "Include revenue breakdown by region and product category",
"taskContext": {},
"taskSuccessCriteria": "Report must include all regions and be formatted as PDF",
"taskQuery": "Generate sales report for Q4 2024 with regional breakdown",
"taskSummary": "Successfully generated Q4 sales report with 15 pages",
"initiationDetail": {},
"triggerRecordId": "msg-abc123",
"startedAt": "2024-01-15T10:00:00Z",
"endedAt": "2024-01-15T10:05:30Z",
"userFeedback": "The report was accurate and well-formatted",
"averageEvaluationScore": 0.85,
"taskState": {
"nodeSelections": [
{
"edgeId": "<string>",
"condition": "<string>",
"selected": true,
"reasoning": "<string>",
"otherEdges": "<array>"
}
]
},
"graphState": {},
"totalExecutionTime": 330.5,
"tokensUsed": 15000,
"totalCost": 0.0225,
"tokenUsages": [
{
"agentTaskId": "<string>",
"agentGraphNodeId": "<string>",
"creditTransactionId": "<string>",
"promptSlug": "<string>",
"iteration": 123,
"model": "<string>",
"inputToken": 123,
"outputToken": 123,
"reasoningToken": 123,
"totalToken": 123,
"isLatest": true,
"agentTask": "<unknown>",
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
},
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"src": "<string>",
"fileKey": "<string>",
"mimeType": "<string>",
"taskId": "<string>",
"agentTaskId": "<string>",
"url": "<string>",
"datasourceConnectionId": "<string>",
"externalFileId": "<string>"
}
],
"agentGraph": {
"id": "<string>",
"agentId": "<string>",
"isActive": true,
"isDraft": true,
"isPublished": true,
"isEdited": true,
"isEverExecuted": true,
"isEverUsedForTemplate": true,
"nodes": [
{
"id": "<string>",
"customId": "<string>",
"objective": "<string>",
"evaluationCriteria": [
"<string>"
],
"isEntryNode": true,
"isExitNode": true,
"isEvaluationEnabled": true,
"autoRetryWhenAccuracyLessThan": 123,
"autoRetryLimitWhenAccuracyIsLow": 123,
"enableAutoRetryWhenAccuracyIsLow": true,
"enableAutoRetryWhenFailure": true,
"autoRetryDescription": null,
"enableAutoRetryDescription": false,
"autoRetryCountWhenFailure": 123,
"autoRetryWaitTimeWhenFailureInMs": 123,
"isAttachmentDataPulledIn": true,
"isEdited": true,
"createdAt": "2023-11-07T05:31:56Z",
"toolConfiguration": {
"id": "<string>",
"toolFunctionName": "<string>",
"toolName": "<string>",
"requiresConsent": true,
"isMemoryTool": true,
"isBackgroundTool": true,
"isBatchExecutionEnabled": true,
"inputParams": [
{
"id": "param-123e4567-e89b-12d3-a456-426614174000",
"paramName": "customerId",
"fillType": "ai_fill",
"agentToolConfigurationId": "config-123e4567-e89b-12d3-a456-426614174000",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"linkOutputParam": {
"id": "param-123e4567-e89b-12d3-a456-426614174000",
"agentToolConfigurationId": "config-123e4567-e89b-12d3-a456-426614174000",
"isArray": false,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"paramName": "customerData",
"position": 1,
"paramDescription": "The customer data retrieved from the database.",
"parentId": "<string>",
"paramPath": "response.data.customer",
"outputExample": "{\"name\": \"John Doe\", \"email\": \"john@example.com\"}",
"dataType": "string",
"typeOptions": {}
},
"linkedOutputParamRules": [
{
"elementKey": "<string>",
"agentToolConfigurationInputParamsId": "<string>",
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"comparisonValue": "<string>"
}
],
"position": 1,
"question": "What is the customer ID?",
"linkParamOutputId": "<string>",
"paramDescription": "The unique identifier for the customer record.",
"paramTip": "Enter the 8-digit customer ID from their account.",
"staticValue": "default_value",
"required": true,
"dataType": "string",
"outputExample": "CUST-12345678",
"reloadProps": false,
"remoteOptions": false,
"options": [
{
"label": "<string>",
"value": "<string>"
}
],
"linkedParamRulePrompt": "<string>",
"ruleConditionConfig": {}
}
],
"outputParams": [
{
"id": "param-123e4567-e89b-12d3-a456-426614174000",
"agentToolConfigurationId": "config-123e4567-e89b-12d3-a456-426614174000",
"isArray": false,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"paramName": "customerData",
"position": 1,
"paramDescription": "The customer data retrieved from the database.",
"parentId": "<string>",
"paramPath": "response.data.customer",
"outputExample": "{\"name\": \"John Doe\", \"email\": \"john@example.com\"}",
"dataType": "string",
"typeOptions": {}
}
],
"iconSrc": "<string>",
"description": "<string>",
"memoryLookupInstruction": "<string>",
"accuracyScore": 123,
"integrationProviderId": "<string>",
"dynamicPropsId": "<string>",
"fallbackModels": "<string>",
"code": "<string>",
"codeLanguage": "<string>",
"originalTool": {
"toolName": "<string>",
"toolFunctionName": "<string>",
"allowWaiting": true,
"iconSrc": "<string>",
"type": "<string>",
"prompt": "<string>",
"description": "<string>",
"preferredModel": "<string>",
"meta": {},
"integrationId": "<string>",
"isIntegrationRequired": true,
"isIntegrationConnected": true,
"integration": {
"systemIntegrationProvider": "<string>",
"systemIntegrationIdentifier": "<string>",
"customAuthParameters": {}
},
"inputParams": [
{
"paramName": "customerId",
"fillType": "ai_fill",
"position": 1,
"question": "What is the customer ID?",
"linkParams": {
"toolId": "<string>",
"toolFunctionName": "<string>",
"outputParam": "<string>",
"outputId": "<string>"
},
"linkParamOutputId": "<string>",
"paramDescription": "The unique identifier for the customer record.",
"paramTip": "Enter the 8-digit customer ID from their account.",
"staticValue": "default_value",
"required": true,
"dataType": "string",
"isArray": false,
"typeOptions": {},
"outputExample": "CUST-12345678",
"reloadProps": false,
"remoteOptions": false,
"options": [
{
"label": "<string>",
"value": "<string>"
}
],
"linkedOutputParamRulesData": {
"linkedParamConfigurations": {},
"rules": [
{
"elementKey": "<string>",
"comparisonValue": "<string>"
}
],
"linkedParamRulePrompt": "<string>"
}
}
],
"outputParams": [
{
"position": 123,
"paramName": "<string>",
"paramDescription": "<string>",
"id": "<string>",
"agentToolConfigurationId": "<string>",
"isArray": true,
"typeOptions": {},
"parentId": "<string>",
"paramPath": "<string>",
"outputExample": "<string>"
}
]
},
"preferredModel": "<string>"
},
"childEdges": [
{
"id": "<string>",
"sourceAgentGraphNodeId": "<string>",
"targetAgentGraphNodeId": "<string>",
"isAttachmentDataPulledIn": true,
"conditionGroups": [
{
"agentGraphEdgeId": "<string>",
"edge": {
"sourceAgentGraphNodeId": "<string>",
"targetAgentGraphNodeId": "<string>",
"isAttachmentDataPulledIn": true,
"conditionGroups": "<array>",
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"condition": "<string>"
},
"rules": [
{
"agentGraphEdgeConditionGroupId": "<string>",
"sourceAgentToolConfigurationOutputParamsId": "<string>",
"group": "<unknown>",
"sourceOutputParam": {
"id": "param-123e4567-e89b-12d3-a456-426614174000",
"agentToolConfigurationId": "config-123e4567-e89b-12d3-a456-426614174000",
"isArray": false,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"paramName": "customerData",
"position": 1,
"paramDescription": "The customer data retrieved from the database.",
"parentId": "<string>",
"paramPath": "response.data.customer",
"outputExample": "{\"name\": \"John Doe\", \"email\": \"john@example.com\"}",
"dataType": "string",
"typeOptions": {}
},
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"comparisonValue": "<string>",
"comparisonAgentToolConfigurationOutputParamsId": "<string>",
"comparisonOutputParam": {
"id": "param-123e4567-e89b-12d3-a456-426614174000",
"agentToolConfigurationId": "config-123e4567-e89b-12d3-a456-426614174000",
"isArray": false,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"paramName": "customerData",
"position": 1,
"paramDescription": "The customer data retrieved from the database.",
"parentId": "<string>",
"paramPath": "response.data.customer",
"outputExample": "{\"name\": \"John Doe\", \"email\": \"john@example.com\"}",
"dataType": "string",
"typeOptions": {}
}
}
],
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"condition": "<string>"
}
],
"parentEdges": [
{
"id": "<string>",
"sourceAgentGraphNodeId": "<string>",
"targetAgentGraphNodeId": "<string>",
"isAttachmentDataPulledIn": true,
"conditionGroups": [
{
"agentGraphEdgeId": "<string>",
"edge": {
"sourceAgentGraphNodeId": "<string>",
"targetAgentGraphNodeId": "<string>",
"isAttachmentDataPulledIn": true,
"conditionGroups": "<array>",
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"condition": "<string>"
},
"rules": [
{
"agentGraphEdgeConditionGroupId": "<string>",
"sourceAgentToolConfigurationOutputParamsId": "<string>",
"group": "<unknown>",
"sourceOutputParam": {
"id": "param-123e4567-e89b-12d3-a456-426614174000",
"agentToolConfigurationId": "config-123e4567-e89b-12d3-a456-426614174000",
"isArray": false,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"paramName": "customerData",
"position": 1,
"paramDescription": "The customer data retrieved from the database.",
"parentId": "<string>",
"paramPath": "response.data.customer",
"outputExample": "{\"name\": \"John Doe\", \"email\": \"john@example.com\"}",
"dataType": "string",
"typeOptions": {}
},
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"comparisonValue": "<string>",
"comparisonAgentToolConfigurationOutputParamsId": "<string>",
"comparisonOutputParam": {
"id": "param-123e4567-e89b-12d3-a456-426614174000",
"agentToolConfigurationId": "config-123e4567-e89b-12d3-a456-426614174000",
"isArray": false,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"paramName": "customerData",
"position": 1,
"paramDescription": "The customer data retrieved from the database.",
"parentId": "<string>",
"paramPath": "response.data.customer",
"outputExample": "{\"name\": \"John Doe\", \"email\": \"john@example.com\"}",
"dataType": "string",
"typeOptions": {}
}
}
],
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"condition": "<string>"
}
],
"xCoordinate": 123,
"yCoordinate": 123,
"nodeConfigurations": {
"llmModel": "<string>",
"fallbackModels": "<string>",
"timeToWaitValue": 123,
"linkedAgentGraphNodeId": "<string>",
"rule": "<string>",
"conditions": [
{
"conditions": [
{
"property": "<string>",
"value": "<string>"
}
]
}
],
"timeoutValue": 123
}
}
],
"agent": {
"id": "<string>",
"name": "<string>",
"creatorId": "<string>",
"order": 123,
"description": "<string>",
"themeIconUrl": "<string>",
"agentCategoryId": "<string>",
"category": {
"id": "<string>",
"title": "<string>"
},
"workspaceId": "<string>"
},
"publishedAt": {}
},
"initiationDetail": {},
"originalTaskQuery": "<string>",
"taskQuery": "<string>",
"taskState": {
"nodeSelections": [
{
"edgeId": "<string>",
"condition": "<string>",
"selected": true,
"reasoning": "<string>",
"otherEdges": "<array>"
}
]
},
"userFeedback": "<string>",
"creditTransactions": [
{
"id": "<string>",
"creditsAmount": 123,
"tokensUsed": 123,
"costAmount": 123,
"usageCategory": "<string>",
"agentGraphNodeId": "<string>",
"toolType": "<string>",
"modelName": "<string>"
}
]
}Authorizations
Headers
Path Parameters
Body
application/json
Response
200 - application/json
Rating submitted successfully
Available options:
QUEUED, IN_PROGRESS, COMPLETED, FAILED, USER_INPUT_REQUIRED, USER_CONSENT_REQUIRED, STOPPED, AUTHENTICATION_REQUIRED, INSUFFICIENT_CREDITS, WAITING Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
positive, negative Show child attributes
Show child attributes
⌘I