Skip to content

agui_agents

Class info

Classes

Name Children Inherits
AGUIAgentConfig
llmling_agent.models.agui_agents
Configuration for AG-UI protocol agents.
    • NodeConfig
    NodeConfig
    llmling_agent_config.nodes
    Configuration for a Node of the messaging system.

    🛈 DocStrings

    Configuration models for AG-UI agents.

    AGUIAgentConfig

    Bases: NodeConfig

    Configuration for AG-UI protocol agents.

    AG-UI agents connect to remote HTTP endpoints that implement the AG-UI protocol, enabling integration of any AG-UI compatible server into the llmling-agent pool.

    Example 
    agui_agents:
  remote_assistant:
    endpoint: http://localhost:8000/agent/run
    timeout: 30.0
    headers:
      X-API-Key: ${API_KEY}

  managed_agent:
    endpoint: http://localhost:8765/agent/run
    startup_command: "uv run ag-ui-server config.yml"
    startup_delay: 3.0
    Source code in src/llmling_agent/models/agui_agents.py 
    10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
    class AGUIAgentConfig(NodeConfig):
    """Configuration for AG-UI protocol agents.

    AG-UI agents connect to remote HTTP endpoints that implement the AG-UI protocol,
    enabling integration of any AG-UI compatible server into the llmling-agent pool.

    Example:
        ```yaml
        agui_agents:
          remote_assistant:
            endpoint: http://localhost:8000/agent/run
            timeout: 30.0
            headers:
              X-API-Key: ${API_KEY}

          managed_agent:
            endpoint: http://localhost:8765/agent/run
            startup_command: "uv run ag-ui-server config.yml"
            startup_delay: 3.0
        ```
    """

    model_config = ConfigDict(
        json_schema_extra={"x-icon": "mdi:api", "x-doc-title": "AG-UI Agent Configuration"}
    )

    endpoint: str = Field(
        ...,
        examples=["http://localhost:8000/agent/run", "https://api.example.com/v1/agent/run"],
    )
    """HTTP endpoint for the AG-UI agent server."""

    timeout: float = Field(default=60.0, ge=0.1, examples=[30.0, 60.0, 120.0])
    """Request timeout in seconds."""

    headers: dict[str, str] = Field(default_factory=dict)
    """Additional HTTP headers to send with requests.

    Useful for authentication or custom routing.
    Environment variables can be used: ${VAR_NAME}
    """

    startup_command: str | None = Field(
        default=None,
        examples=[
            "uv run ag-ui-server config.yml",
            "python -m my_agui_server --port 8000",
        ],
    )
    """Optional shell command to start the AG-UI server automatically.

    When provided, the agent will spawn this command on context entry
    and terminate it on exit. Useful for testing or self-contained deployments.
    """

    startup_delay: float = Field(default=2.0, ge=0.0, examples=[1.0, 2.0, 5.0])
    """Seconds to wait after starting server before connecting.

    Only relevant when startup_command is provided.
    """

    endpoint class-attribute instance-attribute 

    endpoint: str = Field(
    ..., examples=["http://localhost:8000/agent/run", "https://api.example.com/v1/agent/run"]
)

    HTTP endpoint for the AG-UI agent server.

    headers class-attribute instance-attribute 

    headers: dict[str, str] = Field(default_factory=dict)

    Additional HTTP headers to send with requests.

    Useful for authentication or custom routing. Environment variables can be used: ${VAR_NAME}

    startup_command class-attribute instance-attribute 

    startup_command: str | None = Field(
    default=None,
    examples=["uv run ag-ui-server config.yml", "python -m my_agui_server --port 8000"],
)

    Optional shell command to start the AG-UI server automatically.

    When provided, the agent will spawn this command on context entry and terminate it on exit. Useful for testing or self-contained deployments.

    startup_delay class-attribute instance-attribute 

    startup_delay: float = Field(default=2.0, ge=0.0, examples=[1.0, 2.0, 5.0])

    Seconds to wait after starting server before connecting.

    Only relevant when startup_command is provided.

    timeout class-attribute instance-attribute 

    timeout: float = Field(default=60.0, ge=0.1, examples=[30.0, 60.0, 120.0])

    Request timeout in seconds.