Skip to main content

​
Introduction

The Intuned.json file is the configuration file for your Intuned project. It defines various settings including workspace information, replication settings, auth sessions, API access, and deployment options. 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
​
workspaceId
string
Your Intuned workspace ID. If not provided here, it must be supplied via the --workspace-id flag during deployment.
​
projectName
string
The name of your Intuned project. If not provided here, it must be supplied via the command line when deploying using --project-name.
​
replication
object
required
Replication settings that control how your project scales and what resources it uses.
​
authSessions
object
Auth session settings for managing authentication state across browser automation runs.
​
apiAccess
object
API access settings that control how your project can be consumed.
​
headful
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
​
region
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"

​
Configuration Examples

  • Basic API Project
  • Project with API Auth Sessions
  • Project with Manual Auth Sessions
  • Jobs-Only Project
{
  "workspaceId": "your_workspace_id",
  "projectName": "my-automation-project",
  "replication": {
    "maxConcurrentRequests": 1,
    "size": "standard"
  },
  "apiAccess": {
    "enabled": true
  },
  "headful": false,
  "region": "us"
}
⌘I