> ## Documentation Index
> Fetch the complete documentation index at: https://praison.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# A GUI • Rust AI Agent SDK

> AGUI: AG-UI Interface for PraisonAI Agents Exposes a PraisonAI Agent via the AG-UI protocol, enabling integration with CopilotKit and other AG-UI...

# AGUI

> Defined in the [**ui**](../modules/ui) module.

<Badge color="orange">Rust AI Agent SDK</Badge>

AG-UI Interface for PraisonAI Agents Exposes a PraisonAI Agent via the AG-UI protocol, enabling integration with CopilotKit and other AG-UI compatible frontends.

## Fields

| Name          | Type                | Description           |
| ------------- | ------------------- | --------------------- |
| `name`        | `String`            | Agent name            |
| `description` | `String`            | Agent description     |
| `prefix`      | `String`            | URL prefix for router |
| `tags`        | `Vec&lt;String&gt;` | OpenAPI tags          |

## Methods

### `new`

```rust theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
fn new(name: impl Into<String>) -> Self
```

Create a new AGUI interface

**Parameters:**

| Name   | Type                      |
| ------ | ------------------------- |
| `name` | `impl Into&lt;String&gt;` |

### `description`

```rust theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
fn description(mut self, description: impl Into<String>) -> Self
```

Set description

**Parameters:**

| Name          | Type                      |
| ------------- | ------------------------- |
| `description` | `impl Into&lt;String&gt;` |

### `prefix`

```rust theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
fn prefix(mut self, prefix: impl Into<String>) -> Self
```

Set URL prefix

**Parameters:**

| Name     | Type                      |
| -------- | ------------------------- |
| `prefix` | `impl Into&lt;String&gt;` |

### `get_status`

```rust theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
fn get_status(&self) -> HashMap<String, String>
```

Get status

## Source

<Card title="View on GitHub" icon="github" href="https://github.com/MervinPraison/PraisonAI/blob/main/src/praisonai-rust/praisonai/src/parity/ui.rs#L331">
  `praisonai/src/parity/ui.rs` at line 331
</Card>

***

## Related Documentation

<CardGroup cols={2}>
  <Card title="Rust AGUI" icon="display" href="/docs/rust/agui" />

  <Card title="Rust Agent UI" icon="display" href="/docs/rust/agent-ui-agui" />
</CardGroup>