Quickstart

npm install @boxline/sdk playwright

pip install boxline-sdk playwright

# Create a session and keep its id and connectUrl.curl -X POST https://api.boxline.dev/v1/sessions \  -H "x-api-key: $BOXLINE_API_KEY" \  -H "content-type: application/json" \  -d '{"browser": true}'# Connect Playwright to the connectUrl from the response (quickstart.mjs below).CONNECT_URL="wss://…" node quickstart.mjs# Stop the session when you are done. Billing stops at that second.curl -X POST https://api.boxline.dev/v1/sessions/$SESSION_ID/stop \  -H "x-api-key: $BOXLINE_API_KEY"

import { Boxline } from "@boxline/sdk";import { chromium } from "playwright";const bx = new Boxline(); // reads BOXLINE_API_KEY and BOXLINE_API_URLconst session = await bx.sessions.create();console.log("Watch it live:", session.liveUrl);try {  const browser = await chromium.connectOverCDP(session.connectUrl!);  const context = browser.contexts()[0];  const page = context.pages()[0] ?? (await context.newPage());  await page.goto("https://example.com");  console.log("Title:", await page.title());  await browser.close();} finally {  await session.stop(); // billing stops here}

from boxline import Boxlinefrom playwright.sync_api import sync_playwrightbx = Boxline()  # reads BOXLINE_API_KEY and BOXLINE_API_URL# Leaving the "with" block stops the session.with bx.sessions.create() as session:    print("Watch it live:", session.live_url)    with sync_playwright() as p:        browser = p.chromium.connect_over_cdp(session.connect_url)        context = browser.contexts[0]        page = context.pages[0] if context.pages else context.new_page()        page.goto("https://example.com")        print("Title:", page.title())

curl -X POST https://api.boxline.dev/v1/fetch \  -H "x-api-key: $BOXLINE_API_KEY" \  -H "content-type: application/json" \  -d '{"url": "https://example.com", "format": "markdown"}'

import { Boxline } from "@boxline/sdk";const bx = new Boxline();const page = await bx.fetch("https://example.com", { format: "markdown" });console.log(page.title);console.log(page.content);

from boxline import Boxlinebx = Boxline()page = bx.fetch("https://example.com", format="markdown")print(page["title"])print(page["content"])

boxline fetch https://example.com   # the page as Markdown, on stdout

# Start the run.curl -X POST https://api.boxline.dev/v1/agent/runs \  -H "x-api-key: $BOXLINE_API_KEY" \  -H "content-type: application/json" \  -d '{"task": "Open example.com and say in two sentences what the page is for."}'# Poll it with the id from the response until status is "completed" or "failed".curl https://api.boxline.dev/v1/agent/runs/$RUN_ID \  -H "x-api-key: $BOXLINE_API_KEY"

import { Boxline } from "@boxline/sdk";const bx = new Boxline();const { id, sessionId } = await bx.agent.run({  task: "Open example.com and say in two sentences what the page is for.",});const session = await bx.sessions.get(sessionId);console.log("Watch it live:", session.liveUrl);const run = await bx.agent.wait(id); // polls until the run finishesconsole.log(run.status, run.result);

from boxline import Boxlinebx = Boxline()started = bx.agent.run(task="Open example.com and say in two sentences what the page is for.")session = bx.sessions.get(started["sessionId"])print("Watch it live:", session.live_url)run = bx.agent.wait(started["id"])  # polls until the run finishesprint(run["status"], run["result"])

# Shows each step as it happens; the answer comes last, on stdout.boxline run "Open example.com and say in two sentences what the page is for."