Skip to main content

Deep Art MCP server tools reference

This page describes all tools exposed by the Deep Art MCP server.

The server uses synchronous Streamable HTTP at https://api.deepart.ai/mcp.

Authentication

Every MCP request requires one of these HTTP headers:

X-API-Key: <api-key>

or:

Authorization: Bearer <access-token>

The server validates the credential against the Deep Art account service before processing the request. Missing or invalid credentials are rejected. Operations that require more credits than the account balance are rejected with the message:

Your account has insufficient credits to perform this operation.

Available tools

CategoryToolDescription
Imagescreate_imageGenerate an image from a text prompt
Imagesedit_imageEdit an existing image
Videoscreate_videoSubmit an asynchronous video generation job
Videosget_video_statusPoll a video generation job
Creditsget_credit_balanceReturn the current credit balance

The credit balance is checked before a generation request. Credits are consumed only after Deep Art successfully generates the image or accepts the video job.


Image generation

create_image

Creates an AI-generated image from a text prompt and returns a hosted image URL.

Parameters

NameTypeRequiredDefaultDescription
promptstringYesText prompt for image generation
aspectRatiostringNoProvider defaultImage aspect ratio. One of: "1:1", "4:5", "9:16", "16:9"

Output

The tool returns text content and structured content with these fields:

FieldTypeDescription
urlstringHosted URL of the generated PNG image
promptstringThe prompt used to generate the image
aspectRatiostringRequested aspect ratio. Present only when the caller supplied it

The text content has the form Generated image: <url>.

Notes

  • The tool is declared as non-read-only, non-destructive, and closed-world.
  • The generated output is associated with the image-card MCP App resource.

edit_image

Edits an existing image according to a text instruction and returns a hosted image URL.

Parameters

NameTypeRequiredDescription
promptstringYesText instruction describing the image edit
sourceImagestringYesAbsolute HTTP(S) URL or supported Base64 data URL of the source image

Supported Base64 data URL media types are PNG, JPEG, WebP, and GIF. The data URL must contain valid, non-empty Base64 data.

Output

The tool returns text content and structured content with these fields:

FieldTypeDescription
urlstringHosted URL of the edited PNG image
promptstringThe edit instruction applied to the image

The text content has the form Edited image: <url>.

Notes

  • The output does not repeat sourceImage.
  • Blank prompts, blank source images, relative URLs, unsupported URL schemes, and invalid data URLs are rejected.
  • The tool is declared as non-read-only, non-destructive, and closed-world.
  • The generated output is associated with the image-card MCP App resource.

Video generation

create_video

Submits an asynchronous video generation job from a text prompt. The call returns after Deep Art accepts the job; use get_video_status to retrieve its current state and final video URL.

Parameters

NameTypeRequiredDefaultDescription
promptstringYesText prompt for video generation
durationintegerNo4Duration in seconds. One of: 4, 6, 8
resolutionstringNoProvider defaultVideo resolution. One of: "720p", "1080p"
aspectRatiostringNoProvider defaultVideo aspect ratio. One of: "16:9", "9:16"
generateAudiobooleanNoProvider defaultWhether the generated video should include audio

Output

The tool returns text content and structured content with these fields:

FieldTypeDescription
typestringAlways "video"
idstringVideo generation job ID
jobIdstringAlias of id, used for subsequent status calls
statusstringInitial provider status, such as "queued"
donebooleanWhether the job is already in a terminal state
videoUrlsstring[]Empty for a newly submitted job
promptstringThe prompt submitted for generation
durationintegerRequested duration. Present only when the caller supplied it
resolutionstringRequested resolution. Present only when the caller supplied it
aspectRatiostringRequested aspect ratio. Present only when the caller supplied it
generateAudiobooleanRequested audio setting. Present only when the caller supplied it

The text content has the form Submitted video generation job: <jobId> (<status>).

Notes

  • The tool is declared as non-read-only, non-destructive, and closed-world.
  • The generated output is associated with the video-card MCP App resource.

get_video_status

Returns the status of a previously submitted video generation job.

Parameters

NameTypeRequiredDescription
jobIdstringYesVideo generation job ID returned by create_video

Output

The tool returns text content and structured content with these fields:

FieldTypeDescription
typestringAlways "video"
idstringProvider job ID
jobIdstringAlias of id
statusstringCurrent provider status
donebooleantrue for completed, failed, cancelled, or canceled; otherwise false
videoUrlsstring[]Available video URLs, or an empty array when no URL is available

The text content has the form Video status: <status>.

Notes

  • This read-only call does not consume credits.
  • When a job is completed, the server returns the hosted URL.
  • The tool is declared as read-only, non-destructive, and closed-world.
  • The video card can call this tool repeatedly to refresh job progress.

Credit balance

get_credit_balance

Returns the current credit balance for the authenticated account.

Parameters

This tool has no parameters.

Output

FieldTypeDescription
creditsBalanceintegerCurrent number of credits available to the authenticated account

Notes

  • This read-only call does not consume credits.
  • The tool is declared as read-only, non-destructive, and closed-world.

MCP App resources

Generation tools expose HTML resources that compatible MCP clients can use to render their structured output.

image-card

PropertyValue
URIui://deepart/image-card/v1.html
MIME typetext/html;profile=mcp-app
Used bycreate_image, edit_image

video-card

PropertyValue
URIui://deepart/video-card/v1.html
MIME typetext/html;profile=mcp-app
Used bycreate_video