Intuned.json

Introduction

The Intuned.json file is the configuration file for your Intuned project. It defines various settings including workspace information, replication settings, auth sessions, deployment options, runtime defaults, and IDE metadata. This file should be placed in the root directory of your project. When you try to modify Intuned.json in the IDE, we will provide you with a UI that helps you modify the underlying JSON structure and describe what each property does. You can also switch to text mode to manually modify the JSON as you see fit. On the other hand, if you are working with locally using Intuned CLI to run and deploy your project, you will need to manually edit this file and ensure the JSON structure is valid. The main difference between the CLI configuration and the IDE configuration is that the CLI configuration requires additional properties that are used when you want to deploy your project like workspaceId and projectName but these configuration properties are not needed when working in the IDE.

Configuration Properties

CLI Configuration
IDE Configuration

string

Your Intuned workspace ID. If not provided here, it must be supplied via the --workspace-id flag during deployment.

string

The name of your Intuned project. If not provided here, it must be supplied via the command line when deploying using --project-name.

object

required

Replication settings that control how your project scales and what resources it uses.

Show child attributes

number

The number of machines always deployed for this project. When requests arrive, the project scales beyond this up to maxCount. Must be between 0 and maxCount. Counts towards your plan’s machine limit.Default: matches maxCount (all machines are deployed).

number

required

The maximum number of machines the project can scale up to under load. Each machine handles one API request at a time, so this is the most requests your project can process at once. This does not affect jobs.Default: 1

string

required

The machine size to use for this project. This is applicable for both API requests and jobs.Options:

"standard": Standard machine size (6 shared vCPUs, 2GB RAM)
"large": Large machine size (8 shared vCPUs, 4GB RAM)
"x-large": Extra large machine size (1 performance vCPU, 8GB RAM)

Default: "standard"

object

Auth session settings for managing authentication state across browser automation runs.

Show child attributes

boolean

required

Whether auth sessions are enabled for this project. If enabled, auth-sessions/check.ts API must be implemented to validate the auth session.

string

required

The type of auth session to use.Options:

"API": Requires implementing auth-sessions/create.ts API to create/recreate the auth session programmatically
"MANUAL": Uses a recorder to manually create the auth session

string

Recorder start URL for the recorder to navigate to when creating the auth session. Required if type is "MANUAL". Not used if type is "API".

string

Recorder finish URL for the recorder. Once this URL is reached, the recorder stops and saves the auth session. Required if type is "MANUAL". Not used if type is "API".

string

Recorder browser mode. Only applicable for "MANUAL" type.Options:

"fullscreen": Launches the browser in fullscreen mode
"kiosk": Launches the browser in kiosk mode (no address bar, no navigation controls)

Default: "fullscreen"

object

Metadata used by the IDE to prefill the Run playground.

Show child attributes

object

Default input used to prefill the Run playground in the IDE.

Show child attributes

string

The API name to preselect in the Run playground.

object

Default parameters to prefill for the selected API.

boolean

Whether to run the deployed API in a headful browser.

Running in headful can help with some anti-bot detections. However, keep in mind that running in headful mode might increase resource usage , so keep in mind to choose appropriate machine size for you.

Default: false

object

Browser window size used when launching the browser.

Show child attributes

number

Browser width in pixels.Range: 200 to 3840Default: 1024

number

Browser height in pixels.Range: 200 to 2160Default: 800

string

Browser engine to use for this project.Options:

"chromium": Use Chromium
"brave": Use Brave

object

Project-level third-party integration settings.

Show child attributes

object

1Password integration settings.

Show child attributes

boolean

Whether the 1Password integration is enabled.

string

The configured 1Password integration name.

string

The configured 1Password integration version.

string

The region where your Intuned project is hosted.Available regions:

"us": United States
"au": Australia
"ca": Canada
"nl": Netherlands
"mx": Mexico
"ro": Romania
"se": Sweden
"sg": Singapore
"es": Spain
"za": South Africa
"de": Germany
"in": India
"hk": Hong Kong
"jp": Japan
"pl": Poland
"fr": France
"gb": United Kingdom

Default: "us"

object

Default values that Intuned applies when the same values are not provided at run time.

Use dev for local CLI or IDE runs and deployed for runs started on Intuned Platform.

Show child attributes

object

Default proxy by environment. Each value can be a proxy URL string or an object with url and optional timezone. Set the URL to "intuned://auto" to let Intuned pick a managed proxy at run time. See Auto proxy and Proxy with timezone.

Show child attributes

string | object

Default proxy for local development runs. A URL string (including "intuned://auto"), or an object:

Show child attributes

string

Proxy URL. Accepts "intuned://auto".

string

IANA timezone identifier to apply to the browser (for example "America/New_York").

string | object

Default proxy for deployed runs. A URL string (including "intuned://auto"), or an object:

Show child attributes

string

Proxy URL. Accepts "intuned://auto".

string

IANA timezone identifier to apply to the browser (for example "America/New_York").

object

Default trace-saving behavior by environment.

Show child attributes

boolean

Whether to save traces by default for local development runs.

boolean

Whether to save traces by default for deployed runs.

object

Default request timeout, in seconds, by environment.

Show child attributes

number

Default request timeout for local development runs.Default run value: 600

number

Default request timeout for deployed runs.Default run value: 600

object

Default retry policy by environment.

Show child attributes

object

Retry defaults for local development runs.

Show child attributes

number

Maximum number of attempts before the run is marked as failed.Default run value: 3

object

Retry defaults for deployed runs.

Show child attributes

number

Maximum number of attempts before the run is marked as failed.Default run value: 3

object

Default sink configuration by environment.Each environment accepts the same sink object used by run inputs. Every sink supports type ("webhook" or "s3"), skipOnFail (boolean, required), and apisToSend (array of API names, optional). See Webhook Sink and AWS S3 Sink for the type-specific fields.

Show child attributes

object

Default sink configuration for local development runs.

object

Default sink configuration for deployed runs.

object

Default auth session runtime settings by environment.

Show child attributes

object

Default auth session settings for local development runs.

Show child attributes

boolean

Automatically recreate auth sessions when validation fails.

number

Number of attempts for auth session creation.

number

Number of attempts for auth session validation checks.

string | object

Proxy for auth session operations. A URL string, or { url, timezone? } to also set the browser timezone. Set to null to explicitly disable. See Proxy with timezone.

object

Default auth session settings for deployed runs.

Show child attributes

boolean

Automatically recreate auth sessions when validation fails.

number

Number of attempts for auth session creation.

number

Number of attempts for auth session validation checks.

string | object

Proxy for auth session operations. A URL string, or { url, timezone? } to also set the browser timezone. Set to null to explicitly disable. See Proxy with timezone.

object

required

Replication settings that control how your project scales and what resources it uses.

Show child attributes

number

required

string

required

The machine size to use for this project. This is applicable for both API requests and jobs.Options:

"standard": Standard machine size (6 shared vCPUs, 2GB RAM)
"large": Large machine size (8 shared vCPUs, 4GB RAM)
"x-large": Extra large machine size (1 performance vCPU, 8GB RAM)

Default: "standard"

object

Auth session settings for managing authentication state across browser automation runs.

Show child attributes

boolean

required

Whether auth sessions are enabled for this project. If enabled, auth-sessions/check.ts API must be implemented to validate the auth session.

string

required

The type of auth session to use.Options:

"API": Requires implementing auth-sessions/create.ts API to create/recreate the auth session programmatically
"MANUAL": Uses a recorder to manually create the auth session

string

Recorder start URL for the recorder to navigate to when creating the auth session. Required if type is "MANUAL". Not used if type is "API".

string

Recorder finish URL for the recorder. Once this URL is reached, the recorder stops and saves the auth session. Required if type is "MANUAL". Not used if type is "API".

string

Recorder browser mode. Only applicable for "MANUAL" type.Options:

"fullscreen": Launches the browser in fullscreen mode
"kiosk": Launches the browser in kiosk mode (no address bar, no navigation controls)

Default: "fullscreen"

object

Metadata used by the IDE to prefill the Run playground.

Show child attributes

object

Default input used to prefill the Run playground in the IDE.

Show child attributes

string

The API name to preselect in the Run playground.

object

Default parameters to prefill for the selected API.

boolean

Whether to run the deployed API in a headful browser.

Default: false

object

Browser window size used when launching the browser.

Show child attributes

number

Browser width in pixels.Range: 200 to 3840Default: 1024

number

Browser height in pixels.Range: 200 to 2160Default: 800

string

Browser engine to use for this project.Options:

"chromium": Use Chromium
"brave": Use Brave

object

Project-level third-party integration settings.

Show child attributes

object

1Password integration settings.

Show child attributes

boolean

Whether the 1Password integration is enabled.

string

The configured 1Password integration name.

string

The configured 1Password integration version.

string

The region where your Intuned project is hosted.Available regions:

"us": United States
"au": Australia
"ca": Canada
"nl": Netherlands
"mx": Mexico
"ro": Romania
"se": Sweden
"sg": Singapore
"es": Spain
"za": South Africa
"de": Germany
"in": India
"hk": Hong Kong
"jp": Japan
"pl": Poland
"fr": France
"gb": United Kingdom

Default: "us"

object

Default values that Intuned applies when the same values are not provided at run time.

Use dev for local CLI or IDE runs and deployed for runs started on Intuned Platform.

Show child attributes

object

Show child attributes

string | object

Default proxy for local development runs. A URL string (including "intuned://auto"), or an object:

Show child attributes

string

Proxy URL. Accepts "intuned://auto".

string

IANA timezone identifier to apply to the browser (for example "America/New_York").

string | object

Default proxy for deployed runs. A URL string (including "intuned://auto"), or an object:

Show child attributes

string

Proxy URL. Accepts "intuned://auto".

string

IANA timezone identifier to apply to the browser (for example "America/New_York").

object

Default trace-saving behavior by environment.

Show child attributes

boolean

Whether to save traces by default for local development runs.

boolean

Whether to save traces by default for deployed runs.

object

Default request timeout, in seconds, by environment.

Show child attributes

number

Default request timeout for local development runs.Default run value: 600

number

Default request timeout for deployed runs.Default run value: 600

object

Default retry policy by environment.

Show child attributes

object

Retry defaults for local development runs.

Show child attributes

number

Maximum number of attempts before the run is marked as failed.Default run value: 3

object

Retry defaults for deployed runs.

Show child attributes

number

Maximum number of attempts before the run is marked as failed.Default run value: 3

object

Show child attributes

object

Default sink configuration for local development runs.

object

Default sink configuration for deployed runs.

object

Default auth session runtime settings by environment.

Show child attributes

object

Default auth session settings for local development runs.

Show child attributes

boolean

Automatically recreate auth sessions when validation fails.

number

Number of attempts for auth session creation.

number

Number of attempts for auth session validation checks.

string | object

Proxy for auth session operations. A URL string, or { url, timezone? } to also set the browser timezone. Set to null to explicitly disable. See Proxy with timezone.

object

Default auth session settings for deployed runs.

Show child attributes

boolean

Automatically recreate auth sessions when validation fails.

number

Number of attempts for auth session creation.

number

Number of attempts for auth session validation checks.

string | object

Proxy for auth session operations. A URL string, or { url, timezone? } to also set the browser timezone. Set to null to explicitly disable. See Proxy with timezone.

object

Stealth mode settings that control whether requests run in stealth mode.

Show child attributes

boolean

Whether to enable stealth mode for this project.

Stealth mode currently only works on Intuned Platform deployments and is not applied during local development via the CLI.

Upgrade to the latest Playwright version for best stealth mode compatibility. See Playwright and browser support for supported versions.

Default: false

object

CAPTCHA solving settings that control automatic CAPTCHA detection and solving.

CAPTCHA solving requires headful mode to be enabled.
it’s recommended to also have stealth mode enabled and a proxy attached to the run for the best results.
This feature only works on the Intuned Platform and is not available during local CLI development.

The CAPTCHA solving extension works better with newer Playwright versions. Upgrade to the latest supported version for improved solve rates. See Playwright and browser support.

Show child attributes

boolean

Enable the CAPTCHA solver for this project.Default: false

object

Configuration for Cloudflare challenge solving, including Turnstile and interstitial checks.

Show child attributes

boolean

Enable automatic Cloudflare CAPTCHA solving.Default: false

object

Configuration for Google reCAPTCHA solving (checkbox and invisible variants).

Show child attributes

boolean

Enable automatic Google reCAPTCHA solving.Default: false

object

Configuration for AWS CAPTCHA (Amazon’s bot control service) solving.

Show child attributes

boolean

Enable automatic AWS CAPTCHA solving.Default: false

object

Configuration for GeeTest CAPTCHA solving.

Show child attributes

boolean

Enable automatic GeeTest CAPTCHA solving.Default: false

object

Configuration for FunCaptcha (Arkose Labs) solving.

Show child attributes

boolean

Enable automatic FunCaptcha solving.Default: false

object

Configuration for Lemin CAPTCHA platform solving.

Show child attributes

boolean

Enable automatic Lemin CAPTCHA solving.Default: false

object

Configuration for custom image-based CAPTCHA solving using CSS selectors.

Show child attributes

boolean

Enable custom CAPTCHA solving.Default: false

array of strings

CSS selectors for locating the CAPTCHA image element. Multiple selectors can be provided as fallbacks.Example: ["#captcha-image", ".custom-captcha img"]

array of strings

CSS selectors for the input field where the CAPTCHA answer is entered. Multiple selectors can be provided as fallbacks.Example: ["#captcha-input", ".captcha-field input"]

array of strings

CSS selectors for the button that submits the CAPTCHA answer. Multiple selectors can be provided as fallbacks.Example: ["#submit-button", "button[type='submit']"]

object

Configuration for text-based CAPTCHA solving (questions or puzzles) using CSS selectors.

Show child attributes

boolean

Enable text CAPTCHA solving.Default: false

array of strings

CSS selectors for the challenge text or question. Multiple selectors can be provided as fallbacks.Example: ["#captcha-question", ".challenge-text"]

array of strings

CSS selectors for the input field where the answer is entered. Multiple selectors can be provided as fallbacks.Example: ["#answer-input", ".captcha-answer"]

array of strings

CSS selectors for the button that submits the answer. Multiple selectors can be provided as fallbacks.Example: ["#verify-button", "button.submit"]

object

Optional provider authentication for CAPTCHA solving services that require credentials.

Show child attributes

string

Authentication strategy to use.Options:

"bearer": Bearer token authentication
"basic": Basic token authentication
"apiKey": API key authentication

string

Token value used when type is "bearer" or "basic".

string

API key value used when type is "apiKey".

object

Global settings for all CAPTCHA solving operations.

Show child attributes

boolean

Automatically solve detected CAPTCHAs without waiting for manual intervention.Default: true

number

Delay in milliseconds before solving the CAPTCHA after it is detected. Useful for mimicking human behavior and avoiding bot detection.Default: 2000 (2 seconds)

number

Maximum number of times to retry solving a CAPTCHA if solving fails.Default: 3

number

Maximum time in milliseconds to wait for a CAPTCHA to be solved before the automation fails.Default: 30000 (30 seconds)

Configuration Examples

Basic API Project
Project with API Auth Sessions
Project with Manual Auth Sessions
Jobs-Only Project
Project with Defaults and Metadata

{
  "workspaceId": "your_workspace_id",
  "projectName": "my-automation-project",
  "replication": {
    "maxCount": 1,
    "size": "standard"
  },
  "stealthMode": {
    "enabled": false
  },
  "headful": false,
  "region": "us"
}

{
  "workspaceId": "your_workspace_id",
  "projectName": "authenticated-scraper",
  "replication": {
    "minCount": 1,
    "maxCount": 3,
    "size": "large"
  },
  "authSessions": {
    "enabled": true,
    "type": "API"
  },
  "stealthMode": {
    "enabled": false
  },
  "headful": false,
  "region": "us"
}

{
  "workspaceId": "your_workspace_id",
  "projectName": "manual-auth-project",
  "replication": {
    "maxCount": 1,
    "size": "standard"
  },
  "authSessions": {
    "enabled": true,
    "type": "MANUAL",
    "startUrl": "https://example.com/login",
    "finishUrl": "https://example.com/dashboard",
    "browserMode": "fullscreen"
  },
  "stealthMode": {
    "enabled": false
  },
  "headful": false,
  "region": "us"
}

{
  "workspaceId": "your_workspace_id", 
  "projectName": "batch-processing",
  "replication": {
    "maxCount": 1,
    "size": "x-large"
  },
  "stealthMode": {
    "enabled": false
  },
  "headful": true,
  "region": "us"
}

{
  "workspaceId": "your_workspace_id",
  "projectName": "configured-project",
  "replication": {
    "maxCount": 1,
    "size": "standard"
  },
  "authSessions": {
    "enabled": true,
    "type": "API"
  },
  "browserSize": {
    "width": 1440,
    "height": 900
  },
  "defaults": {
    "proxy": {
      "dev": "http://<user>:<pass>@proxy.example.com:8080",
      "deployed": {
        "url": "http://<user>:<pass>@proxy.example.com:8080",
        "timezone": "America/New_York"
      }
    },
    "retry": {
      "dev": {
        "maximumAttempts": 2
      },
      "deployed": {
        "maximumAttempts": 4
      }
    },
    "authSession": {
      "deployed": {
        "autoRecreate": true,
        "checkAttempts": 2,
        "createAttempts": 2
      }
    }
  },
  "metadata": {
    "defaultRunPlaygroundInput": {
      "apiName": "list",
      "parameters": {}
    }
  },
  "headful": false,
  "region": "us"
}

Getting started

Intuned Agent

Web Tasks

Platform features

Learn

How-To

Integrations

References

Resources

Introduction

Configuration Properties

Configuration Examples

​Introduction

​Configuration Properties

​Configuration Examples

Introduction

Configuration Properties

Configuration Examples