# deAPI

- [Introduction](https://docs.deapi.ai/introduction.md): Fast and affordable inference for open-source AI models
- [Quickstart](https://docs.deapi.ai/quickstart.md)
- [Models](https://docs.deapi.ai/models.md): How to discover, select, and use models on deAPI
- [Pricing](https://docs.deapi.ai/pricing.md)
- [OpenAI Compatibility](https://docs.deapi.ai/openai-compatibility.md): Point the official OpenAI SDK at deAPI — images, audio, embeddings and video with the request and response shapes you already know.
- [Architecture & Security](https://docs.deapi.ai/architecture-and-security.md)
- [API Keys](https://docs.deapi.ai/api-keys.md): Key roles (ADMIN and API), the optional restrictions you can set on each key (expiration, spend limit and IP allowlist), and managing keys via the API.
- [Limits & Quotas](https://docs.deapi.ai/limits-and-quotas.md)
- [Execution Modes & HTTP Queue](https://docs.deapi.ai/execution-modes-and-integrations/execution-modes-and-http-queue.md): How to receive job results via webhooks, WebSockets, or polling
- [Webhooks](https://docs.deapi.ai/execution-modes-and-integrations/webhooks.md): Receive real-time notifications about job status changes
- [WebSockets](https://docs.deapi.ai/execution-modes-and-integrations/websockets.md): Receive real-time job status updates via WebSocket connections
- [MCP Server](https://docs.deapi.ai/execution-modes-and-integrations/mcp-server.md): Describes the deAPI MCP server, its available tools, and how to connect agents or IDE integrations to use deAPI as a structured toolbox.
- [n8n Integration](https://docs.deapi.ai/execution-modes-and-integrations/n8n-integration.md)
- [n8n deAPI node](https://docs.deapi.ai/execution-modes-and-integrations/n8n-deapi-node.md)
- [SDKs & Integrations](https://docs.deapi.ai/other/sdks-and-integrations.md)
- [Payment Methods](https://docs.deapi.ai/other/payment-methods.md)
- [FAQ — Frequently Asked Questions](https://docs.deapi.ai/other/faq-frequently-asked-questions.md)
- [Support & Contact](https://docs.deapi.ai/other/support-and-contact.md)
- [API Overview](https://docs.deapi.ai/api/v2/overview.md): Complete reference of all deAPI v2 endpoints
- [Errors](https://docs.deapi.ai/api/v2/errors.md): HTTP status codes and error responses returned by deAPI v2
- [Image Generation](https://docs.deapi.ai/api/v2/images/generations.md): Generate an image from a text prompt.
- [Image Generation Price Calculation](https://docs.deapi.ai/api/v2/images/generations-price.md): Estimate the price of a text-to-image generation request.
- [Image Edit](https://docs.deapi.ai/api/v2/images/edits.md): Edit an image guided by a text prompt. Accepts either a single image via "image" or multiple images via "images[]" (mutually exclusive).
- [Image Edit Price Calculation](https://docs.deapi.ai/api/v2/images/edits-price.md): Estimate the price of an image edit request.
- [Image OCR](https://docs.deapi.ai/api/v2/images/ocr.md): Extract text from an image via OCR.
- [Image OCR Price Calculation](https://docs.deapi.ai/api/v2/images/ocr-price.md): Estimate the price of an image OCR request.
- [Image Background Removal](https://docs.deapi.ai/api/v2/images/background-removals.md): Remove the background from an image.
- [Image Background Removal Price Calculation](https://docs.deapi.ai/api/v2/images/background-removals-price.md): Estimate the price of an image background removal request.
- [Image Upscale](https://docs.deapi.ai/api/v2/images/upscales.md): Upscale an image to a higher resolution.
- [Image Upscale Price Calculation](https://docs.deapi.ai/api/v2/images/upscales-price.md): Estimate the price of an image upscale request.
- [Video Generation](https://docs.deapi.ai/api/v2/videos/generations.md): Generate a video from a text prompt.
- [Video Generation Price Calculation](https://docs.deapi.ai/api/v2/videos/generations-price.md): Estimate the price of a text-to-video generation request.
- [Video Animation (Image-to-Video)](https://docs.deapi.ai/api/v2/videos/animations.md): Animate a still image into a video.
- [Video Animation Price Calculation](https://docs.deapi.ai/api/v2/videos/animations-price.md): Estimate the price of an image-to-video animation request.
- [Video Audio Sync (Audio-to-Video)](https://docs.deapi.ai/api/v2/videos/audio-syncs.md): Generate a video conditioned on an audio track.
- [Video Audio Sync Price Calculation](https://docs.deapi.ai/api/v2/videos/audio-syncs-price.md): Estimate the price of an audio-to-video sync request.
- [Video Replacement](https://docs.deapi.ai/api/v2/videos/replacements.md): Replace a person in a video with a character from a reference image.
- [Video Replacement Price Calculation](https://docs.deapi.ai/api/v2/videos/replacements-price.md): Estimate the price of a video character replacement request.
- [Video Upscale](https://docs.deapi.ai/api/v2/videos/upscales.md): Upscale a video to a higher resolution.
- [Video Upscale Price Calculation](https://docs.deapi.ai/api/v2/videos/upscales-price.md): Estimate the price of a video upscale request.
- [Video Description](https://docs.deapi.ai/api/v2/videos/descriptions.md): Produce a timestamped index of what happens on screen — a list of events, each with `start`, `end` (seconds) and a `description` — plus scene boundaries and source metadata. Reads the picture, not the audio track; for speech use POST /api/v2/audio/transcriptions. Accepts either a video URL (YouTube,…
- [Video Description Price Calculation](https://docs.deapi.ai/api/v2/videos/descriptions-price.md): Quote a video description before submitting it. Priced on the machine time the description takes — which grows with the length of the video and with the `preset` — at the model's hourly rate, except on TikTok, where the price is a fixed card by length (up to 1, 2, 3, 5 or 10 minutes; 10 minutes is t…
- [Text-to-Speech](https://docs.deapi.ai/api/v2/audio/speech.md): Generate speech audio from text. Supports three TTS modes: custom_voice (default, preset speakers), voice_clone (clone from reference audio), voice_design (create voice from description).
- [Text-to-Speech Price Calculation](https://docs.deapi.ai/api/v2/audio/speech-price.md): Estimate the price of a text-to-speech generation request. Either text or count_text must be provided.
- [Text-to-Music](https://docs.deapi.ai/api/v2/audio/music.md): Generate music from a text prompt.
- [Text-to-Music Price Calculation](https://docs.deapi.ai/api/v2/audio/music-price.md): Estimate the price of a text-to-music generation request. Requires duration and inference_steps parameters.
- [Audio/Video Transcription](https://docs.deapi.ai/api/v2/audio/transcriptions.md): Unified transcription — auto-detects URL or file upload for audio and video sources (YouTube, X, Twitch, Kick, TikTok, X/Twitter Spaces).
- [Transcription Price Calculation](https://docs.deapi.ai/api/v2/audio/transcriptions-price.md): Estimate the price of a transcription request. Provide one of: source_url, source_file, or duration_seconds.
- [Embeddings](https://docs.deapi.ai/api/v2/embeddings/embeddings.md): Generate embeddings for one or more input texts.
- [Embeddings Price Calculation](https://docs.deapi.ai/api/v2/embeddings/embeddings-price.md): Estimate the price of an embedding request.
- [Prompt Enhancement - Overview](https://docs.deapi.ai/api/v2/prompt-enhancement/overview.md): AI-powered prompt optimization tools for better generation results.
- [Prompt Booster](https://docs.deapi.ai/api/v2/prompt-enhancement/prompt-booster.md): Rewrites a prompt for a specific model using a guide configured for that model and inference type. Requires a guide for your `model_slug` + `type` pair — call the `/price` sibling first, which runs the same check for free and quotes the fee.
- [Prompt Booster Price](https://docs.deapi.ai/api/v2/prompt-enhancement/prompt-booster-price.md): Price of a prompt boost, and a free check that one is possible: it runs the same guide lookup as the boost itself, so a 422 here means the boost would also be rejected. Charges nothing either way. NOTE the response shape differs from every other price endpoint: this one returns `{"price": …}` at the…
- [Check Balance](https://docs.deapi.ai/api/v2/utilities/balance.md): Retrieve the current account balance for the authenticated client. Needs an ADMIN key.
- [Get Job Results](https://docs.deapi.ai/api/v2/utilities/jobs.md): Retrieve the current status and result of a submitted inference job.
- [Model Selection](https://docs.deapi.ai/api/v2/utilities/models.md): Lists the inference models available to your account. The list is scoped to you: it contains only enabled models that are either public or explicitly granted to your account, and it omits models that require a higher plan tier than your account has (those return 422 on generation and pricing). A mod…
- [Get Current Key](https://docs.deapi.ai/api/v2/keys/get-current-key.md): The key sending the request: name, preview, role, status, dates, spend limit and IP whitelist. Never the secret. Works with any key role.
- [Get Current Key Usage](https://docs.deapi.ai/api/v2/keys/get-current-key-usage.md): Cost, requests and errors of the key sending the request. Works with any key role.
- [List Keys](https://docs.deapi.ai/api/v2/keys/list-keys.md): Every key of the account, newest first. Needs an ADMIN key. Never secrets.
- [Create Key](https://docs.deapi.ai/api/v2/keys/create-key.md): Creates a key with the API role. Needs an ADMIN key; ADMIN keys can only be created in the Dashboard. **The secret is returned once, in this response.** Counts toward the account's limit of active keys and the hourly limit of keys created over the API (shared by all ADMIN keys of the account). An `i…
- [Get Key](https://docs.deapi.ai/api/v2/keys/get-key.md): Any key of the account. Needs an ADMIN key.
- [Update Key](https://docs.deapi.ai/api/v2/keys/update-key.md): Switches an API-role key on or off, changes its expiry date, spend limit and reset window, and sets the addresses it may be used from. Needs an ADMIN key. The role cannot be changed; ADMIN keys are changed in the Dashboard only. Making a key active again counts toward the limit of active keys.
- [Delete Key](https://docs.deapi.ai/api/v2/keys/delete-key.md): Permanently deletes an API-role key. Needs an ADMIN key; ADMIN keys are deleted in the Dashboard only. The key's past usage stays in usage reports.
- [Get Key Usage](https://docs.deapi.ai/api/v2/keys/get-key-usage.md): Like `GET /api/v2/key/usage`, for any key of the account. Needs an ADMIN key.
- [Get Account Billing](https://docs.deapi.ai/api/v2/account/get-account.md): Balance and automatic top-up settings. Needs an ADMIN key.
- [Get Account Usage](https://docs.deapi.ai/api/v2/account/usage.md): Cost, requests and errors of every key of the account, optionally per key. The same data as the Usage screen in the Dashboard. Needs an ADMIN key.
- [List Payments](https://docs.deapi.ai/api/v2/account/payments.md): Top-ups of the balance, newest first, in every status. Needs an ADMIN key.
- [API Overview](https://docs.deapi.ai/api/v1/overview.md): Complete reference of all deAPI endpoints
- [Errors](https://docs.deapi.ai/api/v1/errors.md): HTTP status codes and error responses returned by deAPI
- [Text-to-Image](https://docs.deapi.ai/api/v1/generation/text-to-image.md): Endpoint for requesting text2img inference
- [Text-to-Image Price Calculation](https://docs.deapi.ai/api/v1/generation/text-to-image-price.md): Endpoint for calculating price for text2img inference
- [Text-to-Video](https://docs.deapi.ai/api/v1/generation/text-to-video.md): Endpoint for requesting text2video inference
- [Text-to-Video Price Calculation](https://docs.deapi.ai/api/v1/generation/text-to-video-price.md): Endpoint for calculating price for text2video inference
- [Image-to-Video](https://docs.deapi.ai/api/v1/generation/image-to-video.md): Endpoint for requesting image2video inference
- [Image-to-Video Price Calculation](https://docs.deapi.ai/api/v1/generation/image-to-video-price.md): Endpoint for calculating price for image2video inference
- [Audio-to-Video](https://docs.deapi.ai/api/v1/generation/audio-to-video.md): Endpoint for requesting audio2video inference
- [Audio-to-Video Price Calculation](https://docs.deapi.ai/api/v1/generation/audio-to-video-price.md): Endpoint for calculating price for audio2video inference
- [Text-to-Speech (TTS)](https://docs.deapi.ai/api/v1/generation/text-to-speech.md): Endpoint for requesting text2audio inference
- [Text-to-Speech Price Calculation](https://docs.deapi.ai/api/v1/generation/text-to-speech-price.md): Endpoint for calculating price for text2audio inference. Either text or count_text must be provided.
- [Text-to-Music](https://docs.deapi.ai/api/v1/generation/text-to-music.md): Endpoint for requesting text2music inference
- [Text-to-Music Price Calculation](https://docs.deapi.ai/api/v1/generation/text-to-music-price.md): Endpoint for calculating price for text2music inference. Requires duration and inference_steps parameters.
- [Text-to-Embedding](https://docs.deapi.ai/api/v1/generation/text-to-embedding.md): Endpoint for requesting text to embedding inference
- [Text-to-Embedding Price Calculation](https://docs.deapi.ai/api/v1/generation/text-to-embedding-price.md): Endpoint for calculating price for text to embedding inference
- [Image-to-Text (OCR)](https://docs.deapi.ai/api/v1/analysis/image-to-text.md): Endpoint for requesting image2text (OCR) inference
- [Image-to-Text Price Calculation](https://docs.deapi.ai/api/v1/analysis/image-to-text-price.md): Endpoint for calculating price for image2text (OCR) inference
- [Video-to-Text (Transcription)](https://docs.deapi.ai/api/v1/analysis/video-to-text.md): Unique Platform Support: deAPI is one of the few APIs offering direct transcription from YT, TikTok, Twitch VODs, X and Kick videos — no need to download files first. Just paste the URL.
- [Video-to-Text Price Calculation](https://docs.deapi.ai/api/v1/analysis/video-to-text-price.md): Endpoint for calculating price for video to text inference
- [Audio-to-Text (X Spaces Transcription)](https://docs.deapi.ai/api/v1/analysis/audio-to-text-spaces.md): Endpoint for requesting audio transcription (Twitter Spaces)
- [Audio-to-Text (X Spaces) Price Calculation](https://docs.deapi.ai/api/v1/analysis/audio-to-text-spaces-price.md): Endpoint for calculating price for audio to text inference (Twitter Spaces)
- [Upload Video File (Video-to-Text)](https://docs.deapi.ai/api/v1/analysis/upload-video-file.md): Endpoint for requesting video transcription
- [Upload Video File Price Calculation](https://docs.deapi.ai/api/v1/analysis/upload-video-file-price.md): Endpoint for calculating price for video to text inference
- [Upload Audio File (Audio-to-Text)](https://docs.deapi.ai/api/v1/analysis/upload-audio-file.md): Endpoint for requesting audio transcription
- [Upload Audio File Price Calculation](https://docs.deapi.ai/api/v1/analysis/upload-audio-file-price.md): Endpoint for requesting audio transcription price
- [Transcribe (Unified Transcription)](https://docs.deapi.ai/api/v1/analysis/transcribe.md): A single endpoint for all transcription needs — URL-based (YouTube, X, Twitch, Kick, TikTok, X Spaces) and file uploads (audio & video). Replaces vid2txt, aud2txt, videofile2txt, and audiofile2txt with automatic source detection.
- [Transcribe Price Calculation](https://docs.deapi.ai/api/v1/analysis/transcribe-price.md): Unified endpoint for calculating transcription price. Provide one of: source_url, source_file, or duration_seconds.
- [Image-to-Image](https://docs.deapi.ai/api/v1/transformation/image-to-image.md): Endpoint for requesting img2img inference. Accepts either a single image via "image" or multiple images via "images[]" (mutually exclusive).
- [Image-to-Image Price Calculation](https://docs.deapi.ai/api/v1/transformation/image-to-image-price.md): Endpoint for calculating price for img2img inference
- [Video Replace](https://docs.deapi.ai/api/v1/transformation/video-replace.md): Replace a person in a video with a character from a reference image. Ideal for character animation, face swap, and creative video editing.
- [Video Replace Price Calculation](https://docs.deapi.ai/api/v1/transformation/video-replace-price.md): Endpoint for calculating price for video replace inference
- [Image Background Removal](https://docs.deapi.ai/api/v1/transformation/background-removal.md): Endpoint for requesting image background removal inference
- [Image Background Removal Price Calculation](https://docs.deapi.ai/api/v1/transformation/background-removal-price.md): Endpoint for calculating price for image background removal inference
- [Image Upscale](https://docs.deapi.ai/api/v1/transformation/image-upscale.md): Endpoint for requesting image upscaling inference
- [Image Upscale Price Calculation](https://docs.deapi.ai/api/v1/transformation/image-upscale-price.md): Endpoint for calculating price for image upscaling inference
- [Video Upscale](https://docs.deapi.ai/api/v1/transformation/video-upscale.md): Endpoint for requesting video upscaling inference
- [Video Upscale Price Calculation](https://docs.deapi.ai/api/v1/transformation/video-upscale-price.md): Endpoint for calculating price for video upscaling inference
- [Prompt Enhancement (Removed)](https://docs.deapi.ai/api/v1/prompt-enhancement/overview.md): The v1 prompt boosters have been removed. Use the unified v2 Prompt Booster instead.
- [Check Balance](https://docs.deapi.ai/api/v1/utilities/check-balance.md): Endpoint for requesting client current balance.
- [Get Results](https://docs.deapi.ai/api/v1/utilities/get-results.md): Check job status and retrieve results via polling
- [Model Selection](https://docs.deapi.ai/api/v1/utilities/model-selection.md): Endpoint for fetching all available models.

## OpenAPI Specs

- [openapi-v2](/openapi-v2.json)
- [openapi](/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.