> ## 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.

# Agent OS Protocol • AI Agent SDK

> AgentOSProtocol: Protocol for AgentOS implementations.

# AgentOSProtocol

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

<Badge color="blue">AI Agent</Badge>

Protocol for AgentOS implementations.

AgentOS is a production platform for deploying agents as web services.
It wraps agents, teams, and flows into a unified API server.

Implementations should:

* Provide FastAPI-based HTTP endpoints
* Support WebSocket connections for real-time communication
* Handle agent lifecycle management
* Provide health checks and monitoring endpoints

Example implementation (in praisonai wrapper):
class AgentOS:
def **init**(
self,
name: str = "PraisonAI App",
agents: List\[Agent] = None,
teams: List\[AgentTeam] = None,
flows: List\[AgentFlow] = None,
):
...

def serve(self, host: str = "0.0.0.0", port: int = 8000):
'''Start the FastAPI server.'''
...

def get\_app(self):
'''Get the FastAPI app instance for custom mounting.'''
...

```mermaid theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
%%{init: {'theme': 'base', 'themeVariables': { 'primaryColor': '#8B0000', 'primaryTextColor': '#fff', 'primaryBorderColor': '#710101', 'lineColor': '#189AB4', 'secondaryColor': '#189AB4', 'tertiaryColor': '#fff' }}}%%

graph LR
    input["Input Data"] --> agent["Agent: AgentOSProtocol"]
    agent --> output["Output Result"]
    style agent fill:#8B0000,color:#fff
    style input fill:#8B0000,color:#fff
    style output fill:#8B0000,color:#fff
```

## Methods

<CardGroup cols={2}>
  <Card title="serve()" icon="function" href="../functions/AgentOSProtocol-serve">
    Start the AgentApp server.
  </Card>

  <Card title="get_app()" icon="function" href="../functions/AgentOSProtocol-get_app">
    Get the underlying web application instance.
  </Card>
</CardGroup>

## Notes

The protocol was renamed from `AgentAppProtocol` to `AgentOSProtocol` in v1.0.
`AgentAppProtocol` remains as a silent alias for backward compatibility.

## Source

<Card title="View on GitHub" icon="github" href="https://github.com/MervinPraison/PraisonAI/blob/main/src/praisonai-agents/praisonaiagents/app/protocols.py#L21">
  `praisonaiagents/app/protocols.py` at line 21
</Card>

***

## Related Documentation

<CardGroup cols={2}>
  <Card title="Agents Concept" icon="robot" href="/docs/concepts/agents" />

  <Card title="Single Agent Guide" icon="book-open" href="/docs/guides/single-agent" />

  <Card title="Multi-Agent Guide" icon="users" href="/docs/guides/multi-agent" />

  <Card title="Agent Configuration" icon="gear" href="/docs/configuration/agent-config" />

  <Card title="Auto Agents" icon="wand-magic-sparkles" href="/docs/features/autoagents" />
</CardGroup>
