Skip to main content

Get Started

Get started with Maxun in minutes. Sign up for Maxun Cloud, install the Node.js or Python SDK, or self-host the open-source edition with Docker.

Maxun Cloud​

That’s it! Most users create their first robot in less than a minute.

Maxun SDKs​

Maxun provides official Node.js and Python SDKs for creating and running robots programmatically.

Installation​

npm install maxun-sdk

Requirements​

Environment Variables​

MAXUN_API_KEY=your-api-key

# For LLM Extraction (optional)
ANTHROPIC_API_KEY=your-anthropic-key
OPENAI_API_KEY=your-openai-key

Quick Start​

Create and run a robot programmatically using the Maxun SDK.

import { Maxun } from 'maxun-sdk';

const maxun = new Maxun();

const robot = await maxun.scrape('Example page', 'https://example.com');
const result = await robot.run();

console.log(result.markdown);

For more detailed usage, see the Node.js SDK and Python SDK guides.

Maxun Community Edition​

Maxun is open-source and can run on your own infrastructure. Learn how to self-host Maxun with Docker Compose or a local setup.