Kadoa | Composio Docs

Overview

SLUG: KADOA

Description

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

Authentication Details

API Key

generic_api_key

stringRequired

Connecting to Kadoa

Create an auth config

Use the dashboard to create an auth config for the Kadoa toolkit. This allows you to connect multiple Kadoa accounts to Composio for agents to use.

Select App

Navigate to Kadoa.

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

Create and Get auth config ID

Click “Create Kadoa Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1 from composio import Composio
2 
3 # Replace these with your actual values
4 kadoa_auth_config_id = "ac_YOUR_KADOA_CONFIG_ID" # Auth config ID created above
5 user_id = "0000-0000-0000"  # UUID from database/app
6 
7 composio = Composio()
8 
9 def authenticate_toolkit(user_id: str, auth_config_id: str):
10     # Replace this with a method to retrieve an API key from the user.
11     # Or supply your own.
12     user_api_key = input("[!] Enter API key")
13 
14     connection_request = composio.connected_accounts.initiate(
15         user_id=user_id,
16         auth_config_id=auth_config_id,
17         config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18     )
19 
20     # API Key authentication is immediate - no redirect needed
21     print(f"Successfully connected Kadoa for user {user_id}")
22     print(f"Connection status: {connection_request.status}")
23     
24     return connection_request.id
25 
26 
27 connection_id = authenticate_toolkit(user_id, kadoa_auth_config_id)
28 
29 # You can verify the connection using:
30 connected_account = composio.connected_accounts.get(connection_id)
31 print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Kadoa toolkit’s playground

OpenAI (Python)

Anthropic (TypeScript)

Google (Python)

Vercel (TypeScript)

Python

1 from composio import Composio
2 from openai import OpenAI
3 import json
4 
5 openai = OpenAI()
6 composio = Composio()
7 
8 # User ID must be a valid UUID format
9 user_id = "0000-0000-0000"  # Replace with actual user UUID from your database
10 
11 tools = composio.tools.get(user_id=user_id, toolkits=["KADOA"])
12 
13 print("[!] Tools:")
14 print(json.dumps(tools))
15 
16 def invoke_llm(task = "What can you do?"):
17     completion = openai.chat.completions.create(
18         model="gpt-4o",
19         messages=[
20             {
21                 "role": "user",
22                 "content": task,  # Your task here!
23             },
24         ],
25         tools=tools,
26     )
27 
28     # Handle Result from tool call
29     result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30     print(f"[!] Completion: {completion}")
31     print(f"[!] Tool call result: {result}")
32 
33 invoke_llm()

Tool List

KADOA_CREATE_NOTIFICATION_CHANNEL

Tool Name: Create Notification Channel

Description

Tool to create a notification channel for alerts delivery.

Action Parameters

channelType

stringRequired

config

objectRequired

name

stringRequired

Action Response

data

objectRequired

error

string

message

stringRequired

status

stringRequired

successful

booleanRequired

KADOA_ENABLE_DATA_VALIDATION

Tool Name: Enable Data Validation

Description

Tool to enable data validation on a specified workflow. Use after creating or updating a workflow to enforce its validation rules.

Action Parameters

workflowId

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

KADOA_FETCH_WORKFLOW_CONFIGURATION

Tool Name: Fetch workflow configuration

Description

Tool to fetch an advanced workflow’s configuration details. Use when you have a workflow ID and need its steps and metadata.

Action Parameters

workflow_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

KADOA_GET_ALL_LOCATIONS

Tool Name: Get all locations

Description

Tool to retrieve a list of all available locations. Use when you need to know supported locations before performing location-dependent operations. Use after authenticating with your API key.

Action Parameters

Action Response

data

objectRequired

error

string

successful

booleanRequired

KADOA_GET_CRAWLED_PAGE_CONTENT

Tool Name: Get Crawled Page Content

Description

Tool to retrieve content of a crawled page. Use when you need the HTML or Markdown of a page from a specific crawling session.

Action Parameters

format

stringDefaults to html

pageId

stringRequired

sessionId

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

KADOA_GET_CRAWLED_PAGES

Tool Name: Get Crawled Pages

Description

Tool to list pages crawled during a session. Use when you need to paginate through results after starting a crawl session.

Action Parameters

currentPage

integer

pageSize

integerDefaults to 50

sessionId

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

KADOA_GET_CRAWL_STATUS

Tool Name: Get Crawl Status

Description

Tool to fetch current status of a crawling session. Use when you need to check progress of a crawl by its session ID.

Action Parameters

session_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

KADOA_GET_EVENT_TYPES

Tool Name: Get Notification Event Types

Description

Tool to retrieve supported notification event types. Use when you need to enumerate available notification triggers.

Action Parameters

Action Response

data

objectRequired

error

string

message

stringRequired

status

stringRequired

successful

booleanRequired

KADOA_GET_LATEST_WORKFLOW_DATA

Tool Name: Get Latest Workflow Data

Description

Tool to retrieve the most recent data produced by a workflow. Use after confirming workflowId.

Action Parameters

filters

array

format

stringDefaults to json

gzip

boolean

limit

integerDefaults to 25

order

stringDefaults to asc

page

integerDefaults to 1

runId

string

sortBy

string

workflowId

stringRequired

Action Response

csv

string

data

array

error

string

executedAt

string

pagination

object

runId

string

successful

booleanRequired

workflowId

string

KADOA_GET_NOTIFICATION_CHANNEL

Tool Name: Get Notification Channel

Description

Tool to retrieve details of a specific notification channel. Use when you have a channel's ID and need its configuration.

Action Parameters

channel_id

stringRequired

Action Response

data

objectRequired

error

string

message

stringRequired

status

stringRequired

successful

booleanRequired

KADOA_GET_NOTIFICATION_SETTING

Tool Name: Get Notification Setting

Description

Tool to retrieve a specific notification setting by its identifier. Use when you need to fetch notification configuration details by ID.

Action Parameters

settingsId

stringRequired

Action Response

data

objectRequired

error

string

message

stringRequired

status

stringRequired

successful

booleanRequired

KADOA_GET_VALIDATION_CONFIG

Tool Name: Get validation configuration

Description

Tool to retrieve the configuration settings for data validation. Use when you need to inspect validation and linking settings for a specific workflow.

Action Parameters

workflowId

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

KADOA_GET_WORKFLOW_RUN_HISTORY

Tool Name: Get Workflow Run History

Description

Tool to fetch workflow run history. Use when you need to retrieve past run records for a workflow after execution.

Action Parameters

workflowId

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

KADOA_GET_WORKFLOWS

Tool Name: Get Workflows

Description

Tool to retrieve all workflows. Use when you need to list and filter workflows after authenticating.

Action Parameters

limit

integerDefaults to 25

monitoring

boolean

string

skip

integer

state

string

updateInterval

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

KADOA_GET_WORKFLOW_VALIDATION_RESULTS

Tool Name: Get Workflow Validation Results

Description

Tool to retrieve the latest validation results for a workflow job. Use after a workflow job completes to inspect its validation outcome.

Action Parameters

includeDryRun

boolean

jobId

stringRequired

workflowId

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

KADOA_LIST_VALIDATION_RULES

Tool Name: List Validation Rules

Description

Tool to list all data validation rules with optional pagination and filtering.

Action Parameters

groupId

string

includeDeleted

boolean

page

integerDefaults to 1

pageSize

integerDefaults to 50

status

string

workflowId

string

Action Response

data

arrayRequired

error

string

pagination

objectRequired

successful

booleanRequired

KADOA_POST_ADVANCED_WORKFLOW

Tool Name: Create Advanced Workflow

Description

Tool to create an advanced workflow. Use when you need a valid advanced workflow ID before updating steps.

Action Parameters

limit

integer

name

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

KADOA_POST_CRAWL

Tool Name: Start Crawl Session

Description

Tool to start a web crawling session. Use when you need to initiate a crawl with configuration parameters.

Action Parameters

maxDepth

integer

maxPages

integer

pathsFilterIn

array

pathsFilterOut

array

proxyCountry

string

startUrls

array

strictDomain

boolean

timeout

integer

url

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

KADOA_POST_NOTIFICATION_SETTING

Tool Name: Create Notification Setting

Description

Tool to create a notification setting linking channels to events. Use when subscribing workflows or workspace-level notifications to specific events.

Action Parameters

channelIds

arrayRequired

enabled

booleanDefaults to True

eventConfiguration

objectRequired

eventType

stringRequired

workflowId

string

Action Response

data

objectRequired

error

string

message

stringRequired

status

stringRequired

successful

booleanRequired

KADOA_POST_NOTIFICATION_TEST

Tool Name: Post Notification Test

Description

Tool to send a test notification event. Use when verifying your notification channel configurations.

Action Parameters

eventType

stringRequired

workflowId

string

Action Response

data

objectRequired

error

string

message

stringRequired

status

stringRequired

successful

booleanRequired

KADOA_POST_WEBHOOK_SUBSCRIPTION

Tool Name: Subscribe to Webhook Events

Description

Tool to subscribe to specified webhook events. This will create a webhook channel and then create notification settings for the provided events linking that channel.

Action Parameters

channelName

string

events

arrayRequired

webhookHttpMethod

stringRequired

webhookUrl

Required

workflowId

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

KADOA_POST_WORKFLOW

Tool Name: Create Workflow

Description

Tool to create a new workflow in kadoa. Use after configuring URLs and schema or prompt.

Action Parameters

autoStart

booleanDefaults to True

bypassPreview

boolean

description

string

entity

string

fields

array

interactions

array

interval

string

limit

integer

location

object

monitoring

object

name

string

navigationMode

stringRequired

schedules

array

schemaId

string

KADOA_POST_WORKFLOW_MONITORING

Tool Name: Configure Workflow Monitoring

Description

Tool to configure monitoring for a workflow to detect data changes by updating workflow metadata. Use after creating or selecting the workflow.

Action Parameters

monitoring

object

schedules

array

updateInterval

string

workflowId

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

KADOA_POST_WORKFLOW_VALIDATION_RULE

Tool Name: Post Workflow Validation Rule

Description

Tool to generate and add a new validation rule to a workflow. Use when you need AI-driven data quality rules for a workflow.

Action Parameters

isPreviewRun

boolean

jobId

string

selectedColumns

array

userPrompt

stringRequired

workflowId

stringRequired

Action Response

data

objectRequired

error

string

message

stringRequired

metadata

object

successful

booleanRequired

KADOA_PUT_NOTIFICATION_CHANNEL

Tool Name: Update Notification Channel

Description

Tool to update an existing notification channel. Use when you need to modify channel details.

Action Parameters

channelId

stringRequired

channelType

stringRequired

config

objectRequired

name

stringRequired

Action Response

data

objectRequired

error

string

message

stringRequired

status

stringRequired

successful

booleanRequired

KADOA_RUN_ADHOC_EXTRACTION

Tool Name: Run Ad-hoc Extraction

Description

Tool to synchronously extract data from a URL using a given template. Use after choosing the schemaId (custom or 'html', 'body', 'markdown').

Action Parameters

link

stringRequired

location

object

schemaId

stringRequired

Action Response

data

objectRequired

error

string

link

stringRequired

location

object

message

string

requestTimeMs

integerRequired

screenshotUrl

string

status

stringRequired

successful

booleanRequired

KADOA_UNSUBSCRIBE_FROM_WEBHOOK_EVENTS

Tool Name: Unsubscribe from Webhook Events

Description

Tool to unsubscribe from webhook event notifications by deleting a notification setting. Use when you need to remove an existing notification settings by its ID.

Action Parameters

settingsId

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired