Quickstart Guide

Maeyr processes headless requests in a closed loop. Every goal follows a secure three-step cycle:

1. 1

   Ingest APIs or Python Agents

   Maeyr allows you to ingest OpenAPI (Swagger) specifications directly to register virtual tools. Alternatively, write Python agents using the public SDK with the @mcp_endpoint decorator:

   from typing import Any, Dict
   
   
   from maeyr.runtime import mcp_endpoint
   
   @mcp_endpoint(description="Greet someone by name from the payload")
   async def greet(payload: Dict[str, Any]) -> Dict[str, Any]:
       name = payload.get("name") or "there"
       return {"message": f"Hello, {name}! Welcome to Maeyr."}
   

   See the Python SDK guide or Headless API Fleet configuration.

2. 2

   Review Headless credential encryption

   Platform encryption protects Headless connector credentials automatically. If this project requires customer BYOK, configure its separate Headless Credential KMS with an AWS, GCP, or Azure key. This choice never changes Project Vault encryption or other platform data.

3. 3

   Link Channel Connectors

   Connect your headless workspace to Slack, WhatsApp, Microsoft Teams, Telegram, or Instagram via shared HTTPS webhooks. Replace visual menus (GUI) and terminal scripts (CLI) with headless agent execution.

4. 4

   Trigger Headless Execution

   Users can trigger runs directly from their native messaging app (e.g. Slack or WhatsApp) using natural language. Maeyr binds their identity, decrypts keys via KMS, resolves dependencies, and plans execution loops.

   User: "Greet John and check if our servers are healthy."
   
   Think → Act → Observe:
     1. hello_agent.greet(name="John")
     2. server_health.check_health()

5. 5

   Trigger Headless API Execution

   To execute workflows programmatically from alerts, pipelines, or your custom app, call the endpoint execution gateway POST payload:

   {
     "event": "incident.opened",
     "severity": "high",
     "service": "payments-api",
     "goal": "Investigate elevated error rate and restart unhealthy pods if needed"
   }

Now that you have deployed your first agentic loop, explore advanced configuration topics: