Adhoc Extractions

Introduction

Adhoc extractions let you instantly extract data from a single webpage. Unlike workflows which run on a schedule, these are one-time extractions that run instantly when requested.

Prerequisites

To get the most out of this guide, you’ll need to:

• Create a Kadoa account
• Get your API key

1. Choose the Result Format

Every Adhoc request includes templateId in the URL path:

• Custom Template ID: Use your own workflow template
• html: Returns the page’s raw HTML
• body: Returns a cleaned HTML body
• markdown: Returns the page in Markdown

2. Use A Proxy Location (Optional)

If you need to specify a proxy location, you can retrieve valid locations first:

GET https://api.kadoa.com/v4/locations

See API Reference

Sample Response

{
  "locations": [
    {
      "countryName": "United States",
      "isoCode": "US"
    },
    {
      "countryName": "Germany",
      "isoCode": "DE"
    }
  ]
}

Use the returned isoCode values in your Adhoc requests for location.isoCode.

3. Run an Adhoc Extraction

To initiate an adhoc extraction, send a POST request to the /adhoc endpoint with the desired configuration.

See API Reference

curl -X POST "https://api.kadoa.com/v4/adhoc/markdown" \
  -H "Content-Type: application/json" \
  -H "x-api-key: <YOUR_API_KEY>" \
  -d '{
    "link": "https://demo.vercel.store/product/acme-drawstring-bag",
    "location": {
      "type": "manual",
      "isoCode": "US"
    }
  }'

A successful response should look like this:

{
  "status": "SUCCESS",
  "link": "https://demo.vercel.store/product/acme-drawstring-bag",
  "location": {
    "type": "manual",
    "isoCode": "US"
  },
  "data": "[Acme Store](/)\n* #Sample Markdown\n\n## Heading 2\n\nThis is a **bold** text and this is *italic*.\n\n",
  "screenshotUrl": "https://storage.googleapis.com/kadoa-public-share/screenshots/12345.jpeg",
  "requestTimeMs": 8353
}