Skip to main content

​
Agent API v2

DumplingAI now has a second API lane under /api/v2 designed for agents and technical teams. This surface is organized around two ways to work:
  • capabilities: ask DumplingAI to do a job like google_search or scrape_page
  • provider endpoints: call a specific managed upstream endpoint like serper.search, perplexity.search, or firecrawl.scrape
/api/v1 remains available and unchanged.

​
Base URL

https://app.dumplingai.com

​
Capability lane

Use capabilities when you want the cleanest interface.

​
Endpoints

  • POST /api/v2/search
  • POST /api/v2/details
  • POST /api/v2/run
POST /api/v2/details now returns a lean default object. Pass includeRelated: true when you also want related providers, endpoints, and capabilities.

​
Example

curl -X POST https://app.dumplingai.com/api/v2/run \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "capability",
    "id": "google_search",
    "input": {
      "query": "best seo keywords for plumbers in nyc"
    }
  }'

​
Provider endpoint lane

Use provider endpoints when you know the upstream API you want.

​
Endpoints

  • POST /api/v2/search
  • POST /api/v2/details
  • POST /api/v2/run

​
Example

curl -X POST https://app.dumplingai.com/api/v2/run \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "endpoint",
    "id": "serper.search",
    "input": {
      "query": "best seo keywords for plumbers in nyc"
    },
    "options": {
      "include_native": true
    }
  }'

​
Response envelope

Both lanes share the same outer response shape: 
{
  "success": true,
  "requestId": "req_123",
  "object": "capability_result",
  "data": {},
  "meta": {}
}
Error responses: 
{
  "success": false,
  "requestId": "req_123",
  "error": "Provider not allowed for this API key",
  "code": "PROVIDER_NOT_ALLOWED"
}

​
Current MVP capabilities

  • google_search
  • scrape_page
  • get_youtube_transcript

​
Current provider endpoints

Examples:
  • serper.search
  • perplexity.search
  • firecrawl.scrape
  • firecrawl.search
  • firecrawl.map
  • firecrawl.crawl
  • spidercloud.scrape
  • spidercloud.crawl
  • spidercloud.links
  • phantomjscloud.scrape
  • scrapecreators.youtube_transcript
  • transcriptapi.youtube_transcript
  • transcriptapi.youtube_search
  • transcriptapi.youtube_channel_videos
  • perplexity.search
  • dataforseo.dataforseo_labs_google_keyword_ideas