​
Getting Started with DumplingAI

This guide will help you get started with DumplingAI quickly. Follow these steps to set up your API key and make your first request.

​
1. Sign up and create an API key

  1. Sign up for a DumplingAI account
  2. Navigate to the API Keys section in your dashboard
  3. Click “Create API Key” and give it a descriptive name
  4. Copy your API key - you’ll need it for all API requests

Keep your API key secure. Do not share it or expose it in client-side code.

​
2. Make your first API request

Let’s try a simple example using the scrape endpoint to extract content from a webpage:

curl -X POST https://app.dumplingai.com/api/v1/scrape \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "url": "https://example.com",
    "format": "markdown"
  }'

​
3. Understanding credits

DumplingAI uses a credit system to track API usage. Different endpoints consume different amounts of credits:

  • Simple operations like scraping or searching cost 1-3 credits
  • More complex operations like extracting document content or generating AI images cost more

Check the Credit Costs page for detailed information.

​
4. Next steps

Now that you’ve made your first API request, you can explore more advanced functionality:

API Reference

Explore all available endpoints and parameters

Tutorial: Web Scraping

Learn how to extract and process web content

Tutorial: Knowledge Bases

Create and query knowledge bases from your data

Tutorial: AI Agents

Work with AI agents for complex tasks