Skip to main content

​
1. How do I get access to the deAPI panel?

Register or log in (also via Google OAuth) and after authentication you will automatically gain access to the Control Panel, where you can directly create an API key and get access the full capabilities of the platform.

​
2. How can I get my API key?

Simply sign up or log in, then navigate to your Dashboard → Settings → API Keys and click “Create new secret key” to instantly generate your API key.

​
3. Do I need to fund my account before using the API?

No. Upon registration, you receive a $5 bonus to get started immediately with Basic rate limits. You do not need to make a payment to start testing. Once you make any payment (top-up), your account automatically upgrades to Premium, unlocking the 300 RPM limit and unlimited daily requests.

​
4. How is authentication handled?

Every API request requires an Authorization header with your personal token: 
Authorization: Bearer YOUR_API_KEY

​
5. How do I retrieve the results of my tasks?

After submitting a task, you’ll receive a request_id. Use this ID with the Get Job Results endpoint (GET /api/v2/jobs/{request_id}) to fetch your generated image, video, audio, or transcription.

​
6. Are there any rate limits?

Yes. The limits depend on your account type:
  • Basic (Free): Designed for testing. Limits are restrictive, ranging from 1 to 10 RPM (Requests Per Minute) depending on the endpoint, with daily caps.
  • Premium: Activated by any available payment. Offers a unified high limit of 300 RPM across all endpoints with unlimited daily requests. If you exceed these limits, you’ll receive a 429 Too Many Requests response. For High Volume Production requirements beyond Premium limits, please contact support.

​
7. Can I choose between different AI models?

Yes. Visit the Model Selection endpoint to browse available models, or check the Models page for a complete list. You can specify the desired model using the model parameter when making API requests.

​
8. What file types are supported?

Video (Transcription, Animation, Upscale, Replacement):
  • Max size: 50 MB
  • Supported formats: MP4, MPEG, MOV, AVI, WMV, OGG
Audio (Audio-to-Text):
  • Max size: 20 MB
  • Supported formats: AAC, MP3, OGG, WAV, WebM, FLAC
Images (Image-to-Image, OCR, Background Removal):
  • Max size: 10 MB (dimensions: 64–5000 px per side)
  • Supported formats: JPG, JPEG, PNG, GIF, BMP, WebP
Every API request is also subject to a global 75 MB request body cap (input) and 100 MB job result cap (output). For full details see Limits & Quotas → File Uploads.

​
9. What services does deAPI offer?

deAPI provides the following AI-powered services (v2 REST API):
  • Image Generation — /api/v2/images/generations
  • Image Edit — /api/v2/images/edits
  • Image OCR — /api/v2/images/ocr
  • Image Background Removal — /api/v2/images/background-removals
  • Image Upscale — /api/v2/images/upscales
  • Video Generation — /api/v2/videos/generations
  • Video Animation — /api/v2/videos/animations
  • Video Audio Sync — /api/v2/videos/audio-syncs
  • Video Replacement — /api/v2/videos/replacements
  • Video Upscale — /api/v2/videos/upscales
  • Text-to-Speech — /api/v2/audio/speech
  • Text-to-Music — /api/v2/audio/music
  • Transcription (unified audio/video) — /api/v2/audio/transcriptions
  • Text-to-Embedding — /api/v2/embeddings
  • Prompt Enhancement — /api/v1/client/prompt/* (shared with v1)

​
10. Can I use deAPI with AI assistants like Claude or Cursor?

Yes! deAPI offers an MCP (Model Context Protocol) server that allows AI assistants and IDE extensions to call deAPI capabilities as structured tools. You can connect Claude, Cursor, and other MCP-compatible clients to generate images, transcribe videos, and more directly within conversations. See the MCP Server documentation for setup instructions.

​
11. Can I use deAPI with n8n or other automation tools?

Yes! deAPI works seamlessly with n8n and other workflow automation platforms. You can build automated workflows that generate images, transcribe videos, create speech, and more using deAPI’s HTTP API. The integration uses standard HTTP Request nodes with Bearer token authentication. See the n8n Integration documentation for a complete step-by-step guide with example workflows.

​
12. Can I use deAPI with the OpenAI SDK?

Yes. deAPI exposes an OpenAI-compatible endpoint at https://oai.deapi.ai/v1. Set base_url (and your api_key) on the official OpenAI SDK and your existing code keeps working — only model needs to be a deAPI slug (e.g. Flux1schnell, Kokoro, WhisperLargeV3, Bge_M3_FP16). Supported endpoints: image generation, image edits, text-to-speech, transcription, embeddings, and video generation. Chat completions and inpainting are not in scope. See OpenAI Compatibility for the full guide.

​
13. What’s the difference between v1 and v2?

  • v2 (default, REST-style) — Resource-based URLs (/api/v2/images/generations, /api/v2/videos/upscales), unified transcription (/audio/transcriptions replaces 5 separate v1 endpoints), new video background removal endpoint.
  • v1 (stable, task-style) — Task-based URLs (/api/v1/client/txt2img, /api/v1/client/vid-upscale). Fully supported for existing integrations.
Both versions share authentication, rate limits, webhooks, and the same model catalog. Prompt Enhancement endpoints remain under the v1 path and are accessible from both. Switch docs version using the dropdown in the top-right corner.

​
14. Is deAPI ready for production use?

Yes. deAPI is built to support production-grade workloads. All models and services are optimized for speed, reliability, and scalability. The platform offers 300 RPM immediately after the first account top-up.

​
15. What should I do if I get an error?

Check the error code and make sure:
  • 401 — Your API key is valid
  • 403 — Your account has sufficient permissions
  • 429 — You haven’t exceeded rate limits
  • 500 — Server error (check status.deapi.ai)
Also verify your request parameters are correct. If the issue persists, contact our support team at support@deapi.ai or join our Discord for help.