The Kadoa connector lets your AI agent act in each user's Kadoa account. Each user connects their own Kadoa API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 60 tools.
- Tools
- 60
- What they doRead · write · destructive
- 26 · 27 · 726 read27 write7 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Kadoa connection
In AgentKit > Connections, create a Kadoa connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'kadoa'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Kadoa:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'kadoa_changes_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "kadoa"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Kadoa:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="kadoa_changes_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Kadoa credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolkadoa_change_getGet one data change with its records, optionally only added, removed or changed ones, sorted and paged.Read-onlyGet Data Change
Get one data change with its records, optionally only added, removed or changed ones, sorted and paged. Returns the change and its differing records. Use this to inspect a change from kadoa_changes_list.
Inputs
change_idstringrequired- ID of the data change. Example: 6a1f2c3d4e5f6a7b8c9d0e99.
excludestring- Comma-separated fields to leave out of each change, e.g. data or differences. Example: data.
limitinteger- Maximum number of differences to return (maximum 100; larger values return 400). Without it, all differences are returned. Use differencesCounts for the totals. Example: 25.
orderstring- Sort order: asc or desc. One of: asc, desc. Example: desc.one of
ascdesc skipinteger- Number of items to skip, for paging. Example: 0.
sort_bystring- Field key to sort differences by; without it, differences are grouped by type. Example: createdAt.
typestring- Return only differences of this type. One of: added, removed, changed. Example: added.one of
addedremovedchanged
kadoa_changes_listList the data changes Kadoa detected between runs of monitored workflows, optionally for some workflows and a date range.Read-onlyList Data Changes
List the data changes Kadoa detected between runs of monitored workflows, optionally for some workflows and a date range. Returns per change its ID, workflow, date, and added, removed and changed records. Use this to track what changed on monitored sites. Use kadoa_change_get for one change.
Inputs
end_datestring- Only changes on or before this ISO 8601 date-time. Example: 2026-06-30T23:59:59Z.
excludestring- Comma-separated fields to leave out of each change, e.g. data or differences. Example: data.
limitinteger- Number of records to return (maximum 100; larger values return 400). Defaults to 25. Example: 25.
skipinteger- Number of items to skip, for paging. Example: 0.
start_datestring- Only changes on or after this ISO 8601 date-time. Example: 2026-01-01T00:00:00Z.
workflow_idsstring- Comma-separated workflow IDs to filter by. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.
kadoa_notification_channel_getGet one notification channel.Read-onlyGet Notification Channel
Get one notification channel. Returns its name, type and config. Use this when you know the channel ID.
Inputs
channel_idstringrequired- ID of the notification channel. Example: 6a1f2c3d4e5f6a7b8c9d0e66.
include_configurationsboolean- Set to true to include the channel's settings. Defaults to true. Example: true.
kadoa_notification_channels_listList notification channels (email, Slack, webhook, websocket), optionally those used by one workflow.Read-onlyList Notification Channels
List notification channels (email, Slack, webhook, websocket), optionally those used by one workflow. Returns per channel its ID, name, type and config. Use this to find channel IDs for notification settings.
Inputs
include_configurationsboolean- Set to true to include each channel's settings. Defaults to true. Example: true.
workflow_idstring- Only channels used by this workflow. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.
kadoa_notification_event_types_listList the event types you can be notified about, such as workflow_finished, workflow_failed and workflow_data_change.Read-onlyList Notification Event Types
List the event types you can be notified about, such as workflow_finished, workflow_failed and workflow_data_change. Returns each type with its description. Use this to choose an event for a notification setting.
Inputs
This tool takes no inputs.
kadoa_notification_setting_getGet one notification setting.Read-onlyGet Notification Setting
Get one notification setting. Returns its workflow, event type, enabled flag and channels. Use this when you know the setting ID.
Inputs
settings_idstringrequired- ID of the notification setting. Example: 6a1f2c3d4e5f6a7b8c9d0e88.
kadoa_notification_settings_listList notification settings, optionally for one workflow or event type.Read-onlyList Notification Settings
List notification settings, optionally for one workflow or event type. Returns per setting its ID, workflow, event type, enabled flag and channels. Use this to see who gets notified of what.
Inputs
event_typestring- Only settings for this event type. One of: workflow_started, workflow_finished, workflow_failed, workflow_sample_finished, workflow_data_change, system_maintenance, service_degradation, credits_low, free_trial_ending. Example: workflow_finished.one of
workflow_startedworkflow_finishedworkflow_failedworkflow_sample_finishedworkflow_data_changesystem_maintenanceservice_degradationcredits_lowfree_trial_ending workflow_idstring- Only settings of this workflow. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.
kadoa_schema_getGet one extraction schema.Read-onlyGet Schema
Get one extraction schema. Returns its name, entity and fields. Use this when you know the schema ID.
Inputs
schema_idstringrequired- ID of the schema. Find it with kadoa_schemas_list. Example: 6a1f2c3d4e5f6a7b8c9d0e33.
kadoa_schemas_listList the saved extraction schemas in your workspace.Read-onlyList Schemas
List the saved extraction schemas in your workspace. Returns per schema its ID, name, entity and fields. Use this to reuse a schema when creating workflows.
Inputs
This tool takes no inputs.
kadoa_template_getGet one template with its versions.Read-onlyGet Template
Get one template with its versions. Returns name, description, versions and their prompt, schema and settings. Use this when you know the template ID.
Inputs
template_idstringrequired- ID of the template. Find it with kadoa_templates_list. Example: 6a1f2c3d4e5f6a7b8c9d0e44.
kadoa_template_schemas_listList the schemas used by a template's versions.Read-onlyList Template Schemas
List the schemas used by a template's versions. Returns schema IDs, names and fields. Use this to inspect a template's output.
Inputs
template_idstringrequired- ID of the template. Find it with kadoa_templates_list. Example: 6a1f2c3d4e5f6a7b8c9d0e44.
kadoa_template_workflows_listList the workflows linked to a template and the version each uses.Read-onlyList Template Workflows
List the workflows linked to a template and the version each uses. Returns workflow IDs, names and versions. Use this before applying a new version.
Inputs
template_idstringrequired- ID of the template. Find it with kadoa_templates_list. Example: 6a1f2c3d4e5f6a7b8c9d0e44.
kadoa_templates_listList workflow templates in your workspace.Read-onlyList Templates
List workflow templates in your workspace. Returns per template its ID, name, description and latest version. Use this to find a template for kadoa_workflow_create.
Inputs
This tool takes no inputs.
kadoa_workflow_audit_log_listList the audit log of a workflow: who changed, ran or paused it and when.Read-onlyList Workflow Audit Log
List the audit log of a workflow: who changed, ran or paused it and when. Returns entries with user, action, timestamp and details. Use this to trace changes.
Inputs
workflow_idstringrequired- ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.
limitinteger- Number of items per page. Defaults to 25. Example: 25.
pageinteger- Page number, starting at 1. Defaults to 1. Example: 1.
kadoa_workflow_connectors_listList the destinations (connectors) that deliver a workflow's results, such as databases or storage.Read-onlyList Workflow Destinations
List the destinations (connectors) that deliver a workflow's results, such as databases or storage. Returns per destination its ID, type and status. Use this to see where data goes.
Inputs
workflow_idstringrequired- ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.
kadoa_workflow_data_getGet the records a workflow extracted, from the latest run or a specific run, with optional sorting, filters and paging.Read-onlyGet Workflow Data
Get the records a workflow extracted, from the latest run or a specific run, with optional sorting, filters and paging. Returns the rows with their fields, plus pagination and run info. Use this to read scraped results. Use kadoa_changes_list for differences between runs.
Inputs
workflow_idstringrequired- ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.
filtersstring- JSON array of filter conditions, each with field, operator and value. Example: [{"field":"price","operator":"gt","value":10}]
limitinteger- Number of items per page (0 for streaming all data). Defaults to 25. Example: 25.
orderstring- Sort order: asc or desc. One of: asc, desc. Defaults to asc. Example: desc.one of
ascdesc pageinteger- Page number, starting at 1. Defaults to 1. Example: 1.
row_idsstring- Comma-separated row IDs to return. Example: row_1,row_2.
run_idstring- ID of a specific run (job); leave empty for the latest run. Example: 6a1f2c3d4e5f6a7b8c9d0e55.
sort_bystring- Field to sort by. Example: createdAt.
kadoa_workflow_getGet one workflow by ID.Read-onlyGet Workflow
Get one workflow by ID. Returns its name, URLs, prompt, schema (entity and fields), schedule, location, monitoring, state, run state, last run details and record counts. Use this when you know the workflow ID.
Inputs
workflow_idstringrequired- ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.
kadoa_workflow_history_listList the run history of a workflow, optionally by status or run ID.Read-onlyList Workflow Runs
List the run history of a workflow, optionally by status or run ID. Returns per run its job ID, status, start and end time, record count and errors. Use this to check recent runs. Use kadoa_workflow_job_get for one run's telemetry.
Inputs
workflow_idstringrequired- ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.
limitinteger- Maximum number of runs per page (default 25, min 1, max 1000). Example: 25.
pageinteger- Page number, starting at 1. Defaults to 1. Example: 1.
run_idstring- ID of a specific run (job); leave empty for the latest run. Example: 6a1f2c3d4e5f6a7b8c9d0e55.
statusstring- Filter runs by outcome. success maps to FINISHED, failed maps to FAILED, in_progress maps to RUNNING, stopped maps to STOPPED. One of: success, failed, in_progress, stopped. Example: success.one of
successfailedin_progressstopped
kadoa_workflow_history_metrics_getGet aggregated run success metrics of a workflow over a number of days.Read-onlyGet Workflow Run Metrics
Get aggregated run success metrics of a workflow over a number of days. Returns success and failure counts and rates. Use this to judge a workflow's reliability.
Inputs
workflow_idstringrequired- ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.
daysinteger- Number of past days to aggregate. Defaults to 30. Example: 30.
kadoa_workflow_job_getGet the status and telemetry of one workflow run (job).Read-onlyGet Workflow Run
Get the status and telemetry of one workflow run (job). Returns state, timestamps, pages and records processed, credits used and errors. Use this to follow a run started with kadoa_workflow_run.
Inputs
job_idstringrequired- ID of the workflow run (job), from kadoa_workflow_history_list. Example: 6a1f2c3d4e5f6a7b8c9d0e55.
workflow_idstringrequired- ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.
kadoa_workflow_quality_metrics_getGet data quality metrics of a workflow's latest run or a given run: field fill rates and validation-rule results.Read-onlyGet Workflow Quality Metrics
Get data quality metrics of a workflow's latest run or a given run: field fill rates and validation-rule results. Returns the metrics per field. Use this to spot broken extractions.
Inputs
workflow_idstringrequired- ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.
job_idstring- ID of the workflow run (job), from kadoa_workflow_history_list. Example: 6a1f2c3d4e5f6a7b8c9d0e55.
kadoa_workflow_rules_getGet the data quality (schema validation) rules of a workflow.Read-onlyGet Workflow Data Quality Rules
Get the data quality (schema validation) rules of a workflow. Returns the rules per field. Use this before changing rules.
Inputs
workflow_idstringrequired- ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.
kadoa_workflow_sql_generateTurn a natural-language question into a DuckDB SQL query over a workflow's data, given its column names and a few sample rows.Read-onlyGenerate Data Query
Turn a natural-language question into a DuckDB SQL query over a workflow's data, given its column names and a few sample rows. Returns the SQL. Use this to help analyse scraped data; it does not run the query.
Inputs
columnsarrayrequired- Columns of the workflow data, each an object with name and type. Example: [{"name":"brand","type":"VARCHAR"},{"name":"price","type":"DOUBLE"}]
promptstringrequired- Question to answer, in plain language. Example: Average price per brand.
sample_rowsarrayrequired- Up to 5 sample rows, each an array of string values in column order. Example: [["Acme","19.99"],["Globex","24.50"]]
workflow_idstringrequired- ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.
kadoa_workflow_trigger_getGet one trigger of a workflow.Read-onlyGet Workflow Trigger
Get one trigger of a workflow. Returns its target workflow, event type and enabled flag. Use this when you know the trigger ID.
Inputs
trigger_idstringrequired- ID of the trigger. Example: 6a1f2c3d4e5f6a7b8c9d0e77.
workflow_idstringrequired- ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.
kadoa_workflow_triggers_listList the triggers of a workflow, which start another workflow when an event happens.Read-onlyList Workflow Triggers
List the triggers of a workflow, which start another workflow when an event happens. Returns per trigger its ID, target workflow, event type and enabled flag. Use this to see workflow chains.
Inputs
workflow_idstringrequired- ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.
kadoa_workflows_listList the workflows (scrapers) in your Kadoa workspace, filtered by search text, state, run state, tags, template, update interval or schedule type.Read-onlyList Workflows
List the workflows (scrapers) in your Kadoa workspace, filtered by search text, state, run state, tags, template, update interval or schedule type. Returns per workflow its ID, name, URLs, state, run state, schedule, tags, last run and record count, plus pagination. Use this to find a workflow. Use kadoa_workflow_get for one workflow's full configuration.
Inputs
display_statestring- Filter by the workflow's computed operational state. This does not include pending user input or support ownership; use statusFilters for those dashboard categories. Accepts comma-separated values. One of: ACTIVE, DRAFT, PAUSED, PREVIEW, FAILED, RUNNING, VALIDATING, INVESTIGATING, PENDING_START, COMPLIANCE_REVIEW, COMPLIANCE_REJECTED. Example: ACTIVE.one of
ACTIVEDRAFTPAUSEDPREVIEWFAILEDRUNNINGVALIDATINGINVESTIGATINGPENDING_STARTCOMPLIANCE_REVIEWCOMPLIANCE_REJECTED include_deletedboolean- Include deleted workflows (for compliance officers). Defaults to false. Example: false.
limitinteger- Maximum number of items to return. Defaults to 25. Example: 25.
monitoringstring- Filter workflows by monitoring status. One of: true, false. Example: true.one of
truefalse run_statestring- Filter by the latest execution attempt. Use this for run diagnostics, not workflow status UI. One of: FAILED, FINISHED, RUNNING, STOPPED. Example: FINISHED.one of
FAILEDFINISHEDRUNNINGSTOPPED schedule_typestring- Filter workflows by schedule type. RUN_ONCE = no recurring schedule (Complete), RECURRING = has a recurring/real-time schedule (Scheduled). One of: RUN_ONCE, RECURRING. Example: RECURRING.one of
RUN_ONCERECURRING searchstring- Search term to filter workflows by name or workflow ID. Example: products.
skipinteger- Number of items to skip, for paging. Defaults to 0. Example: 0.
statestring- Filter by the persisted state of the long-lived workflow. Use displayState for its computed operational status, statusFilters for dashboard categories, and inSupport for support ownership. DRAFT workflows are excluded by default unless explicitly requested. One of: ACTIVE, DRAFT, PAUSED, PREVIEW, QUEUED, SETUP, COMPLIANCE_REVIEW, COMPLIANCE_REJECTED, NOT_SUPPORTED, ERROR, DELETED. Example: ACTIVE.one of
ACTIVEDRAFTPAUSEDPREVIEWQUEUEDSETUPCOMPLIANCE_REVIEWCOMPLIANCE_REJECTEDNOT_SUPPORTEDERRORDELETED tagsarray- Tags to filter by. Example: ["pricing"]
template_idarray- Template IDs to filter by. Example: ["6a1f2c3d4e5f6a7b8c9d0e44"]
update_intervalstring- Filter workflows by update interval. REAL_TIME matches workflows that run in real time, independent of notification configuration. One of: HOURLY, DAILY, WEEKLY, MONTHLY, REAL_TIME. Example: DAILY.one of
HOURLYDAILYWEEKLYMONTHLYREAL_TIME
kadoa_notification_channel_createCreate a notification channel (EMAIL, SLACK, WEBHOOK or WEBSOCKET) or reuse an identical one.WriteCreate Notification Channel
Create a notification channel (EMAIL, SLACK, WEBHOOK or WEBSOCKET) or reuse an identical one. Returns the channel. Use kadoa_notification_setting_create to send events to it.
Inputs
channel_typestringrequired- Channel type. One of: EMAIL, SLACK, WEBHOOK, WEBSOCKET. Example: WEBHOOK.one of
EMAILSLACKWEBHOOKWEBSOCKET configobjectrequired- Channel settings: for EMAIL {"recipients": [emails]}, for SLACK {"webhookUrl": url}, for WEBHOOK {"webhookUrl": url, "httpMethod": "POST"}. Example: {"webhookUrl":"https://example.com/kadoa","httpMethod":"POST"}
namestringrequired- Channel name. Example: sk-test product prices.
kadoa_notification_channel_updateReplace a notification channel's name, type and config.WriteUpdate Notification Channel
Replace a notification channel's name, type and config. Returns the updated channel. Use this to change recipients or a webhook URL.
- Idempotent
Inputs
channel_idstringrequired- ID of the notification channel. Example: 6a1f2c3d4e5f6a7b8c9d0e66.
channel_typestringrequired- Channel type. One of: EMAIL, SLACK, WEBHOOK, WEBSOCKET. Example: WEBHOOK.one of
EMAILSLACKWEBHOOKWEBSOCKET configobjectrequired- Channel settings: for EMAIL {"recipients": [emails]}, for SLACK {"webhookUrl": url}, for WEBHOOK {"webhookUrl": url, "httpMethod": "POST"}. Example: {"webhookUrl":"https://example.com/kadoa","httpMethod":"POST"}
namestringrequired- Channel name. Example: sk-test product prices.
kadoa_notification_setting_createSend an event type to one or more channels, for one workflow or the whole workspace.WriteCreate Notification Setting
Send an event type to one or more channels, for one workflow or the whole workspace. Returns the new setting. Use kadoa_notification_channel_create first to get channel IDs.
Inputs
event_configurationobjectrequired- Event-specific settings; pass {} today. Example: {}
event_typestringrequired- Event to notify about. One of: workflow_started, workflow_finished, workflow_failed, workflow_sample_finished, workflow_data_change, system_maintenance, service_degradation, credits_low, free_trial_ending. Example: workflow_finished.one of
workflow_startedworkflow_finishedworkflow_failedworkflow_sample_finishedworkflow_data_changesystem_maintenanceservice_degradationcredits_lowfree_trial_ending channel_idsarray- IDs of the notification channels to deliver to. Example: ["6a1f2c3d4e5f6a7b8c9d0e66"]
enabledboolean- Set to false to create it disabled. Example: true.
workflow_idstring- Workflow to watch; leave empty for a workspace-wide setting. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.
kadoa_notification_setting_updateChange a notification setting's event type, channels or enabled flag.WriteUpdate Notification Setting
Change a notification setting's event type, channels or enabled flag. Returns the updated setting. Use this to pause a notification or reroute it.
- Idempotent
Inputs
settings_idstringrequired- ID of the notification setting. Example: 6a1f2c3d4e5f6a7b8c9d0e88.
channel_idsarray- IDs of the notification channels to deliver to. Example: ["6a1f2c3d4e5f6a7b8c9d0e66"]
enabledboolean- true to enable, false to disable. Example: true.
event_configurationobject- Event-specific settings; pass {} today. Example: {}
event_typestring- Event to notify about. One of: workflow_started, workflow_finished, workflow_failed, workflow_sample_finished, workflow_data_change, system_maintenance, service_degradation, credits_low, free_trial_ending. Example: workflow_finished.one of
workflow_startedworkflow_finishedworkflow_failedworkflow_sample_finishedworkflow_data_changesystem_maintenanceservice_degradationcredits_lowfree_trial_ending expected_channel_idsarray- Channel IDs you expect the setting to have now; the update fails if they differ (optimistic check). Example: ["6a1f2c3d4e5f6a7b8c9d0e66"]
kadoa_schema_createCreate a reusable extraction schema with an entity name and fields.WriteCreate Schema
Create a reusable extraction schema with an entity name and fields. Returns the new schema ID. Use it with kadoa_workflow_create (schema_id).
Inputs
fieldsarrayrequired- Fields to extract. Each needs a name, a description, a dataType (STRING, NUMBER, BOOLEAN, DATE, DATETIME, MONEY, IMAGE, LINK, OBJECT, ARRAY) and an example value. Example: [{"name":"title","description":"Product title","dataType":"STRING","example":"Acme Laptop 14"},{"name":"price","description":"Price in USD","dataType":"MONEY...
namestringrequired- Name of the schema. Example: sk-test product prices.
entitystring- Entity name, e.g. Product. Example: Product.
kadoa_schema_updateUpdate a schema's name, entity or fields.WriteUpdate Schema
Update a schema's name, entity or fields. Returns the updated schema. Use this to change what workflows using it extract.
- Idempotent
Inputs
schema_idstringrequired- ID of the schema. Find it with kadoa_schemas_list. Example: 6a1f2c3d4e5f6a7b8c9d0e33.
entitystring- Entity name, e.g. Product. Example: Product.
fieldsarray- Fields to extract. Each needs a name, a description, a dataType (STRING, NUMBER, BOOLEAN, DATE, DATETIME, MONEY, IMAGE, LINK, OBJECT, ARRAY) and an example value. Example: [{"name":"title","description":"Product title","dataType":"STRING","example":"Acme Laptop 14"},{"name":"price","description":"Price in USD","dataType":"MONEY...
namestring- Name of the schema. Example: sk-test product prices.
kadoa_scrapeFetch one URL through Kadoa's proxies and optional headless browser and return its content, as HTML or as markdown for LLMs, with options for method, headers, body, geo location, device, wait conditions, browser actions and captured network responses.WriteScrape URL
Fetch one URL through Kadoa's proxies and optional headless browser and return its content, as HTML or as markdown for LLMs, with options for method, headers, body, geo location, device, wait conditions, browser actions and captured network responses. Uses account credits. Returns the status code, final URL, headers and page content. Use this for a one-off fetch. Use kadoa_workflow_create for structured, repeated extraction.
Inputs
urlstringrequired- URL to fetch. Example: https://example.com/products.
browser_actionsarray- Browser actions to run before capturing, e.g. clicks, typing, scrolling and waits. Example: [{"type":"click","selector":"#load-more"}]
capture_responsesarray- Substrings matched against network response URLs (browser workers only). The worker hooks every response the page makes and returns the body of each whose URL contains any of these substrings, in capturedResponses. Use this to read data that arrives via XHR/fetch and is NOT in the DOM — SPA dashboards (Tableau VizQL, Power BI) where values come back in a JSON/command response. Triggers a browser worker; pair with browserActions (clicks/waits) to drive the requests you want captured. Example: ["/api/products"]
contextobject- Sticky proxy session, e.g. {"sessionId": "sess-1"}. Example: {"sessionId":"sess-1"}
devicestring- Device to emulate, by descriptor name (e.g. 'iPad', 'iPhone 13'). Honored by workers that support device emulation; ignored by the rest. Some sites only serve content for a given device profile. Example: iPhone 13.
fetch_modestring- Fetch mode: http for fast requests, browser for JavaScript rendering and browser actions, or auto for smart routing that starts cheap and escalates when blocked. Default: auto. One of: http, browser, auto. Example: auto.one of
httpbrowserauto formatstring- Content format for HTML pages. markdown converts the page to markdown with navigation, header, and footer stripped — the compact shape to feed an LLM. Non-HTML responses (JSON, binary) and HTML pages over 2 MB are returned unchanged; check the response contentType to see which format was applied. Default: html. One of: html, markdown. Example: markdown.one of
htmlmarkdown headersarray- Request headers, each an object with name and value. Example: [{"name":"Accept-Language","value":"en-US"}]
locationobject- Geo-targeting for the proxy, e.g. {"type": "manual", "isoCode": "US"}. Example: {"type":"manual","isoCode":"US"}
methodstring- HTTP method. Default: GET. One of: GET, POST, PUT, DELETE, PATCH. Example: GET.one of
GETPOSTPUTDELETEPATCH overall_timeoutinteger- Wall-clock deadline for the complete scrape in milliseconds. Default and maximum: 240000. Example: 120000.
proxystring- Proxy tier: auto (smart selection), direct (Squid server egress without location guarantees), dc (datacenter), isp, residential, or stealth to route through the anti-bot providers for sites that block bots. Stealth providers use their own egress and pricing. Default: auto. One of: auto, direct, dc, isp, residential, stealth. Example: auto.one of
autodirectdcispresidentialstealth raw_bodystring- Exact request body text to forward to the upstream URL. Use for endpoints that reject wrapper objects or require a specific JSON/form payload string. Example: {"q":"laptop"}
settle_msinteger- Browser-worker cap (ms) for the best-effort networkidle settle after domcontentloaded. Default 15000. Raise for slow client-rendered pages that need more time for lazy content; lower to return faster. Ignored when waitUntil: networkidle and for non-browser workers. Example: 15000.
timeoutinteger- Per-attempt timeout in milliseconds. Example: 30000.
wait_untilstring- Browser-worker navigation gate. Default (omitted) is domcontentloaded + a bounded best-effort networkidle settle, which returns content even on heavy pages that never go fully idle (ASP.NET, SignalR, ad/telemetry-heavy). Set networkidle to block the whole navigation on full idle (old behavior — only when the page reliably goes idle and you need every lazy request). No-op for non-browser workers. One of: load, domcontentloaded, networkidle, commit. Example: networkidle.one of
loaddomcontentloadednetworkidlecommit
kadoa_template_applyUpdate linked workflows to a given template version.WriteApply Template Version
Update linked workflows to a given template version. Returns per workflow whether it was updated. Use this after kadoa_template_version_publish.
Inputs
target_versionintegerrequired- Template version number to apply. Example: 2.
template_idstringrequired- ID of the template. Find it with kadoa_templates_list. Example: 6a1f2c3d4e5f6a7b8c9d0e44.
workflow_idsarrayrequired- IDs of the linked workflows to update. Example: ["6a1f2c3d4e5f6a7b8c9d0e1f"]
kadoa_template_createCreate an empty workflow template with a name and description.WriteCreate Template
Create an empty workflow template with a name and description. Returns the new template ID. Use kadoa_template_version_publish to give it a prompt and schema, or kadoa_template_from_workflow to start from a workflow.
Inputs
namestringrequired- Template name. Example: sk-test product prices.
descriptionstring- Template description. Example: Daily prices of laptops on example.com.
kadoa_template_duplicateDuplicate a template under a new name.WriteDuplicate Template
Duplicate a template under a new name. Returns the new template. Use this to start a variant.
Inputs
template_idstringrequired- ID of the template. Find it with kadoa_templates_list. Example: 6a1f2c3d4e5f6a7b8c9d0e44.
namestring- Name of the copy. Example: sk-test product prices.
kadoa_template_from_workflowSave a workflow's prompt, schema and settings as a new template, or as a new version of an existing template.WriteSave Workflow as Template
Save a workflow's prompt, schema and settings as a new template, or as a new version of an existing template. Returns the template and version. Use this to reuse a working scraper for other sites.
Inputs
workflow_idstringrequired- ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.
descriptionstring- Description for a new template. Example: Daily prices of laptops on example.com.
include_partsarray- Parts of the workflow to copy, e.g. prompt, schema, notifications. Example: ["prompt","schema"]
namestring- Name for a new template. Example: sk-test product prices.
template_idstring- Existing template to add a version to; leave empty to create a new template. Example: 6a1f2c3d4e5f6a7b8c9d0e44.
kadoa_template_linkLink existing workflows to a template so template versions can be applied to them.WriteLink Workflows to Template
Link existing workflows to a template so template versions can be applied to them. Returns the linked workflows. Use kadoa_template_unlink to detach them.
Inputs
template_idstringrequired- ID of the template. Find it with kadoa_templates_list. Example: 6a1f2c3d4e5f6a7b8c9d0e44.
workflow_idsarrayrequired- Workflow IDs. Example: ["6a1f2c3d4e5f6a7b8c9d0e1f"]
forceboolean- Set to true to link even if a workflow is already linked to another template. Example: false.
kadoa_template_unlinkDetach workflows from a template; they keep their current configuration.WriteUnlink Workflows from Template
Detach workflows from a template; they keep their current configuration. Returns the unlinked workflows. Use kadoa_template_link to link them again.
Inputs
template_idstringrequired- ID of the template. Find it with kadoa_templates_list. Example: 6a1f2c3d4e5f6a7b8c9d0e44.
workflow_idsarrayrequired- Workflow IDs. Example: ["6a1f2c3d4e5f6a7b8c9d0e1f"]
kadoa_template_updateRename a template or change its description.WriteUpdate Template
Rename a template or change its description. Returns the updated template. Use kadoa_template_version_publish to change its content.
- Idempotent
Inputs
template_idstringrequired- ID of the template. Find it with kadoa_templates_list. Example: 6a1f2c3d4e5f6a7b8c9d0e44.
descriptionstring- Template description. Example: Daily prices of laptops on example.com.
namestring- Template name. Example: sk-test product prices.
kadoa_template_version_publishPublish a new version of a template with a prompt, a schema (schema ID or inline fields and entity), validation rules, notifications, frequency and record limit.WritePublish Template Version
Publish a new version of a template with a prompt, a schema (schema ID or inline fields and entity), validation rules, notifications, frequency and record limit. Returns the new version number. Use kadoa_template_apply to roll it out to linked workflows.
Inputs
template_idstringrequired- ID of the template. Find it with kadoa_templates_list. Example: 6a1f2c3d4e5f6a7b8c9d0e44.
frequencyobject- Run frequency, e.g. {"interval": "DAILY"}. Example: {"interval":"DAILY"}
notificationsarray- Notification settings to apply to workflows. Example: []
promptstring- Extraction instructions for the template. Example: Extract every product with title and price.
record_limitinteger- Maximum records per run. Example: 100.
record_limit_managedboolean- true to let the template manage the record limit. Example: false.
schema_entitystring- Entity name for the inline schema. Example: Product.
schema_fieldsarray- Inline schema fields; same shape as fields on kadoa_schema_create. Example: [{"name":"title","description":"Product title","dataType":"STRING","example":"Acme Laptop 14"}]
schema_idstring- ID of the schema. Find it with kadoa_schemas_list. Example: 6a1f2c3d4e5f6a7b8c9d0e33.
schema_validation_rulesobject- Data quality rules per field. Example: {}
kadoa_workflow_compliance_approveApprove a workflow that is waiting for compliance review so it can run.WriteApprove Workflow (Compliance)
Approve a workflow that is waiting for compliance review so it can run. Returns the updated workflow. Use kadoa_workflow_compliance_reject to reject it.
- Idempotent
Inputs
workflow_idstringrequired- ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.
kadoa_workflow_compliance_rejectReject a workflow that is waiting for compliance review, with a reason.WriteReject Workflow (Compliance)
Reject a workflow that is waiting for compliance review, with a reason. Returns the updated workflow. Use kadoa_workflow_compliance_approve to approve it.
- Idempotent
Inputs
reasonstringrequired- Why the workflow is rejected. Example: Scrapes personal data that we are not allowed to collect.
workflow_idstringrequired- ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.
kadoa_workflow_createCreate a scraping workflow for one website from natural-language instructions (user_prompt), an existing schema (schema_id), an inline entity and fields, or a template (template_id).WriteCreate Workflow
Create a scraping workflow for one website from natural-language instructions (user_prompt), an existing schema (schema_id), an inline entity and fields, or a template (template_id). Kadoa builds the scraper, runs a preview and then runs it on the chosen interval; extraction uses account credits. Returns the new workflow ID. Use kadoa_workflow_run to run it again and kadoa_workflow_data_get to read results.
Inputs
urlsarrayrequired- Source URLs to scrape. Several URLs must belong to one website. Example: ["https://example.com/products"]
bypass_previewboolean- Set to true to skip the preview and deploy immediately. Example: false.
descriptionstring- What the workflow does, up to 500 characters. Example: Daily prices of laptops on example.com.
entitystring- Entity name to extract, used with fields, e.g. Product or JobListing. Example: Product.
fieldsarray- Fields to extract. Each needs a name, a description, a dataType (STRING, NUMBER, BOOLEAN, DATE, DATETIME, MONEY, IMAGE, LINK, OBJECT, ARRAY) and an example value. Example: [{"name":"title","description":"Product title","dataType":"STRING","example":"Acme Laptop 14"},{"name":"price","description":"Price in USD","dataType":"MONEY...
intervalstring- How often to run. Example: DAILY.one of
ONLY_ONCEEVERY_10_MINUTESEVERY_20_MINUTESHALF_HOURLYHOURLYTWO_HOURLYTHREE_HOURLYFOUR_HOURLYSIX_HOURLYTWELVE_HOURLYEIGHTEEN_HOURLYDAILYTWO_DAYTHREE_DAYWEEKLYBIWEEKLYTRIWEEKLYFOUR_WEEKSMONTHLYCUSTOM limitinteger- Maximum number of items to scrape per run. Example: 100.
locationobject- Geo location for scraping: {"type": "auto"} or {"type": "manual", "isoCode": "US"}. Example: {"type":"manual","isoCode":"US"}
namestring- Human-readable workflow name. Example: sk-test laptop prices.
schedulesarray- Cron expressions for a custom schedule; they override interval. Example: ["0 9 * * 1-5"]
schema_idstring- ID of an existing schema to extract (from kadoa_schemas_list). Example: 6a1f2c3d4e5f6a7b8c9d0e33.
tagsarray- Tags for organising workflows (at least 2 characters each). Example: ["pricing"]
template_idstring- ID of a published template to instantiate (from kadoa_templates_list). Example: 6a1f2c3d4e5f6a7b8c9d0e44.
timezonestring- IANA time zone for the cron schedules; defaults to UTC. Example: America/New_York.
user_promptstring- Natural-language instructions (10 to 5000 characters) describing what to extract. Give this, schema_id, entity with fields, or template_id. Example: Extract every laptop with its title, price and rating.
kadoa_workflow_metadata_updateUpdate a workflow's name, description, tags, URLs, prompt, schema fields, item limit, update interval, schedules, time zone, location or monitoring; fields you leave out are unchanged.WriteUpdate Workflow
Update a workflow's name, description, tags, URLs, prompt, schema fields, item limit, update interval, schedules, time zone, location or monitoring; fields you leave out are unchanged. Returns the updated workflow. Use this to edit a workflow.
- Idempotent
Inputs
workflow_idstringrequired- ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.
descriptionstring- The new description for the workflow. Example: Daily prices of laptops on example.com.
entitystring- The new entity for the workflow. Example: Product.
limitinteger- Maximum records per run. Pass null to clear the limit and extract all rows. Example: 25.
locationobject- The new location for the workflow. Example: {"type":"manual","isoCode":"US"}
monitoringobject- The monitoring config for the workflow. Example: {"enabled":true}
namestring- The new name for the workflow. Example: sk-test product prices.
schedulesarray- Array of cron expressions for the workflow schedule. Example: ["0 9 * * 1-5"]
schemaarray- The new extraction schema for the workflow. Example: [{"name":"title","description":"Product title","dataType":"STRING","example":"Acme Laptop 14"}]
tagsarray- The tags for the workflow. Example: ["pricing"]
timezonestring- IANA timezone for cron schedules. A timezone-only update preserves existing cron expressions. Example: America/New_York.
update_intervalstring- The new update interval for the workflow. One of: 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, CUSTOM. Example: DAILY.one of
ONLY_ONCEEVERY_10_MINUTESHALF_HOURLYHOURLYTHREE_HOURLYSIX_HOURLYTWELVE_HOURLYEIGHTEEN_HOURLYDAILYTWO_DAYTHREE_DAYWEEKLYBIWEEKLYTRIWEEKLYFOUR_WEEKSMONTHLYCUSTOM urlsarray- List of target URLs for the workflow. Example: ["https://example.com/products"]
user_promptstring- Natural language instructions for the workflow. Example: Extract every laptop with its title, price and rating.
kadoa_workflow_pausePause a workflow's schedule.WritePause Workflow
Pause a workflow's schedule. Returns the updated state. Use kadoa_workflow_resume to restart it.
- Idempotent
Inputs
workflow_idstringrequired- ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.
kadoa_workflow_resumeResume a paused workflow's schedule.WriteResume Workflow
Resume a paused workflow's schedule. Returns the updated state. Use kadoa_workflow_pause to pause it.
- Idempotent
Inputs
workflow_idstringrequired- ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.
kadoa_workflow_runStart a run of a workflow now, optionally with variables, an item limit or as a preview; uses account credits.WriteRun Workflow
Start a run of a workflow now, optionally with variables, an item limit or as a preview; uses account credits. Returns the run (job) ID. Use kadoa_workflow_job_get to follow progress and kadoa_workflow_data_get for results.
Inputs
workflow_idstringrequired- ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.
limitnumber- Optional limit for the number of records to process. Example: 25.
previewboolean- Rerun the preview of a PREVIEW-state workflow instead of starting a production run. Example: true.
variablesobject- Optional variables to pass to the workflow execution. Example: {"category":"laptops"}
kadoa_workflow_scheduleSchedule a single run of a workflow at a date and time.WriteSchedule Workflow Run
Schedule a single run of a workflow at a date and time. Returns the scheduled workflow. Use kadoa_workflow_run to run it now.
- Idempotent
Inputs
workflow_idstringrequired- ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.
datestring- ISO 8601 date and time of the run. Example: 2026-07-01T09:00:00Z.
kadoa_workflow_stopStop the run of a workflow that is in progress.WriteStop Workflow Run
Stop the run of a workflow that is in progress. Returns the updated run state. Use this to cancel a long or mistaken run.
- Idempotent
Inputs
workflow_idstringrequired- ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.
kadoa_workflow_trigger_createCreate a trigger that starts a target workflow when this workflow emits an event (for example when it finishes).WriteCreate Workflow Trigger
Create a trigger that starts a target workflow when this workflow emits an event (for example when it finishes). Returns the new trigger. Use this to chain workflows.
Inputs
event_typestringrequired- Event of this workflow that fires the trigger, e.g. workflow_finished. One of: workflow_started, workflow_finished, workflow_export_completed, workflow_failed, workflow_recovered, workflow_sample_finished, workflow_data_change, workflow_data_quality_change, workflow_health_degraded. Example: workflow_finished.one of
workflow_startedworkflow_finishedworkflow_export_completedworkflow_failedworkflow_recoveredworkflow_sample_finishedworkflow_data_changeworkflow_data_quality_changeworkflow_health_degraded target_workflow_idstringrequired- ID of the workflow to start. Example: 6a1f2c3d4e5f6a7b8c9d0e20.
workflow_idstringrequired- ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.
enabledboolean- Set to false to create it disabled. Example: true.
kadoa_workflow_trigger_updateChange a trigger's event type or enable or disable it.WriteUpdate Workflow Trigger
Change a trigger's event type or enable or disable it. Returns the updated trigger. Use this to pause a workflow chain.
- Idempotent
Inputs
trigger_idstringrequired- ID of the trigger. Example: 6a1f2c3d4e5f6a7b8c9d0e77.
workflow_idstringrequired- ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.
enabledboolean- true to enable, false to disable. Example: true.
event_typestring- Event that fires the trigger. One of: workflow_started, workflow_finished, workflow_export_completed, workflow_failed, workflow_recovered, workflow_sample_finished, workflow_data_change, workflow_data_quality_change, workflow_health_degraded. Example: workflow_finished.one of
workflow_startedworkflow_finishedworkflow_export_completedworkflow_failedworkflow_recoveredworkflow_sample_finishedworkflow_data_changeworkflow_data_quality_changeworkflow_health_degraded
kadoa_workflows_bulk_actionRun, pause, resume, stop, delete, approve or tag up to 50 workflows at once.WriteBulk Workflow Action
Run, pause, resume, stop, delete, approve or tag up to 50 workflows at once. Returns per workflow whether the action succeeded. Use this for batch changes; the single-workflow tools cover one at a time.
Inputs
actionstringrequired- The action to perform on all workflows. One of: run, pause, resume, stop, delete, approve, assignTags. Example: pause.one of
runpauseresumestopdeleteapproveassignTags workflow_idsarrayrequired- IDs of up to 50 workflows. Example: ["6a1f2c3d4e5f6a7b8c9d0e1f"]
paramsobject- Action-specific parameters, e.g. {"tags": ["q3"]} for assignTags. Example: {"tags":["q3"]}
kadoa_notification_channel_deleteDelete a notification channel.DestructiveDelete Notification Channel
Delete a notification channel. Returns a success message. Settings that used it stop delivering there.
- Idempotent
Inputs
channel_idstringrequired- ID of the notification channel. Example: 6a1f2c3d4e5f6a7b8c9d0e66.
kadoa_notification_setting_deleteDelete a notification setting.DestructiveDelete Notification Setting
Delete a notification setting. Returns a success message. Use this to stop a notification.
- Idempotent
Inputs
settings_idstringrequired- ID of the notification setting. Example: 6a1f2c3d4e5f6a7b8c9d0e88.
kadoa_schema_deleteDelete an extraction schema.DestructiveDelete Schema
Delete an extraction schema. Returns a success message. Use this to remove a schema no workflow needs.
- Idempotent
Inputs
schema_idstringrequired- ID of the schema. Find it with kadoa_schemas_list. Example: 6a1f2c3d4e5f6a7b8c9d0e33.
kadoa_template_deleteArchive a template so it can no longer be used for new workflows.DestructiveArchive Template
Archive a template so it can no longer be used for new workflows. Returns a success message. Linked workflows keep running.
- Idempotent
Inputs
template_idstringrequired- ID of the template. Find it with kadoa_templates_list. Example: 6a1f2c3d4e5f6a7b8c9d0e44.
kadoa_workflow_deleteDelete a workflow and stop its schedule.DestructiveDelete Workflow
Delete a workflow and stop its schedule. Returns a success message. Use kadoa_workflow_pause to stop it temporarily instead.
- Idempotent
Inputs
workflow_idstringrequired- ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.
kadoa_workflow_rule_deleteDelete the data quality rules of one field of a workflow.DestructiveDelete Workflow Field Rules
Delete the data quality rules of one field of a workflow. Returns a success message. Use kadoa_workflow_rules_get to see the rules first.
- Idempotent
Inputs
field_namestringrequired- Name of the field whose rules to delete. Example: price.
workflow_idstringrequired- ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.
kadoa_workflow_trigger_deleteDelete a trigger of a workflow.DestructiveDelete Workflow Trigger
Delete a trigger of a workflow. Returns a success message. Use kadoa_workflow_trigger_update to disable it instead.
- Idempotent
Inputs
trigger_idstringrequired- ID of the trigger. Example: 6a1f2c3d4e5f6a7b8c9d0e77.
workflow_idstringrequired- ID of the workflow. Find it with kadoa_workflows_list. Example: 6a1f2c3d4e5f6a7b8c9d0e1f.
No tools match.