Skip to content
Changelog

Report a bug

Kadoa integration: operations for AI agents

Kadoa connects to Type.com as an integration. This page lists the 119 operations documented for Claude and Codex in Type.com: 62 read, 34 write, 23 destructive.

About Kadoa

Kadoa is an API-first platform that enables users to create, manage, and monitor data extraction workflows from unstructured data sources.

Categories: Analytics & Data

How to connect Kadoa to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

119 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

119 operations listed.

Workflows

  • Read

    Get all data changes

    GET /v4/changes

  • Read

    Get data change by ID

    GET /v4/changes/{changeId}

  • Read

    Download a change PDF file

    GET /v4/changes/files/{encodedPath}

  • Read

    Get workflow audit log entries

    GET /v4/workflows/{workflowId}/auditlog

  • Read

    Get workflow by ID

    Retrieves detailed information about a specific workflow. This endpoint requires authentication and proper team access permissions.

  • Read

    List destinations delivering this workflow's results

    Returns the team's destinations that deliver this workflow after each run. Only deliverable destinations are listed (enabled, verified, not revoked).

  • Read

    Get workflow data by ID

    GET /v4/workflows/{workflowId}/data

  • Read

    Create workflow data export

    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.

  • Read

    Workflow data Parquet option

    Streams the canonical Parquet artifact for the latest successful workflow run, or for a specific run when runId is provided. The file is the full, unfiltered dataset for that run.

  • Read

    Download workflow data export

    Streams a file previously materialized via GET /v4/workflows/{workflowId}/data/export. Sets Content-Disposition: attachment so browsers trigger a download.

  • Read

    Get aggregated run success metrics for a workflow

    Per-day successful/failed run counts and the overall success rate over the requested window, aggregated over all runs (not paginated). Days are bucketed by the run's finish date in UTC.

  • Read

    Get the workflow run history

    GET /v4/workflows/{workflowId}/history

  • Read

    Get a list of workflows

    Retrieves a list of workflows with pagination and search capabilities

  • Read

    Get workflow quality metrics

    Returns the data quality metric results for a workflow run, plus the run's total data quality issue count. Metrics are only available once the run has finished, before that the endpoint returns { "results": null, "issueCount": null }.

  • Read

    Get all data changes (PostgreSQL)

    GET /v5/changes

  • Read

    Get data change by ID (PostgreSQL)

    GET /v5/changes/{changeId}

  • Read

    Get workflow audit log entries

    GET /v5/workflows/{workflowId}/auditlog

  • Read

    Get job status and telemetry

    Retrieve the current status and telemetry information for a specific job

  • Write

    Perform bulk operations on multiple workflows

    Execute actions on multiple workflows at once. Best-effort processing - each workflow is processed independently. The 'approve' action approves preview data for workflows in PREVIEW state. The 'stop' action cancels each workflow's running job without changing its schedule.

  • Write

    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.

  • Write

    Generate a DuckDB query from a natural-language request

    Generates SQL without executing it. Requires read access to the workflow. Send the selected dataset's columns and up to five sample rows. Ambiguous requests use reasonable defaults explained in the response. A null SQL result explains why the request cannot be answered.

  • Destructive

    Delete a workflow

    DELETE /v4/workflows/{workflowId}

  • Destructive

    Approve workflow for compliance

    PUT /v4/workflows/{workflowId}/compliance-approve

  • Destructive

    Reject workflow for compliance

    PUT /v4/workflows/{workflowId}/compliance-reject

  • Destructive

    Update workflow metadata

    PUT /v4/workflows/{workflowId}/metadata

  • Destructive

    Pause a workflow

    PUT /v4/workflows/{workflowId}/pause

  • Destructive

    Resume or unpause a workflow

    Unpauses a paused workflow, or resumes a preview/error workflow.

  • Destructive

    Run a workflow

    PUT /v4/workflows/{workflowId}/run

  • Destructive

    Schedule a workflow

    PUT /v4/workflows/{workflowId}/schedule

  • Destructive

    Stop a running workflow

    Cancels the active run for the specified workflow. Queued and pending steps are removed from the pipeline; the in-flight step may still complete.

Files

  • Read

    Download a file

    Downloads a specific file from the storage

  • Read

    Download multiple files as a ZIP archive

    Downloads multiple files from the storage and returns them as a ZIP archive

Locations

  • Read

    Get all available locations

    GET /v4/locations

Support

  • Read

    Get support issues for the current customer

    GET /v4/support/issues

  • Read

    Get available issue states

    GET /v4/support/states

  • Write

    Create a new support issue

    Creates a support ticket. User info is inferred from auth context.

  • Write

    Upload support ticket attachments

    Uploads files to Linear's asset storage and returns their asset URLs for use in a subsequent issue creation. Multipart form data with a "files" field (max 10 files, 25MB each).

  • Write

    Update issue priority and/or status

    PATCH /v4/support/issues/{issueId}

Data Quality

  • Read

    Get data quality rules for a workflow

    Returns the per-field data quality rules persisted on the workflow. The response is a map keyed by schema field name. A workflow without any rules returns rules: null.

  • Destructive

    Upsert data quality rules for a workflow

    Patch-merge the per-field data quality rules persisted on the workflow. Fields included in the request body replace any existing rules for those fields; fields not included are left untouched. To remove a field's rules, call the corresponding DELETE endpoint instead.

  • Destructive

    Delete data quality rules for a single field

    Remove all data quality rules for a single schema field on a workflow. Other fields' rules are left untouched.

Workflow Triggers

  • Read

    List workflow triggers

    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.

  • Read

    Get a specific trigger

    GET /v4/workflows/{workflowId}/triggers/{triggerId}

  • Write

    Create a workflow trigger

    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.

  • Write

    Update a trigger

    Update trigger properties (eventType, enabled)

  • Destructive

    Delete a trigger

    DELETE /v4/workflows/{workflowId}/triggers/{triggerId}

Agent

  • Read

    Read customer-visible Assistant message history

    Returns user messages, Assistant messages, and clarification questions from the latest Lighthouse/Shelly or Julie customer thread. Internal and operations lanes are never selectable.

  • Read

    Get durable Assistant pause and question state

    GET /v5/agent/{sessionId}/pause-state

  • Read

    Get the latest customer-safe Assistant extraction strategy

    Returns strategy null when the session exists but no build strategy is available yet.

  • Read

    List extraction script builds for an Assistant session

    Requires the ACCESSSOURCECODE feature flag. Returns versions/statuses only, newest first, and only builds whose source currently passes Kadoa's source review; other builds are left out.

  • Read

    Get the extraction script source of one build

    Requires the ACCESSSOURCECODE feature flag. Returns the script source, no file names, for builds whose source currently passes Kadoa's source review.

  • Write

    Create or continue a public Agent session

    Creates a draft workflow-backed Assistant session. Explicit productType=realtime dispatches the Julie realtime lane after realtime notification settings are provisioned.

  • Write

    Request an Assistant update to an existing workflow

    Bootstraps or reuses the workflow's customer Assistant session and enqueues update instructions without changing the workflow ID.

  • Write

    Answer a durable Assistant question

    POST /v5/agent/answer

  • Write

    Safely interrupt an active Assistant session

    POST /v5/agent/{sessionId}/interrupt

  • Write

    Resume an inactive or interrupted Assistant session

    Resumes with the persona persisted on the session, preserving Lighthouse versus Julie behavior.

  • Write

    Stop an active Assistant session

    POST /v5/agent/{sessionId}/stop

  • Write

    Start (or return) the workflow's Assistant session

    Bootstraps the customer-facing Assistant lane for a workflow. Concurrent bootstraps converge on the same session; 201 marks a fresh start, 200 an already-existing lane.

  • Destructive

    Delete an inactive Assistant session

    Deletes the session and its related data. Only inactive sessions with a customer-facing thread can be deleted. Re-sending after a successful delete returns 404, which callers should treat as already done.

Notifications

  • Read

    Download the changed-records CSV for a data change

    Accepts either normal team authentication or a signed link minted for a notification. Pass latest as changeId to get the workflow's most recent change, which the settings editor uses as a sample download.

  • Read

    Retrieve all notification channels

    GET /v5/notifications/channels

  • Read

    Retrieve a specific notification channel

    GET /v5/notifications/channels/{channelId}

  • Read

    Retrieve all available notification event types

    GET /v5/notifications/event-types

  • Read

    Retrieve a specific event type details

    GET /v5/notifications/event-types/{eventType}

  • Read

    Download the extracted records of a workflow run as CSV

    Accepts either normal team authentication or a signed link minted for a workflow-finished notification.

  • Read

    Retrieve notification event logs

    GET /v5/notifications/logs

  • Read

    Retrieve all notification settings

    GET /v5/notifications/settings

  • Read

    Retrieve a specific notification settings

    GET /v5/notifications/settings/{settingsId}

  • Write

    Create a new notification channel

    POST /v5/notifications/channels

  • Write

    Test a notification settings with mock data

    POST /v5/notifications/test

  • Write

    Create a new notification settings

    POST /v5/notifications/settings

  • Destructive

    Update a notification channel

    PUT /v5/notifications/channels/{channelId}

  • Destructive

    Delete a notification channel

    DELETE /v5/notifications/channels/{channelId}

  • Destructive

    Update a notification settings

    PUT /v5/notifications/settings/{settingsId}

  • Destructive

    Delete a notification settings

    DELETE /v5/notifications/settings/{settingsId}

Workspaces

  • Read

    Get daily workflow totals, approvals, and extracted rows

    Returns informational usage across all execution modes. This data does not determine the workspace billing model.

  • Read

    List the billable workflows behind the current billing period (teams and organizations)

    The per-workflow detail behind the approved-workflows count. A workflow is billable if it has at least one successful (FINISHED), non-preview run whose finishedat falls inside the current billing period — of any current state, deleted included (deleted workflows still bill if th…

  • Read

    Get workspace details (supports teams and organizations)

    GET /v5/workspaces/{workspaceId}/details

  • Read

    Recorded usage and historical Active workflow estimates

    Historical values come from daily usage snapshots; unavailable values are null. activeWorkflows counts ACTIVE-state workflows, while active and activeSlots count billable usage. Active billing counts real-time workflows or workflows on an enabled schedule.

  • Read

    Get observability run metrics for a workspace

    Returns per-workflow reliability for enterprise workspaces over the last N UTC calendar days including today. The top level covers scheduled workflows (success rate, records delivered, mean time to recover, lifecycles) and the workspace's tickets.

  • Read

    Daily per-billing-period cumulative series for Approved workflows and extracted rows (teams and organizations)

    For each of the last N days, the Approved-workflow count, weighted slot usage, and extracted-row sum accumulated since the start of the billing period that day falls in, resetting at each renewal anniversary (a sawtooth across renewals).

  • Read

    Get workspace quotas and usage (supports teams and organizations)

    GET /v5/workspaces/{workspaceId}/quotas

  • Read

    Get workspace usage data (supports teams and organizations)

    GET /v5/workspaces/{workspaceId}/usage

Schemas

  • Read

    List all schemas

    Retrieve all schemas accessible by the authenticated user

  • Read

    Get schema by ID

    Retrieve a specific schema by its unique identifier

  • Write

    Create new schema

    Create a new data schema with specified fields and entity type

  • Destructive

    Update existing schema

    Update schema metadata or create a new revision with updated fields

  • Destructive

    Delete schema

    Delete a schema and all its revisions

Scrape

  • Write

    Scrape a URL

    Fetch a URL through Kadoa. Defaults to smart routing (auto fetch mode and proxy), can return page content as markdown for LLM consumption, and offers a stealth proxy tier for sites that block bots.

Templates

  • Read

    List all templates

    List all active templates for the authenticated user's team

  • Read

    Get template by ID

    Retrieve a template with all its published versions

  • Read

    List template schemas

    List all schemas linked to this template

  • Read

    List template workflows

    List all workflows created from this template (isOutdated flag is informational-only in v1 — applyUpdate is disabled)

  • Read

    Preview schema change

    Preview the data a schema change would produce for one linked workflow, without applying the template or running the workflow

  • Write

    Create new template

    Create a new template for the team

  • Write

    Duplicate template

    Create an independent copy of a template from its latest published version as a single new version 1, including prompt, schema, validation rules, notifications, and frequency. The copy has no linked workflows.

  • Write

    Publish template version

    Create a new immutable version of a template with prompt, schema, and/or data validation

  • Write

    Rename template version

    Set or clear the display name of a published template version. The version content stays immutable; only the label changes.

  • Write

    Apply template update

    Apply a template version's config to existing workflows (clone with lineage update)

  • Write

    Save workflow as template

    Extract a workflow's prompt, schema, validation rules, and notifications into a new template or as a new version of an existing template. The source workflow is not modified (v1: no auto-link).

  • Destructive

    Update template

    Update template name or description

  • Destructive

    Archive template

    Soft-delete (archive) a template and cascade-unlink any workflows that referenced it.

Activity

  • Read

    Export workflow metadata

    Export workflow configurations and metadata as CSV for portfolio reviews and compliance reporting. Includes notification channel details.

  • Read

    List activity events (new implementation)

    Retrieve activity events from auditlogs table with basic filtering and pagination.

  • Read

    Export activity events as CSV (new implementation)

    Export activity events from auditlogs table to CSV format for compliance and audit purposes.

User

  • Write

    Finish onboarding

    Complete user onboarding process, update profile, and send welcome email

Me

  • Read

    Get enabled capabilities

    Return the capabilities enabled for the authenticated team. Clients (such as the Kadoa MCP) use this to decide which tools to expose.

Variables

  • Read

    List secret provider connections

    GET /v4/variables/connections

  • Read

    List all variables

    Retrieve all variables in the current team/user scope (max 100).

  • Read

    Get a variable

    Retrieve a specific variable by its ID.

  • Write

    Create and verify a Google Secret Manager connection

    POST /v4/variables/connections

  • Write

    Reconnect a Google Secret Manager connection

    PATCH /v4/variables/connections/{connectionId}

  • Write

    Retry secret provider connection verification

    POST /v4/variables/connections/{connectionId}/verify

  • Write

    Create a variable

    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.

  • Write

    Update a variable

    Update an existing variable. At least one field (key, value, or dataType) must be provided.

  • Destructive

    Delete an unused secret provider connection

    DELETE /v4/variables/connections/{connectionId}

  • Destructive

    Delete a variable

    Permanently delete a variable by its ID. A secret bound to a connector returns 409 Conflict.

See How connections work for access and permissions, or browse all integrations.

Reference date: October 27, 2026. Kadoa API docs.