Getting Started

Get up and running with MeshAI in minutes. Connect your AI agents and start orchestrating intelligent workflows.

1

Sign Up & Get API Key

Create your account at app.meshai.dev/signup and generate your API key from the dashboard.

2

Connect Your Agents

Register your agents via REST API or MCP protocol with automatic capability detection.

3

Monitor & Scale

Track performance, debug issues, and scale your agent mesh from the admin dashboard.

🔐 Authentication

API Key Types

  • msk_test_... - Development and testing
  • msk_live_... - Production use

Usage Example

headers = {
  "Authorization": "Bearer YOUR_API_KEY",
  "Content-Type": "application/json"
}

🎯 Standardized Capabilities

MeshAI uses intelligent capability detection to route tasks to the right agents:

CapabilityDescriptionAuto-Detection Keywords
text_generationQ&A, writing, explanations"what is", "explain", "write", "tell me"
code_generationProgramming, debugging"implement", "debug", "write code"
data_analysisStatistics, calculations"analyze", "calculate", "metrics"
reasoningLogic, problem-solving"solve", "deduce", "reason"
image_generationVisual content"draw", "image", "diagram"

💡 Pro tip: Let auto-detection handle capability matching - just describe your task naturally!

🔗

REST API Integration

Register and execute tasks using our REST API:

import requests

# Register an agent
response = requests.post(
    "https://api.meshai.dev/api/v1/agents",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json={
        "name": "my-agent",
        "framework": "langchain",
        "endpoint": "https://your-agent.com",
        "capabilities": ["text_generation", "reasoning"]
    }
)

# Submit a task
task_response = requests.post(
    "https://api.meshai.dev/api/v1/tasks",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={
        "task": "Explain quantum computing",
        # Capabilities auto-detected as ["text_generation"]
    }
)
🤖

MCP (Model Context Protocol) Integration

Use MCP for seamless tool-based integration with automatic capability detection:

Configuration

{
  "mcpServers": {
    "meshai": {
      "command": "npx",
      "args": ["-y", "@meshai/mcp-server"],
      "env": {
        "MESHAI_API_KEY": "YOUR_API_KEY"
      }
    }
  }
}

Usage

{
  "method": "tools/call",
  "params": {
    "name": "mesh_execute",
    "arguments": {
      "task": "Analyze sales data",
      "capabilities": ["data_analysis"]
      // Or omit for auto-detection
    }
  }
}
📦

SDK Integration

Use our Python SDK for advanced integrations:

from meshai import MeshAIClient

# Initialize client
client = MeshAIClient(api_key="YOUR_API_KEY")

# Register an agent
agent = client.register_agent(
    name="my-agent",
    framework="langchain",
    endpoint="https://your-agent.com",
    capabilities=["text_generation", "reasoning"]
)

# Submit task with auto-detection
result = await client.execute_task(
    task="What are the key AI trends?"
    # Capabilities auto-detected as ["text_generation"]
)

# Complex task with explicit capabilities
result = await client.execute_task(
    task="Analyze data and create visualization",
    capabilities=["data_analysis", "code_generation"],
    routing_strategy="performance"
)

📊 Dashboard & Monitoring

Access comprehensive monitoring and management tools at app.meshai.dev:

Main Dashboard

  • Overview: System metrics and activity
  • Agents: Manage and monitor agents
  • Tasks: Track execution and results
  • API Keys: Credential management
  • Analytics: Usage patterns and costs

Agent Monitoring

  • • Real-time health monitoring
  • • Performance metrics and charts
  • • Circuit breaker status
  • • Task history and success rates
  • • Automatic failover management
→ View Agent Monitoring

🔧 Troubleshooting

"No suitable agents found"

Cause: No agents match required capabilities

Solution: Check agent capabilities in dashboard, verify agents are active, use broader capabilities, or enable auto-import

Authentication Failures

Cause: Invalid or expired API key

Solution: Verify key format (msk_test_... or msk_live_...), check key status in dashboard, ensure Bearer prefix in header

Capability Mismatches

Cause: Task requirements don't match agent capabilities

Solution: Review auto-detected capabilities, explicitly specify if needed, use multiple capabilities for complex tasks

Task Timeouts

Cause: Agent taking too long to respond

Solution: Check agent endpoint accessibility, review agent logs, increase timeout, use performance-based routing

🌐 API Endpoints

ServiceEndpointDescription
API Gatewayhttps://api.meshai.devMain API endpoint
Dashboardhttps://app.meshai.devWeb dashboard
Registryhttps://registry.meshai.devAgent discovery
Runtimehttps://runtime.meshai.devTask execution