Documentation Index
Fetch the complete documentation index at: https://intunedhq.com/docs/llms.txt
Use this file to discover all available pages before exploring further.
Introduction
TheIntuned.json file is the configuration file for your Intuned project. It defines various settings including workspace information, replication settings, auth sessions, API access, 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
Your Intuned workspace ID. If not provided here, it must be supplied via the
--workspace-id flag during deployment.The name of your Intuned project. If not provided here, it must be supplied via the command line when deploying using
--project-name.Replication settings that control how your project scales and what resources it uses.
Show child attributes
Show child attributes
The maximum number of concurrent executions allowed via Intuned API. This does not affect jobs. A number of machines equal to this will be allocated to handle API requests. Not applicable if API access is disabled.Default:
1The 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)
"standard"Auth session settings for managing authentication state across browser automation runs.
Show child attributes
Show child attributes
Whether auth sessions are enabled for this project. If enabled,
auth-sessions/check.ts API must be implemented to validate the auth session.The type of auth session to use.Options:
"API": Requires implementingauth-sessions/create.tsAPI to create/recreate the auth session programmatically"MANUAL": Uses a recorder to manually create the auth session
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".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".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)
"fullscreen"API access settings that control how your project can be consumed.
Show child attributes
Show child attributes
Whether to enable consumption through Intuned API. If this is false, the project can only be consumed through jobs. This is required for projects that use auth sessions.Default:
trueMetadata used by the IDE to prefill the Run playground.
Whether to run the deployed API in a headful browser.Default:
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.
falseBrowser engine to use for this project.Options:
"chromium": Use Chromium"brave": Use Brave
Project-level third-party integration settings.
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
"us"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
Show child attributes
Default retry policy by environment.
Show child attributes
Show child attributes
Retry defaults for local development runs.
Show child attributes
Show child attributes
Maximum number of attempts before the run is marked as failed.Default run value:
3Default sink configuration by environment.Each environment accepts the same sink object used by run inputs.See Webhook Sink and AWS S3 Sink for the supported fields.
Default runtime settings for local development and deployed runs.
Show child attributes
Show child attributes
Default sink configuration for sending run results to an external destination.
Each sink object supports
Show child attributes
Show child attributes
type ("webhook" or "s3"), skipOnFail (boolean, required), and apisToSend (array of API names, optional).Webhook sink additionally requires url and optionally accepts headers.S3 sink additionally requires bucket, accessKeyId, secretAccessKey, and optionally accepts region, prefix, endpoint, forcePathStyle.Default auth session behavior.
Show child attributes
Show child attributes
Auth session defaults for local development.
Show child attributes
Show child attributes
Automatically recreate auth sessions when validation fails.
Number of attempts for auth session creation.
Number of attempts for auth session validation checks.
Proxy URL for auth session operations. Set to
null to explicitly disable.Auth session defaults for deployed runs.
Show child attributes
Show child attributes
Automatically recreate auth sessions when validation fails.
Number of attempts for auth session creation.
Number of attempts for auth session validation checks.
Proxy URL for auth session operations. Set to
null to explicitly disable.Replication settings that control how your project scales and what resources it uses.
Show child attributes
Show child attributes
The maximum number of concurrent executions allowed via Intuned API. This does not affect jobs. A number of machines equal to this will be allocated to handle API requests. Not applicable if API access is disabled.Default:
1The 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)
"standard"Auth session settings for managing authentication state across browser automation runs.
Show child attributes
Show child attributes
Whether auth sessions are enabled for this project. If enabled,
auth-sessions/check.ts API must be implemented to validate the auth session.The type of auth session to use.Options:
"API": Requires implementingauth-sessions/create.tsAPI to create/recreate the auth session programmatically"MANUAL": Uses a recorder to manually create the auth session
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".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".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)
"fullscreen"API access settings that control how your project can be consumed.
Show child attributes
Show child attributes
Whether to enable consumption through Intuned API. If this is false, the project can only be consumed through jobs. This is required for projects that use auth sessions.Default:
trueMetadata used by the IDE to prefill the Run playground.
Whether to run the deployed API in a headful browser.Default:
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.
falseBrowser engine to use for this project.Options:
"chromium": Use Chromium"brave": Use Brave
Project-level third-party integration settings.
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
"us"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
Show child attributes
Default retry policy by environment.
Show child attributes
Show child attributes
Retry defaults for local development runs.
Show child attributes
Show child attributes
Maximum number of attempts before the run is marked as failed.Default run value:
3Default sink configuration by environment.Each environment accepts the same sink object used by run inputs.See Webhook Sink and AWS S3 Sink for the supported fields.
Stealth mode settings that control whether requests run in stealth mode.
Show child attributes
Show child attributes
Whether to enable stealth mode for this project.Default:
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.
falseCAPTCHA 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
Show child attributes
Enable the CAPTCHA solver for this project.Default:
falseConfiguration for Cloudflare challenge solving, including Turnstile and interstitial checks.
Show child attributes
Show child attributes
Enable automatic Cloudflare CAPTCHA solving.Default:
falseConfiguration for Google reCAPTCHA v2 solving (checkbox and invisible variants).
Show child attributes
Show child attributes
Enable automatic Google reCAPTCHA v2 solving.Default:
falseConfiguration for Google reCAPTCHA v3 solving.
Show child attributes
Show child attributes
Enable automatic Google reCAPTCHA v3 solving.Default:
falseConfiguration for AWS CAPTCHA (Amazon’s bot control service) solving.
Show child attributes
Show child attributes
Enable automatic AWS CAPTCHA solving.Default:
falseConfiguration for GeeTest CAPTCHA solving.
Show child attributes
Show child attributes
Enable automatic GeeTest CAPTCHA solving.Default:
falseConfiguration for FunCaptcha (Arkose Labs) solving.
Show child attributes
Show child attributes
Enable automatic FunCaptcha solving.Default:
falseConfiguration for Lemin CAPTCHA platform solving.
Show child attributes
Show child attributes
Enable automatic Lemin CAPTCHA solving.Default:
falseConfiguration for custom image-based CAPTCHA solving using CSS selectors.
Show child attributes
Show child attributes
Enable custom CAPTCHA solving.Default:
falseCSS selectors for locating the CAPTCHA image element. Multiple selectors can be provided as fallbacks.Example:
["#captcha-image", ".custom-captcha img"]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"]CSS selectors for the button that submits the CAPTCHA answer. Multiple selectors can be provided as fallbacks.Example:
["#submit-button", "button[type='submit']"]Configuration for text-based CAPTCHA solving (questions or puzzles) using CSS selectors.
Show child attributes
Show child attributes
Enable text CAPTCHA solving.Default:
falseCSS selectors for the challenge text or question. Multiple selectors can be provided as fallbacks.Example:
["#captcha-question", ".challenge-text"]CSS selectors for the input field where the answer is entered. Multiple selectors can be provided as fallbacks.Example:
["#answer-input", ".captcha-answer"]CSS selectors for the button that submits the answer. Multiple selectors can be provided as fallbacks.Example:
["#verify-button", "button.submit"]Optional provider authentication for CAPTCHA solving services that require credentials.
Global settings for all CAPTCHA solving operations.
Show child attributes
Show child attributes
Automatically solve detected CAPTCHAs without waiting for manual intervention.Default:
trueDelay in milliseconds before solving the CAPTCHA after it is detected. Useful for mimicking human behavior and avoiding bot detection.Default:
2000 (2 seconds)Maximum number of times to retry solving a CAPTCHA if solving fails.Default:
3Maximum 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": {
"maxConcurrentRequests": 1,
"size": "standard"
},
"apiAccess": {
"enabled": true
},
"stealthMode": {
"enabled": false
},
"headful": false,
"region": "us"
}
{
"workspaceId": "your_workspace_id",
"projectName": "authenticated-scraper",
"replication": {
"maxConcurrentRequests": 2,
"size": "large"
},
"authSessions": {
"enabled": true,
"type": "API"
},
"apiAccess": {
"enabled": true
},
"stealthMode": {
"enabled": false
},
"headful": false,
"region": "us"
}
{
"workspaceId": "your_workspace_id",
"projectName": "manual-auth-project",
"replication": {
"maxConcurrentRequests": 1,
"size": "standard"
},
"authSessions": {
"enabled": true,
"type": "MANUAL",
"startUrl": "https://example.com/login",
"finishUrl": "https://example.com/dashboard",
"browserMode": "fullscreen"
},
"apiAccess": {
"enabled": true
},
"stealthMode": {
"enabled": false
},
"headful": false,
"region": "us"
}
{
"workspaceId": "your_workspace_id",
"projectName": "batch-processing",
"replication": {
"maxConcurrentRequests": 1,
"size": "x-large"
},
"apiAccess": {
"enabled": false
},
"stealthMode": {
"enabled": false
},
"headful": true,
"region": "us"
}
{
"workspaceId": "your_workspace_id",
"projectName": "configured-project",
"replication": {
"maxConcurrentRequests": 1,
"size": "standard"
},
"authSessions": {
"enabled": true,
"type": "API"
},
"apiAccess": {
"enabled": true
},
"browserSize": {
"width": 1440,
"height": 900
},
"defaults": {
"proxy": {
"dev": "http://<user>:<pass>@proxy.example.com:8080"
},
"retry": {
"dev": {
"maximumAttempts": 2
},
"deployed": {
"maximumAttempts": 4
}
},
"authSession": {
"deployed": {
"autoRecreate": true,
"checkAttempts": 2,
"createAttempts": 2
}
}
},
"metadata": {
"defaultRunPlaygroundInput": {
"apiName": "list",
"parameters": {}
}
},
"headful": false,
"region": "us"
}