# Kadoa Documentation ## Docs - [Get session status](https://docs.kadoa.com/api-reference/crawling/crawling-session-status.md): Get the current status of 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 paginated session pages](https://docs.kadoa.com/api-reference/crawling/get-crawled-pages.md): Get a paginated list of pages for a crawling session - [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) - [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 - [Introduction](https://docs.kadoa.com/api-reference/introduction.md) - [Get all available locations](https://docs.kadoa.com/api-reference/locations/get-all-locations.md) - [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) - [Create new schema](https://docs.kadoa.com/api-reference/schemas/create-schema.md): Create a new data schema with specified fields and entity type - [Delete schema](https://docs.kadoa.com/api-reference/schemas/delete-schema.md): Delete a schema and all its revisions - [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 - [Update existing schema](https://docs.kadoa.com/api-reference/schemas/update-schema.md): Update schema metadata or create a new revision with updated fields - [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 - [List support issues](https://docs.kadoa.com/api-reference/support/get-support-issues.md): Retrieve all support issues for the current customer - [Get issue states](https://docs.kadoa.com/api-reference/support/get-support-states.md): Retrieve the available states for support issues - [Update support issue](https://docs.kadoa.com/api-reference/support/update-support-issue.md): Update the priority or status of an existing support issue - [Apply template update](https://docs.kadoa.com/api-reference/templates/apply-update.md): Apply a template version's settings to linked workflows - [Create template](https://docs.kadoa.com/api-reference/templates/create-template.md): Create a new template for reusing prompts, schemas, and settings across workflows - [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 - [Delete template](https://docs.kadoa.com/api-reference/templates/delete-template.md): Archive a template (soft delete) - [Get template](https://docs.kadoa.com/api-reference/templates/get-template.md): Retrieve a template by ID, including its version history - [Link workflows to template](https://docs.kadoa.com/api-reference/templates/link-workflows.md): Link one or more workflows to a template - [List template schemas](https://docs.kadoa.com/api-reference/templates/list-schemas.md): Retrieve all schemas linked to a template - [List templates](https://docs.kadoa.com/api-reference/templates/list-templates.md): Retrieve all templates for the current team - [List template workflows](https://docs.kadoa.com/api-reference/templates/list-workflows.md): Retrieve all workflows linked to 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 - [Unlink workflows from template](https://docs.kadoa.com/api-reference/templates/unlink-workflows.md): Unlink one or more workflows from a template - [Update template](https://docs.kadoa.com/api-reference/templates/update-template.md): Update a template's name or description - [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. - [Delete a variable](https://docs.kadoa.com/api-reference/variables/delete-a-variable.md): Permanently delete a variable by its ID. - [Get a variable](https://docs.kadoa.com/api-reference/variables/get-a-variable.md): Retrieve a specific variable by its ID. - [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). - [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. - [Create a new workflow](https://docs.kadoa.com/api-reference/workflows/create-a-new-workflow.md): Create a workflow using natural-language instructions, with optional schema guidance for structured extraction. - [Delete a workflow](https://docs.kadoa.com/api-reference/workflows/delete-a-workflow.md) - [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 the workflow run history](https://docs.kadoa.com/api-reference/workflows/get-the-workflow-history.md) - [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. - [Get workflow data by ID](https://docs.kadoa.com/api-reference/workflows/get-workflow-data-by-id.md) - [Pause a workflow](https://docs.kadoa.com/api-reference/workflows/pause-a-workflow.md) - [Resume a workflow](https://docs.kadoa.com/api-reference/workflows/resume-a-workflow.md): Resumes/Activates a paused, preview, or error workflow. - [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) - [Change Detection](https://docs.kadoa.com/docs/change-detection.md): How Kadoa detects and classifies data changes between workflow runs - [Compliance Center](https://docs.kadoa.com/docs/compliance-center.md): View compliance rules and access audit tools for your team's workflows - [Data Validation](https://docs.kadoa.com/docs/data-validation.md): Understanding validation rules, states, and how data quality is enforced - [Cloud Storage](https://docs.kadoa.com/docs/integrations/cloud-storage.md): Automatic data delivery to S3, GCS, and Azure Blob Storage - [Email](https://docs.kadoa.com/docs/integrations/email.md): Receive email notifications when workflow events occur - [Google Sheets](https://docs.kadoa.com/docs/integrations/google-sheets.md) - [Overview](https://docs.kadoa.com/docs/integrations/overview.md): Choose how to receive your extracted data - [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 - [Slack](https://docs.kadoa.com/docs/integrations/slack.md): Build web scrapers through natural conversation in Slack. - [Snowflake Integration](https://docs.kadoa.com/docs/integrations/snowflake.md): Load Kadoa data into Snowflake via S3 and Snowpipe - [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 - [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.
Effortless, reliable, compliant. - [Notifications](https://docs.kadoa.com/docs/notifications.md): Get notified when workflow events occur - [Crawling](https://docs.kadoa.com/docs/sdk/crawling.md): Crawl websites and convert pages into structured JSON or markdown. - [Data Validation](https://docs.kadoa.com/docs/sdk/data-validation.md): Configure data validation rules programmatically - [Getting Started](https://docs.kadoa.com/docs/sdk/introduction.md): Get up and running with Kadoa in 2 minutes using SDK, MCP Server, or REST API - [MCP Server](https://docs.kadoa.com/docs/sdk/mcp.md): Use Kadoa from ChatGPT, Claude.ai, Claude Code, Cursor, and other MCP clients - [Notifications](https://docs.kadoa.com/docs/sdk/notifications/overview.md): Get workflow notifications programmatically - [Schemas](https://docs.kadoa.com/docs/sdk/schemas/overview.md): Create and manage reusable schemas programmatically using the SDK - [Templates](https://docs.kadoa.com/docs/sdk/templates/overview.md): Create and manage reusable workflow templates programmatically using the SDK - [Variables](https://docs.kadoa.com/docs/sdk/variables/overview.md): Create and manage reusable variables programmatically using the SDK - [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 - [Overview](https://docs.kadoa.com/docs/security/compliance.md): Learn more about our built-in compliance layer - [Introduction](https://docs.kadoa.com/docs/security/introduction.md): Learn more about our data security practices and compliance measures. - [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 - [Support Center](https://docs.kadoa.com/docs/support-center.md): Submit support requests and track issues directly from the dashboard - [Templates](https://docs.kadoa.com/docs/templates.md): Reusable, versioned configurations that standardize prompt, schema, and notifications across workflows - [Export & Access Data](https://docs.kadoa.com/docs/ui/data-export.md): View and export your extracted data from the Kadoa dashboard - [Data Validation](https://docs.kadoa.com/docs/ui/data-validation.md) - [Getting Started](https://docs.kadoa.com/docs/ui/getting-started.md): Learn how to extract data from websites - [Notifications](https://docs.kadoa.com/docs/ui/notifications.md): Get notified when workflow events occur in the Kadoa Dashboard - [Team Management](https://docs.kadoa.com/docs/ui/team-management.md): Add members, manage invitations, and assign roles in your team workspace - [Templates](https://docs.kadoa.com/docs/ui/templates.md): Create and manage reusable workflow configurations in the Kadoa Dashboard - [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 - [Scheduling](https://docs.kadoa.com/docs/ui/workflows/scheduling.md) - [Define Schema](https://docs.kadoa.com/docs/ui/workflows/schemas.md): Set up data schemas when creating workflows in the UI - [Sources](https://docs.kadoa.com/docs/ui/workflows/sources.md): Configure source URLs for data extraction in the UI - [Usage](https://docs.kadoa.com/docs/usage.md) - [Error Handling & Monitoring](https://docs.kadoa.com/docs/workflows/error-handling.md): Understand failures, get notified, and track scraper reliability - [Overview](https://docs.kadoa.com/docs/workflows/overview.md) - [Prompts](https://docs.kadoa.com/docs/workflows/prompts.md): Tell Kadoa what to extract and how to get there - [Schemas](https://docs.kadoa.com/docs/workflows/schemas.md): Create and manage reusable schemas that define what data to extract - [Secret Variables](https://docs.kadoa.com/docs/workflows/secrets.md): How Kadoa securely handles sensitive data like passwords and API keys - [States](https://docs.kadoa.com/docs/workflows/states.md): Understand workflow status and lifecycle - [Variables](https://docs.kadoa.com/docs/workflows/variables.md): Create reusable values for your workflow prompts - [Workspaces](https://docs.kadoa.com/docs/workspaces.md): Manage your workflows and collaborate using workspaces. ## OpenAPI Specs - [openapi](https://docs.kadoa.com/api-reference/openapi.json) ## Optional - [Changelog](https://www.kadoa.com/changelog) - [Trust Center](https://trust.kadoa.com) - [Contact Us](https://www.kadoa.com/contact)