Skip to main content
POST
Create a new workflow

Authorizations

x-api-key
string
header
required

API key for authentication

Body

application/json

Body

Create a workflow using natural-language instructions. Navigation is handled automatically for new integrations.

urls
string<uri>[]
required

List of URLs to scrape. Can be a single URL or multiple URLs to scrape across different pages or domains.

Minimum array length: 1
userPrompt
string
required

Natural language instructions for the workflow (10-5000 characters). Describe what data to extract and how to navigate the site

Required string length: 10 - 5000
name
string

Human-readable name for this workflow (e.g., 'Product Catalog Scraper')

Minimum string length: 1
description
string

Detailed description of what this workflow does and why it was created (maximum 500 characters)

Maximum string length: 500
tags
string[]

Tags for organizing and categorizing workflows (minimum 2 characters per tag)

Minimum string length: 2
limit
integer | null

Maximum number of items to scrape. Useful for limiting scope during development or cost control. Pass null to clear an existing limit (unlimited).

Required range: x >= 1
location
Location · object

Geographic location for scraping. Use 'auto' for automatic detection or 'manual' to specify a country

monitoring
MonitoringConfig · object

Monitoring configuration

interval
enum<string>

How frequently this workflow should run (ONLY_ONCE, HOURLY, DAILY, WEEKLY, etc.)

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 expressions for custom schedules. Overrides the interval setting for fine-grained control

timezone
string

IANA timezone for cron schedules (e.g. 'America/New_York'). Defaults to UTC. Cron schedules only.

bypassPreview
boolean
default:false

Skip preview and validation, deploy scraper immediately. Use with caution - set to true only when you're confident the configuration is correct

interactions
(BrowserInteraction · object | WebExtensionInteraction · object)[]

Browser interactions to perform before scraping (e.g., clicking buttons, filling forms, scrolling). See Interaction schema for available action types

Browser interaction definition. Examples:

  • CLICK: {type: 'CLICK', selector: '#submit-btn'}
  • TYPE: {type: 'TYPE', text: 'hello world'}
  • WAIT: {type: 'WAIT', timeMs: 2000}
  • GOTO: {type: 'GOTO', url: 'https://example.com'}
  • ENTER/TAB/BACKSPACE/DELETE/REFRESH/NAVIGATE_BACK/SCROLL/HOVER/SELECT/LOAD/KEYPRESS: {type: 'ENTER'} (no additional parameters needed)
dataValidationEnabled
boolean

Enable data quality validation. When true, scraped data is validated against the schema and anomalies are detected

additionalData
any | null

Additional data for the workflow (e.g. IDs from your system to link data)

templateId
string<uuid>

Optional: ID of the template this workflow was created from. Records provenance only — the template's config is cloned at creation, not synced.

schemaId
string

Optional: Schema ID to use with prompt-driven extraction

entity
string

Optional: Entity name for prompt-driven extraction

Minimum string length: 1
fields
(DataField · object | ClassificationField · object)[]

Optional: Additional extraction fields to guide the workflow

Extraction field schema

Response

201

Response for workflow creation

error
enum<boolean>
required

Error flag (always false on success)

Available options:
false
success
boolean
required

Success flag

workflowId
string
required

ID of the created workflow

message
string
required

Success message