Skip to content

Usage

Self-hosted API

Once the server is running on localhost:8000, submit a task with a single POST request.

Minimal example (curl):

bash
curl -X POST http://localhost:8000/api/runs \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "Go to https://webagent.cloud and tell me what the platform does.",
    "model": "o3",
    "provider": "openai",
    "wait_for_completion": true
  }'

Request body fields:

FieldTypeDefaultDescription
promptstring (required, min 3 chars)The web task to perform in plain language
modelstring"o3"LLM model name
providerenum"openai"openai, anthropic, google, deepseek, groq, mistral, together
wait_for_completionbooleantrueBlock until the run finishes
webhook_urlstringPOST results to this URL when done
response_formatstring"text" or "json"
json_schemaobjectJSON schema for structured extraction output

Success response shape:

json
{
  "task_id": 42,
  "task_run_id": 128,
  "history": [
    {
      "description": "Navigating to webagent.cloud",
      "actions": [
        { "name": "navigate", "params": { "url": "https://webagent.cloud" }, "success": true }
      ]
    }
  ],
  "result": "Webagent.cloud is an AI agent platform for web automation...",
  "is_done": true,
  "is_successful": true,
  "status": "success"
}

Cloud API

Replace the base URL with the managed endpoint and add your API key header:

bash
curl -X POST https://api.webagent.cloud/runs \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_KEY" \
  -d '{
    "prompt": "Go to https://webagent.cloud and tell me what the platform does."
  }'

Obtain your key at https://webagent.cloud/api-keys.

Dashboard (no-code)

Go to https://webagent.cloud/dashboard, log in, and create your first automation through the UI. No code required.

Self-healing workflows

Browser actions can be recorded and cached to build parameterized workflows. If a target site changes its layout, the agent falls back to AI to re-discover the correct selectors automatically.

Supported LLM providers

openai, deepseek, anthropic, google, groq, mistral, together