Skip to main content

​
API Reference

Use /api/v2 for DumplingAI’s Unified API Platform. This is the new API lane for technical users who want either:
  • standardized capabilities
  • direct access to exact managed provider endpoints

​
Two ways to use /api/v2

​
Capabilities

Use capabilities when you want the simplest possible request shape. Examples:
  • google_search
  • search_news
  • search_places
  • get_google_reviews
  • crawl_site
  • screenshot
  • extract_web
  • extract_document
  • scrape_page
  • get_youtube_transcript

​
Provider endpoints

Use provider endpoints when you want the exact upstream provider endpoint. Examples:
  • serper.search
  • serper.news
  • serper.places
  • serper.maps
  • serper.autocomplete
  • serper.images
  • serper.videos
  • serper.shopping
  • serper.scholar
  • serper.patents
  • perplexity.search
  • firecrawl.scrape
  • firecrawl.screenshot
  • scrapingfish.screenshot
  • phantomjscloud.screenshot
  • transcriptapi.youtube_transcript
  • transcriptapi.youtube_search
  • dataforseo.dataforseo_labs_google_keyword_ideas
Provider notes:
  • screenshot supports firecrawl, scrapingfish, and phantomjscloud
  • extract_web and extract_document are DumplingAI-managed and use provider: "dumplingai"

​
What OpenAPI covers here

The OpenAPI spec documents the real transport endpoints under /api/v2:
  • search
  • details
  • run
  • balance
  • usage
  • transactions
Capabilities, providers, and endpoints are documented through the Unified API Platform Workbench pages rather than fake per-operation HTTP paths. Use the canonical execution request shape when calling /api/v2/run: 
{
  "type": "capability",
  "id": "extract_document",
  "input": {
    "inputMethod": "url",
    "files": ["https://example.com/invoice.pdf"],
    "prompt": "Extract the invoice number and total due"
  }
}
Or for a provider endpoint: 
{
  "type": "endpoint",
  "id": "firecrawl.scrape",
  "input": {
    "url": "https://example.com",
    "format": "markdown"
  }
}