MH MediaHarvester Web Context API
107 API OPERATIONS 207 GUIDES REST + SDK CLI + MCP NO-CODE

Developer Docs

We help developers extract and structure publicly accessible or authorized web data responsibly.

Local API access http://127.0.0.1:8013 Send X-API-Key: 1d251a33bcf2e90689dd9eac608f70c0302faccec7afaedc for protected /api/* and /v1/* calls.
Open Playground

Choose your goal

Start with the outcome you want

You do not need to understand the whole platform first. Pick a goal, run the smallest working request, then add the next capability only when your product needs it.

One request, clear evidence

How MediaHarvester fits into your application

Your app sends a URL, domain, file or structured question. MediaHarvester returns the requested data plus the status and source context your application needs to decide what happens next.

1Choose an inputURL, domain, email, ticker, file or question
2Call one capabilityScrape, enrich, extract, capture or transform
3Check the resultData, sources, confidence, access state and metadata
4Use it in your productAgent, CRM, dashboard, report, workflow or download

Feature directory

Every customer-facing capability

Search by task, format, endpoint or output. Each result opens the focused guide or working tool.

Use casesEnd-to-end examples that connect product problems to working API flows. 14
Power LLMs with Web Context

Give AI agents real-time website context with clean markdown, crawl results, screenshots, brand data and structured extraction.

POST /v1/web/crawl
Reduce Onboarding Friction

Personalize onboarding automatically with company logos, colors, fonts, styleguides, descriptions and industry classification.

GET /v1/brand/retrieve
Enrich Company Profiles

Build richer CRM, directory and marketplace profiles with logos, descriptions, socials, colors, addresses and industry data.

GET /v1/brand/retrieve-by-email
Automated Brand Kits

Generate brand kits on demand with logos, colors, typography, component tokens, CSS variables and Tailwind theme exports.

POST /v1/workflows/brand-kit
Stock Ticker Enrichment

Resolve public-company tickers and ISINs into company websites, logos, brand profiles and stock metadata.

GET /v1/brand/retrieve-by-ticker
Logo Link API

Serve company logos through a spreadsheet-friendly public Logo Link endpoint with monogram fallback.

GET /logo-link
Power Generative AI

Enhance AI generation with real-time brand context, product facts, pricing pages, images and styleguide tokens.

POST /v1/brand/ai/query
Transaction and Billing Data

Map messy merchant descriptors to real-world brands, categories, logos and company context.

GET /v1/brand/transaction-identifier
Programmatic Theming

Make your app adopt each customer’s look and feel with extracted colors, typography, buttons, cards and CSS exports.

GET /v1/web/styleguide
Zapier Automations

Build no-code workflows for brand enrichment, client slides, company research and logo delivery.

integrations/zapier
Competitor Intelligence API

Monitor competitor websites for positioning, products, pricing, screenshots, style changes and content updates.

POST /v1/workflows/competitor-monitoring
E-commerce Product Extraction

Extract product names, prices, currencies, availability, images and catalog candidates from e-commerce websites.

POST /v1/brand/ai/products
RAG Website Ingestion

Convert websites into clean markdown, metadata, links and source-aware chunks for retrieval-augmented generation.

POST /v1/web/crawl
Agency Client Reporting

Automate branded audits, website research, screenshots, styleguides and client presentation assets.

POST /v1/workflows/client-presentation
Web and company dataFocused data APIs with request fields, response guidance and developer FAQs. 25
Crawl Website

Crawl any public or authorized site and extract Markdown from every selected page.

POST /v1/web/crawl
Scrape HTML

Extract HTML from any accessible URL, including page frames when requested.

GET /v1/web/scrape/html
Scrape Markdown

Convert webpages to clean, LLM-ready Markdown with links, images and freshness controls.

GET /v1/web/scrape/markdown
Meta Title and Description

Extract title tags, meta descriptions, Open Graph, Twitter card, canonical URL and language metadata from a URL.

GET /v1/web/meta
Scrape Images

Extract images, responsive sources, CSS backgrounds, inline SVGs and video posters from any URL.

GET /v1/web/scrape/images
Royalty-Free Image Finder

Find attribution-free stock image links from curated providers for website heroes, sections and design mockups.

POST /v1/royalty-free-images/search
Image OCR

Extract text from image uploads, image URLs or base64 payloads with a Paddle-first OCR fallback chain.

POST /v1/ocr/json
YouTube Transcript

Fetch timestamped YouTube transcripts with a three-step fallback chain and minute-second labels.

POST /v1/youtube/transcript
Scrape Sitemap

Discover all page URLs from robots.txt, sitemap indexes and XML sitemap files.

GET /v1/web/scrape/sitemap
Company Logos

Fetch company logo candidates and serve spreadsheet-ready logo images from a domain.

GET /logo-link
Company Colors

Extract brand color palettes and semantic color tokens from any public or authorized website.

GET /v1/brand/retrieve
Company Address

Find company address, contact page and location signals from public website data.

GET /v1/brand/retrieve
Company Description

Generate concise company summaries from title, meta, Open Graph and website content.

GET /v1/brand/retrieve
Company Socials

Find official social media profiles and normalized profile links for a company domain.

GET /v1/brand/retrieve
Company Styleguide

Retrieve full website styleguides with colors, typography, spacing, shadows and component tokens.

GET /v1/web/styleguide
Company Fonts

Detect web fonts used by a company and return font links where available.

GET /v1/web/fonts
NAICS Classification

Classify companies by NAICS industry codes from domain or descriptive text input.

GET /v1/web/naics
SIC Classification

Classify companies by SIC industry codes from public web context or text.

GET /v1/web/sic
Website Screenshot

Capture up-to-date website screenshots for demos, audits, monitoring and reports.

GET /v1/web/screenshot
Transaction Identification

Map merchant descriptors to real-world brands, categories and logo-ready company profiles.

GET /v1/brand/transaction-identifier
Web Search API

Search the web and optionally collect clean markdown from result pages.

POST /v1/web/search
AI Query API

Ask a website for custom datapoints and receive structured JSON with source evidence.

POST /v1/brand/ai/query
Product Extraction

Extract product data, images, prices and availability from ecommerce pages and catalogs.

POST /v1/brand/ai/products
Image Enrichment

Classify and enrich website images with dimensions, MIME type, colors and hosted URLs.

GET /v1/web/scrape/images
EIC Classification

Classify companies with MediaHarvester's extended industry categories for modern web workflows.

GET /v1/web/eic
Image conversionsFormat-specific conversion pages with upload, API and CLI access. 88
App Icon Generator

Generates a ZIP of multi-size app icons.

POST /api/image-conversion/app-icon-generator/convert
AVIF to BMP Converter

None

POST /api/image-conversion/avif-to-bmp/convert
AVIF to GIF Converter

None

POST /api/image-conversion/avif-to-gif/convert
AVIF to JPEG Converter

None

POST /api/image-conversion/avif-to-jpeg/convert
AVIF to JPG Converter

None

POST /api/image-conversion/avif-to-jpg/convert
AVIF to PDF Converter

None

POST /api/image-conversion/avif-to-pdf/convert
AVIF to PNG Converter

None

POST /api/image-conversion/avif-to-png/convert
AVIF to TIFF Converter

None

POST /api/image-conversion/avif-to-tiff/convert
AVIF to WEBP Converter

None

POST /api/image-conversion/avif-to-webp/convert
BMP to AVIF Converter

None

POST /api/image-conversion/bmp-to-avif/convert
BMP to JPG Converter

None

POST /api/image-conversion/bmp-to-jpg/convert
BMP to PDF Converter

None

POST /api/image-conversion/bmp-to-pdf/convert
BMP to PNG Converter

None

POST /api/image-conversion/bmp-to-png/convert
BMP to WEBP Converter

None

POST /api/image-conversion/bmp-to-webp/convert
Favicon Generator

Generates favicon.ico plus PNG variants from uploaded image.

POST /api/image-conversion/favicon-generator/convert
GIF to AVIF Converter

None

POST /api/image-conversion/gif-to-avif/convert
GIF to JPG Converter

None

POST /api/image-conversion/gif-to-jpg/convert
GIF to MP4 Converter

None

POST /api/image-conversion/gif-to-mp4/convert
GIF to PDF Converter

None

POST /api/image-conversion/gif-to-pdf/convert
GIF to PNG Converter

None

POST /api/image-conversion/gif-to-png/convert
GIF to WEBM Converter

None

POST /api/image-conversion/gif-to-webm/convert
GIF to WEBP Converter

None

POST /api/image-conversion/gif-to-webp/convert
HEIC to AVIF Converter

None

POST /api/image-conversion/heic-to-avif/convert
HEIC to JPEG Converter

None

POST /api/image-conversion/heic-to-jpeg/convert
HEIC to JPG Converter

None

POST /api/image-conversion/heic-to-jpg/convert
HEIC to PDF Converter

None

POST /api/image-conversion/heic-to-pdf/convert
HEIC to PNG Converter

None

POST /api/image-conversion/heic-to-png/convert
HEIC to WEBP Converter

None

POST /api/image-conversion/heic-to-webp/convert
HEIF to JPG Converter

None

POST /api/image-conversion/heif-to-jpg/convert
HEIF to PNG Converter

None

POST /api/image-conversion/heif-to-png/convert
ICO to JPG Converter

None

POST /api/image-conversion/ico-to-jpg/convert
ICO to PNG Converter

None

POST /api/image-conversion/ico-to-png/convert
ICO to WEBP Converter

None

POST /api/image-conversion/ico-to-webp/convert
JPEG to AVIF Converter

None

POST /api/image-conversion/jpeg-to-avif/convert
JPEG to JPG Converter

None

POST /api/image-conversion/jpeg-to-jpg/convert
JPEG to PNG Converter

None

POST /api/image-conversion/jpeg-to-png/convert
JPEG to WEBP Converter

None

POST /api/image-conversion/jpeg-to-webp/convert
JPG to AVIF Converter

None

POST /api/image-conversion/jpg-to-avif/convert
JPG to BMP Converter

None

POST /api/image-conversion/jpg-to-bmp/convert
JPG to GIF Converter

None

POST /api/image-conversion/jpg-to-gif/convert
JPG to HEIC Converter

None

POST /api/image-conversion/jpg-to-heic/convert
JPG to ICO Converter

None

POST /api/image-conversion/jpg-to-ico/convert
JPG to JPEG Converter

None

POST /api/image-conversion/jpg-to-jpeg/convert
JPG to PDF Converter

None

POST /api/image-conversion/jpg-to-pdf/convert
JPG to PNG Converter

None

POST /api/image-conversion/jpg-to-png/convert
JPG to SVG Converter

SVG mode supports real vector tracing (Basic/High Detail) and fast embed output. Default is Basic Vector.

POST /api/image-conversion/jpg-to-svg/convert
JPG to TIFF Converter

None

POST /api/image-conversion/jpg-to-tiff/convert
JPG to WEBP Converter

None

POST /api/image-conversion/jpg-to-webp/convert
Logo to Favicon Converter

Converts logo to favicon package.

POST /api/image-conversion/logo-to-favicon/convert
PDF to JPG Converter

None

POST /api/image-conversion/pdf-to-jpg/convert
PDF to PNG Converter

None

POST /api/image-conversion/pdf-to-png/convert
PDF to TIFF Converter

None

POST /api/image-conversion/pdf-to-tiff/convert
PDF to WEBP Converter

None

POST /api/image-conversion/pdf-to-webp/convert
PNG to AVIF Converter

None

POST /api/image-conversion/png-to-avif/convert
PNG to BMP Converter

None

POST /api/image-conversion/png-to-bmp/convert
PNG to GIF Converter

None

POST /api/image-conversion/png-to-gif/convert
PNG to HEIC Converter

None

POST /api/image-conversion/png-to-heic/convert
PNG to ICO Converter

None

POST /api/image-conversion/png-to-ico/convert
PNG to JPEG Converter

None

POST /api/image-conversion/png-to-jpeg/convert
PNG to JPG Converter

None

POST /api/image-conversion/png-to-jpg/convert
PNG to PDF Converter

None

POST /api/image-conversion/png-to-pdf/convert
PNG to SVG Converter

SVG mode supports real vector tracing (Basic/High Detail) and fast embed output. Default is Basic Vector.

POST /api/image-conversion/png-to-svg/convert
PNG to TIFF Converter

None

POST /api/image-conversion/png-to-tiff/convert
PNG to WEBP Converter

None

POST /api/image-conversion/png-to-webp/convert
SVG to AVIF Converter

None

POST /api/image-conversion/svg-to-avif/convert
SVG to ICO Converter

None

POST /api/image-conversion/svg-to-ico/convert
SVG to JPEG Converter

None

POST /api/image-conversion/svg-to-jpeg/convert
SVG to JPG Converter

None

POST /api/image-conversion/svg-to-jpg/convert
SVG to PDF Converter

None

POST /api/image-conversion/svg-to-pdf/convert
SVG to PNG Converter

None

POST /api/image-conversion/svg-to-png/convert
SVG to WEBP Converter

None

POST /api/image-conversion/svg-to-webp/convert
TIF to JPG Converter

None

POST /api/image-conversion/tif-to-jpg/convert
TIF to PNG Converter

None

POST /api/image-conversion/tif-to-png/convert
TIFF to AVIF Converter

None

POST /api/image-conversion/tiff-to-avif/convert
TIFF to JPG Converter

None

POST /api/image-conversion/tiff-to-jpg/convert
TIFF to PDF Converter

None

POST /api/image-conversion/tiff-to-pdf/convert
TIFF to PNG Converter

None

POST /api/image-conversion/tiff-to-png/convert
TIFF to WEBP Converter

None

POST /api/image-conversion/tiff-to-webp/convert
WEBP to AVIF Converter

None

POST /api/image-conversion/webp-to-avif/convert
WEBP to BMP Converter

None

POST /api/image-conversion/webp-to-bmp/convert
WEBP to GIF Converter

None

POST /api/image-conversion/webp-to-gif/convert
WEBP to ICO Converter

None

POST /api/image-conversion/webp-to-ico/convert
WEBP to JPEG Converter

None

POST /api/image-conversion/webp-to-jpeg/convert
WEBP to JPG Converter

None

POST /api/image-conversion/webp-to-jpg/convert
WEBP to PDF Converter

None

POST /api/image-conversion/webp-to-pdf/convert
WEBP to PNG Converter

None

POST /api/image-conversion/webp-to-png/convert
WEBP to SVG Converter

SVG mode supports real vector tracing (Basic/High Detail) and fast embed output. Default is Basic Vector.

POST /api/image-conversion/webp-to-svg/convert
WEBP to TIFF Converter

None

POST /api/image-conversion/webp-to-tiff/convert
Image toolsSingle and batch image transformations for common production workflows. 80
Batch Compress Images

Reduce image file size with balanced, smallest, lossless, target-size, and web-optimized modes. Upload multiple images, tune output settings, and download the result instantly.

POST /v1/image/compress
Compress AVIF

Reduce image file size with balanced, smallest, lossless, target-size, and web-optimized modes. Upload AVIF images, tune output settings, and download the result instantly.

POST /v1/image/compress
Compress BMP

Reduce image file size with balanced, smallest, lossless, target-size, and web-optimized modes. Upload BMP images, tune output settings, and download the result instantly.

POST /v1/image/compress
Compress GIF

Reduce image file size with balanced, smallest, lossless, target-size, and web-optimized modes. Upload GIF images, tune output settings, and download the result instantly.

POST /v1/image/compress
Compress HEIC

Reduce image file size with balanced, smallest, lossless, target-size, and web-optimized modes. Upload HEIC images, tune output settings, and download the result instantly.

POST /v1/image/compress
Compress HEIF

Reduce image file size with balanced, smallest, lossless, target-size, and web-optimized modes. Upload HEIF images, tune output settings, and download the result instantly.

POST /v1/image/compress
Compress ICO

Reduce image file size with balanced, smallest, lossless, target-size, and web-optimized modes. Upload ICO images, tune output settings, and download the result instantly.

POST /v1/image/compress
Compress Image

Reduce image file size with balanced, smallest, lossless, target-size, and web-optimized modes. Upload images, tune output settings, and download the result instantly.

POST /v1/image/compress
Compress JPEG

Reduce image file size with balanced, smallest, lossless, target-size, and web-optimized modes. Upload JPEG images, tune output settings, and download the result instantly.

POST /v1/image/compress
Compress JPG

Reduce image file size with balanced, smallest, lossless, target-size, and web-optimized modes. Upload JPG images, tune output settings, and download the result instantly.

POST /v1/image/compress
Compress PDF

Reduce image file size with balanced, smallest, lossless, target-size, and web-optimized modes. Upload PDF images, tune output settings, and download the result instantly.

POST /v1/image/compress
Compress PNG

Reduce image file size with balanced, smallest, lossless, target-size, and web-optimized modes. Upload PNG images, tune output settings, and download the result instantly.

POST /v1/image/compress
Compress SVG

Reduce image file size with balanced, smallest, lossless, target-size, and web-optimized modes. Upload SVG images, tune output settings, and download the result instantly.

POST /v1/image/compress
Compress TIF

Reduce image file size with balanced, smallest, lossless, target-size, and web-optimized modes. Upload TIF images, tune output settings, and download the result instantly.

POST /v1/image/compress
Compress TIFF

Reduce image file size with balanced, smallest, lossless, target-size, and web-optimized modes. Upload TIFF images, tune output settings, and download the result instantly.

POST /v1/image/compress
Compress WebP

Reduce image file size with balanced, smallest, lossless, target-size, and web-optimized modes. Upload WebP images, tune output settings, and download the result instantly.

POST /v1/image/compress
Batch Crop Images

Crop images manually or by common aspect ratio presets for web, social, and product assets. Upload multiple images, tune output settings, and download the result instantly.

POST /v1/image/crop
Crop AVIF

Crop images manually or by common aspect ratio presets for web, social, and product assets. Upload AVIF images, tune output settings, and download the result instantly.

POST /v1/image/crop
Crop BMP

Crop images manually or by common aspect ratio presets for web, social, and product assets. Upload BMP images, tune output settings, and download the result instantly.

POST /v1/image/crop
Crop GIF

Crop images manually or by common aspect ratio presets for web, social, and product assets. Upload GIF images, tune output settings, and download the result instantly.

POST /v1/image/crop
Crop HEIC

Crop images manually or by common aspect ratio presets for web, social, and product assets. Upload HEIC images, tune output settings, and download the result instantly.

POST /v1/image/crop
Crop HEIF

Crop images manually or by common aspect ratio presets for web, social, and product assets. Upload HEIF images, tune output settings, and download the result instantly.

POST /v1/image/crop
Crop ICO

Crop images manually or by common aspect ratio presets for web, social, and product assets. Upload ICO images, tune output settings, and download the result instantly.

POST /v1/image/crop
Crop Image

Crop images manually or by common aspect ratio presets for web, social, and product assets. Upload images, tune output settings, and download the result instantly.

POST /v1/image/crop
Crop JPEG

Crop images manually or by common aspect ratio presets for web, social, and product assets. Upload JPEG images, tune output settings, and download the result instantly.

POST /v1/image/crop
Crop JPG

Crop images manually or by common aspect ratio presets for web, social, and product assets. Upload JPG images, tune output settings, and download the result instantly.

POST /v1/image/crop
Crop PDF

Crop images manually or by common aspect ratio presets for web, social, and product assets. Upload PDF images, tune output settings, and download the result instantly.

POST /v1/image/crop
Crop PNG

Crop images manually or by common aspect ratio presets for web, social, and product assets. Upload PNG images, tune output settings, and download the result instantly.

POST /v1/image/crop
Crop SVG

Crop images manually or by common aspect ratio presets for web, social, and product assets. Upload SVG images, tune output settings, and download the result instantly.

POST /v1/image/crop
Crop TIF

Crop images manually or by common aspect ratio presets for web, social, and product assets. Upload TIF images, tune output settings, and download the result instantly.

POST /v1/image/crop
Crop TIFF

Crop images manually or by common aspect ratio presets for web, social, and product assets. Upload TIFF images, tune output settings, and download the result instantly.

POST /v1/image/crop
Crop WebP

Crop images manually or by common aspect ratio presets for web, social, and product assets. Upload WebP images, tune output settings, and download the result instantly.

POST /v1/image/crop
Batch Resize Images

Resize images by width, height, exact size, fit mode, or aspect-safe constraints. Upload multiple images, tune output settings, and download the result instantly.

POST /v1/image/resize
Resize AVIF

Resize images by width, height, exact size, fit mode, or aspect-safe constraints. Upload AVIF images, tune output settings, and download the result instantly.

POST /v1/image/resize
Resize BMP

Resize images by width, height, exact size, fit mode, or aspect-safe constraints. Upload BMP images, tune output settings, and download the result instantly.

POST /v1/image/resize
Resize GIF

Resize images by width, height, exact size, fit mode, or aspect-safe constraints. Upload GIF images, tune output settings, and download the result instantly.

POST /v1/image/resize
Resize HEIC

Resize images by width, height, exact size, fit mode, or aspect-safe constraints. Upload HEIC images, tune output settings, and download the result instantly.

POST /v1/image/resize
Resize HEIF

Resize images by width, height, exact size, fit mode, or aspect-safe constraints. Upload HEIF images, tune output settings, and download the result instantly.

POST /v1/image/resize
Resize ICO

Resize images by width, height, exact size, fit mode, or aspect-safe constraints. Upload ICO images, tune output settings, and download the result instantly.

POST /v1/image/resize
Resize Image

Resize images by width, height, exact size, fit mode, or aspect-safe constraints. Upload images, tune output settings, and download the result instantly.

POST /v1/image/resize
Resize JPEG

Resize images by width, height, exact size, fit mode, or aspect-safe constraints. Upload JPEG images, tune output settings, and download the result instantly.

POST /v1/image/resize
Resize JPG

Resize images by width, height, exact size, fit mode, or aspect-safe constraints. Upload JPG images, tune output settings, and download the result instantly.

POST /v1/image/resize
Resize PDF

Resize images by width, height, exact size, fit mode, or aspect-safe constraints. Upload PDF images, tune output settings, and download the result instantly.

POST /v1/image/resize
Resize PNG

Resize images by width, height, exact size, fit mode, or aspect-safe constraints. Upload PNG images, tune output settings, and download the result instantly.

POST /v1/image/resize
Resize SVG

Resize images by width, height, exact size, fit mode, or aspect-safe constraints. Upload SVG images, tune output settings, and download the result instantly.

POST /v1/image/resize
Resize TIF

Resize images by width, height, exact size, fit mode, or aspect-safe constraints. Upload TIF images, tune output settings, and download the result instantly.

POST /v1/image/resize
Resize TIFF

Resize images by width, height, exact size, fit mode, or aspect-safe constraints. Upload TIFF images, tune output settings, and download the result instantly.

POST /v1/image/resize
Resize WebP

Resize images by width, height, exact size, fit mode, or aspect-safe constraints. Upload WebP images, tune output settings, and download the result instantly.

POST /v1/image/resize
Batch Rotate Images

Rotate images clockwise or counter-clockwise while preserving transparency and choosing output format. Upload multiple images, tune output settings, and download the result instantly.

POST /v1/image/rotate
Rotate AVIF

Rotate images clockwise or counter-clockwise while preserving transparency and choosing output format. Upload AVIF images, tune output settings, and download the result instantly.

POST /v1/image/rotate
Rotate BMP

Rotate images clockwise or counter-clockwise while preserving transparency and choosing output format. Upload BMP images, tune output settings, and download the result instantly.

POST /v1/image/rotate
Rotate GIF

Rotate images clockwise or counter-clockwise while preserving transparency and choosing output format. Upload GIF images, tune output settings, and download the result instantly.

POST /v1/image/rotate
Rotate HEIC

Rotate images clockwise or counter-clockwise while preserving transparency and choosing output format. Upload HEIC images, tune output settings, and download the result instantly.

POST /v1/image/rotate
Rotate HEIF

Rotate images clockwise or counter-clockwise while preserving transparency and choosing output format. Upload HEIF images, tune output settings, and download the result instantly.

POST /v1/image/rotate
Rotate ICO

Rotate images clockwise or counter-clockwise while preserving transparency and choosing output format. Upload ICO images, tune output settings, and download the result instantly.

POST /v1/image/rotate
Rotate Image

Rotate images clockwise or counter-clockwise while preserving transparency and choosing output format. Upload images, tune output settings, and download the result instantly.

POST /v1/image/rotate
Rotate JPEG

Rotate images clockwise or counter-clockwise while preserving transparency and choosing output format. Upload JPEG images, tune output settings, and download the result instantly.

POST /v1/image/rotate
Rotate JPG

Rotate images clockwise or counter-clockwise while preserving transparency and choosing output format. Upload JPG images, tune output settings, and download the result instantly.

POST /v1/image/rotate
Rotate PDF

Rotate images clockwise or counter-clockwise while preserving transparency and choosing output format. Upload PDF images, tune output settings, and download the result instantly.

POST /v1/image/rotate
Rotate PNG

Rotate images clockwise or counter-clockwise while preserving transparency and choosing output format. Upload PNG images, tune output settings, and download the result instantly.

POST /v1/image/rotate
Rotate SVG

Rotate images clockwise or counter-clockwise while preserving transparency and choosing output format. Upload SVG images, tune output settings, and download the result instantly.

POST /v1/image/rotate
Rotate TIF

Rotate images clockwise or counter-clockwise while preserving transparency and choosing output format. Upload TIF images, tune output settings, and download the result instantly.

POST /v1/image/rotate
Rotate TIFF

Rotate images clockwise or counter-clockwise while preserving transparency and choosing output format. Upload TIFF images, tune output settings, and download the result instantly.

POST /v1/image/rotate
Rotate WebP

Rotate images clockwise or counter-clockwise while preserving transparency and choosing output format. Upload WebP images, tune output settings, and download the result instantly.

POST /v1/image/rotate
Batch Watermark Images

Add text watermarks with custom position, opacity, color, and output format for brand-safe image delivery. Upload multiple images, tune output settings, and download the result instantly.

POST /v1/image/watermark
Watermark AVIF

Add text watermarks with custom position, opacity, color, and output format for brand-safe image delivery. Upload AVIF images, tune output settings, and download the result instantly.

POST /v1/image/watermark
Watermark BMP

Add text watermarks with custom position, opacity, color, and output format for brand-safe image delivery. Upload BMP images, tune output settings, and download the result instantly.

POST /v1/image/watermark
Watermark GIF

Add text watermarks with custom position, opacity, color, and output format for brand-safe image delivery. Upload GIF images, tune output settings, and download the result instantly.

POST /v1/image/watermark
Watermark HEIC

Add text watermarks with custom position, opacity, color, and output format for brand-safe image delivery. Upload HEIC images, tune output settings, and download the result instantly.

POST /v1/image/watermark
Watermark HEIF

Add text watermarks with custom position, opacity, color, and output format for brand-safe image delivery. Upload HEIF images, tune output settings, and download the result instantly.

POST /v1/image/watermark
Watermark ICO

Add text watermarks with custom position, opacity, color, and output format for brand-safe image delivery. Upload ICO images, tune output settings, and download the result instantly.

POST /v1/image/watermark
Watermark Image

Add text watermarks with custom position, opacity, color, and output format for brand-safe image delivery. Upload images, tune output settings, and download the result instantly.

POST /v1/image/watermark
Watermark JPEG

Add text watermarks with custom position, opacity, color, and output format for brand-safe image delivery. Upload JPEG images, tune output settings, and download the result instantly.

POST /v1/image/watermark
Watermark JPG

Add text watermarks with custom position, opacity, color, and output format for brand-safe image delivery. Upload JPG images, tune output settings, and download the result instantly.

POST /v1/image/watermark
Watermark PDF

Add text watermarks with custom position, opacity, color, and output format for brand-safe image delivery. Upload PDF images, tune output settings, and download the result instantly.

POST /v1/image/watermark
Watermark PNG

Add text watermarks with custom position, opacity, color, and output format for brand-safe image delivery. Upload PNG images, tune output settings, and download the result instantly.

POST /v1/image/watermark
Watermark SVG

Add text watermarks with custom position, opacity, color, and output format for brand-safe image delivery. Upload SVG images, tune output settings, and download the result instantly.

POST /v1/image/watermark
Watermark TIF

Add text watermarks with custom position, opacity, color, and output format for brand-safe image delivery. Upload TIF images, tune output settings, and download the result instantly.

POST /v1/image/watermark
Watermark TIFF

Add text watermarks with custom position, opacity, color, and output format for brand-safe image delivery. Upload TIFF images, tune output settings, and download the result instantly.

POST /v1/image/watermark
Watermark WebP

Add text watermarks with custom position, opacity, color, and output format for brand-safe image delivery. Upload WebP images, tune output settings, and download the result instantly.

POST /v1/image/watermark

REST API reference

107 operations, grouped by job

Use this compact index to find the exact method, path and accepted input fields. OpenAPI remains available for schema-level detail.

Scraping and crawlFetch pages, discover URLs, crawl sites and return clean web content. 15
POST /v1/scrape/md
Scrape Markdown Input: url, include_links, include_images, main_content_only, render_js, fresh
GET /v1/scrape/html
Scrape Html Alias Get Input: url, includeLinks, includeImages, includeFrames, maxAgeMs, waitForMs, timeoutMS
POST /v1/scrape/html
Scrape Html Input: url, include_links, include_images, main_content_only, render_js, fresh
GET /v1/scrape/markdown
Scrape Markdown Alias Get Input: url, includeLinks, includeImages, shortenBase64Images, useMainContentOnly, includeFrames, maxAgeMs, waitForMs, timeoutMS
POST /v1/scrape/markdown
Scrape Markdown Alias Input: url, include_links, include_images, main_content_only, render_js, fresh
POST /v1/sitemap
Sitemap Input: url, max_urls
POST /v1/crawl
Crawl Input: url, max_pages, max_depth, output, respect_robots, webhook_url
GET /v1/web/scrape/html
Web Scrape Html Input: url, includeLinks, includeImages, includeFrames, maxAgeMs, waitForMs, timeoutMS, respectRobots
GET /v1/web/scrape/markdown
Web Scrape Markdown Input: url, includeLinks, includeImages, shortenBase64Images, useMainContentOnly, includeFrames, maxAgeMs, waitForMs, timeoutMS, respectRobots
GET /v1/web/scrape/meta
Web Meta Input: url, maxAgeMs
GET /v1/web/scrape/images
Web Scrape Images Input: url, includeCssBackgrounds, includeInlineSvg, includeDataUri, includeVideoPosters, enrichDimensions, enrichHostedUrl, enrichDominantColors, maxAgeMs
GET /v1/scrape/images
Scrape Images Alias Get Input: url, includeCssBackgrounds, includeInlineSvg, includeDataUri, includeVideoPosters, enrichDimensions, enrichHostedUrl, enrichDominantColors, maxAgeMs
GET /v1/web/scrape/sitemap
Web Scrape Sitemap Input: domain, maxLinks, urlRegex
GET /v1/scrape/sitemap
Scrape Sitemap Alias Get Input: domain, maxLinks, urlRegex
POST /v1/web/crawl
Web Crawl Input: url, maxPages, maxDepth, urlRegex, useMainContentOnly, followSubdomains, includeFrames, respectRobots, waitForMs, stopAfterMs, maxAgeMs, pdf
Brand and company dataResolve companies and return brand, logo, profile and classification data. 24
POST /v1/brand
Brand Input: domain, force_refresh
GET /v1/logo
Logo Input: domain, size
GET /logo
Logo Input: domain, size
GET /v1/logo-link
Public Logo Link Input: publicClientId, domain, size
HEAD /v1/logo-link
Public Logo Link Head Input: publicClientId, domain, size
GET /logos
Public Logo Link Input: publicClientId, domain, size
HEAD /logos
Public Logo Link Head Input: publicClientId, domain, size
GET /logo-link
Public Logo Link Input: publicClientId, domain, size
HEAD /logo-link
Public Logo Link Head Input: publicClientId, domain, size
GET /v1/brand/retrieve
Brand Retrieve Input: domain, force_refresh, force_language, maxSpeed, maxAgeMs, timeoutMS
GET /v1/brand/retrieve-simplified
Brand Retrieve Simplified Input: domain, maxAgeMs
GET /v1/brand/retrieve-by-email
Brand Retrieve By Email Input: email, maxAgeMs
GET /v1/brand/retrieve-by-name
Brand Retrieve By Name Input: name, country_gl, maxAgeMs
GET /v1/brand/retrieve-by-ticker
Brand Retrieve By Ticker Input: ticker, ticker_exchange
GET /v1/brand/retrieve-by-isin
Brand Retrieve By Isin Input: isin
GET /v1/brand/transaction-identifier
Transaction Identifier Api Input: transaction_info, country_gl, city, mcc, phone, high_confidence_only
POST /v1/brand/prefetch
Brand Prefetch Input: domain, force_refresh
POST /v1/brand/prefetch-by-email
Brand Prefetch By Email No request fields.
GET /v1/web/naics
Web Naics Input: value
GET /v1/web/sic
Web Sic Input: value
GET /v1/web/eic
Web Eic Input: value, domain
POST /v1/brand/ai/query
Brand Ai Query Input: domain, data_to_extract, specific_pages, timeoutMS
POST /v1/brand/ai/product
Brand Ai Product Input: url, timeoutMS
POST /v1/brand/ai/products
Brand Ai Products Input: domain, directUrl, maxProducts, maxAgeMs, timeoutMS
Structured extractionExtract custom fields, products, search results and workflow-ready records. 13
GET /v1/transaction-identifier
Transaction Identifier Api Input: transaction_info, country_gl, city, mcc, phone, high_confidence_only
POST /v1/web/search
Web Search Input: query, numResults, scrapeResults, domainFilters, freshness, queryFanout, markdown
POST /v1/workflows/lead-enrichment
Workflow Lead Enrichment Api Input: email, crm, external_id, allowManualOverride
POST /v1/workflows/brand-kit
Workflow Brand Kit Api Input: domain, includeStyleguide
POST /v1/workflows/client-presentation
Workflow Client Presentation Api Input: domain, templateId, title
POST /v1/workflows/competitor-monitoring
Workflow Competitor Monitoring Api Input: domains, fields
POST /v1/ai/query
Ai Query Api Input: domain, data_to_extract, max_pages
POST /v1/product
Product Api Input: url
POST /v1/products
Products Api Input: url, max_products
POST /v1/styleguide
Styleguide Api Input: domain
POST /v1/fonts
Fonts Api Input: domain
POST /v1/search
Search Api Input: domain, query, max_results
POST /v1/transaction
Transaction Api Input: transaction_text, amount, currency, mcc, location
Screenshots and media AICapture websites, run OCR and retrieve timestamped transcripts. 12
POST /v1/screenshot
Screenshot Api Input: url, device, full_page, format, width, height
POST /api/ocr/json
Ocr Json Api Input: image_url, image_base64, languages, preferred_engine, include_boxes
POST /v1/web/ocr/json
Ocr Json Api Input: image_url, image_base64, languages, preferred_engine, include_boxes
POST /v1/web/ocr
Ocr Json Api Input: image_url, image_base64, languages, preferred_engine, include_boxes
POST /v1/ocr/json
Ocr Json Api Input: image_url, image_base64, languages, preferred_engine, include_boxes
POST /api/ocr
Ocr Upload Api Input: file, image_url, image_base64, languages, preferred_engine, include_boxes
POST /v1/ocr
Ocr Upload Api Input: file, image_url, image_base64, languages, preferred_engine, include_boxes
POST /api/youtube/transcript
Youtube Transcript Api Input: video_id, video_url, languages, preserve_newlines
POST /v1/youtube/transcript
Youtube Transcript Api Input: video_id, video_url, languages, preserve_newlines
GET /v1/web/screenshot
Web Screenshot Input: domain, directUrl, page, fullScreenshot, handleCookiePopup, width, height, waitForMs
POST /v1/screenshots/batch
Web Screenshots Batch No request fields.
POST /v1/web/screenshots/batch
Web Screenshots Batch No request fields.
Image conversion and toolsConvert and transform uploaded images in single or batch requests. 11
GET /api/image-conversion/catalog
Image Conversion Catalog No request fields.
GET /v1/image/tools/catalog
Image Tools Catalog No request fields.
GET /api/image/tools/catalog
Image Tools Catalog No request fields.
GET /v1/image/advanced-formats
Advanced Image Formats No request fields.
POST /v1/image/batch
Image Tool Batch Operation Input: operation, files, width, height, fit, position, without_enlargement, output_format, quality, background_color, remove_metadata, crop_x, crop_y, crop_width, crop_height, crop_mode, aspect_ratio, compress_mode, target_size_kb, rotate_degrees, rotate_expand, watermark_text, watermark_position, watermark_opacity, watermark_font_size, watermark_color, page, dpi, force_zip
POST /api/image/batch
Image Tool Batch Operation Input: operation, files, width, height, fit, position, without_enlargement, output_format, quality, background_color, remove_metadata, crop_x, crop_y, crop_width, crop_height, crop_mode, aspect_ratio, compress_mode, target_size_kb, rotate_degrees, rotate_expand, watermark_text, watermark_position, watermark_opacity, watermark_font_size, watermark_color, page, dpi, force_zip
POST /v1/image/{operation}/json
Image Tool Json Operation Input: operation
POST /api/image/{operation}/json
Image Tool Json Operation Input: operation
POST /v1/image/{operation}
Image Tool Operation Input: operation, files, width, height, fit, position, without_enlargement, output_format, quality, background_color, remove_metadata, crop_x, crop_y, crop_width, crop_height, crop_mode, aspect_ratio, compress_mode, target_size_kb, rotate_degrees, rotate_expand, watermark_text, watermark_position, watermark_opacity, watermark_font_size, watermark_color, page, dpi, force_zip
POST /api/image/{operation}
Image Tool Operation Input: operation, files, width, height, fit, position, without_enlargement, output_format, quality, background_color, remove_metadata, crop_x, crop_y, crop_width, crop_height, crop_mode, aspect_ratio, compress_mode, target_size_kb, rotate_degrees, rotate_expand, watermark_text, watermark_position, watermark_opacity, watermark_font_size, watermark_color, page, dpi, force_zip
POST /api/image-conversion/{slug}/convert
Convert Image Slug Input: slug, files, quality, width, height, background_color, remove_metadata, compress_level, page, dpi, fps, all_frames, force_zip, svg_mode, svg_color_count, svg_detail, svg_remove_white
Files and media bundlesPreview scraped media, create bundles and download generated assets. 4
POST /api/preview
Preview Input: source_mode, mode, image_size_filter, custom_min_edge_px, file_types, file_size_filter, file_size_kb, pagination_mode, infinite_scroll_mode, link_branch_depth, drive_subfolder_depth, dedupe_media, urls
POST /api/download
Download Input: source_mode, mode, image_size_filter, custom_min_edge_px, file_types, file_size_filter, file_size_kb, pagination_mode, infinite_scroll_mode, link_branch_depth, drive_subfolder_depth, dedupe_media, urls
POST /api/generate-download
Generate Download Input: source_mode, mode, image_size_filter, custom_min_edge_px, file_types, file_size_filter, file_size_kb, pagination_mode, infinite_scroll_mode, link_branch_depth, drive_subfolder_depth, dedupe_media, urls
GET /downloads/{download_name}
Get Generated Download Input: download_name
Platform and trustManage keys, usage, jobs, retention, robots checks and compliance status. 28
GET /v1/meta
Web Meta Input: url, maxAgeMs
POST /v1/meta
Web Meta Post Input: maxAgeMs, url, include_links, include_images, main_content_only, render_js, fresh
GET /v1/web/meta
Web Meta Input: url, maxAgeMs
POST /v1/web/meta
Web Meta Post Input: maxAgeMs, url, include_links, include_images, main_content_only, render_js, fresh
GET /api/royalty-free-images/sources
Royalty Free Image Sources No request fields.
GET /v1/royalty-free-images/sources
Royalty Free Image Sources No request fields.
POST /api/royalty-free-images/search
Royalty Free Image Search Api Input: use_case, query, negative_keywords, orientation, style, count, alternative_count, sources
POST /v1/royalty-free-images/search
Royalty Free Image Search Api Input: use_case, query, negative_keywords, orientation, style, count, alternative_count, sources
GET /v1/web/fonts
Web Fonts Input: domain, directUrl
GET /v1/web/styleguide
Web Styleguide Input: domain, directUrl
POST /v1/naics
Naics Api Input: value
POST /v1/sic
Sic Api Input: value
GET /api/health
Health No request fields.
GET /v1/usage/summary
Usage Summary Api Input: limit
GET /v1/billing/plans
Billing Plans No request fields.
GET /v1/api-keys
Api Keys Catalog No request fields.
POST /v1/api-keys
Create Api Key Api No request fields.
DELETE /v1/api-keys/{key_id}
Revoke Api Key Api Input: key_id
GET /v1/compliance
Compliance Overview No request fields.
GET /v1/compliance/status
Compliance Status No request fields.
GET /v1/compliance/error-codes
Compliance Error Codes No request fields.
GET /v1/compliance/data-retention
Compliance Data Retention No request fields.
DELETE /v1/compliance/data-retention/cache
Compliance Purge Cache No request fields.
GET /v1/compliance/abuse-monitoring
Compliance Abuse Monitoring Input: limit
POST /v1/compliance/abuse-report
Compliance Abuse Report No request fields.
GET /v1/compliance/robots-check
Compliance Robots Check Input: url, userAgent
GET /v1/jobs/{job_id}
Job Status Input: job_id
GET /v1/jobs/{job_id}/results
Job Results Input: job_id
scraping-engine

Scraping Engine Router

The crawl layer uses Crawlee-style orchestration metadata and routes hard pages through the requested fallback chain.

  • Crawlee-style orchestration manages URL queue, retry/session metadata, crawl depth and rate-limit hooks.
  • Scrapling is attempted first for hard pages and adaptive fetch behavior.
  • pydoll is attempted next when installed for browser automation fallback.
  • jo-inc/camofox-browser is attempted after pydoll when installed.
  • The local Markdown/JSON normalizer extracts clean markdown/html and quality scores.
  • Firecrawl is the default hosted fallback when FIRECRAWL_API_KEY is configured.
  • Apify is the premium/hard-domain fallback when APIFY_TOKEN is configured.
GET /v1/web/scrape/markdown?url=https://example.com&maxAgeMs=0
POST /v1/web/crawl
Response meta: scraping_stack, quality_score, fallback_chain
quality-cache

Quality Score and Cache Freshness

Every scrape response includes quality_score and supports cache freshness controls through maxAgeMs.

  • Set maxAgeMs=0 to force a fresh fetch.
  • Use the response meta.quality_score to decide if data is usable.
  • Blocked, login, permission and robots states are returned as explicit error codes instead of bypass attempts.
curl.exe -H "X-API-Key: mh-localhost-dev-key" "http://127.0.0.1:8013/v1/web/scrape/markdown?url=https://example.com&maxAgeMs=0"
iframe-pdf-ocr

Iframe, PDF and OCR Controls

HTML/Markdown endpoints can include iframe content and parse PDF page ranges; scanned PDFs expose OCR availability metadata.

  • Use includeFrames=true to collect iframe HTML snippets.
  • Use pdf.shouldParse, pdf.start and pdf.end query parameters for PDF page ranges.
  • If a PDF appears scanned, the response reports ocr_recommended and whether TESSERACT_CMD is configured.
GET /v1/web/scrape/html?url=https://example.com&page=1&includeFrames=true&pdf.shouldParse=true&pdf.start=1&pdf.end=5
image-enrichment

Image Enrichment and Brand Asset CDN

Image scraping extracts responsive images, CSS backgrounds, inline SVGs, video posters, dimensions, colors and hosted asset URLs.

  • Use /v1/web/scrape/images for page media enrichment.
  • Use enrichHostedUrl=true to persist fetched assets under /generated-assets/media/.
  • Use /logo-link with publicClientId for spreadsheet-ready brand/logo delivery.
GET /v1/web/scrape/images?url=https://example.com&enrichHostedUrl=true
GET /logo-link?publicClientId=logoLL_local_demo&domain=example.com
ocr-api

OCR API

OCR accepts uploads, image URLs or base64 and runs a Paddle-first local fallback chain.

  • Use POST /v1/ocr for multipart uploads or /v1/ocr/json for URL/base64 payloads.
  • The engine chain tries PaddleOCR first, then RapidOCR if Paddle is unavailable or fails.
  • Responses return plain text, line-level confidence, optional boxes and fallback metadata.
POST /v1/ocr/json
{"image_url":"https://example.com/scan.png","languages":["tr","en"],"preferred_engine":"auto","include_boxes":true}
youtube-transcript-api

YouTube Transcript API

YouTube transcript extraction tries three local methods and returns minute-second timestamps for every line.

  • Send a video_id or full video_url to /v1/youtube/transcript.
  • The service tries youtube_transcript_api first, then yt-dlp subtitle extraction, then pytubefix caption parsing.
  • Each transcript line includes start, duration, minute, second and a formatted timestamp.
POST /v1/youtube/transcript
{"video_url":"https://www.youtube.com/watch?v=M7lc1UVf-VE","languages":["en"]}
typescript-sdk

TypeScript SDK

Use the source client in sdk/typescript for browser, Node or server-side integration work.

  • Import the runtime client from sdk/typescript/index.mjs or use sdk/typescript/index.ts for type-aware source imports.
  • Run npm --prefix sdk/typescript run smoke to verify the local SDK against the running API.
  • Set baseUrl to http://127.0.0.1:8013 and apiKey to mh-localhost-dev-key for local usage.
  • Call brand, scraping or search methods from your application code.
import { MediaHarvesterClient } from './sdk/typescript/index.mjs';
const client = new MediaHarvesterClient({ baseUrl: 'http://127.0.0.1:8013', apiKey: 'mh-localhost-dev-key' });
const brand = await client.brandSimplified('example.com');
python-sdk

Python SDK

Use the Python source client for scripts, notebooks, workers and backend automation.

  • Add sdk/python to PYTHONPATH, install the local pyproject, or copy mediaharvester_client.py into your project.
  • Instantiate MediaHarvesterClient with the localhost API key.
  • Call scraping, brand, search or Logo Link helpers.
from mediaharvester_client import MediaHarvesterClient
client = MediaHarvesterClient(base_url='http://127.0.0.1:8013', api_key='mh-localhost-dev-key')
print(client.brand_simplified('example.com'))
mcp-server

MCP Server

The MCP wrapper exposes web context tools to compatible agents and local automation workflows.

  • Run scripts/web_context_mcp_server.py from the project root.
  • Use integrations/mcp/claude-desktop-config.json as a ready local client config example.
  • Available helpers include scrape_markdown, scrape_html, retrieve_brand, web_search, web_screenshot and workflow tools.
.venv\Scripts\python.exe scripts\web_context_mcp_server.py
zapier-make-n8n

Zapier, Make and n8n

No-code integration templates are included as local implementation briefs and workflow artifacts.

  • Use integrations/zapier/index.js as the Zapier app scaffold and integrations/zapier/README.md for the action map.
  • Use integrations/make/brand-client-slides-blueprint.json for Make/Google Slides flows.
  • Import integrations/n8n/mediaharvester-web-context.workflow.json into n8n and set the API key header.
Header: X-API-Key: mh-localhost-dev-key
Base URL: http://127.0.0.1:8013
sheets-excel

Google Sheets and Excel

Logo Link works directly from spreadsheet IMAGE formulas without exposing the private API key.

  • Put a domain in cell A2.
  • Use the IMAGE formula with publicClientId=logoLL_local_demo.
  • Use integrations/spreadsheets/google-apps-script.gs or excel-office-script.ts for reusable spreadsheet helpers.
  • For protected API calls, use automation tools that can send X-API-Key.
=IMAGE("http://127.0.0.1:8013/logo-link?publicClientId=logoLL_local_demo&domain=" & A2)
usage-dashboard

Usage Dashboard

Usage events, request logs and plan metadata are available through the dashboard and API.

  • Open /dashboard/billing for the local UI.
  • Call /v1/usage/summary for endpoint counts and recent request logs.
  • Call /v1/billing/plans for Free/Pro/Business capability metadata.
GET /v1/usage/summary
GET /v1/billing/plans
api-keys

Multiple API Keys

Local API keys can be supplied by environment variable or generated/revoked through the API.

  • Use MEDIAHARVESTER_LOCAL_API_KEY for the primary local key.
  • Use MEDIAHARVESTER_LOCAL_API_KEYS for comma-separated extra local keys.
  • Use POST /v1/api-keys to generate database-backed keys and DELETE /v1/api-keys/{key_id} to revoke.
POST /v1/api-keys
GET /v1/api-keys
DELETE /v1/api-keys/{key_id}
trust-center

Trust Center

Trust, fair use, privacy, terms, DPA, enterprise security, retention and abuse monitoring are exposed as UI pages and APIs.

  • Open /trust for the central trust page.
  • Open /fair-use to review responsible use and no-bypass language.
  • Use /v1/compliance/error-codes for blocked-state taxonomy.
GET /trust
GET /v1/compliance
GET /v1/compliance/error-codes
workflow-templates

Ready-Made Workflow Templates

Workflow APIs and templates cover lead enrichment, brand kits, client presentations and competitor monitoring.

  • Call /v1/workflows/lead-enrichment for CRM-friendly fields.
  • Call /v1/workflows/brand-kit for logos/colors/styleguide payloads.
  • Call /v1/workflows/client-presentation for Google Slides replacement data.
  • Call /v1/workflows/competitor-monitoring for competitor profile setup.
POST /v1/workflows/lead-enrichment
POST /v1/workflows/brand-kit
POST /v1/workflows/client-presentation
POST /v1/workflows/competitor-monitoring

Quick links