MeshAI Client - MeshAI Documentation

The MeshAI class is the main entry point for the SDK. All operations (agent management, telemetry, cost, anomalies, and governance) are methods on this class.

Constructor

from meshai import MeshAI

client = MeshAI(
    api_key="msh_...",
    agent_name="my-agent",
    base_url="https://api.meshai.dev",
    environment="production",
    heartbeat_interval=30,
    timeout=10,
    auto_register=False,
)

Parameters

string

required

Your MeshAI API key (msh_...). Can also be set via MESHAI_API_KEY environment variable.

string

Name of the agent this client represents. Required for register(), start_heartbeat(), and track_usage().

string

default:"https://api.meshai.dev"

MeshAI API base URL. Override for self-hosted or staging deployments. Can also be set via MESHAI_BASE_URL.

string

default:"production"

Agent environment. One of production, staging, or dev. Can also be set via MESHAI_ENVIRONMENT.

integer

default:"30"

Seconds between automatic heartbeats when start_heartbeat() is called. Can also be set via MESHAI_HEARTBEAT_INTERVAL.

integer

default:"10"

HTTP request timeout in seconds. Can also be set via MESHAI_TIMEOUT.

boolean

default:"false"

If true, automatically calls register() on initialization. Requires agent_name to be set.

Properties

Property	Type	Description
`client.agent_id`	`str	None`	The agent ID after registration

Example

from meshai import MeshAI

client = MeshAI(
    api_key="msh_...",
    agent_name="production-summarizer",
    environment="production",
)

# Register the agent
agent = client.register(
    framework="crewai",
    model_provider="openai",
    model_name="gpt-4o",
    description="Summarizes customer support tickets",
)

# Start automatic heartbeats
client.start_heartbeat()

# Use any SDK method
summary = client.get_cost_summary()

Method Overview

Category	Methods
Agents	`register()`, `list_agents()`, `get_agent()`, `update_agent()`, `delete_agent()`
Telemetry	`heartbeat()`, `start_heartbeat()`, `track_usage()`
Cost	`get_cost_summary()`, `get_cost_by_agent()`, `get_cost_by_model()`
Anomalies	`list_anomalies()`, `get_anomaly()`, `acknowledge_anomaly()`, `resolve_anomaly()`, `get_anomaly_summary()`
Governance	`classify_risk()`, `create_policy()`, `list_approvals()`, `decide_approval()`, `list_audit_events()`
Compliance	`get_readiness_score()`, `get_fria()`, `get_transparency_card()`, `create_incident()`
Billing	`get_billing_info()`

​Constructor

​Parameters

​Properties

​Example

​Method Overview

Constructor

Parameters

Properties

Example

Method Overview