# Kadoa Documentation

- [Introduction](https://docs.kadoa.com/docs/introduction.md): Kadoa automates web scraping at scale with AI. Our AI agents extract, transform, and integrate data from any website. <br/>Effortless, reliable, compliant.
- [Overview](https://docs.kadoa.com/docs/workflows/overview.md): What a workflow is and how to build one
- [Prompts](https://docs.kadoa.com/docs/workflows/prompts.md): Tell Kadoa what to extract and how to get there
- [Variables](https://docs.kadoa.com/docs/workflows/variables.md): Create reusable values for your workflow prompts
- [Secret Variables](https://docs.kadoa.com/docs/workflows/secrets.md): Store write-only credentials and make them available only to selected workflows
- [Schemas](https://docs.kadoa.com/docs/workflows/schemas.md): Create and manage reusable schemas that define what data to extract
- [Lifecycle](https://docs.kadoa.com/docs/workflows/lifecycle.md): Understand workflow status, runs, and when action is needed
- [Error Handling](https://docs.kadoa.com/docs/workflows/error-handling.md): Understand failures, get notified, and track workflow reliability
- [Templates](https://docs.kadoa.com/docs/templates.md): Reusable, versioned configurations that standardize prompt, schema, data quality, notifications, and frequency across workflows
- [Notifications](https://docs.kadoa.com/docs/notifications.md): Get notified when workflow events occur
- [Change Detection](https://docs.kadoa.com/docs/change-detection.md): How Kadoa detects and classifies data changes between workflow runs
- [Data Quality](https://docs.kadoa.com/docs/data-quality.md): Per-field rules and platform metrics that surface quality issues in your workflow data
- [Observability](https://docs.kadoa.com/docs/observability.md): Reliability, throughput, and incident metrics for every workflow in your workspace
- [Usage & Billing](https://docs.kadoa.com/docs/usage.md): Usage-based pricing that charges for active workflows
- [Workspaces](https://docs.kadoa.com/docs/workspaces.md): Manage your workflows and collaborate using workspaces.
- [Support Center](https://docs.kadoa.com/docs/support-center.md): Submit support requests and track issues directly from the dashboard
- [Introduction](https://docs.kadoa.com/docs/security/introduction.md): Learn more about our data security practices and compliance measures.
- [IP ACL](https://docs.kadoa.com/docs/security/ip-allowlist.md): Restrict access to your Kadoa workspace to a trusted set of IP addresses.
- [SCIM](https://docs.kadoa.com/docs/security/scim.md): SCIM, or System for Cross-domain Identity Management allows for the automation of user provisioning for your Kadoa workspace.
- [Single Sign-On (SSO)](https://docs.kadoa.com/docs/security/sso.md): Configure SAML-based Single Sign-On for centralized identity management
- [Overview](https://docs.kadoa.com/docs/security/compliance.md): Learn more about our built-in compliance layer
- [Compliance Center](https://docs.kadoa.com/docs/compliance-center.md): View compliance rules and access audit tools for your team's workflows
- [Getting Started](https://docs.kadoa.com/docs/ui/getting-started.md): Build a web dataset from a single prompt with the Kadoa Assistant
- [Kadoa Assistant](https://docs.kadoa.com/docs/ui/assistant.md): Change and debug your workflows by chatting in natural language
- [AI personalization](https://docs.kadoa.com/docs/ui/ai-personalization.md): Give your workspace's AI agents standing instructions they follow on every new workflow
- [Sources](https://docs.kadoa.com/docs/ui/workflows/sources.md): Choose the URLs a workflow extracts from
- [Define Schema](https://docs.kadoa.com/docs/ui/workflows/schemas.md): Set up data schemas when creating workflows in the UI
- [Scheduling](https://docs.kadoa.com/docs/ui/workflows/scheduling.md)
- [Triggers](https://docs.kadoa.com/docs/ui/workflows/triggers.md): Start one workflow automatically when another workflow's data changes
- [Human-in-the-Loop](https://docs.kadoa.com/docs/ui/workflows/human-in-the-loop.md): How Kadoa's human-in-the-loop system ensures data quality and handles edge cases
- [Templates](https://docs.kadoa.com/docs/ui/templates.md): Create and manage reusable workflow configurations in the Kadoa Dashboard
- [Export & Access Data](https://docs.kadoa.com/docs/ui/data-export.md): View and export your extracted data from the Kadoa dashboard
- [Notifications](https://docs.kadoa.com/docs/ui/notifications.md): Get notified when workflow events occur in the Kadoa Dashboard
- [Data Quality](https://docs.kadoa.com/docs/ui/data-quality.md): View per-field validation rules and platform metrics for a workflow, and edit rules from the dashboard
- [Team Management](https://docs.kadoa.com/docs/ui/team-management.md): Add members, manage invitations, and assign roles in your team workspace
- [Getting Started](https://docs.kadoa.com/docs/sdk/introduction.md): Create and run your first extraction using SDK, CLI, MCP Server, or REST API
- [Create Workflows](https://docs.kadoa.com/docs/sdk/workflows/create.md): Create and manage workflows programmatically using SDK, CLI, MCP Server, or REST API
- [Manage Workflows](https://docs.kadoa.com/docs/sdk/workflows/manage.md): List, retrieve, and manage existing workflows
- [Schedule & Run Workflows](https://docs.kadoa.com/docs/sdk/workflows/scheduling.md): Configure scheduling, run workflows manually, and check execution status
- [Kadoa Assistant](https://docs.kadoa.com/docs/sdk/workflows/assistant.md): Build, update, and monitor workflows with the Kadoa Assistant
- [Schemas](https://docs.kadoa.com/docs/sdk/schemas/overview.md): Create and manage reusable schemas programmatically using the SDK
- [Variables](https://docs.kadoa.com/docs/sdk/variables/overview.md): Create and manage reusable variables programmatically using the SDK
- [Templates](https://docs.kadoa.com/docs/sdk/templates/overview.md): Create and manage reusable workflow templates programmatically using the SDK
- [Notifications](https://docs.kadoa.com/docs/sdk/notifications/overview.md): Get workflow notifications programmatically
- [Overview](https://docs.kadoa.com/docs/integrations/overview.md): Choose where Kadoa sends your data
- [How data integrations work](https://docs.kadoa.com/docs/integrations/data-integrations.md): What Kadoa delivers, when, and where to see it
- [Amazon S3](https://docs.kadoa.com/docs/integrations/amazon-s3.md): Deliver data from completed runs to your S3 bucket
- [Google Cloud Storage](https://docs.kadoa.com/docs/integrations/google-cloud-storage.md): Deliver data from completed runs to a Cloud Storage bucket
- [SFTP](https://docs.kadoa.com/docs/integrations/sftp.md): Deliver data from completed runs to your SFTP server
- [Snowflake](https://docs.kadoa.com/docs/integrations/snowflake.md): Query data from completed runs through read-only Snowflake views
- [Databricks](https://docs.kadoa.com/docs/integrations/databricks.md): Query data from completed runs through Delta Sharing
- [Webhooks](https://docs.kadoa.com/docs/integrations/webhooks.md): Receive HTTP notifications when workflow events occur
- [WebSockets](https://docs.kadoa.com/docs/integrations/websockets.md): Receive real-time event notifications via WebSockets
- [REST API](https://docs.kadoa.com/docs/integrations/rest-api.md): Pull data from Kadoa on-demand using the REST API
- [SDK](https://docs.kadoa.com/docs/integrations/sdk.md): Access and retrieve extracted data using the Kadoa SDK
- [Command Line Interface (CLI)](https://docs.kadoa.com/docs/sdk/cli.md): Manage Kadoa workflows from the terminal
- [MCP Server](https://docs.kadoa.com/docs/sdk/mcp.md)
- [MCP Service Connector](https://docs.kadoa.com/docs/sdk/mcp-service-connector.md)
- [Google Sheets](https://docs.kadoa.com/docs/integrations/google-sheets.md)
- [Email](https://docs.kadoa.com/docs/integrations/email.md): Receive email notifications when workflow events occur
- [Slack](https://docs.kadoa.com/docs/integrations/slack.md): Receive workflow notifications in Slack
- [Introduction](https://docs.kadoa.com/api-reference/introduction.md)
- [Start crawl](https://docs.kadoa.com/api-reference/crawling/start-crawling-session.md): Create a crawling configuration and start a session in one operation (equivalent to v4/crawl)
- [Get session status](https://docs.kadoa.com/api-reference/crawling/crawling-session-status.md): Get the current status of a crawling session
- [Get paginated session pages](https://docs.kadoa.com/api-reference/crawling/get-crawled-pages.md): Get a paginated list of pages for a crawling session
- [Get session page content](https://docs.kadoa.com/api-reference/crawling/get-crawled-page-meta.md): Get the content of a specific page from a crawling session in HTML or Markdown format
- [Get workflow data by ID](https://docs.kadoa.com/api-reference/workflows/get-workflow-data-by-id.md)
- [Create workflow data export](https://docs.kadoa.com/api-reference/workflows/create-workflow-data-export.md): Materializes the full result set as CSV, JSON, or Parquet to object storage and returns a self-authenticating URL that can be opened by external clients (Claude Desktop, Claude for Excel, code execution sandboxes, browsers) without an Authorization header. The URL is HMAC-signed and bound to the exp…
- [Download workflow data export](https://docs.kadoa.com/api-reference/workflows/download-workflow-data-export.md): Streams a file previously materialized via GET /v4/workflows/{workflowId}/data/export. Sets Content-Disposition: attachment so browsers trigger a download.
- [Get a list of workflows](https://docs.kadoa.com/api-reference/workflows/get-all-workflows.md): Retrieves a list of workflows with pagination and search capabilities
- [Get workflow by ID](https://docs.kadoa.com/api-reference/workflows/get-workflow-by-id.md): Retrieves detailed information about a specific workflow. This endpoint requires authentication and proper team access permissions.
- [Create a new workflow](https://docs.kadoa.com/api-reference/workflows/create-a-new-workflow.md): Create a workflow from natural-language instructions, an existing schema, an inline schema, raw-data output options, or a published template.
- [Run a workflow](https://docs.kadoa.com/api-reference/workflows/run-a-workflow.md)
- [Schedule a workflow](https://docs.kadoa.com/api-reference/workflows/schedule-a-workflow.md)
- [Update workflow metadata](https://docs.kadoa.com/api-reference/workflows/update-workflow-metadata.md)
- [Pause a workflow](https://docs.kadoa.com/api-reference/workflows/pause-a-workflow.md)
- [Delete a workflow](https://docs.kadoa.com/api-reference/workflows/delete-a-workflow.md)
- [Resume or unpause a workflow](https://docs.kadoa.com/api-reference/workflows/resume-a-workflow.md): Unpauses a paused workflow, or resumes a preview/error workflow.
- [Get the workflow run history](https://docs.kadoa.com/api-reference/workflows/get-the-workflow-history.md)
- [Get workflow quality metrics](https://docs.kadoa.com/api-reference/workflows/get-workflow-quality-metrics.md): Returns the data quality metric results for a workflow run, plus the run's total data quality issue count.
- [List workflow triggers](https://docs.kadoa.com/api-reference/workflows/list-workflow-triggers.md): Get the triggers where the specified workflow is the source (`triggers`) and the triggers where it is the target (`incoming`). Outgoing rows are always returned; each carries `targetWorkflowName` when the caller can access the target. Incoming rows are returned only when the caller can access the so…
- [Create a workflow trigger](https://docs.kadoa.com/api-reference/workflows/create-workflow-trigger.md): Create a trigger that fires when the source workflow emits an event. The target must share the source ownership scope (same team for team workflows, or the same user for personal workflows) and must not be a realtime workflow. Superadmins are subject to the same scope check on the public endpoint.
- [Get a specific trigger](https://docs.kadoa.com/api-reference/workflows/get-workflow-trigger.md)
- [Update a trigger](https://docs.kadoa.com/api-reference/workflows/update-workflow-trigger.md): Update trigger properties (eventType, enabled)
- [Delete a trigger](https://docs.kadoa.com/api-reference/workflows/delete-workflow-trigger.md)
- [Create or continue an Assistant session](https://docs.kadoa.com/api-reference/assistant/create-or-continue-session.md): Creates a draft workflow-backed Assistant session. Explicit productType=realtime dispatches the Julie realtime lane after realtime notification settings are provisioned.
- [Send a Workflow Assistant message](https://docs.kadoa.com/api-reference/assistant/send-workflow-message.md): Bootstraps or reuses the workflow's customer Assistant session and enqueues update instructions without changing the workflow ID.
- [Get Workflow Assistant timeline](https://docs.kadoa.com/api-reference/assistant/get-workflow-timeline.md): Returns user messages, Assistant messages, and clarification questions from the latest Lighthouse/Shelly or Julie customer thread. Internal and operations lanes are never selectable.
- [Get Assistant pause state](https://docs.kadoa.com/api-reference/assistant/get-pause-state.md)
- [Answer an Assistant question](https://docs.kadoa.com/api-reference/assistant/answer-question.md)
- [Interrupt an Assistant session](https://docs.kadoa.com/api-reference/assistant/interrupt-session.md)
- [Resume an Assistant session](https://docs.kadoa.com/api-reference/assistant/resume-session.md): Resumes with the persona persisted on the session, preserving Lighthouse versus Julie behavior.
- [Stop an Assistant session](https://docs.kadoa.com/api-reference/assistant/stop-session.md)
- [Get Assistant strategy](https://docs.kadoa.com/api-reference/assistant/get-strategy.md): Returns strategy null when the session exists but no build strategy is available yet.
- [Create a variable](https://docs.kadoa.com/api-reference/variables/create-a-variable.md): Create a new key-value variable. Keys must be unique within the team/user scope. Variables can be referenced in workflow prompts using @variableKey syntax.
- [List all variables](https://docs.kadoa.com/api-reference/variables/list-all-variables.md): Retrieve all variables in the current team/user scope (max 100).
- [Get a variable](https://docs.kadoa.com/api-reference/variables/get-a-variable.md): Retrieve a specific variable by its ID.
- [Update a variable](https://docs.kadoa.com/api-reference/variables/update-a-variable.md): Update an existing variable. At least one field (key, value, or dataType) must be provided.
- [Delete a variable](https://docs.kadoa.com/api-reference/variables/delete-a-variable.md): Permanently delete a variable by its ID. A secret bound to a connector returns 409 Conflict.
- [Get all data changes](https://docs.kadoa.com/api-reference/monitoring/get-all-changes.md)
- [Get data change by ID](https://docs.kadoa.com/api-reference/monitoring/get-change-by-id.md)
- [Create a new notification channel](https://docs.kadoa.com/api-reference/notifications/create-notification-channel.md)
- [Create a new notification settings](https://docs.kadoa.com/api-reference/notifications/create-notification-settings.md)
- [Delete a notification channel](https://docs.kadoa.com/api-reference/notifications/delete-notification-channel.md)
- [Delete a notification settings](https://docs.kadoa.com/api-reference/notifications/delete-notification-settings.md)
- [Retrieve a specific event type details](https://docs.kadoa.com/api-reference/notifications/get-event-type.md)
- [Retrieve all available notification event types](https://docs.kadoa.com/api-reference/notifications/get-event-types.md)
- [Retrieve a specific notification channel](https://docs.kadoa.com/api-reference/notifications/get-notification-channel.md)
- [Retrieve all notification channels](https://docs.kadoa.com/api-reference/notifications/get-notification-channels.md)
- [Retrieve a specific notification settings](https://docs.kadoa.com/api-reference/notifications/get-notification-setting.md)
- [Retrieve all notification settings](https://docs.kadoa.com/api-reference/notifications/get-notification-settings.md)
- [Test a notification settings with mock data](https://docs.kadoa.com/api-reference/notifications/test-notifications.md)
- [Update a notification channel](https://docs.kadoa.com/api-reference/notifications/update-notification-channel.md)
- [Update a notification settings](https://docs.kadoa.com/api-reference/notifications/update-notification-settings.md)
- [List all schemas](https://docs.kadoa.com/api-reference/schemas/get-all-schemas.md): Retrieve all schemas accessible by the authenticated user
- [Get schema by ID](https://docs.kadoa.com/api-reference/schemas/get-schema-by-id.md): Retrieve a specific schema by its unique identifier
- [Create new schema](https://docs.kadoa.com/api-reference/schemas/create-schema.md): Create a new data schema with specified fields and entity type
- [Update existing schema](https://docs.kadoa.com/api-reference/schemas/update-schema.md): Update schema metadata or create a new revision with updated fields
- [Delete schema](https://docs.kadoa.com/api-reference/schemas/delete-schema.md): Delete a schema and all its revisions
- [Get all available locations](https://docs.kadoa.com/api-reference/locations/get-all-locations.md)
- [Get data quality rules](https://docs.kadoa.com/api-reference/data-quality/get-rules.md): Retrieve the per-field data quality rules persisted on a workflow
- [Upsert data quality rules](https://docs.kadoa.com/api-reference/data-quality/upsert-rules.md): Patch-merge the per-field data quality rules on a workflow; rules take effect on the next run
- [Delete data quality rules for a field](https://docs.kadoa.com/api-reference/data-quality/delete-field-rules.md): Remove all data quality rules for a single schema field on a workflow
- [List templates](https://docs.kadoa.com/api-reference/templates/list-templates.md): Retrieve all templates for the current team
- [Get template](https://docs.kadoa.com/api-reference/templates/get-template.md): Retrieve a template by ID, including its version history
- [Create template](https://docs.kadoa.com/api-reference/templates/create-template.md): Create a new template for reusing prompts, schemas, and settings across workflows
- [Update template](https://docs.kadoa.com/api-reference/templates/update-template.md): Update a template's name or description
- [Delete template](https://docs.kadoa.com/api-reference/templates/delete-template.md): Archive a template (soft delete)
- [Create template version](https://docs.kadoa.com/api-reference/templates/create-version.md): Publish a new version of a template with prompt, schema, validation, and notification settings
- [List template schemas](https://docs.kadoa.com/api-reference/templates/list-schemas.md): Retrieve all schemas linked to a template
- [List template workflows](https://docs.kadoa.com/api-reference/templates/list-workflows.md): Retrieve all workflows linked to a template
- [Apply template update](https://docs.kadoa.com/api-reference/templates/apply-update.md): Apply a template version's settings to linked workflows
- [Preview schema change](https://docs.kadoa.com/api-reference/templates/preview-schema-change.md): Preview the data a schema change would produce for one linked workflow, without applying the template or running the workflow
- [Link workflows to template](https://docs.kadoa.com/api-reference/templates/link-workflows.md): Link one or more workflows to a template
- [Unlink workflows from template](https://docs.kadoa.com/api-reference/templates/unlink-workflows.md): Unlink one or more workflows from a template
- [Save workflow as template](https://docs.kadoa.com/api-reference/templates/save-from-workflow.md): Create a new template from an existing workflow's configuration
- [List support issues](https://docs.kadoa.com/api-reference/support/get-support-issues.md): Retrieve all support issues for the current customer
- [Create support issue](https://docs.kadoa.com/api-reference/support/create-support-issue.md): Create a new support ticket linked to a workflow or data change
- [Update support issue](https://docs.kadoa.com/api-reference/support/update-support-issue.md): Update the priority or status of an existing support issue
- [Get issue states](https://docs.kadoa.com/api-reference/support/get-support-states.md): Retrieve the available states for support issues
- [Bulk approve validation rules](https://docs.kadoa.com/api-reference/data-validation/approve-rules.md): Approve multiple preview validation rules at once to activate them for automatic validation runs
- [Bulk delete validation rules](https://docs.kadoa.com/api-reference/data-validation/delete-rules.md): Delete multiple validation rules at once with an optional reason for audit trail
- [Generate validation rules](https://docs.kadoa.com/api-reference/data-validation/generate-rules.md): Use AI to automatically generate data validation rules based on sample data or specific requirements
- [Generate targeted rules](https://docs.kadoa.com/api-reference/data-validation/generate-targeted-rules.md): Create specific validation rules targeting particular data fields or patterns using AI analysis
- [Get latest validation](https://docs.kadoa.com/api-reference/data-validation/latest-validation.md): Retrieve the most recent validation results for a specific job within a workflow
- [List validation rules](https://docs.kadoa.com/api-reference/data-validation/list-rules.md): Retrieve a paginated list of data validation rules with optional filtering by workflow, status, and other criteria
- [Toggle validation](https://docs.kadoa.com/api-reference/data-validation/toggle-validation.md): Enable or disable data validation for a specific workflow with optional reason tracking
- [Get validation configuration](https://docs.kadoa.com/api-reference/data-validation/validation-config.md): Retrieve the current data validation configuration for a specific workflow, including enabled rules and alerting settings

## OpenAPI Specs

- [openapi](https://api.kadoa.com/openapi)

## Optional

- [Changelog](https://www.kadoa.com/changelog)
- [Trust Center](https://trust.kadoa.com)
- [Contact Us](https://www.kadoa.com/contact)