API Reference
API Reference
A REST API and typed SDKs for Python, Node.js, Go and Java. Trigger agents, deploy bots, extract documents, and stream audit events — all from your own code.
v4.8
current API version
99.99%
API uptime SLA
<80ms
P95 response time
4
official SDKs
Quickstart
From API key to first agent run in minutes
01
Install the SDK
Choose your language and install the official Menelaus SDK.
02
Create an API key
Generate a key in the dashboard under Settings → API Keys.
03
Run your first agent
Use the snippet to start an agent run and poll for the result.
🐍
Python
pip install menelaus-ai🟢
Node.js
npm install @menelaus/sdk🔵
Go
go get github.com/menelaus/go-sdk☕
Java
implementation "ai.menelaus:sdk:4.8.1"Python · quickstart.py
import menelaus client = menelaus.Client(api_key="sk-mne-...") "color:#94a3b8"># Start an agent run run = client.agents.runs.create( agent_id="agent_kyc_01", objective="Process KYC for applicant_id=AP-8842", context={"applicant_id": "AP-8842"}, ) "color:#94a3b8"># Poll until complete result = run.wait(timeout=120) print(result.output) "color:#94a3b8"># → {"status": "approved", "risk": "low"}
API resources
Organized by capability
Agents API
Create, run, and monitor autonomous agents programmatically.
12 endpoints
Bots API
Deploy and schedule RPA bots, receive run callbacks.
9 endpoints
Documents API
Submit documents for extraction, query results by schema.
8 endpoints
Processes API
Trigger, inspect and manage Orchestrator process instances.
14 endpoints
Connectors API
List, authenticate and test third-party integrations.
6 endpoints
Audit API
Query the immutable audit log for compliance exports.
5 endpoints
Endpoints
Agents API
POST
/v1/agents/runsStart a new agent run with a given objective
GET
/v1/agents/runs/{run_id}Poll run status, steps and tool calls
POST
/v1/agents/runs/{run_id}/cancelCancel a running agent
GET
/v1/agentsList all agent definitions in your workspace
POST
/v1/documents/extractSubmit a document for structured extraction
GET
/v1/documents/{doc_id}Retrieve extraction result by document ID
POST
/v1/bots/{bot_id}/runsTrigger a bot run on a schedule or on-demand
PATCH
/v1/processes/{proc_id}Update process variables mid-flight
DELETE
/v1/connectors/{conn_id}Remove a connector and revoke credentials
GET
/v1/audit/eventsStream audit events with filtering and pagination
Ready to integrate Menelaus into your stack?
Get your API key in seconds. Full docs, SDKs and a sandbox environment included.