W↓
All docs
🔑
Sign Up/Sign In
docs.kadoa.com/api-reference
Public Link
Apr 8, 2025, 9:44:29 AM - complete - 37 kB
Created by:
****ad@vlad.studio
Starting URLs:
https://docs.kadoa.com/api-reference
## Page: https://docs.kadoa.com/api-reference Kadoa is built as an API-first platform. Everything you can do on your Kadoa Dashboard is also possible with our flexible API. ## Quickstart 1. Get your API key * Personal API Key: Found under Account Settings in your Kadoa account. * Team API Key: Found under Team Settings, grants access to all workflows and data belonging to that team. 2. Create your first workflow on Kadoa.com 3. Fetch the data by using our API. ## Authentication All API endpoints are authenticated using an API key. On this page * Quickstart * Authentication --- ## Page: https://docs.kadoa.com/api-reference/introduction Kadoa is built as an API-first platform. Everything you can do on your Kadoa Dashboard is also possible with our flexible API. ## Quickstart 1. Get your API key * Personal API Key: Found under Account Settings in your Kadoa account. * Team API Key: Found under Team Settings, grants access to all workflows and data belonging to that team. 2. Create your first workflow on Kadoa.com 3. Fetch the data by using our API. ## Authentication All API endpoints are authenticated using an API key. On this page * Quickstart * Authentication --- ## Page: https://docs.kadoa.com/api-reference/crawling/start-crawling-session POST x-api-key string required API key for authentication #### Body application/json url string required URL to start crawling pathsFilterIn string\[\] List of path patterns to include in the crawl pathsFilterOut string\[\] List of path patterns to exclude from the crawl timeout integer Maximum time for crawling in milliseconds Example: `"1800000 - default 30 minutes"` maxDepth integer Maximum depth to traverse during the crawl Example: `10` maxPages integer Maximum number of pages to crawl Example: `1000` strictDomain boolean Set this flag to true when you want the crawler to stay on the same exact domain, not going to subdomains Example: `true` proxyCountry string country flag code to assign to proxy configuration to navigate behind the proxy Example: `"DE"` #### Response 200 application/json Crawling session started successfully message string Example: `"Session started"` sessionId string Unique ID for the started crawl session error string | null Null if no error occurred --- ## Page: https://docs.kadoa.com/api-reference/crawling/crawling-session-status Crawling Fetches the current status of a specified crawling session using the session ID. GET / v4 / crawl / {sessionId} / status curl --request GET \ --url https://api.kadoa.com/v4/crawl/{sessionId}/status \ --header 'x-api-key: <api-key>' { "payload": {}, "sessionId": "<string>", "error": "<string>" } x-api-key string header required x-api-key string required API key for authentication sessionId string required Unique ID of the crawling session #### Response 200 application/json Crawling session status retrieved successfully payload object Details about the crawling session status sessionId string ID of the crawling session error string | null Null if no error occurred curl --request GET \ --url https://api.kadoa.com/v4/crawl/{sessionId}/status \ --header 'x-api-key: <api-key>' { "payload": {}, "sessionId": "<string>", "error": "<string>" } --- ## Page: https://docs.kadoa.com/api-reference/crawling/get-crawled-pages GET x-api-key string required API key for authentication sessionId string required Unique ID of the crawling session currentPage integer Current page number for pagination Example: `1` pageSize integer Number of items per page for pagination Example: `10` #### Response 200 application/json Crawled pages retrieved successfully payload object\[\] List of crawled pages with statuses payload.id string Unique ID of the crawled page payload.url string URL of the crawled page payload.status enum<string> Status of the page crawl Available options: `DONE`, `CRAWLING`, `PENDING` Pagination details Current page number Number of items per page Total number of pages available sessionId string ID of the crawling session error string | null Null if no error occurred --- ## Page: https://docs.kadoa.com/api-reference/crawling/get-crawled-page-meta Crawling Fetches data for a specific page from a crawling session by page ID, optionally allowing format specification. GET x-api-key string header required x-api-key string required API key for authentication sessionId string required Unique ID of the crawling session pageId string required Unique ID of the crawled page format string Desired format for the page data Example: `"json"` #### Response 200 application/json Crawled page data retrieved successfully payload object Data associated with the specific page pageId string Unique ID of the page pageFormat string Format of the retrieved page data error string | null Null if no error occurred --- ## Page: https://docs.kadoa.com/api-reference/workflows/get-workflow-data-by-id GET x-api-key string API key for authorization Authorization string Bearer token for authorization workflowId string required ID of the workflow to retrieve data from runId string ID of a specific run to retrieve data from format enum<string> default:json Format of the response data Available options: `json`, `csv` sortBy string Field to sort the results by order enum<string> default:asc Sort order (ascending or descending) Available options: `asc`, `desc` filters string JSON-encoded array of filter objects page integer default:1 Page number for pagination Required range: `x >= 1` limit integer default:25 Number of items per page (0 for streaming all data) Required range: `x >= 0` gzip boolean default:false Enable gzip compression for the response #### Response 200 application/json Workflow data returned successfully workflowId string required data object\[\] required runId string | null executedAt string | null --- ## Page: https://docs.kadoa.com/api-reference/workflows/get-all-workflows GET search string Search term to filter workflows by name or URL skip integer default:0 Number of items to skip Required range: `x >= 0` limit integer default:25 Maximum number of items to return Required range: `x >= 1` state enum<string> Filter workflows by state Available options: `ACTIVE`, `ERROR`, `PAUSED`, `NOT_SUPPORTED` tags string\[\] Filter workflows by tags monitoring enum<string> Filter workflows by monitoring status Available options: `true`, `false` updateInterval enum<string> Filter workflows by update interval Available options: `HOURLY`, `DAILY`, `WEEKLY`, `MONTHLY` templateId string Filter workflows by template ID #### Response 200 application/json Successfully retrieved workflows workflows object\[\] workflows.\_id string workflows.name string workflows.state enum<string> The actual workflow state stored in the database Available options: `ACTIVE`, `ERROR`, `PAUSED`, `NOT_SUPPORTED`, `PREVIEW`, `QUEUED`, `SETUP_RUNNING`, `ERROR_SETUP` workflows.tags string\[\] Tags associated with the workflow workflows.displayState enum<string> Aggregated state for frontend display purposes, combining workflow state with additional runtime states Available options: `ACTIVE`, `ERROR`, `PAUSED`, `NOT_SUPPORTED`, `PREVIEW`, `QUEUED`, `SETUP_RUNNING`, `ERROR_SETUP`, `DRAFT`, `RUNNING` workflows.userId string workflows.createdAt string workflows.isAdvanced boolean workflows.limit integer workflows.finishedAt string workflows.startedAt string workflows.protocol string workflows.dataKey string workflows.location object workflows.location.type enum<string> Available options: `auto`, `manual` workflows.location.isoCode enum<string> Available options: `DE`, `US`, `GB`, `NL`, `CA` workflows.runCosts number workflows.runState string workflows.totalRecords integer workflows.url string workflows.schema object workflows.schemaType enum<string> Available options: `DETAIL`, `DIRECTORY` workflows.templateName string workflows.templateId string Total number of items across all pages Current page number Total number of pages Number of items per page --- ## Page: https://docs.kadoa.com/api-reference/workflows/get-workflow-by-id GET workflowId string required ID of the workflow to retrieve #### Response 200 application/json Workflow details retrieved successfully \_id string Unique identifier of the workflow name string Name of the workflow limit integer Record limit for the workflow state enum<string> The actual workflow state stored in the database Available options: `ACTIVE`, `ERROR`, `PAUSED`, `NOT_SUPPORTED`, `PREVIEW`, `QUEUED` displayState enum<string> Aggregated state for frontend display purposes, combining workflow state with additional runtime states Available options: `ACTIVE`, `ERROR`, `PAUSED`, `NOT_SUPPORTED`, `PREVIEW`, `QUEUED`, `DRAFT`, `SETUP_RUNNING`, `RUNNING` userId string ID of the user who owns the workflow updateInterval string Update interval configuration nextInvocation string Next scheduled execution time monitoring object Monitoring configuration notificationConfig object Notification settings createdAt string Workflow creation timestamp location object Location configuration location.type enum<string> Available options: `auto`, `manual` location.isoCode enum<string> Available options: `DE`, `US`, `GB`, `NL`, `CA` schedules any\[\] Scheduled execution configurations isAdvanced boolean Indicates if this is an advanced workflow finishedAt string Last execution completion time startedAt string Last execution start time protocol string Workflow protocol dataKey string Key for accessing workflow data runCosts number Execution cost in credits runState string State of the last execution totalRecords integer Total number of records processed templateName string Name of the associated template templateId string ID of the associated template schema object Schema configuration --- ## Page: https://docs.kadoa.com/api-reference/workflows/create-a-new-workflow curl --request POST \ --url https://api.kadoa.com/v4/workflows \ --header 'Content-Type: application/json' \ --header 'x-api-key: <api-key>' \ --data '{ "templateId": "<string>", "link": "<string>", "name": "<string>", "updateInterval": "ONLY_ONCE", "schedules": [ "<string>" ], "monitoring": { "enabled": true, "fields": [ "<string>" ], "mode": "ADDED", "channels": [ { "type": "EMAIL", "emails": [ "jsmith@example.com" ], "url": "<string>" } ] }, "limit": 123, "location": { "type": "auto", "isoCode": "DE" }, "tags": [ "<string>" ] }' --- ## Page: https://docs.kadoa.com/api-reference/workflows/run-a-workflow Workflows PUT / v4 / workflows / {workflowId} / run curl --request PUT \ --url https://api.kadoa.com/v4/workflows/{workflowId}/run \ --header 'x-api-key: <api-key>' "Workflow started" #### Authorizations x-api-key string header required #### Path Parameters workflowId string required The ID of the workflow to run #### Response 200 text/plain Workflow started successfully The response is of type `string`. Example: `"Workflow started"` Create a new workflowSchedule a workflow curl --request PUT \ --url https://api.kadoa.com/v4/workflows/{workflowId}/run \ --header 'x-api-key: <api-key>' "Workflow started" --- ## Page: https://docs.kadoa.com/api-reference/workflows/schedule-a-workflow Workflows PUT / v4 / workflows / {workflowId} / schedule curl --request PUT \ --url https://api.kadoa.com/v4/workflows/{workflowId}/schedule \ --header 'Content-Type: application/json' \ --header 'x-api-key: <api-key>' \ --data '{ "date": "2023-10-07T10:00:00.000Z" }' "Workflow scheduled" x-api-key string header required workflowId string required The ID of the workflow to schedule #### Body application/json ISO date (attention its timezone UTC) string required in request body date string Example: `"2023-10-07T10:00:00.000Z"` #### Response 200 text/plain Workflow scheduled successfully The response is of type `string`. Example: `"Workflow scheduled"` curl --request PUT \ --url https://api.kadoa.com/v4/workflows/{workflowId}/schedule \ --header 'Content-Type: application/json' \ --header 'x-api-key: <api-key>' \ --data '{ "date": "2023-10-07T10:00:00.000Z" }' "Workflow scheduled" --- ## Page: https://docs.kadoa.com/api-reference/workflows/update-workflow-metadata curl --request PUT \ --url https://api.kadoa.com/v4/workflows/{workflowId}/metadata \ --header 'Content-Type: application/json' \ --header 'x-api-key: <api-key>' \ --data '{ "limit": 123, "updateInterval": "ONLY_ONCE", "schedules": [ "<string>" ], "name": "<string>", "tags": [ "tag1", "tag2" ], "location": { "type": "auto", "isoCode": "<string>" }, "monitoring": { "enabled": true, "fields": [ { "fieldName": "<string>", "operator": "changed" } ], "channels": [ { "type": "EMAIL", "emails": [ "<string>" ] } ], "conditions": { "logicalOperator": "AND", "conditions": [ { "type": "SINGLE", "field": "<string>", "operator": "<string>", "value": "<string>" } ] } } }' --- ## Page: https://docs.kadoa.com/api-reference/workflows/pause-a-workflow Workflows PUT / v4 / workflows / {workflowId} / pause curl --request PUT \ --url https://api.kadoa.com/v4/workflows/{workflowId}/pause \ --header 'x-api-key: <api-key>' "Workflow paused" #### Authorizations x-api-key string header required #### Path Parameters workflowId string required The ID of the workflow to pause #### Response 200 text/plain Workflow paused successfully The response is of type `string`. Example: `"Workflow paused"` Update workflow metadataDelete a workflow curl --request PUT \ --url https://api.kadoa.com/v4/workflows/{workflowId}/pause \ --header 'x-api-key: <api-key>' "Workflow paused" --- ## Page: https://docs.kadoa.com/api-reference/workflows/delete-a-workflow Workflows DELETE / v4 / workflows / {workflowId} curl --request DELETE \ --url https://api.kadoa.com/v4/workflows/{workflowId} \ --header 'x-api-key: <api-key>' "Workflow deleted" #### Authorizations x-api-key string header required #### Path Parameters workflowId string required The ID of the workflow to delete #### Response 200 text/plain Workflow deleted successfully The response is of type `string`. Example: `"Workflow deleted"` Pause a workflowResume a workflow curl --request DELETE \ --url https://api.kadoa.com/v4/workflows/{workflowId} \ --header 'x-api-key: <api-key>' "Workflow deleted" --- ## Page: https://docs.kadoa.com/api-reference/workflows/resume-a-workflow Workflows PUT / v4 / workflows / {workflowId} / resume curl --request PUT \ --url https://api.kadoa.com/v4/workflows/{workflowId}/resume \ --header 'x-api-key: <api-key>' "Workflow resumed" x-api-key string header required workflowId string required The ID of the workflow to resume #### Response 200 text/plain Workflow resumed successfully The response is of type `string`. Example: `"Workflow resumed"` curl --request PUT \ --url https://api.kadoa.com/v4/workflows/{workflowId}/resume \ --header 'x-api-key: <api-key>' "Workflow resumed" --- ## Page: https://docs.kadoa.com/api-reference/workflows/get-the-workflow-history GET workflowId string required The unique identifier of the workflow whose runs history is to be retrieved #### Response 200 application/json History of workflow runs workflowId string Unique identifier of the workflow workflowRuns object\[\] workflowRuns.id string Unique identifier of the workflow run workflowRuns.state enum<string> State of the workflow run Available options: `IN_PROGRESS`, `FINISHED`, `FAILED`, `NOT_SUPPORTED`, `FAILED_INSUFFICIENT_FUNDS` workflowRuns.startedAt string Start date and time of the workflow run workflowRuns.finishedAt string Finish date and time of the workflow run workflowRuns.screenshot string Screenshot of the navigation during the workflow run workflowRuns.records integer Number of records processed in the workflow run workflowRuns.protocol object workflowRuns.protocol.decision string state of the run if it FAILED workflowRuns.protocol.reasoning string description why the run failed workflowRuns.credits number Number of credits used for this workflow run --- ## Page: https://docs.kadoa.com/api-reference/monitoring/get-all-changes GET x-api-key string API key for authorization Authorization string Bearer token for authorization workflowIds string Comma-separated list of workflow IDs. If not provided, returns changes for all ACTIVE workflows startDate string Start date to filter changes (ISO format) endDate string End date to filter changes (ISO format) skip integer Number of records to skip for pagination limit integer Number of records to return for pagination #### Response 200 application/json Workflow changes returned successfully timestamp string Timestamp of the response changesCount integer Total number of changes found changes object\[\] changes.id string Unique identifier of the change changes.workflowId string ID of the workflow this change belongs to changes.data object\[\] Current state of the data after the change changes.diff object\[\] deprecated Structured representation of changes with text-based diffing (deprecated, use differences instead) changes.diff.count integer Number of lines affected by the change changes.diff.added boolean Whether this is an addition changes.diff.removed boolean | null Whether this is a removal changes.diff.value string The actual changed content changes.differences object\[\] Structured representation of changes with object-based diffing changes.differences.type enum<string> Type of change (added, removed, or changed) Available options: `added`, `removed`, `changed` changes.differences.fields object\[\] List of field changes changes.differences.fields.key string Field name changes.differences.fields.value string Current field value changes.differences.fields.previousValue string Previous field value (only present for changed type) changes.url string URL where the change was detected changes.screenshotUrl string URL of the screenshot taken when the change was detected changes.createdAt string Timestamp when the change was created Total number of changes found Current page number Total number of pages Number of records per page --- ## Page: https://docs.kadoa.com/api-reference/monitoring/get-change-by-id GET x-api-key string API key for authorization Authorization string Bearer token for authorization changeId string required ID of the workflow change to retrieve #### Response 200 application/json Workflow change returned successfully id string Unique identifier of the change workflowId string ID of the workflow this change belongs to data object\[\] Current state of the data after the change diff object\[\] deprecated Structured representation of changes with text-based diffing (deprecated, use differences instead) diff.count integer Number of lines affected by the change diff.added boolean Whether this is an addition diff.removed boolean | null Whether this is a removal diff.value string The actual changed content differences object\[\] Structured representation of changes with object-based diffing differences.type enum<string> Type of change (added, removed, or changed) Available options: `added`, `removed`, `changed` differences.fields object\[\] List of field changes differences.fields.key string Field name differences.fields.value string Current field value differences.fields.previousValue string Previous field value (only present for changed type) url string URL where the change was detected screenshotUrl string URL of the screenshot taken when the change was detected createdAt string Timestamp when the change was created --- ## Page: https://docs.kadoa.com/api-reference/advanced-workflows/create-advanced-workflow Kadoa API home page * Support * Kadoa Dashboard * Kadoa Dashboard Advanced Workflows Create a new advanced workflow ##### Documentation * Introduction * Quickstart * Workflow States * Schemas and Templates * Credits and Usage * Crawling * Adhoc Extractions * Workspaces * Chrome Extension * Monitoring * Integrations * Advanced Workflows * Security * Compliance * SDKs ##### API Reference * Introduction * Crawling * Workflows * Monitoring * Advanced Workflows * POST Create a new advanced workflow * GET Get all available workflow operators * PUT Update workflow steps * Templates * Adhoc * Events * Files * Webhooks * Locations Advanced Workflows Creates a new empty advanced workflow. POST / v4 / advanced-workflows curl -X POST "https://api.kadoa.com/v4/advanced-workflows" \ -H "x-api-key: YOUR_API_KEY" { "workflowId": "<string>" } #### Authorizations x-api-key string header required #### Headers x-api-key string API key for authorization Authorization string Bearer token for authorization #### Response 201 application/json Advanced workflow created successfully workflowId string ID of the newly created workflow Get data change by IDGet all available workflow operators curl -X POST "https://api.kadoa.com/v4/advanced-workflows" \ -H "x-api-key: YOUR_API_KEY" { "workflowId": "<string>" } --- ## Page: https://docs.kadoa.com/api-reference/advanced-workflows/get-all-available-workflow-operators Advanced Workflows Retrieves a list of all registered operators with their metadata, parameters, and type information GET x-api-key string header required #### Response 200 application/json Successfully retrieved operators operators object\[\] operators.name string The name of the operator operators.type enum<string> The type of the operator (input, action, or output) Available options: `input`, `action`, `output` operators.details object Detailed information about the operator operators.params object JSON schema for operator parameters operators.metadata object JSON schema for operator metadata --- ## Page: https://docs.kadoa.com/api-reference/advanced-workflows/update-workflow-steps Advanced Workflows Updates the steps of a specified workflow with validation and version control PUT x-api-key string header required x-api-key string required API key for authentication workflowId string required ID of the workflow to update #### Body application/json steps object\[\] required steps.id string required Unique identifier for the step steps.type enum<string> required Type of the workflow step Available options: `action`, `input`, `output` steps.name string required Name of the step steps.params object Parameters for the step (required for action and input types) steps.inputs object\[\] Array of input references (required for action and output types) steps.inputs.id string required ID reference to another step #### Response 200 application/json Steps updated successfully message string Example: `"Steps updated successfully"` id string Workflow ID version number Updated workflow version --- ## Page: https://docs.kadoa.com/api-reference/templates/get-all-templates Kadoa API home page * Support * Kadoa Dashboard * Kadoa Dashboard Templates Get all available templates ##### Documentation * Introduction * Quickstart * Workflow States * Schemas and Templates * Credits and Usage * Crawling * Adhoc Extractions * Workspaces * Chrome Extension * Monitoring * Integrations * Advanced Workflows * Security * Compliance * SDKs ##### API Reference * Introduction * Crawling * Workflows * Monitoring * Advanced Workflows * Templates * GET Get all available templates * GET Get template by ID * DEL Delete a template * PUT Rename a template * Adhoc * Events * Files * Webhooks * Locations Templates GET / v4 / templates curl --request GET \ --url https://api.kadoa.com/v4/templates \ --header 'x-api-key: <api-key>' { "data": [ {} ] } #### Authorizations x-api-key string header required #### Headers x-api-key string required API key for authorization #### Response 200 application/json Templates retrieved successfully data object\[\] Update workflow stepsGet template by ID curl --request GET \ --url https://api.kadoa.com/v4/templates \ --header 'x-api-key: <api-key>' { "data": [ {} ] } --- ## Page: https://docs.kadoa.com/api-reference/templates/get-template-by-id Templates GET / v4 / templates / {templateId} curl --request GET \ --url https://api.kadoa.com/v4/templates/{templateId} \ --header 'x-api-key: <api-key>' { "template": {} } #### Authorizations x-api-key string header required #### Headers x-api-key string required API key for authorization #### Path Parameters templateId string required ID of the schema to retrieve #### Response 200 application/json template retrieved successfully template object Get all available templatesDelete a template curl --request GET \ --url https://api.kadoa.com/v4/templates/{templateId} \ --header 'x-api-key: <api-key>' { "template": {} } --- ## Page: https://docs.kadoa.com/api-reference/templates/delete-a-template-by-id Templates DELETE / v4 / templates / {templateId} curl --request DELETE \ --url https://api.kadoa.com/v4/templates/{templateId} \ --header 'x-api-key: <api-key>' #### Authorizations x-api-key string header required #### Headers x-api-key string required API key for authorization #### Path Parameters templateId string required ID of the template to delete #### Response 200 \_mintlify/placeholder Template deleted successfully Get template by IDRename a template curl --request DELETE \ --url https://api.kadoa.com/v4/templates/{templateId} \ --header 'x-api-key: <api-key>' --- ## Page: https://docs.kadoa.com/api-reference/templates/rename-a-template-by-id Templates PUT / v4 / templates / {templateId} / rename curl --request PUT \ --url https://api.kadoa.com/v4/templates/{templateId}/rename \ --header 'Content-Type: application/json' \ --header 'x-api-key: <api-key>' \ --data '{ "name": "<string>" }' x-api-key string header required x-api-key string required API key for authorization templateId string required ID of the template to rename #### Body application/json name string New name for the template #### Response 200 \_mintlify/placeholder Template renamed successfully curl --request PUT \ --url https://api.kadoa.com/v4/templates/{templateId}/rename \ --header 'Content-Type: application/json' \ --header 'x-api-key: <api-key>' \ --data '{ "name": "<string>" }' --- ## Page: https://docs.kadoa.com/api-reference/adhoc/run-synchronous-extraction POST templateId string required Either a custom template ID or one of the following special values: * `html` - Returns raw HTML of the page * `body` - Returns cleaned HTML body content * `markdown` - Returns content converted to markdown format #### Body application/json link string required The URL link to be scraped location object The location object for the proxy location.type string The type of location, either auto or manual location.isoCode string The ISO code of the location, only required if type is manual. Available locations can be found on the locations api. #### Response 200 application/json Response object containing scraping data and request metadata status string Status of the response link string The URL that was scraped location object The location object used for the proxy data object Validated data after scraping and processing screenshotUrl string Path to the screenshot requestTimeMs integer The time taken to process the request in milliseconds --- ## Page: https://docs.kadoa.com/api-reference/events/get-the-list-of-available-webhook-events ##### Documentation * Introduction * Quickstart * Workflow States * Schemas and Templates * Credits and Usage * Crawling * Adhoc Extractions * Workspaces * Chrome Extension * Monitoring * Integrations * Advanced Workflows * Security * Compliance * SDKs ##### API Reference * Introduction * Crawling * Workflows * Monitoring * Advanced Workflows * Templates * Adhoc * Events * GET Get the list of webhook events * Files * Webhooks * Locations Events GET / v4 / events curl --request GET \ --url https://api.kadoa.com/v4/events \ --header 'x-api-key: <api-key>' [ { "name": "<string>", "description": "<string>", "schema": {} } ] #### Authorizations x-api-key string header required #### Response 200 application/json List of available events name string The name of the event description string A brief description of the event schema object The schema of the event payload Extract data from a single webpageDownload a file curl --request GET \ --url https://api.kadoa.com/v4/events \ --header 'x-api-key: <api-key>' [ { "name": "<string>", "description": "<string>", "schema": {} } ] --- ## Page: https://docs.kadoa.com/api-reference/files/get-file-by-name Files Downloads a specific file from the storage GET / v4 / files / {fileName} curl --request GET \ --url https://api.kadoa.com/v4/files/{fileName} \ --header 'x-api-key: <api-key>' This response does not have an example. #### Authorizations x-api-key string header required #### Path Parameters fileName string required Name of the file to download #### Response 200 application/octet-stream File content File content in its original format Get the list of webhook eventsList all webhook event subscriptions --- ## Page: https://docs.kadoa.com/api-reference/webhooks/list-all-webhook-event-subscriptions Webhooks GET x-api-key string header required #### Response 200 application/json List of webhook subscriptions id string The ID of the webhook subscription webhookConfig object The configuration of the webhook webhookConfig.url string The URL where the webhook events are sent webhookConfig.httpMethod string The HTTP method to use for the webhook (GET or POST) events string\[\] The list of subscribed events --- ## Page: https://docs.kadoa.com/api-reference/webhooks/subscribe-to-webhook-events Webhooks POST x-api-key string header required #### Body application/json webhookUrl string required The URL to send the webhook events to webhookHttpMethod enum<string> required The HTTP method to use for the webhook (GET or POST) Available options: `GET`, `POST` events any\[\] required The list of events to subscribe to (available events can be fetched over the /events API) #### Response 201 application/json Webhook subscription created successfully id string The ID of the created webhook subscription message string Success message --- ## Page: https://docs.kadoa.com/api-reference/webhooks/unsubscribe-from-webhook-events ##### Documentation * Introduction * Quickstart * Workflow States * Schemas and Templates * Credits and Usage * Crawling * Adhoc Extractions * Workspaces * Chrome Extension * Monitoring * Integrations * Advanced Workflows * Security * Compliance * SDKs ##### API Reference * Introduction * Crawling * Workflows * Monitoring * Advanced Workflows * Templates * Adhoc * Events * Files * Webhooks * GET List all webhook event subscriptions * POST Subscribe to webhook events * DEL Unsubscribe from webhook events * Locations Webhooks DELETE / v4 / webhook-subscriptions / {subscriptionId} curl --request DELETE \ --url https://api.kadoa.com/v4/webhook-subscriptions/{subscriptionId} \ --header 'x-api-key: <api-key>' #### Authorizations x-api-key string header required #### Path Parameters subscriptionId string required The ID of the webhook subscription to unsubscribe from #### Response 200 \_mintlify/placeholder Webhook subscription deleted successfully Subscribe to webhook eventsGet all available locations curl --request DELETE \ --url https://api.kadoa.com/v4/webhook-subscriptions/{subscriptionId} \ --header 'x-api-key: <api-key>' --- ## Page: https://docs.kadoa.com/api-reference/locations/get-all-locations ##### Documentation * Introduction * Quickstart * Workflow States * Schemas and Templates * Credits and Usage * Crawling * Adhoc Extractions * Workspaces * Chrome Extension * Monitoring * Integrations * Advanced Workflows * Security * Compliance * SDKs ##### API Reference * Introduction * Crawling * Workflows * Monitoring * Advanced Workflows * Templates * Adhoc * Events * Files * Webhooks * Locations * GET Get all available locations Locations GET / v4 / locations curl --request GET \ --url https://api.kadoa.com/v4/locations \ --header 'x-api-key: <api-key>' { "locations": [ { "countryName": "<string>", "isoCode": "<string>" } ] } x-api-key string header required #### Response 200 application/json List of available locations locations object\[\] locations.countryName string Full name of the country locations.isoCode string Two-letter ISO country code in uppercase curl --request GET \ --url https://api.kadoa.com/v4/locations \ --header 'x-api-key: <api-key>' { "locations": [ { "countryName": "<string>", "isoCode": "<string>" } ] }