Skip to main content
POST
/
{workspaceId}
/
web-tasks
/
start
webTaskStart
import { IntunedClient } from "@intuned/client";

const client = new IntunedClient({
  workspaceId: "123e4567-e89b-12d3-a456-426614174000",
  apiKey: process.env["INTUNED_API_KEY"] ?? "",
});

async function run() {
  const result = await client.webTasks.start(
    {
      task: "Scrape YC companies from batch S24",
    },
);

  console.log(result);
}

run();
{
  "webTaskId": "wt_123",
  "status": "pending"
}

Authorizations

​
x-api-key
string
header
required

API Key used to authenticate your requests. How to create one.

Path Parameters

​
workspaceId
string<uuid>
required

Your workspace ID. How to find it?

Body

application/json

Web Task input schema

Request body for POST /web-tasks/start. Stored verbatim in web_task.input.

​
task
string
required

Natural-language description of what to do.

Example:

"Scrape YC companies from batch S24"

​
startUrl
string<uri>

URL the agent should start from.

Example:

"https://www.ycombinator.com/companies"

​
parameters
object

Free-form parameters substituted into the task at runtime.

Example:
{
  "param1": "value1",
  "param2": 42,
  "param3": true
}
​
outputSchema
object

Schema describing the expected output shape. Accepts JSON-Schema-shaped objects as well as Intuned's extended type vocabulary (e.g. { type: 'attachment' }).

​
reuseKey
string

Caller-provided key that ties this task to a persisted code and resources tree.

​
model
enum<string>

Anthropic model the agent should run with. Defaults to 'haiku' when omitted.

Available options:
haiku,
sonnet,
opus
Example:

"sonnet"

​
proxy
string<uri>

Proxy URL to use for all browser traffic in this task.

Example:

"http://my-proxy.com:8080"

​
auth
string

Id of a captured web task auth (recorder-based session). When set, the agent's browser is pre-loaded with that session's storage state so the task runs authenticated.

Example:

"wta_123"

​
sink
S3 Sink Configuration · object

Optional sink configuration. When set, the web task result is delivered to a webhook or S3 bucket once the task completes. Returned partially obfuscated in the result API response.

Response

Web task accepted and queued for execution.

​
webTaskId
string
required

Unique web task id, prefixed nanoid (wt_...).

Example:

"wt_123"

​
status
enum<string>
required
Available options:
pending