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"}
Endpoints

Agents API

POST
/v1/agents/runs

Start 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}/cancel

Cancel a running agent

GET
/v1/agents

List all agent definitions in your workspace

POST
/v1/documents/extract

Submit a document for structured extraction

GET
/v1/documents/{doc_id}

Retrieve extraction result by document ID

POST
/v1/bots/{bot_id}/runs

Trigger 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/events

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