POST/v1/automation/run-async

Start automation (async)

Start a browser automation task asynchronously. Returns a run_id immediately without waiting for completion. Use GET /v1/runs/{id} to poll for results.

TinyFish·$0 per call

Example code

// Using @orth/sdk - The simplest way to call APIs
// Install: npm install @orth/sdk
import Orthogonal from "@orth/sdk";

const orthogonal = new Orthogonal({
  apiKey: process.env.ORTHOGONAL_API_KEY,
});

const output = await orthogonal.run({
  api: "tinyfish/agent",
  path: "/v1/automation/run-async",
  body: {
    "url": "example",
    "goal": "example"
  }
});

console.log(output);

Body parameters

urlrequired

string

Target website URL to automate

goalrequired

string

Natural language description of what to accomplish on the website

browser_profile

string

Browser profile: lite (standard) or stealth (anti-detection)

agent_config

object

Agent behavior config: mode (default/strict), max_duration_seconds, cursor_style. Note: max_steps requires beta access and will return 403 if used without it.

capture_config

object

Configure data capture: elements, snapshots, screenshots, recording, html

webhook_url

string

HTTPS URL for webhook notifications on run lifecycle events

use_vault

boolean

Opt-in to vault credentials for this run

use_profile

boolean

Opt-in to default Browser Context Profile

profile_id

string

Browser Context Profile ID to use

proxy_config

object

Proxy config: enabled (bool), country_code (US, GB, CA, DE, FR, JP, AU)

output_schema

object

Structured-output schema for the run result