API Reference

import httpx

resp = await client.post(
    "https://api.babelwrap.com/v1/sessions",
    headers={"Authorization": f"Bearer {API_KEY}"},
    json={"metadata": {"label": "my-flow"}},
)
session_id = resp.json()["session_id"]

const resp = await fetch("https://api.babelwrap.com/v1/sessions", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ metadata: { label: "my-flow" } }),
});
const { session_id } = await resp.json();

resp = await client.get(
    f"https://api.babelwrap.com/v1/sessions/{session_id}",
    headers={"Authorization": f"Bearer {API_KEY}"},
)
session = resp.json()
print(f"Status: {session['status']}, URL: {session['current_url']}")

const resp = await fetch(
  `https://api.babelwrap.com/v1/sessions/${session_id}`,
  { headers: { Authorization: `Bearer ${API_KEY}` } }
);
const session = await resp.json();
console.log(`Status: ${session.status}, URL: ${session.current_url}`);

resp = await client.delete(
    f"https://api.babelwrap.com/v1/sessions/{session_id}",
    headers={"Authorization": f"Bearer {API_KEY}"},
)
print(resp.json()["success"])  # True

const resp = await fetch(
  `https://api.babelwrap.com/v1/sessions/${session_id}`,
  { method: "DELETE", headers: { Authorization: `Bearer ${API_KEY}` } }
);
const { success } = await resp.json();

resp = await client.post(
    f"{BASE}/sessions/{session_id}/navigate",
    headers=HEADERS,
    json={"url": "https://news.ycombinator.com"},
)
snapshot = resp.json()["snapshot"]
print(f"Title: {snapshot['title']}")

const resp = await fetch(`${BASE}/sessions/${session_id}/navigate`, {
  method: "POST",
  headers,
  body: JSON.stringify({ url: "https://news.ycombinator.com" }),
});
const { snapshot } = await resp.json();
console.log(`Title: ${snapshot.title}`);

resp = await client.post(
    f"{BASE}/sessions/{session_id}/snapshot",
    headers=HEADERS,
    json={},
)
snapshot = resp.json()["snapshot"]

const resp = await fetch(`${BASE}/sessions/${session_id}/snapshot`, {
  method: "POST",
  headers,
  body: JSON.stringify({}),
});
const { snapshot } = await resp.json();

resp = await client.post(
    f"{BASE}/sessions/{session_id}/click",
    headers=HEADERS,
    json={"target": "the Sign In button"},
)
snapshot = resp.json()["snapshot"]

const resp = await fetch(`${BASE}/sessions/${session_id}/click`, {
  method: "POST",
  headers,
  body: JSON.stringify({ target: "the Sign In button" }),
});
const { snapshot } = await resp.json();

resp = await client.post(
    f"{BASE}/sessions/{session_id}/fill",
    headers=HEADERS,
    json={"target": "Email address field", "value": "alice@example.com"},
)
snapshot = resp.json()["snapshot"]
# Verify the field was filled
email_input = next(i for i in snapshot["inputs"] if "email" in i["label"].lower())
print(f"Email value: {email_input['value']}")

const resp = await fetch(`${BASE}/sessions/${session_id}/fill`, {
  method: "POST",
  headers,
  body: JSON.stringify({
    target: "Email address field",
    value: "alice@example.com",
  }),
});
const { snapshot } = await resp.json();

resp = await client.post(
    f"{BASE}/sessions/{session_id}/submit",
    headers=HEADERS,
    json={"target": "the login form"},
)
snapshot = resp.json()["snapshot"]
print(f"Redirected to: {snapshot['url']}")

const resp = await fetch(`${BASE}/sessions/${session_id}/submit`, {
  method: "POST",
  headers,
  body: JSON.stringify({ target: "the login form" }),
});
const { snapshot } = await resp.json();
console.log(`Redirected to: ${snapshot.url}`);

resp = await client.post(
    f"{BASE}/sessions/{session_id}/extract",
    headers=HEADERS,
    json={"query": "all product names and prices"},
)
products = resp.json()["data"]
for product in products:
    print(f"{product['name']}: {product['price']}")

const resp = await fetch(`${BASE}/sessions/${session_id}/extract`, {
  method: "POST",
  headers,
  body: JSON.stringify({ query: "all product names and prices" }),
});
const { data: products } = await resp.json();
products.forEach((p) => console.log(`${p.name}: ${p.price}`));

import base64

resp = await client.post(
    f"{BASE}/sessions/{session_id}/screenshot",
    headers=HEADERS,
    json={},
)
image_b64 = resp.json()["image"]
with open("screenshot.png", "wb") as f:
    f.write(base64.b64decode(image_b64))

const resp = await fetch(`${BASE}/sessions/${session_id}/screenshot`, {
  method: "POST",
  headers,
  body: JSON.stringify({}),
});
const { image } = await resp.json();
// image is base64-encoded PNG
const buffer = Buffer.from(image, "base64");
await fs.writeFile("screenshot.png", buffer);

resp = await client.post(
    f"{BASE}/sessions/{session_id}/press",
    headers=HEADERS,
    json={"key": "Enter"},
)
snapshot = resp.json()["snapshot"]

const resp = await fetch(`${BASE}/sessions/${session_id}/press`, {
  method: "POST",
  headers,
  body: JSON.stringify({ key: "Enter" }),
});
const { snapshot } = await resp.json();

import base64

with open("resume.pdf", "rb") as f:
    file_b64 = base64.b64encode(f.read()).decode()

resp = await client.post(
    f"{BASE}/sessions/{session_id}/upload",
    headers=HEADERS,
    json={
        "target": "the resume upload field",
        "file_base64": file_b64,
        "filename": "resume.pdf",
    },
)
snapshot = resp.json()["snapshot"]

const fs = await import("fs/promises");
const fileBuffer = await fs.readFile("resume.pdf");
const fileBase64 = fileBuffer.toString("base64");

const resp = await fetch(`${BASE}/sessions/${session_id}/upload`, {
  method: "POST",
  headers,
  body: JSON.stringify({
    target: "the resume upload field",
    file_base64: fileBase64,
    filename: "resume.pdf",
  }),
});
const { snapshot } = await resp.json();

resp = await client.post(
    f"{BASE}/sessions/{session_id}/hover",
    headers=HEADERS,
    json={"target": "the user avatar in the top right"},
)
snapshot = resp.json()["snapshot"]
# Check for newly visible dropdown menu

const resp = await fetch(`${BASE}/sessions/${session_id}/hover`, {
  method: "POST",
  headers,
  body: JSON.stringify({ target: "the user avatar in the top right" }),
});
const { snapshot } = await resp.json();

resp = await client.post(
    f"{BASE}/sessions/{session_id}/back",
    headers=HEADERS,
    json={},
)
snapshot = resp.json()["snapshot"]
print(f"Back to: {snapshot['url']}")

const resp = await fetch(`${BASE}/sessions/${session_id}/back`, {
  method: "POST",
  headers,
  body: JSON.stringify({}),
});
const { snapshot } = await resp.json();
console.log(`Back to: ${snapshot.url}`);

resp = await client.post(
    f"{BASE}/sessions/{session_id}/forward",
    headers=HEADERS,
    json={},
)
snapshot = resp.json()["snapshot"]
print(f"Forward to: {snapshot['url']}")

const resp = await fetch(`${BASE}/sessions/${session_id}/forward`, {
  method: "POST",
  headers,
  body: JSON.stringify({}),
});
const { snapshot } = await resp.json();
console.log(`Forward to: ${snapshot.url}`);

resp = await client.post(
    f"{BASE}/sessions/{session_id}/scroll",
    headers=HEADERS,
    json={"direction": "down", "amount": "half"},
)
snapshot = resp.json()["snapshot"]

const resp = await fetch(`${BASE}/sessions/${session_id}/scroll`, {
  method: "POST",
  headers,
  body: JSON.stringify({ direction: "down", amount: "half" }),
});
const { snapshot } = await resp.json();

resp = await client.post(
    f"{BASE}/sessions/{session_id}/wait_for",
    headers=HEADERS,
    json={"text": "Results loaded", "timeout_ms": 5000},
)
snapshot = resp.json()["snapshot"]

const resp = await fetch(`${BASE}/sessions/${session_id}/wait_for`, {
  method: "POST",
  headers,
  body: JSON.stringify({ text: "Results loaded", timeout_ms: 5000 }),
});
const { snapshot } = await resp.json();

resp = await client.post(
    f"{BASE}/sessions/{session_id}/batch",
    headers=HEADERS,
    json={
        "actions": [
            {"action": "fill", "target": "email field", "value": "alice@example.com"},
            {"action": "fill", "target": "password field", "value": "secret123"},
            {"action": "click", "target": "Sign In button"},
        ],
    },
)
results = resp.json()["results"]
for r in results:
    print(f"{r['action_id']}: {r['success']}")

const resp = await fetch(`${BASE}/sessions/${session_id}/batch`, {
  method: "POST",
  headers,
  body: JSON.stringify({
    actions: [
      { action: "fill", target: "email field", value: "alice@example.com" },
      { action: "fill", target: "password field", value: "secret123" },
      { action: "click", target: "Sign In button" },
    ],
  }),
});
const { results } = await resp.json();
results.forEach((r) => console.log(`${r.action_id}: ${r.success}`));

resp = await client.get(
    f"{BASE}/sessions/{session_id}/pages",
    headers=HEADERS,
)
data = resp.json()
for page in data["pages"]:
    print(f"[{page['index']}] {page['title']} - {page['url']}")

const resp = await fetch(`${BASE}/sessions/${session_id}/pages`, {
  headers,
});
const { pages, active_index } = await resp.json();
pages.forEach((p) => console.log(`[${p.index}] ${p.title} - ${p.url}`));

resp = await client.post(
    f"{BASE}/sessions/{session_id}/switch_page",
    headers=HEADERS,
    json={"index": 1},
)
snapshot = resp.json()["snapshot"]
print(f"Switched to: {snapshot['title']}")

const resp = await fetch(`${BASE}/sessions/${session_id}/switch_page`, {
  method: "POST",
  headers,
  body: JSON.stringify({ index: 1 }),
});
const { snapshot } = await resp.json();
console.log(`Switched to: ${snapshot.title}`);

resp = await client.post(
    f"{BASE}/sessions/{session_id}/cookies",
    headers=HEADERS,
    json={
        "cookies": [
            {"name": "session_token", "value": "abc123", "domain": ".example.com"},
            {"name": "prefs", "value": "dark_mode=1", "domain": ".example.com", "path": "/"},
        ],
    },
)
print(f"Added {resp.json()['cookies_added']} cookies")

const resp = await fetch(`${BASE}/sessions/${session_id}/cookies`, {
  method: "POST",
  headers,
  body: JSON.stringify({
    cookies: [
      { name: "session_token", value: "abc123", domain: ".example.com" },
      { name: "prefs", value: "dark_mode=1", domain: ".example.com", path: "/" },
    ],
  }),
});
const { cookies_added } = await resp.json();
console.log(`Added ${cookies_added} cookies`);

resp = await client.get(
    f"{BASE}/sessions/{session_id}/history",
    headers=HEADERS,
)
history = resp.json()["actions"]
for entry in history:
    print(f"{entry['timestamp']} {entry['action']} - {entry['success']}")

const resp = await fetch(`${BASE}/sessions/${session_id}/history`, {
  headers,
});
const { actions } = await resp.json();
actions.forEach((a) => console.log(`${a.timestamp} ${a.action} - ${a.success}`));

resp = await client.get(
    "https://api.babelwrap.com/v1/usage",
    headers={"Authorization": f"Bearer {API_KEY}"},
)
usage = resp.json()
print(f"Plan: {usage['plan']}")
print(f"Actions: {usage['actions_used']}/{usage['actions_limit']}")
print(f"Sessions: {usage['sessions_active']}/{usage['sessions_limit']}")
print(f"Resets: {usage['reset_date']}")

const resp = await fetch("https://api.babelwrap.com/v1/usage", {
  headers: { Authorization: `Bearer ${API_KEY}` },
});
const usage = await resp.json();
console.log(`Plan: ${usage.plan}`);
console.log(`Actions: ${usage.actions_used}/${usage.actions_limit}`);
console.log(`Sessions: ${usage.sessions_active}/${usage.sessions_limit}`);
console.log(`Resets: ${usage.reset_date}`);

resp = await client.get("https://api.babelwrap.com/v1/health")
health = resp.json()
print(f"Status: {health['status']}, Version: {health['version']}")

const resp = await fetch("https://api.babelwrap.com/v1/health");
const health = await resp.json();
console.log(`Status: ${health.status}, Version: ${health.version}`);