curl --request GET \
--url https://api.beamstudio.ai/agent-setup/session/{agentId} \
--header 'x-api-key: <api-key>'{
"agentIntroMessage": "I am a customer support agent designed to help users with their inquiries.",
"processInstructions": "First, I will gather information about your issue. Then, I will provide relevant solutions.",
"agentSop": "Step 1: Greet the user. Step 2: Identify the issue. Step 3: Provide resolution.",
"status": "in_progress",
"step": "GRAPH_GENERATION",
"generatedGraph": {
"preliminaryReasoning": "Based on the SOP, the agent needs to handle user inquiries through a multi-step verification process.",
"graphDescription": "This graph handles customer support requests by routing them through identification, verification, and resolution nodes.",
"trigger": "User sends a message to the agent",
"graphSummary": "A 5-node workflow that processes customer inquiries from intake to resolution.",
"mermaidGraph": "graph TD\n A[Start] --> B[Process]\n B --> C[End]",
"graphNodes": [
{
"isEntryNode": true,
"id": "node-123e4567-e89b-12d3-a456-426614174000",
"expertReasoning": "This node handles initial user authentication before proceeding to data retrieval.",
"objective": "Verify user identity and gather account information.",
"toolCategory": "authentication",
"nodeType": "executionNode",
"edgeReasoning": "Routes to verification node on success, or error handling node on failure.",
"evaluationCriteria": [
"User identity verified",
"Account status is active",
"No security flags detected"
],
"xCoordinate": 250,
"yCoordinate": 100,
"isAttachmentDataPulledIn": true,
"childEdges": [
{
"id": "edge-123e4567-e89b-12d3-a456-426614174000",
"targetAgentGraphNodeId": "node-target-123e4567-e89b-12d3-a456-426614174000",
"sourceAgentGraphNodeId": "node-source-123e4567-e89b-12d3-a456-426614174000",
"name": "On Success",
"condition": "userVerified === true",
"isAttachmentDataPulledIn": true
}
],
"parentEdges": [
{
"id": "edge-123e4567-e89b-12d3-a456-426614174000",
"targetAgentGraphNodeId": "node-target-123e4567-e89b-12d3-a456-426614174000",
"sourceAgentGraphNodeId": "node-source-123e4567-e89b-12d3-a456-426614174000",
"name": "On Success",
"condition": "userVerified === true",
"isAttachmentDataPulledIn": true
}
],
"toolConfiguration": {
"toolFunctionName": "fetchCustomerData",
"actionType": "api_call",
"inputParams": [
{
"paramName": "<string>",
"dataType": "<string>",
"paramDescription": "<string>",
"fillType": "ai_fill",
"id": "<string>",
"paramTip": "<string>",
"staticValue": "<string>",
"question": "<string>",
"reloadProps": true,
"remoteOptions": true,
"options": [
{
"label": "<string>",
"value": "<string>"
}
]
}
],
"outputParams": [
{
"paramName": "customerData",
"dataType": "string",
"paramDescription": "The customer data retrieved from the database including name and contact information.",
"id": "param-123e4567-e89b-12d3-a456-426614174000",
"position": 1,
"agentToolConfigurationId": "config-123e4567-e89b-12d3-a456-426614174000",
"outputExample": "{\"name\": \"John Doe\", \"email\": \"john@example.com\"}",
"linkParamOutputId": "<string>",
"required": true,
"typeOptions": {},
"isArray": false
}
],
"originalTool": {
"id": "<string>",
"toolFunctionName": "<string>",
"toolName": "<string>",
"iconSrc": "<string>",
"type": "beam_tool",
"prompt": "<string>",
"integrationId": "<string>",
"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": {
"conditionType": "llm_based"
},
"rules": [
{
"elementKey": "<string>",
"operator": "equals",
"comparisonValueType": "static",
"comparisonValue": "<string>",
"nextRuleOperator": "AND"
}
],
"linkedParamRulePrompt": "<string>"
}
}
],
"outputParams": [
{
"position": 123,
"paramName": "<string>",
"paramDescription": "<string>",
"id": "<string>",
"agentToolConfigurationId": "<string>",
"dataType": "string",
"isArray": true,
"typeOptions": {},
"parentId": "<string>",
"paramPath": "<string>",
"outputExample": "<string>"
}
],
"preferredModel": "<string>",
"description": "<string>",
"shortDescription": "<string>",
"isIntegrationConnected": true,
"isIntegrationRequired": true
},
"isIntegrationRequired": true,
"isIntegrationConnected": true,
"fallbackModels": "gpt-3.5-turbo",
"isMemoryTool": false,
"memoryLookupInstruction": "Retrieve customer records matching the provided email address.",
"isBatchExecutionEnabled": false,
"isBackgroundTool": false,
"requiresConsent": false,
"consentRequired": false,
"integrationProviderId": "provider-123e4567-e89b-12d3-a456-426614174000",
"dynamicPropsId": "<string>",
"code": "<string>",
"codeLanguage": "<string>",
"preferredModel": "GPT40"
},
"isExitNode": false,
"nodeConfigurations": {
"conditionType": "llm_based",
"llmModel": "<string>",
"fallbackModels": "<string>"
}
}
]
}
}Retrieves the current setup session state for a specific agent, including configuration and progress.
curl --request GET \
--url https://api.beamstudio.ai/agent-setup/session/{agentId} \
--header 'x-api-key: <api-key>'{
"agentIntroMessage": "I am a customer support agent designed to help users with their inquiries.",
"processInstructions": "First, I will gather information about your issue. Then, I will provide relevant solutions.",
"agentSop": "Step 1: Greet the user. Step 2: Identify the issue. Step 3: Provide resolution.",
"status": "in_progress",
"step": "GRAPH_GENERATION",
"generatedGraph": {
"preliminaryReasoning": "Based on the SOP, the agent needs to handle user inquiries through a multi-step verification process.",
"graphDescription": "This graph handles customer support requests by routing them through identification, verification, and resolution nodes.",
"trigger": "User sends a message to the agent",
"graphSummary": "A 5-node workflow that processes customer inquiries from intake to resolution.",
"mermaidGraph": "graph TD\n A[Start] --> B[Process]\n B --> C[End]",
"graphNodes": [
{
"isEntryNode": true,
"id": "node-123e4567-e89b-12d3-a456-426614174000",
"expertReasoning": "This node handles initial user authentication before proceeding to data retrieval.",
"objective": "Verify user identity and gather account information.",
"toolCategory": "authentication",
"nodeType": "executionNode",
"edgeReasoning": "Routes to verification node on success, or error handling node on failure.",
"evaluationCriteria": [
"User identity verified",
"Account status is active",
"No security flags detected"
],
"xCoordinate": 250,
"yCoordinate": 100,
"isAttachmentDataPulledIn": true,
"childEdges": [
{
"id": "edge-123e4567-e89b-12d3-a456-426614174000",
"targetAgentGraphNodeId": "node-target-123e4567-e89b-12d3-a456-426614174000",
"sourceAgentGraphNodeId": "node-source-123e4567-e89b-12d3-a456-426614174000",
"name": "On Success",
"condition": "userVerified === true",
"isAttachmentDataPulledIn": true
}
],
"parentEdges": [
{
"id": "edge-123e4567-e89b-12d3-a456-426614174000",
"targetAgentGraphNodeId": "node-target-123e4567-e89b-12d3-a456-426614174000",
"sourceAgentGraphNodeId": "node-source-123e4567-e89b-12d3-a456-426614174000",
"name": "On Success",
"condition": "userVerified === true",
"isAttachmentDataPulledIn": true
}
],
"toolConfiguration": {
"toolFunctionName": "fetchCustomerData",
"actionType": "api_call",
"inputParams": [
{
"paramName": "<string>",
"dataType": "<string>",
"paramDescription": "<string>",
"fillType": "ai_fill",
"id": "<string>",
"paramTip": "<string>",
"staticValue": "<string>",
"question": "<string>",
"reloadProps": true,
"remoteOptions": true,
"options": [
{
"label": "<string>",
"value": "<string>"
}
]
}
],
"outputParams": [
{
"paramName": "customerData",
"dataType": "string",
"paramDescription": "The customer data retrieved from the database including name and contact information.",
"id": "param-123e4567-e89b-12d3-a456-426614174000",
"position": 1,
"agentToolConfigurationId": "config-123e4567-e89b-12d3-a456-426614174000",
"outputExample": "{\"name\": \"John Doe\", \"email\": \"john@example.com\"}",
"linkParamOutputId": "<string>",
"required": true,
"typeOptions": {},
"isArray": false
}
],
"originalTool": {
"id": "<string>",
"toolFunctionName": "<string>",
"toolName": "<string>",
"iconSrc": "<string>",
"type": "beam_tool",
"prompt": "<string>",
"integrationId": "<string>",
"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": {
"conditionType": "llm_based"
},
"rules": [
{
"elementKey": "<string>",
"operator": "equals",
"comparisonValueType": "static",
"comparisonValue": "<string>",
"nextRuleOperator": "AND"
}
],
"linkedParamRulePrompt": "<string>"
}
}
],
"outputParams": [
{
"position": 123,
"paramName": "<string>",
"paramDescription": "<string>",
"id": "<string>",
"agentToolConfigurationId": "<string>",
"dataType": "string",
"isArray": true,
"typeOptions": {},
"parentId": "<string>",
"paramPath": "<string>",
"outputExample": "<string>"
}
],
"preferredModel": "<string>",
"description": "<string>",
"shortDescription": "<string>",
"isIntegrationConnected": true,
"isIntegrationRequired": true
},
"isIntegrationRequired": true,
"isIntegrationConnected": true,
"fallbackModels": "gpt-3.5-turbo",
"isMemoryTool": false,
"memoryLookupInstruction": "Retrieve customer records matching the provided email address.",
"isBatchExecutionEnabled": false,
"isBackgroundTool": false,
"requiresConsent": false,
"consentRequired": false,
"integrationProviderId": "provider-123e4567-e89b-12d3-a456-426614174000",
"dynamicPropsId": "<string>",
"code": "<string>",
"codeLanguage": "<string>",
"preferredModel": "GPT40"
},
"isExitNode": false,
"nodeConfigurations": {
"conditionType": "llm_based",
"llmModel": "<string>",
"fallbackModels": "<string>"
}
}
]
}
}UUID of the agent to retrieve the session for
Agent setup session retrieved successfully.
Introduction message describing the agent and its capabilities.
"I am a customer support agent designed to help users with their inquiries."
Instructions outlining the process and workflow the agent follows.
"First, I will gather information about your issue. Then, I will provide relevant solutions."
Standard Operating Procedures (SOP) that define how the agent handles tasks.
"Step 1: Greet the user. Step 2: Identify the issue. Step 3: Provide resolution."
Current status of the agent setup process.
"in_progress"
Current step in the agent setup workflow.
"GRAPH_GENERATION"
Generated workflow graph for the agent, including nodes and their connections.
Show child attributes