REST API Reference

[
  {
    "id": "task_1",
    "name": "Scraper",
    "description": "Extracts product prices daily",
    "url": "https://example.com",
    "mode": "agent"
  }
]

{
  "tasks": [
    {
      "id": "task_1",
      "name": "Scraper",
      "description": "Extracts product prices daily",
      "mode": "agent",
      "schedule": { "enabled": true, "cron": "0 9 * * *" },
      "variables": {},
      "updatedAt": "2026-08-05T18:04:12.335Z",
      "createdAt": "2026-08-01T12:00:00.000Z"
    }
  ]
}

{
  "id": "task_1",
  "updatedAt": "2026-08-16T12:00:00.000Z"
}

{
  "name": "New Task",
  "description": "Optional summary of what this task does",
  "url": "https://example.com",
  "mode": "agent",
  "actions": []
}

{
  "name": "Renamed scraper",
  "description": "Runs every morning",
  "url": "https://example.com/products"
}

{
  "id": "task_1",
  "updatedAt": "2026-08-05T18:04:12.335Z",
  "status": "success",
  "task": { "id": "task_1", "name": "Renamed scraper", "...": "..." }
}

{
  "id": "task_1",
  "deleted": true,
  "message": "Task successfully removed."
}

{
  "variables": {
    "query": "override value"
  },
  "webhookUrl": "https://your-server.com/callback"
}

{
  "executionId": "exec_abc123",
  "taskId": "task_1",
  "status": "success",
  "durationMs": 4200,
  "result": { "data": [ ... ] }
}

{
  "task": { "url": "https://example.com", "actions": [...] },
  "actionIndex": 2,
  "prompt": "the search input field"
}

{
  "selector": "input[aria-label=\"Search\"]"
}

{
  "description": "extract all article titles and links from the page"
}

{
  "script": "const articles = Array.from(document.querySelectorAll('article'));\nreturn articles.map(a => ({\n  title: a.querySelector('h2')?.innerText.trim(),\n  link: a.querySelector('a')?.href\n}));"
}

{
  "executions": [
    {
      "id": "exec_abc123",
      "taskId": "task_1",
      "taskName": "Scraper",
      "status": "success",
      "startedAt": "2026-08-05T18:04:12.335Z",
      "durationMs": 4200
    }
  ]
}

{
  "executions": [
    {
      "id": "exec_abc123",
      "taskId": "task_1",
      "status": "success",
      "startedAt": "2026-08-05T18:04:12.335Z",
      "finishedAt": "2026-08-05T18:04:16.535Z",
      "durationMs": 4200
    }
  ]
}

{ "success": true }

{ "success": true }

{
  "geminiApiKeys": ["your-gemini-key"]
}

{
  "openAiApiKeys": ["your-openai-key"]
}

{
  "claudeApiKeys": ["your-claude-key"]
}

{
  "ollamaApiKeys": ["{\"url\":\"http://localhost:11434\",\"model\":\"gemma4:e2b\"}"]
}

{
  "gemini": "gemini-3-flash-preview",
  "openai": "gpt-5-nano",
  "claude": "claude-haiku-4-6",
  "ollama": "llama3.2"
}

{
  "openai": "gpt-4o",
  "claude": "claude-sonnet-4-5"
}

{
  "proxies": [
    { "id": "host", "server": "host_ip", "label": "Host IP (no proxy)" },
    { "id": "proxy_a1b2c3", "server": "http://1.2.3.4:8080", "label": "US Proxy" }
  ],
  "defaultProxyId": "host",
  "includeDefaultInRotation": false,
  "rotationMode": "round-robin"
}

{
  "server": "http://1.2.3.4:8080",
  "username": "user",
  "password": "pass",
  "label": "US Proxy",
  "isRotatingPool": false,
  "estimatedPoolSize": 500
}

{
  "proxies": [
    { "server": "http://1.2.3.4:8080", "label": "US" },
    { "server": "socks5://5.6.7.8:1080", "username": "user", "password": "pass" }
  ]
}

{
  "ids": ["proxy_a1b2c3", "proxy_d4e5f6"]
}

{
  "defaultProxyId": "proxy_a1b2c3",
  "includeDefaultInRotation": true,
  "rotationMode": "random"
}

[
  {
    "id": "cred_a1b2c3d4e5f6g7h8",
    "name": "My Baserow",
    "provider": "baserow",
    "config": {
      "baseUrl": "https://baserow.io",
      "token": "••••••••"
    }
  }
]

{
  "provider": "baserow",
  "name": "My Baserow",
  "config": {
    "baseUrl": "https://baserow.io",
    "token": "your-api-token"
  }
}

{ "error": "INVALID_BASE_URL", "details": "Invalid base URL format or restricted destination" }

{ "success": true }

[
  { "id": 1, "name": "Web Scraping" },
  { "id": 2, "name": "Product Data" }
]

[
  { "id": 45, "name": "Products" },
  { "id": 46, "name": "Pricing History" }
]

{
  "apiKey": "your-custom-key"
}

{ "selectorFinder": "highlight" }

{ "selectorFinder": "ai" }

{ "theme": "dark" }

{ "theme": "solarized-dark" }

{ "theme": "solarized-dark" }

{
  "url": "https://example.com",
  "mode": "headful",
  "devTools": false,
  "headless": false
}

{
  "sessionId": "sess_a1b2c3",
  "status": "launched",
  "wsEndpoint": "ws://localhost:11345/devtools/browser/sess_a1b2c3"
}

curl -X POST http://localhost:11345/api/browser/open \
  -H "x-api-key: $FIGRANIUM_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com"}'

curl -X POST http://localhost:11345/api/browser/open \
  -H "x-api-key: $FIGRANIUM_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com", "headless": true}'

{
  "sessionId": "sess_a1b2c3",
  "url": "https://example.com",
  "targetHint": "Sign in"
}

{
  "success": true,
  "selectors": [
    { "css": "button#login", "xpath": "//*[@id=\"login\"]", "confidence": 0.98 },
    { "css": "button.primary", "xpath": "/html/body/div[2]/button[1]", "confidence": 0.93 }
  ],
  "snapshot": "<base64 JPEG or null>"
}

curl -X POST http://localhost:11345/api/inspector/highlight \
  -H "x-api-key: $FIGRANIUM_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com", "targetHint": "Sign in"}'

{
  "useNovnc": true,
  "novncPort": 54311,
  "isRunning": true
}

{
  "useNovnc": false
}

{
  "password": "aB3cD4eF5gH6"
}

{
  "schedules": [
    {
      "taskId": "c1f7a08b",
      "taskName": "Daily Price Check",
      "schedule": {
        "enabled": true,
        "frequency": "daily",
        "hour": 9,
        "minute": 0,
        "nextRun": 1690099200000
      }
    }
  ]
}

{
  "enabled": true,
  "frequency": "daily",
  "hour": 9,
  "minute": 0
}

{
  "enabled": true,
  "cron": "0 9 * * 1-5"
}

{
  "schedule": { ... },
  "description": "Every day at 9:00 AM",
  "nextRun": 1690099200000
}

{ "success": true }

{
  "schedule": {
    "enabled": true,
    "frequency": "daily",
    "hour": 9,
    "minute": 0
  },
  "cron": "0 9 * * *",
  "description": "Every day at 9:00 AM",
  "isValid": true
}

{
  "frequency": "daily",
  "hour": 9,
  "minute": 0
}

{
  "valid": true,
  "cron": "0 9 * * *",
  "description": "Every day at 9:00 AM",
  "nextRun": 1690099200000
}

{
  "running": true,
  "scheduledCount": 2,
  "tasks": [
    {
      "taskId": "c1f7a08b",
      "cron": "0 9 * * *",
      "nextRun": "2024-07-23T09:00:00.000Z"
    }
  ]
}