Skip to main content

Understand Agent Fields and Validation Rules

Here's a table summarizing the main fields for each agent:

Agent Fields

FieldTypeDescriptionRequiredExample
agent_namestringUnique name for the agentYes"example_agent"
LLM_configarrayConfiguration of the LLM(s) used by the agentYesSee LLM Configurations
RolestringRole of the agent (normal or supervisor)No"supervisor"
agent_functionstringList of functions the agent performsYes"Your goal is to send a request to the API endpoint with the given parameters. Make sure you check the parameters before sending the request. Parameters are: "param1": "value1", "param2": "value2"
incoming_edgearrayList of agents or Start connected to this agentYes["Start"]
outgoing_edgearrayList of agents connected from this agentYes["agent-2"]
toolsobjectTools assigned to the agentNoSee Tool Configuration

LLM Configurations

Each entry in LLM_config includes:

FieldTypeDescriptionRequiredExample
providerstringLLM provider (ChatOpenAI, ChatNvidia)No - Only for Enterprise (BYOAI)"ChatOpenAI"
paramsobjectProvider-specific parametersYesSee below

BYOAI (Bring Your Own AI) is only available for Enterprise users.

Parameters:

FieldTypeAllowed ValuesRequiredExample
modelstring"gpt-5", "gpt-5-mini"Yes"gpt-5-mini"
max_tokensintegerMinimum: 1No500
request_timeoutintegerMinimum: 1No30

Validation Rules

  • Top-Level Key: Must only contain create_vertical_agent_network.
  • Agent Names: Each agent's agent_name must be unique.
  • Edges:
    • incoming_edge can contain Start (only once across all agents).
    • outgoing_edge must not contain Start.
    • Edges must reference valid agent names.
  • Supervisor Limitations:
    • supervisor agents can only connect to agents defined earlier in the YAML file.
  • LLMs:
    • Ensure and params matches the allowed models.
  • Start Node:
    • Exactly one agent must have Start in its incoming_edge.