Create a new workflow
Create a workflow from natural-language instructions, an existing schema, an inline schema, raw-data output options, or a published template.
Authorizations
API key for authentication
Body
Body
- WorkflowFromTemplate
- PromptWorkflow
- RawDataWorkflow
- WorkflowWithExistingSchema
- WorkflowWithEntityAndFields
Create a workflow by instantiating a published template. Only urls and templateId are required; prompt, schema, frequency, and notifications are inherited from the template version. templateVersion is optional — omit it to use the latest published version.
Example: {"urls": ["https://example.com"], "templateId": "..."}
List of URLs to scrape. Can be a single URL or multiple URLs to scrape across different pages or domains.
1ID of the template to instantiate.
Human-readable name for this workflow (e.g., 'Product Catalog Scraper')
1Detailed description of what this workflow does and why it was created (maximum 500 characters)
500Tags for organizing and categorizing workflows (minimum 2 characters per tag)
2How frequently this workflow should run (ONLY_ONCE, HOURLY, DAILY, WEEKLY, etc.)
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 Cron expressions for custom schedules. Overrides the interval setting for fine-grained control
IANA timezone for cron schedules (e.g. 'America/New_York'). Defaults to UTC. Cron schedules only.
Geographic location for scraping. Use 'auto' for automatic detection or 'manual' to specify a country
Skip preview and validation, deploy scraper immediately. Use with caution - set to true only when you're confident the configuration is correct
Additional data for the workflow (e.g. IDs from your system to link data)
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)
- BrowserInteraction
- WebExtensionInteraction
Enable data quality validation. When true, scraped data is validated against the schema and anomalies are detected
Maximum number of items to scrape. Useful for limiting scope during development or cost control. Pass null to clear an existing limit (unlimited).
x >= 1Optional version (integer) of the template to instantiate. Omit to use the latest published version (resolved once at request time). Provide it to pin a specific version.
x >= 1Workflow-specific instructions added to the selected template prompt. The template prompt remains template-owned and this text survives template updates.
10 - 5000