​

DumplingAI API Reference

Welcome to the DumplingAI API reference. This documentation provides detailed information about all available endpoints, request parameters, response formats, and example code.

​

Authentication

All API requests require authentication using an API key. To use the API, you need to include your API key in the Authorization header of your requests.

Authorization: Bearer YOUR_API_KEY

​

Base URL

All API endpoints should be accessed through our base URL:

https://app.dumplingai.com

​

Response Format

All responses are returned in JSON format. Successful responses will have a 2xx status code, while errors will return appropriate 4xx or 5xx status codes with error details in the response body.

​

Success Response Example

{
  "data": { ... },
  "status": "success"
}

​

Error Response Example

{
  "error": {
    "code": "invalid_request",
    "message": "The request was invalid. Please check your parameters."
  },
  "status": "error"
}

​

Rate Limiting

Rate limiting is applied based on your subscription plan. Rate limits are enforced based on your account’s credit allocation and usage patterns. If you exceed these limits, you’ll receive a 429 Too Many Requests error response.

​

Versioning

The current API version is v1. We recommend explicitly specifying the API version in your requests to ensure compatibility as we evolve the API.

​

API Endpoints

Explore all available API endpoints in the sidebar navigation.