Skip to main content

​
API Reference

Welcome to the DumplingAI API reference. DumplingAI now exposes two API surfaces:
  • /api/v1 for the existing endpoint-oriented API
  • /api/v2 for the new agent-oriented platform with capabilities, providers, and provider endpoints
Our focus is helping you pull structured data out of the real world: websites, PDFs, screenshots, videos, audio, and social feeds, fast. What you can extract
  • Web and app pages: crawl full sites or targeted URLs, run JS, and return cleaned HTML or markdown (/crawl, /scrape).
  • Documents and PDFs: convert, merge, or read metadata; turn files into text or embeddings (/doc-to-text, /convert-to-pdf, /merge-pdfs, /read-pdf-metadata).
  • Media to text: transcribe and summarize YouTube, TikTok, audio, and video; capture frames and OCR images (/get-youtube-transcript, /get-tiktok-transcript, /extract-audio, /extract-video, /extract-image).
  • Social and places data: pull profiles, posts, reviews, search results, or screenshots from major networks (/search-youtube, /get-linkedin-profile, /search-places, /screenshot).

​
Authentication

All API requests require authentication using an API key. Include your API key in the Authorization header: 
Authorization: Bearer YOUR_API_KEY
If you do not have an API key yet, sign in to the DumplingAI dashboard and generate one from the API Keys section.

​
Base URL

All API endpoints share the same host: 
https://app.dumplingai.com

​
API versions

​
/api/v1

Use /api/v1 when you want the existing endpoint-specific API reference documented throughout the sidebar.

​
/api/v2

Use /api/v2 when you want the new agent-native execution model:
  • capability-first calls such as google_search and scrape_page
  • provider-operation calls such as serper.search and firecrawl.scrape
See API Reference v2.

​
Rate limits and versioning

Requests consume credits tied to your plan. Exceeding limits returns 429 Too Many Requests. /api/v1 and /api/v2 can coexist on the same account and API key.

​
Next steps

Pick the API version you need from the API Reference selector. Use v1 for direct endpoint access, or start with API Reference v2 for Unified API Platform capabilities and provider endpoints.