Skip to main content
GET
/
agent-setup
/
session
/
{agentId}
Get agent setup session
curl --request GET \
  --url https://api.beamstudio.ai/agent-setup/session/{agentId} \
  --header 'x-api-key: <api-key>'
{
  "agentIntroMessage": "<string>",
  "processInstructions": "<string>",
  "agentSop": "<string>",
  "status": "<string>",
  "step": "<string>",
  "generatedGraph": {
    "preliminaryReasoning": "<string>",
    "graphDescription": "<string>",
    "trigger": "<string>",
    "graphSummary": "<string>",
    "mermaidGraph": "<string>",
    "graphNodes": [
      {
        "isEntryNode": true,
        "id": "<string>",
        "expertReasoning": "<string>",
        "objective": "<string>",
        "toolCategory": "<string>",
        "edgeReasoning": "<string>",
        "evaluationCriteria": [
          "<string>"
        ],
        "xCoordinate": 123,
        "yCoordinate": 123,
        "childEdges": [
          {
            "id": "<string>",
            "targetAgentGraphNodeId": "<string>",
            "sourceAgentGraphNodeId": "<string>",
            "name": "<string>",
            "condition": "<string>"
          }
        ],
        "parentEdges": [
          {
            "id": "<string>",
            "targetAgentGraphNodeId": "<string>",
            "sourceAgentGraphNodeId": "<string>",
            "name": "<string>",
            "condition": "<string>"
          }
        ],
        "toolConfiguration": {
          "toolFunctionName": "<string>",
          "actionType": "<string>",
          "inputParams": [
            {
              "paramName": "<string>",
              "dataType": "<string>",
              "paramDescription": "<string>",
              "fillType": "ai_fill",
              "id": "<string>",
              "staticValue": "<string>",
              "question": "<string>",
              "reloadProps": true,
              "options": [
                {
                  "label": "<string>",
                  "value": "<string>"
                }
              ]
            }
          ],
          "outputParams": [
            {
              "paramName": "<string>",
              "dataType": "<string>",
              "paramDescription": "<string>",
              "id": "<string>",
              "position": 123,
              "agentToolConfigurationId": "<string>",
              "outputExample": "<string>",
              "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": "<string>",
                "fillType": "ai_fill",
                "position": 123,
                "question": "<string>",
                "linkParams": {
                  "toolId": "<string>",
                  "toolFunctionName": "<string>",
                  "outputParam": "<string>",
                  "outputId": "<string>"
                },
                "linkParamOutputId": "<string>",
                "paramDescription": "<string>",
                "staticValue": "<string>",
                "required": true,
                "dataType": "string",
                "isArray": false,
                "typeOptions": {},
                "outputExample": "<string>",
                "reloadProps": true,
                "options": [
                  {
                    "label": "<string>",
                    "value": "<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,
          "isMemoryTool": true,
          "memoryLookupInstruction": "<string>",
          "isBatchExecutionEnabled": true,
          "isBackgroundTool": true,
          "requiresConsent": true,
          "isCodeExecutionEnabled": true,
          "consentRequired": true,
          "integrationProviderId": "<string>",
          "dynamicPropsId": "<string>"
        },
        "isExitNode": true
      }
    ]
  }
}

Authorizations

x-api-key
string
header
required

Path Parameters

agentId
string<uuid>
required

UUID of the agent to retrieve the session for

Response

Agent setup session retrieved successfully.

agentIntroMessage
string
required
processInstructions
string
required
agentSop
string
required
status
string
required
step
string
required
generatedGraph
object