Submit task

Submit a task.

post/api/v1/task

Cookies

apikeystring

Request body

taskstring nullable

The task to run. If None, opens a blank browser and waits for further instructions.

response_modelobject nullable

If provided, the JSON schema describing the desired output structure. Default is None

urlstring nullable

The starting URL for the task. If not provided, the agent will infer it from the task.

metadataobject nullable

A dictionary containing variables or parameters that will be passed to the agent.

filesstring[] nullable

A list of file ids to pass to the agent.

agentstring

The agent to use for the task. Default is 'smooth'.

max_stepsinteger

Maximum number of steps the agent can take (min 2, max 128).

device'desktop' | 'mobile' | 'desktop-lg'

Device type for the task. Default is desktop.

allowed_urlsstring[] nullable

List of allowed URL patterns using wildcard syntax (e.g., https://example.com/). If None, all URLs are allowed.

enable_recordingboolean

Enable video recording of the task execution. Default is True

profile_idstring nullable

Browser profile ID to use. Each profile maintains its own state, such as cookies and login credentials.

profile_read_onlyboolean

If true, the profile specified by profile_id will be loaded in read-only mode. Changes made during the task will not be saved back to the profile.

stealth_modeboolean

(Deprecated, ignored) Use use_stealth instead. Stealth is on by default.

use_stealthboolean

Run the browser in stealth mode. Default is True.

proxy_serverstring nullable

Proxy server url to route browser traffic through.

proxy_usernamestring nullable

Proxy server username.

proxy_passwordstring password nullable

Proxy server password.

proxy_idstring nullable

Name of a Smooth-managed proxy to route browser traffic through, as returned by list_proxies(). Cannot be combined with proxy_server.

use_adblockboolean nullable

Enable adblock for the browser session. Default is True.

use_captcha_solverboolean nullable

Enable captcha solver for the browser session. Default is True.

additional_toolsobject nullable

Additional tools to enable for the task.

experimental_featuresobject nullable

Experimental features to enable for the task.

extensionsstring[] nullable

List of extensions to install for the task.

show_cursorboolean

Show mouse cursor. Default is False.

cursor_textstring nullable

Custom text shown in the cursor label bubble (max 16 characters). Requires show_cursor=True and a Growth plan.

cursor_bubble_colorstring nullable

Custom hex color (e.g. '#0081ff') for the cursor label bubble. Requires show_cursor=True and a Growth plan.

idle_timeoutinteger nullable

Seconds of inactivity (no task, goto, evaluate_js, or extract) after which an open session auto-closes. Only applies to sessions (task is None). None uses the server default (5 minutes); 0 or negative disables auto-close.

Response

Successful Response

Changes

No recorded changes to this endpoint across all 1 revision of this API.