---
title: "Web Task - Start"
method: POST
path: "/{workspaceId}/web-tasks/start"
tags: ["webTasks"]
---

# Web Task - Start

`POST /{workspaceId}/web-tasks/start`

## Request

- Base URL: `https://app.intuned.io/api/v1/workspace`
- URL: `https://app.intuned.io/api/v1/workspace/{workspaceId}/web-tasks/start`
- Auth: API key in header `x-api-key`

Start a Web Task. The task runs asynchronously; poll the result endpoint for status and output.

## Path parameters

- `workspaceId` string, uuid, required

## Request body

- object: Request body for POST /web-tasks/start. Stored verbatim in web_task.input.
  - `task` string, required: Natural-language description of what to do.
  - `startUrl` string, uri: URL the agent should start from.
  - `parameters` object: Free-form parameters substituted into the task at runtime.
  - `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` 'haiku' | 'sonnet' | 'opus': Anthropic model the agent should run with. Defaults to 'haiku' when omitted.
  - `proxy` string, uri: Proxy URL to use for all browser traffic in this task.
  - `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.
  - `sink` union: 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.
    - object: Configuration for the S3 sink.
      - `type` 's3', required
      - `bucket` string, required: The name of the S3 bucket where the data will be stored.
      - `accessKeyId` string, required: The access key ID for the S3 bucket.
      - `secretAccessKey` string, required: The secret access key for the S3 bucket.
      - `region` string, required: The region where the S3 bucket is located.
      - `prefix` string: Optional prefix for the S3 objects. This can be used to organize objects within the bucket.
      - `skipOnFail` boolean: If enabled, failed payload runs will ***not*** be written to the bucket.
      - `apisToSend` string[]: List of API names to be sent to the S3 bucket. If not provided, all APIs will be sent.
      - `endpoint` string: Optional custom endpoint for the S3 bucket. This can be used for S3-compatible services.
      - `forcePathStyle` boolean: If true, the S3 client will use path-style URLs instead of virtual-hosted-style URLs. This is useful for S3-compatible services that require path-style access.
    - object: Configuration for the webhook sink.
      - `type` 'webhook', required
      - `url` string, required: The URL to which the webhook will send the data.
      - `headers` object: Optional headers to be sent with the webhook request.
      - `skipOnFail` boolean: If true, the webhook will not be sent if the API execution fails.
      - `apisToSend` string[]: List of API names to be sent to the webhook. If not provided, all APIs will be sent.

## Response `200`

Web task accepted and queued for execution.

- object
  - `webTaskId` string, required: Unique web task id, prefixed nanoid (wt_...).
  - `status` 'pending', required

## Other responses

- `400`: Bad Request
- `401`: Unauthorized

---

[API](https://skmtc.dev/intunedhq/apis/intuned-client.md) - [All operations](https://skmtc.dev/intunedhq/apis/intuned-client/llms.txt) - [OpenAPI document](https://skmtc.dev/intunedhq/apis/intuned-client/revisions/9f87fec44145?raw)
