Skip to main content
POST
/
v4
/
workflows
/
Create a new workflow
curl --request POST \
  --url https://api.kadoa.com/v4/workflows/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "urls": [
    "<string>"
  ],
  "navigationMode": "agentic-navigation",
  "name": "<string>",
  "description": "<string>",
  "tags": [
    "<string>"
  ],
  "limit": 2,
  "location": {
    "type": "auto",
    "isoCode": "<string>"
  },
  "monitoring": {
    "enabled": true,
    "fields": [
      {
        "fieldName": "<string>",
        "operator": "changed"
      }
    ],
    "channels": [
      "<any>"
    ],
    "conditions": [
      "<any>"
    ],
    "logicalOperator": "AND"
  },
  "interval": "ONLY_ONCE",
  "schedules": [
    "<string>"
  ],
  "bypassPreview": false,
  "autoStart": true,
  "interactions": [
    {
      "type": "CLICK",
      "selector": "<string>",
      "text": "<string>"
    }
  ],
  "dataValidationEnabled": true,
  "userPrompt": "<string>",
  "schemaId": "<string>",
  "entity": "<string>",
  "fields": [
    {
      "name": "<string>",
      "description": "<string>",
      "fieldType": "SCHEMA",
      "example": "<string>",
      "dataType": "STRING",
      "isKey": true
    }
  ]
}'
{
  "error": true,
  "success": true,
  "workflowId": "<string>",
  "message": "<string>"
}

Authorizations

x-api-key
string
header
required

API key for authentication

Body

application/json

Body

  • CreateWorkflowAgenticBody
  • CreateWorkflowWithSchemaBody
  • CreateWorkflowWithCustomSchemaBody

Request body for creating a new workflow Create an agentic workflow with natural language instructions

urls
string<uri>[]
required

List of URLs to scrape

Minimum length: 1
navigationMode
enum<string>
required

Must be agentic-navigation mode

Available options:
agentic-navigation
userPrompt
string
required

Natural language instructions for the agent (between 10 and 5000 characters)

Required string length: 10 - 5000
name
string

Name of the workflow

Minimum length: 1
description
string

Optional description of the workflow (maximum 500 characters)

Maximum length: 500
tags
string[]

Tags for categorization

limit
integer

Maximum number of items to scrape

Required range: x >= 1
location
object

Scraping location configuration

monitoring
object

Monitoring configuration

interval
enum<string>

Update frequency

Available options:
ONLY_ONCE,
EVERY_10_MINUTES,
HALF_HOURLY,
HOURLY,
THREE_HOURLY,
SIX_HOURLY,
TWELVE_HOURLY,
EIGHTEEN_HOURLY,
DAILY,
TWO_DAY,
THREE_DAY,
WEEKLY,
BIWEEKLY,
TRIWEEKLY,
FOUR_WEEKS,
MONTHLY,
REAL_TIME,
CUSTOM
schedules
string[]

Cron schedules for updates

bypassPreview
boolean
default:false

When true, bypasses preview and installs the scraper immediately

autoStart
boolean
default:true

Whether to automatically start the workflow after creation

interactions
Interaction · object[]

Optional browser interactions to perform during scraping

dataValidationEnabled
boolean

Whether data validation is enabled

schemaId
string

Optional schema ID for agentic workflows

entity
string

Optional entity name for agentic workflows

fields
(ExtractionSchemaField · object | ExtractionMetadataField · object | ExtractionClassificationField · object)[]

Optional schema fields for agentic workflows

  • ExtractionSchemaField
  • ExtractionMetadataField
  • ExtractionClassificationField

Response

201

Response for workflow creation

error
boolean
required

Error flag (always false on success)

success
boolean
required

Success flag

workflowId
string
required

ID of the created workflow

message
string
required

Success message

I