deAPI MCP Server
OfficialClick on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@deAPI MCP Server transcribe audio from this YouTube video: https://youtu.be/abc123"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
deAPI MCP Server
Production-ready Model Context Protocol (MCP) server for the deAPI REST API. This server exposes all deAPI AI capabilities as MCP tools, enabling LLMs to perform audio transcription, image generation, OCR, video generation, text-to-speech, and more.
deAPI v2 — this server targets the deAPI v2 client API (OpenAI-aligned noun paths under
/api/v2/*). API v1 is not supported: the tools send v2 payloads only.
Features
Complete API Coverage: 39 deAPI tools exposed via MCP, covering every v2 client endpoint
Smart Adaptive Polling: Automatically polls async jobs with optimized intervals based on job type
OAuth 2.0 Authentication: Secure token exchange via OAuth Authorization Code flow with PKCE
Error Recovery: Automatic retry logic with exponential backoff
Progress Reporting: Real-time progress updates to MCP clients
Type Safety: Full Pydantic schema validation
Production Ready: Built with FastMCP framework for reliability
Related MCP server: MCP Skill Registry
Available Tools
Audio Tools
audio_transcription- Transcribe audio files to text using Whisper modelsaudio_transcription_price- Calculate transcription costtext_to_audio- Convert text to natural speech (TTS)text_to_audio_price- Calculate TTS costtext_to_music- Generate music from text description and lyricstext_to_music_price- Calculate music generation costaudio_url_transcription- Transcribe audio from URLs of completed Twitter Spacesaudio_url_transcription_price- Calculate Twitter Spaces transcription cost
Video Transcription Tools
video_file_transcription- Transcribe video files to textvideo_file_transcription_price- Calculate video file transcription costvideo_url_transcription- Transcribe videos from URLs (YouTube, Twitter/X, Twitch, Kick, TikTok)video_url_transcription_price- Calculate video URL transcription cost
Image Tools
text_to_image- Generate images from text promptsimage_to_image- Transform images with text guidanceimage_to_text- Extract text from images (OCR)image_remove_background- Remove background from imagesimage_upscale- Upscale images to higher resolutiontext_to_image_price- Calculate image generation costimage_to_image_price- Calculate image transformation costimage_to_text_price- Calculate OCR costimage_remove_background_price- Calculate background removal costimage_upscale_price- Calculate upscaling cost
Video Tools
text_to_video- Generate videos from text promptsimage_to_video- Animate static images into videosaudio_to_video- Generate video conditioned on audio contentvideo_description- Describe a video in text (from an uploaded file or a video URL)video_upscale- Upscale a video to higher resolutiontext_to_video_price- Calculate text-to-video costimage_to_video_price- Calculate image-to-video costaudio_to_video_price- Calculate audio-to-video costvideo_description_price- Calculate video description costvideo_upscale_price- Calculate video upscaling cost
Embedding Tools
text_to_embedding- Generate text embeddings for semantic searchtext_to_embedding_price- Calculate embedding cost
Prompt Tools
prompt_booster- Enhance a prompt for any deAPI inference type using AI guides (synchronous, returns refined prompt directly)prompt_booster_price- Calculate prompt-enhancement cost
Utility Tools
get_balance- Check account balanceget_available_models- List available AI models with specificationscheck_job_status- Query async job status by ID; withwait_secondsit waits for the job and returns the finished result in the original tool's shape. A failed job reportssuccess: falsewitherror_reason,error_code,retryableandrefunded
Webhooks
Every generation tool accepts webhook_url (HTTPS) and an optional webhook_secret (32–255 chars). deAPI calls that URL when the job finishes, signed with X-DeAPI-Signature: sha256=<HMAC-SHA256(secret, "<timestamp>.<body>")>; the tool still returns the result to the caller as usual.
Model-driven defaults
Generation parameters such as width, height, steps, frames and fps default to the selected model's own values when left unset — each model has different limits, so there is no fixed default that works everywhere. The get_available_models output and every tool description list each model's accepted ranges. Set enhance_prompt: true on text_to_image/image_to_image to let deAPI rewrite the prompt; the result then includes prompt_boost with the prompt actually used.
Installation
Prerequisites
For running the MCP server:
Python 3.11 or higher
uv,pip, orcondafor package management
For a deAPI account:
Sign up at app.deapi.ai and create an API token at app.deapi.ai/settings/api-keys
Setup
Clone the repository:
git clone https://github.com/deapi-ai/mcp-server-deapi.git
cd mcp-server-deapiChoose your Python environment setup:
Option A: Using uv (recommended - fastest)
uv pip install -e .Option B: Using pip
pip install -e .Option C: Using conda
# Create conda environment
conda create -n mcp-server-deapi python=3.11
conda activate mcp-server-deapi
# Install dependencies
pip install -e .(Optional) Create a
.envfile for configuration:
# Copy the example file
cp .env.example .env
# Edit with your preferences (optional - defaults work fine locally).
# Set DEAPI_JWT_SECRET_KEY before exposing the server beyond localhost.
# DEAPI_API_BASE_URL=https://api.deapi.ai
# DEAPI_HTTP_TIMEOUT=30.0
# DEAPI_MAX_RETRIES=3Usage
Running the Server
The server can run in two modes:
Local Mode (for use with Claude Desktop on the same machine):
MCP_HOST=127.0.0.1 python -m deapi_mcp.server_remoteThe server starts on http://localhost:8000. On loopback it may run without DEAPI_JWT_SECRET_KEY
(it then signs OAuth tokens with a per-process key, so a restart logs clients out).
Remote Mode (for deployment to a remote server):
# A fixed signing key is required whenever the server binds beyond loopback
# (the default host is 0.0.0.0) or uses Redis; without it the server refuses to start.
export DEAPI_JWT_SECRET_KEY=$(python -c "import secrets; print(secrets.token_urlsafe(32))")
MCP_HOST=0.0.0.0 MCP_PORT=8000 python -m deapi_mcp.server_remoteSee the Remote Deployment section for production deployment options.
Connecting from Claude Desktop / Claude.ai
Option 1: Add Connector (Recommended)
Both Claude Desktop and Claude.ai support MCP connectors with built-in OAuth authentication.
Get your deAPI token from app.deapi.ai/settings/api-keys
In Claude Desktop or Claude.ai, go to Settings → Connectors → Add Connector
Fill in the connector details:
Name: deAPI
Remote MCP server: https://your-server-domain:8000/mcp
▼ Advanced settings
OAuth Client ID: deapi-mcp
OAuth Client Secret: YOUR_DEAPI_TOKENClick Add — Claude will automatically authenticate via OAuth and discover all tools.
For details on the OAuth flow, see AUTH.md.
Option 2: Config File with Bearer Token (Local Development)
Best for: Server running on the same machine, quick setup without OAuth.
Edit your Claude Desktop config file:
macOS:
~/Library/Application Support/Claude/claude_desktop_config.jsonWindows:
%APPDATA%\Claude\claude_desktop_config.json
{
"mcpServers": {
"deapi": {
"url": "http://localhost:8000/mcp",
"headers": {
"Authorization": "Bearer YOUR_DEAPI_TOKEN"
}
}
}
}Replace YOUR_DEAPI_TOKEN with your actual deAPI token. Save the file and restart Claude Desktop.
Using the Tools
Authentication is handled at the connection level, not per-tool-call. Tools do NOT accept a deapi_api_token parameter.
Here's an example workflow:
Get available models:
Use get_available_models to see available modelsCheck your balance:
Use get_balance to check remaining creditsGenerate an image:
Use text_to_image with:
- prompt: "A beautiful sunset over mountains"
- model: "Flux1schnell"Transcribe audio:
Use audio_transcription with:
- audio: "base64-encoded-audio-or-url"
- include_ts: trueNote: When calling tools via Claude Desktop or MCP SDK, authentication is handled automatically through the server connection (OAuth or HTTP headers). See AUTH.md for detailed OAuth setup.
Architecture
Key Components
DeapiClient (
deapi_mcp/deapi_client.py): HTTP client with auth forwarding, built on the deAPI Python SDK transportPollingManager (
deapi_mcp/polling_manager.py): Smart adaptive polling for async jobsSchemas (
deapi_mcp/schemas.py): Pydantic models for type safetyAuth code store (
deapi_mcp/auth_code_store.py): single-use OAuth authorization codes, in Redis whenDEAPI_REDIS_HOSTis set (so any replica can finish a login), otherwise in process memoryWebhooks (
deapi_mcp/webhooks.py): optional HMAC-verified receiver for deAPI completion callbacks, so waiting tools wake on the callback instead of polling (DEAPI_WEBHOOKS_INTERNAL)Tools (
deapi_mcp/tools/): Organized tool implementationsaudio.py- Audio transcription, TTS & music generation toolsimage.py- Image generation, transformation, OCR, background removal & upscalingvideo.py- Video generation, image/audio-to-video, description & upscale toolsembedding.py- Text embedding toolsprompt.py- Prompt booster toolsutility.py- Balance, models, status tools
Smart Adaptive Polling
The server uses job-type-specific polling strategies:
Job Type | Initial Delay | Max Delay | Timeout |
Audio | 1s | 5s | 5 min |
Image | 2s | 8s | 5 min |
Video | 5s | 30s | 15 min |
Embedding | 0.5s | 3s | 2 min |
Other (incl. | 2s | 10s | 5 min |
Polling uses exponential backoff with a configurable multiplier (default: 1.5x,
DEAPI_POLLING_<TYPE>__BACKOFF_FACTOR).
Error Handling
HTTP Errors: Reads are retried (3 attempts) with exponential backoff; a job submission is retried only when it provably was not processed (rate limited, or the connection never opened), so a job is never submitted twice
Long jobs: one tool call waits at most
DEAPI_TOOL_MAX_WAIT(45 s, below the 60 s call timeout many MCP clients use). A job still running then returnssuccess: true, done: falsewith itsjob_id, andcheck_job_status(job_id, wait_seconds=...)resumes the waitJob Failures: Reported with the API's reason, error code, and whether the job is retryable / was refunded
API Errors: Properly formatted error responses
Configuration
Configuration can be set via environment variables (prefixed with DEAPI_). A variable set to
an empty value (DEAPI_REDIS_PORT=) counts as unset and takes the default. Comments go on their
own line: some tools (docker --env-file, kubectl create configmap --from-env-file) keep text
after a value, # ... included, as part of that value. .env.example lists
every variable with its default; the block below shows the common ones.
# API Configuration
DEAPI_API_BASE_URL=https://api.deapi.ai
DEAPI_API_VERSION=v2
# HTTP Client
DEAPI_HTTP_TIMEOUT=30.0
DEAPI_MAX_RETRIES=3
# Seconds one tool call waits before returning done=false and the job_id
DEAPI_TOOL_MAX_WAIT=45.0
# Polling Configuration (override defaults)
DEAPI_POLLING_AUDIO__INITIAL_DELAY=1.0
DEAPI_POLLING_AUDIO__MAX_DELAY=5.0
DEAPI_POLLING_AUDIO__TIMEOUT=300.0
# Internal completion webhooks (off by default). The receiver URL must be
# reachable from api.deapi.ai; a half-configured set refuses to start.
# Uncomment and fill in all three to turn them on.
DEAPI_WEBHOOKS_INTERNAL=false
# DEAPI_WEBHOOK_RECEIVER_URL=https://mcp.example.com/webhooks/deapi
# Secret the API signs callbacks with: 32-255 characters
# DEAPI_WEBHOOK_SECRET=
DEAPI_WEBHOOK_FALLBACK_POLL_INTERVAL=15.0
# Shared store for OAuth authorization codes (optional). Unset host = in-memory
# store, which only works with a single replica. Uncomment and set your own host.
# DEAPI_REDIS_HOST=redis.example.com
DEAPI_REDIS_PORT=6379
# DEAPI_REDIS_PASSWORD=
DEAPI_REDIS_DB=0
# Connection scheme: plain | tls (tls needs DEAPI_REDIS_CA_FILE)
DEAPI_REDIS_SCHEME=plain
# true = refuse to start without a Redis host
DEAPI_REDIS_REQUIRED=false
# Seconds in-flight tool calls may run after SIGTERM before they are cancelled.
# Keep it below your platform's termination grace period.
MCP_GRACEFUL_SHUTDOWN_SECONDS=930
# Behind a reverse proxy: the public URL OAuth discovery advertises (without it the
# 401 challenge points at the bind address), and which proxies' X-Forwarded-* headers
# are trusted.
# PUBLIC_BASE_URL=https://mcp.example.com
# FORWARDED_ALLOW_IPS=*With internal webhooks on, every job the server submits carries its own receiver URL and the API calls back the moment the job ends; the waiting tool wakes at once, with a slow poll underneath as a safety net. A caller-supplied webhook_url takes precedence for that job (the API takes one webhook per job), which then polls normally. A replayed delivery (same delivery_id) wakes nobody twice. The job registry is in process memory by default; with several replicas, see DEPLOYMENT.md.
Development
Project Structure
mcp-server-deapi/
├── deapi_mcp/
│ ├── server_remote.py # Streamable-HTTP MCP server
│ ├── deapi_client.py # HTTP client with auth forwarding
│ ├── polling_manager.py # Smart adaptive polling logic
│ ├── schemas.py # Pydantic models
│ ├── config.py # Configuration management
│ ├── auth.py # Authentication middleware
│ ├── fastmcp_auth.py # FastMCP OAuth provider
│ ├── oauth_endpoints.py # OAuth 2.0 endpoints
│ ├── auth_code_store.py # OAuth authorization codes (Redis or in-memory)
│ ├── observability.py # Per-call outcome, injectable metrics sinks
│ ├── webhooks.py # Internal completion-webhook receiver
│ └── tools/ # Tool implementations
│ ├── audio.py # Audio transcription, TTS & music generation
│ ├── image.py # Image generation, OCR & processing
│ ├── video.py # Video generation, image/audio-to-video, description & upscale
│ ├── embedding.py # Text embeddings
│ ├── prompt.py # Prompt booster
│ ├── utility.py # Balance, models, status
│ ├── _price_helpers.py # Resolve parameters from the model card
│ └── _responses.py # Shared tool response shape
├── tests/ # Test suite
│ ├── __init__.py
│ └── conftest.py # Pytest fixtures
├── pyproject.toml # Dependencies
├── Dockerfile # Container build
├── docker-compose.yml # Container orchestration
├── .env.example # Environment config template
├── README.md # This file
├── DEPLOYMENT.md # Deployment guide
├── AUTH.md # OAuth authentication setup
└── CLAUDE.md # Claude Code guidanceRunning Tests
Install dev dependencies:
uv pip install -e ".[dev]"Run tests:
pytestRun smoke tests (requires a running server):
python tests/smoke_test.pyCode Formatting
Format code with Black:
black deapi_mcp/ tests/Lint with Ruff:
ruff check deapi_mcp/ tests/Type-check with mypy (strict):
mypy deapi_mcpCI runs all three plus the test suite on Python 3.11–3.14.
Building your own server on the core
deapi_mcp is importable, so a deployment can assemble its own server from the same tools
and add what it needs (for example its own metrics) without forking:
from fastmcp import FastMCP
from deapi_mcp.server_remote import create_app, register_core_tools
server = FastMCP("my-deapi")
register_core_tools(server) # every deAPI tool
app = create_app(server, metrics=None) # Starlette app: /mcp, /health, OAuth routesAs with the stock server, set DEAPI_JWT_SECRET_KEY first: without it the app refuses to start
on a non-local host.
metrics is an optional overlay that instruments tool calls and OAuth and mounts its own
routes; the stock server (build_app()) passes none. job_registry replaces the in-process
registry that completion webhooks wake waiting tools through, for a deployment whose replicas
share one receiver URL: implement deapi_mcp.webhooks.JobRegistry (or subclass
JobCompletionRegistry, relay signal to the other replicas and call wake where it arrives).
Its start/stop run with the app's lifespan. Recorders for per-call outcomes and
rejected logins plug in through deapi_mcp.observability. Settings an overlay can use
(DEAPI_METRICS_TOKEN, DEAPI_METRICS_REDIS_DB, DEAPI_METRICS_PREFIX) are already defined
in deapi_mcp.config; the core itself never reads them.
The package ships type information (py.typed) and exposes deapi_mcp.__version__.
API Token Security
Important: The MCP server does NOT store API tokens. Authentication works as follows:
For Remote HTTP Server: Authentication is handled via OAuth 2.0 (Authorization Code with PKCE) or HTTP headers (Authorization: Bearer token)
Token forwarding: The server forwards authentication to the deAPI API for each request
No persistence: Tokens are used only for the specific request and never persisted or logged
Per-connection auth: Tools do NOT accept
deapi_api_tokenparameters - authentication is managed at the connection level
Always keep your API tokens secure and never commit them to version control. See AUTH.md for detailed OAuth setup.
Remote Deployment
For production environments or when you want to host the MCP server on a remote machine, use the remote server mode.
Quick Start with Docker
Build and run with Docker:
docker build -t mcp-server-deapi .
docker run -d -p 8000:8000 --name mcp-server-deapi -e DEAPI_JWT_SECRET_KEY="<a long random secret>" --stop-timeout 960 mcp-server-deapiOr use Docker Compose (reads
DEAPI_JWT_SECRET_KEYfrom the environment or.env):
docker compose up -dConfigure Claude Desktop to connect:
{
"mcpServers": {
"deapi": {
"url": "http://your-server-ip:8000/mcp"
}
}
}Manual Remote Deployment
On your remote server:
git clone https://github.com/deapi-ai/mcp-server-deapi.git
cd mcp-server-deapi
pip install -e .
export DEAPI_JWT_SECRET_KEY="<a long random secret>"
python -m deapi_mcp.server_remoteFor production with systemd:
# Create /etc/systemd/system/mcp-server-deapi.service
sudo systemctl enable mcp-server-deapi
sudo systemctl start mcp-server-deapiBehind a reverse proxy (nginx + SSL):
server {
listen 443 ssl http2;
server_name mcp.yourdomain.com;
ssl_certificate /path/to/cert.pem;
ssl_certificate_key /path/to/key.pem;
location / {
proxy_pass http://localhost:8000;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
proxy_buffering off;
proxy_cache off;
proxy_read_timeout 86400;
}
}Cloud Deployment Options
Railway.app: Push to GitHub, connect repository, deploy automatically
Fly.io:
fly launch && fly deployHeroku:
heroku create && git push heroku mainDigitalOcean: Use App Platform or Droplets with Docker
AWS/GCP/Azure: Deploy with container services (ECS, Cloud Run, Container Instances)
For detailed deployment instructions, security considerations, monitoring, and troubleshooting, see DEPLOYMENT.md.
Troubleshooting
Connection Issues
If the server fails to connect:
Check your API token is valid
Verify network connectivity to api.deapi.ai
Check the logs for specific error messages
For remote servers: verify firewall rules and that port 8000 is accessible
Job Timeouts
If jobs are timing out:
Check your balance with
get_balanceVerify the job type timeout is appropriate
Use
check_job_statusto check if the job is still processing
Model Not Found
If you get model errors:
Use
get_available_modelsto see available modelsEnsure you're using the correct model name
Check if the model supports your requested operation
Remote Connection Issues
If remote MCP connection fails:
Test the server:
curl http://your-server:8000/health(a bareGET /mcpanswers 405: the transport is stateless, POST only)Check server logs:
docker logs mcp-server-deapiorjournalctl -u mcp-server-deapiVerify firewall rules and SSL certificates (if using HTTPS)
Ensure MCP endpoint is accessible from your client
License
This project is licensed under the MIT License - see the LICENSE file for details.
Changelog
See CHANGELOG.md.
Support
For issues related to:
This MCP Server: Open an issue
A security vulnerability: do not open a public issue; see SECURITY.md
deAPI Platform: Visit docs.deapi.ai
MCP Protocol: Visit modelcontextprotocol.io
Available Tools
39 toolsaudio_to_videoAudio To VideoAInspect
Generate video from audio and text prompt.
Creates videos conditioned on audio content. The audio drives the video generation, allowing synchronized audio-visual output. Optionally accepts anchor frame images.
IMPORTANT: Check model specifications using get_available_models() before calling. Pay attention to features.supports_guidance, features.supports_steps, and model limits.
Inputs: audio (required), model (required), prompt (required), fps, +11 more. Returns: object
audio_to_video_priceAudio To Video PriceCInspect
Calculate price for audio-to-video generation.
Inputs: model (required), fps, steps, width, +2 more. Returns: object
audio_transcriptionAudio TranscriptionCInspect
Transcribe audio file to text using Whisper models.
Converts audio files to text transcription with optional timestamps. Automatically polls until transcription is complete.
Inputs: audio (required), include_ts (required), lang, model, +5 more. Returns: object
audio_transcription_priceAudio Transcription PriceAInspect
Calculate price for audio transcription.
Quotes an uploaded audio file by its length. For a URL use video_url_transcription_price or audio_url_transcription_price.
Inputs: include_ts (required), duration_seconds (required), lang, model, +2 more. Returns: object
audio_url_transcriptionAudio Url TranscriptionAInspect
Transcribe audio from Twitter Spaces URL to text using Whisper models.
Extracts and transcribes audio from Twitter Spaces URLs. NOTE: This endpoint only works with Twitter Spaces URLs. For video content, use video_url_transcription instead.
Inputs: audio_url (required), include_ts (required), lang, model, +6 more. Returns: object
audio_url_transcription_priceAudio Url Transcription PriceAInspect
Calculate price for Twitter Spaces audio transcription.
Provide either audio_url or duration_seconds for price calculation.
platform is only accepted alongside duration_seconds; with a URL the
API derives the platform from the source.
Inputs: include_ts (required), lang, model, diarize, +5 more. Returns: object
check_job_statusCheck Job StatusAInspect
Check status of a submitted job, optionally waiting for it to finish.
Every generation tool waits a limited time for its job. A job that takes longer (a long video, a long transcript, up to an hour) comes back with done=false and status 'processing'; call this with the job_id and wait_seconds to keep waiting, and repeat while done is false. Do not submit the job again — it is already running and paid for.
Inputs: job_id (required), wait_seconds. Returns: object
get_available_modelsGet Available ModelsAInspect
Get list of available AI models with detailed specifications.
Retrieves all available models for different inference types (txt2img, txt2video, img2img, img2video, audio_file2text, img2txt, video2desc, etc.) along with their capabilities, limits, defaults, and features.
IMPORTANT - How to use model specifications:
Each model's 'info' field contains critical information you MUST check before using:
inference_types: List of supported operations (e.g., ["txt2img", "img2img"])
info.limits: Min/max constraints for ALL parameters. Examples:
max_guidance/min_guidance: Valid range for guidance_scale
max_steps/min_steps: Valid range for inference steps
max_width/min_width, max_height/min_height: Image/video dimensions
max_frames/min_frames: Number of video frames
max_fps/min_fps: Video frame rate
info.defaults: Recommended default values for the model. Examples:
If defaults.guidance="0", use guidance_scale=0
If defaults.steps="1", use steps=1
Use these when model has specific requirements
info.features: Boolean flags (0=false, 1=true) indicating support:
supports_steps: If "0", model has fixed steps
supports_negative_prompt: If "0", don't pass negative_prompt
supports_last_frame: If "1", img2video supports initial frame control
supports_voice_clone / supports_voice_design / supports_custom_voice: which TTS mode the model implements. It implements exactly one and returns 422 for the others
supports_guidance: no model in the catalogue currently sets this to "1", so leave guidance unset and the model's own default is used
supports_image_refs / supports_video_refs / supports_audio_refs: img2video reference mode (ref_images / ref_videos / ref_audios); limits.max_ref_* give the counts, 0 meaning that type is not taken
supports_presets: video description presets, listed in limits.available_presets
General rule: rather than assuming a value, omit the parameter and let the model's info.defaults apply, or read the bound from info.limits.
Example workflow for txt2video with LTX-Video model:
Check inference_types includes "txt2video"
Check limits.max_steps = "1" → must use steps=1
Check limits.min_fps = "30", max_fps = "30" → must use fps=30
Use defaults for other parameters (width=512, height=512, frames=120)
Inputs: no named parameters. Returns: object
get_balanceGet BalanceAInspect
Get current account balance.
Check your deAPI account balance and remaining credits.
Inputs: no named parameters. Returns: object
image_remove_backgroundImage Remove BackgroundAInspect
Remove background from an image.
Takes an image and removes its background, returning a transparent PNG. Accepts images as:
Public URLs (recommended: chains with text_to_image, and the ONLY way in for a file of your own - chat clients do not pass files through to tools)
Data URIs or raw base64 (for callers that already hold the bytes)
Inputs: image (required), model (required), webhook_url, webhook_secret. Returns: object
image_remove_background_priceImage Remove Background PriceBInspect
Calculate price for image background removal.
Pass the image, or its width and height.
Inputs: model (required), image, width, height. Returns: object
image_to_imageImage To ImageAInspect
Transform an existing image using a text prompt.
Modifies images based on text descriptions. Useful for style transfer and editing. Accepts images as URLs (preferred), data URIs (data:image/...;base64,...), or base64 strings. When a URL is available (e.g., from a previous text_to_image result), always prefer passing the URL directly.
Pass either image for a single source or images for up to five; the API
rejects a request carrying both.
Inputs: model (required), prompt (required), seed, image, +11 more. Returns: object
image_to_image_priceImage To Image PriceAInspect
Calculate price for image-to-image transformation.
Pass the same parameters and source image(s) the edit call will use:
quality and the input size both change the charge on some models, so a
quote without them may not match the job.
Inputs: model (required), prompt (required), seed, image, +8 more. Returns: object
image_to_textImage To TextBInspect
Extract text from image using OCR (Optical Character Recognition).
Reads text from images like documents, screenshots, signs, etc.
Inputs: image (required), model (required), format, language, +3 more. Returns: object
image_to_text_priceImage To Text PriceBInspect
Calculate price for OCR text extraction.
Pass the image, or its width and height.
Inputs: model (required), image, width, height, +1 more. Returns: object
image_to_videoImage To VideoAInspect
Generate video from static image(s), or from reference images, videos and audio.
Two modes, mutually exclusive:
Keyframes: first_frame_image (and optionally last_frame_image) is animated.
References: ref_images / ref_videos / ref_audios, on models that support them (the model list shows "refs: ..." for those). The prompt addresses each reference by its tag: <Picture 1>, <Picture 2> for images, <Video 1> for a video, <Audio 1> for audio, numbered from 1 within each type in the order given. Order matters: swapping two images swaps what the tags refer to. Example prompt: "<Picture 1> walks into the room from <Picture 2>, speaking with the voice of <Audio 1>".
Accepts files as:
Public URLs (recommended: chains with text_to_image, and the ONLY way in for a file of your own - chat clients do not pass files through to tools)
Data URIs or raw base64 (for callers that already hold the bytes)
IMPORTANT: Check model specifications using get_available_models() before calling. Pay attention to limits for width/height/frames/fps and, in reference mode, the max_ref_* counts and durations.
Inputs: model (required), prompt (required), fps, seed, +14 more. Returns: object
image_to_video_priceImage To Video PriceAInspect
Calculate price for image-to-video generation.
For reference mode, pass the number of reference files the job will carry (not the files themselves). Surcharges do not stack: the highest applies, so 4 images plus a video is x3, not x6.
Inputs: model (required), fps, steps, width, +5 more. Returns: object
image_upscaleImage UpscaleAInspect
Upscale an image to higher resolution.
Takes an image and upscales it using AI models for enhanced quality. Accepts images as:
Public URLs (recommended: chains with text_to_image, and the ONLY way in for a file of your own - chat clients do not pass files through to tools)
Data URIs or raw base64 (for callers that already hold the bytes)
Inputs: image (required), model (required), webhook_url, webhook_secret. Returns: object
image_upscale_priceImage Upscale PriceAInspect
Calculate price for image upscaling.
Pass the image, or its width and height.
Inputs: model (required), image, width, height. Returns: object
prompt_boosterPrompt BoosterAInspect
Enhance a prompt using AI guides tailored to a specific deAPI model + inference type.
Synchronous — returns the enhanced prompt(s) directly. Charged per call;
use prompt_booster_price first if you want a quote.
Inputs: type (required), prompt (required), model_slug (required), image, +1 more. Returns: object
prompt_booster_pricePrompt Booster PriceCInspect
Calculate the price for a prompt-booster call.
Inputs: type (required), prompt (required), model_slug (required), image, +1 more. Returns: object
text_to_audioText To AudioAInspect
Convert text to speech audio using TTS models.
Generates natural-sounding speech from text with customizable voice and parameters.
Supports three modes, and each model implements exactly one — passing the
wrong one is rejected with a 422. Leave mode unset and it is taken from
the model's own card:
custom_voice: pick a preset
voice(e.g. Kokoro, Chatterbox)voice_clone: reproduce the speaker in
ref_audio(+ optionalref_text)voice_design: build a voice from an
instructdescription
lang and voice values are per-model and listed under each model in the
"Available models" section below (Kokoro: lang 'en-us', voice 'af_alloy';
Qwen3: lang 'English'). Leave them unset to use the model's own defaults.
Inputs: text (required), model (required), lang, mode, +9 more. Returns: object
text_to_audio_priceText To Audio PriceAInspect
Calculate price for text-to-audio generation.
The price follows the number of characters (text, or count_text), the
language and the speed. mode, voice and instruct are only validated,
so the quote fails where the job would. Left unset they are taken from the
model's card, exactly as text_to_audio does.
Inputs: text (required), model (required), lang, mode, +6 more. Returns: object
text_to_embeddingText To EmbeddingBInspect
Generate text embeddings using AI models.
Converts text into vector embeddings for semantic search, similarity comparison, and other NLP tasks. Accepts a single string or a list of strings.
Inputs: input (required), model, webhook_url, webhook_secret, +1 more. Returns: object
text_to_embedding_priceText To Embedding PriceCInspect
Calculate price for text embedding generation.
Inputs: input (required), model. Returns: object
text_to_imageText To ImageBInspect
Generate image from text prompt using AI diffusion models.
Creates images from text descriptions. Returns the generated image URL.
Inputs: model (required), prompt (required), seed, loras, +9 more. Returns: object
text_to_image_priceText To Image PriceAInspect
Calculate price for text-to-image generation.
Pass the same parameters the generation call will use. Fields that affect
the charge — quality above all — change the quote, so omitting them here
produces a number the job will not honour.
Inputs: model (required), prompt (required), seed, loras, +6 more. Returns: object
text_to_musicText To MusicAInspect
Generate music from text description and lyrics.
Creates music tracks from text prompts with customizable parameters including tempo, key, time signature, and optional style reference audio.
IMPORTANT: Check model specifications using get_available_models() before calling. Pay attention to model limits for duration, inference_steps, guidance_scale, and bpm.
Inputs: model (required), lyrics (required), caption (required), duration (required), +11 more. Returns: object
text_to_music_priceText To Music PriceCInspect
Calculate price for text-to-music generation.
Inputs: model (required), duration (required), inference_steps. Returns: object
text_to_videoText To VideoAInspect
Generate video from text prompt.
Creates videos from text descriptions. Returns the generated video URL.
IMPORTANT: Before calling this tool, use get_available_models() to check the model's specifications. Pay special attention to:
limits.max_steps/min_steps: Valid range for steps parameter
limits.max_fps/min_fps: Valid range for fps parameter
defaults: Recommended values for the model
Inputs: model (required), prompt (required), fps, seed, +9 more. Returns: object
text_to_video_priceText To Video PriceCInspect
Calculate price for text-to-video generation.
Inputs: model (required), fps, steps, width, +2 more. Returns: object
video_descriptionVideo DescriptionAInspect
Describe what happens on screen in a video, as a timestamped index of events.
The visual counterpart of transcription: reads the picture, not the audio track (for speech use the transcription tools). Pass exactly one source: video_url for a YouTube, Twitter/X, Twitch, Kick or TikTok link, or video_file for a file.
The result is a JSON document: {"events": [{"start", "end", "description", ...}], "scenes": [...], "meta": {"duration", "preset", ...}}, with start/end in seconds. Priced on machine time, so longer videos and higher presets cost more; quote first with video_description_price. A long video can take several minutes: if the tool times out, follow up with check_job_status.
Inputs: model (required), preset, video_url, video_file, +4 more. Returns: object
video_description_priceVideo Description PriceAInspect
Calculate the price of a video description.
Pass exactly one source: video_url, video_file or duration_seconds (with an optional platform). Use the same preset and include_metadata the job will use, since both change the price.
Inputs: model (required), preset, platform, video_url, +3 more. Returns: object
video_file_transcriptionVideo File TranscriptionAInspect
Transcribe video file to text using Whisper models.
Extracts audio from video and converts it to text transcription with optional timestamps. Accepts video files as URLs (preferred), data URIs, or base64 strings. Automatically polls until transcription is complete.
Inputs: video (required), include_ts (required), lang, model, +5 more. Returns: object
video_file_transcription_priceVideo File Transcription PriceAInspect
Calculate price for video file transcription.
Quotes an uploaded video file by its length. For a URL use video_url_transcription_price.
Inputs: include_ts (required), duration_seconds (required), lang, model, +2 more. Returns: object
video_upscaleVideo UpscaleAInspect
Upscale a video to higher resolution.
Takes a video and upscales it using AI models for enhanced quality. Accepts videos as:
Public URLs (recommended, and the ONLY way in for a file of your own - chat clients do not pass files through to tools)
Data URIs or raw base64 (for callers that already hold the bytes)
Inputs: model (required), video (required), scale, webhook_url, +1 more. Returns: object
video_upscale_priceVideo Upscale PriceAInspect
Calculate price for video upscaling.
Pass the video itself, or its width, height and duration.
Inputs: model (required), scale, video, width, +2 more. Returns: object
video_url_transcriptionVideo Url TranscriptionBInspect
Transcribe video from URL to text using Whisper models.
Extracts audio from video URL and converts it to text transcription with optional timestamps. Supports YouTube, Twitter/X, Twitch, Kick and TikTok videos. Automatically polls until transcription is complete.
Inputs: video_url (required), include_ts (required), lang, model, +6 more. Returns: object
video_url_transcription_priceVideo Url Transcription PriceAInspect
Calculate price for video URL transcription.
Quote either from a URL or from a duration. The API accepts exactly one:
given a URL it derives duration and platform from the source itself, so
duration_seconds and platform are rejected alongside it.
Inputs: include_ts (required), lang, model, diarize, +5 more. Returns: object
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 39 tools
Generation tools are cleanly separated by input modality (text_to_image, image_to_image, text_to_video, image_to_video, audio_to_video) and each has an unambiguous `*_price` twin. The main friction is the transcription cluster (audio_transcription vs audio_url_transcription vs video_file_transcription vs video_url_transcription) plus image_to_text, where the boundaries rest on source type and descriptions must be read carefully to avoid picking the wrong one.
The dominant pattern is consistent snake_case source_to_target for generators and a uniform `_price` suffix for every quote tool, which makes pairs easy to spot. A handful of tools break the verb_noun shape (prompt_booster, video_description, get_balance, get_available_models, check_job_status), but these are few and readable rather than chaotic.
39 tools is well past the heavy threshold, and nearly half the surface is `*_price` duplicates of the generation calls. The doubling is defensible because pricing is parameter-dependent, but the set could be tightened (e.g. folding source variants like audio_url vs audio_file transcription) rather than exposing one tool per endpoint permutation.
Coverage across the multi-modal domain is strong: image, video, audio, music, embeddings, prompt boosting, model discovery, balance, and a price quote for essentially every operation, plus check_job_status for long-running jobs. The only real gaps are job lifecycle management — no cancel, list, or history of previously submitted jobs — which an agent would have to work around.
Related MCP Connectors
MCP server that lets AI assistants use all OneSchema features exposed via the public API.
MCP server for your apps' tools and custom tools, plus hosted AI agents and approval-gated workflows
Focused MCP server for OpenAI image/audio generation (v2.0.0). Wraps endpoints via HAPI CLI.
MCP server for OpenAI API (chat completions, image generation, embeddings) via AceDataCloud
Related MCP Servers
- AlicenseBqualityDmaintenanceProduction-ready MCP server with 40+ tools — QR codes, PDFs, text processing, TTS, web scraping, image generation and more. Built for AI agents.2553 npmMIT
- AlicenseNot gradedqualityCmaintenanceA self-hostable MCP server that turns a folder of skills into callable tools via MCP and REST APIs.3MIT
- FlicenseNot gradedqualityDmaintenanceEnterprise MCP server providing a suite of tools including file, database, GitHub, Slack, calendar, email, vector search, and Python execution, with safe defaults and OpenAI integration for automatic tool selection.-
- FlicenseNot gradedqualityDmaintenanceA local MCP server exposing the OpenAI platform REST API as tools for file management, fine-tuning, inference, images, audio, batch processing, and organization usage/costs.-