VidMage

VidMage is an AI video and image creation platform for creators. Turn your ideas and images into videos and fresh visuals.

Open the creator tools
Explore APIs
AI Video APIsAI Image APIsAI Audio APIsAI 3D APIsAI Face Swap APIsAI Effects APIs
Build with VidMage
QuickstartAPI keysVidMage MCPError reference
Your account
Developer consoleAbout VidMagePlans and creditsAPI billingContact support
© 2026 VidMage. All rights reserved.
Privacy PolicyTerms of ServiceReport Abuse
Skip to content
VidMage/Developers
Overview
APIs
All APIsAI Video APIsAI Image APIsAI Audio APIsAI 3D APIsAI Face Swap APIsAI Effects APIs
DocumentationVidMage MCPOpen console
Developers/Seedream API

Seedream API

Build image generation and editing into your app with Seedream. Set width and height, supply source images for edits, and configure sequential generation and output count for workflows that need related image sets.

Get API keyView API docs
Abstract illustration for Seedream API
PlaygroundAPIPricingGuideFAQs

Seedream API Playground

Use your existing API key and subscription. Submitting a generation uses credits; uploading and preparing a request does not start a generation.

API access is available to subscribers only. Your subscription credits are shared across the website and the API.

View plans

Parameter

8 parameters

Text prompt describing the image to generate (max 2000 chars). For an unspecified character or figurine, use an original non-branded character with no logos and no resemblance to existing copyrighted superheroes; preserve any character the user explicitly names.

Optional input image URL. When provided, the task runs in image edit mode.(Optional)

Ordered input image URLs for image editing mode. The prompt can reference them by their one-based order.(Optional)

minItems 1maxItems 10

Output width in pixels; ignored when a resolution tier is selected.(Optional)

Default: 2048min 512max 8192

Output height in pixels; ignored when a resolution tier is selected.(Optional)

Default: 2048min 512max 8192

Allow the model to generate a coherent image sequence.(Optional)

Default: disabled

Maximum number of images to generate in a sequence.(Optional)

Default: 1min 1max 15

Optional output resolution tier; overrides width and height.(Optional)

Request code

#!/usr/bin/env bash
set -euo pipefail
# Set this once per intended task; preserve it and the body for transport retries.
: "${VIDMAGE_IDEMPOTENCY_KEY:?Set a unique key for this task}"

SUBMIT_RESPONSE="$(curl --fail-with-body --silent --show-error -X POST "https://vidmage.ai/api/v1/seedream-ai-image-generator/submit" \
  -H "Authorization: Bearer ${VIDMAGE_API_KEY}" \
  -H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "prompt": "Luxury perfume bottle on black stone with soft mist, dramatic studio lighting, premium advertising photography",
  "width": 2048,
  "height": 2048,
  "sequentialImageGeneration": "disabled",
  "maxImages": 1
}')"
TASK_ID="$(printf '%s' "$SUBMIT_RESPONSE" | jq -er '.["taskId"]')"

while true; do
  QUERY_RESPONSE="$(curl --fail-with-body --silent --show-error -X POST "https://vidmage.ai/api/v1/seedream-ai-image-generator/query" \
    -H "Authorization: Bearer ${VIDMAGE_API_KEY}" \
    -H "Content-Type: application/json" \
    --data-raw "{\"taskId\":\"${TASK_ID}\"}")"
  STATUS="$(printf '%s' "$QUERY_RESPONSE" | jq -r '(.status // .data.status // "") | ascii_downcase')"
  case "$STATUS" in
    success|succeeded|completed)
      RESULT="$(printf '%s' "$QUERY_RESPONSE" | jq -r '(.result // .["imageUrl"] // .data["imageUrl"] // empty)')"
      if [ -z "$RESULT" ]; then
        printf '%s' "Result missing; preserve task $TASK_ID and query the same task again. Do not resubmit." >&2
        exit 2
      fi
      printf '%s\n' "$RESULT"
      break
      ;;
    needs_input)
      printf '%s' "Face selection required; preserve task $TASK_ID" >&2
      exit 2
      ;;
    failed|error)
      printf '%s' "$QUERY_RESPONSE" | jq -r '(.message // .error // .data.error // "Task failed")' >&2
      exit 1
      ;;
  esac
  sleep 5
done

Response data

Submit the task to see the API response here.
PlaygroundCapabilities

API documentation

Submit a request, track the task, and retrieve your result.

Required inputs
prompt
Output
Image·imageUrl
Request setup & limitsHeaders, input options and media limits

Request headers

Authorization
Bearer YOUR_API_KEY

Keep your API key on your server.

Content-Type
application/json
Idempotency-Key
YOUR_UNIQUE_KEY

Use a new key per task. Reuse it only when retrying the same submission.

Input options & limits

Request controls follow each task's parameter rules; they do not guarantee output properties.

Seedream AI Image Generator

Modes: text-to-image, image-edit

Additional inputs; requirements vary by mode

prompt imageUrl imageUrls sequentialImageGeneration maxImages

Media limits by mode
  • Image EditImage: jpeg, png; up to 10 files
Request controls
  • width: default 2048
  • height: default 2048
  • resolution: "2k", "4k"

Input retention and output-link lifetime depend on the API contract. Confirm API-specific retention terms before making promises to your users. Upload guide ↗

Seedream AI Image Generator

POST /api/v1/seedream-ai-image-generator/submit

Full API documentation ↗

prompt is required.

Required inputs

promptstring
Text prompt describing the image to generate (max 2000 chars). For an unspecified character or figurine, use an original non-branded character with no logos and no resemblance to existing copyrighted superheroes; preserve any character the user explicitly names.

Edit the sample inputs for your own task before submitting.

Seedream AI Image Generator request
# Set VIDMAGE_IDEMPOTENCY_KEY to a unique value for this task; preserve it for transport retries.
curl -X POST "https://vidmage.ai/api/v1/seedream-ai-image-generator/submit" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
  -H "Content-Type: application/json" \
  -d '{"prompt":"Luxury perfume bottle on black stone with soft mist, dramatic studio lighting, premium advertising photography","width":2048,"height":2048,"sequentialImageGeneration":"disabled","maxImages":1}'
# -> { "success": true, "taskId": "...", "creditsConsumed": ... }
Parameters and input rules8 fields
FieldTypeRequiredDefaultMeaning and limits
promptstringYesNot specifiedText prompt describing the image to generate (max 2000 chars). For an unspecified character or figurine, use an original non-branded character with no logos and no resemblance to existing copyrighted superheroes; preserve any character the user explicitly names. Minimum length: 5 · Maximum length: 2000
imageUrlstringNoNot specifiedOptional input image URL. When provided, the task runs in image edit mode. No additional field constraint listed.
imageUrlsstring[]NoNot specifiedOrdered input image URLs for image editing mode. The prompt can reference them by their one-based order. Minimum items: 1 · Maximum items: 10
widthnumberNo2048Output width in pixels; ignored when a resolution tier is selected. Default: 2048 · Minimum: 512 · Maximum: 8192 · Multiple of: 8 · Whole numbers only
heightnumberNo2048Output height in pixels; ignored when a resolution tier is selected. Default: 2048 · Minimum: 512 · Maximum: 8192 · Whole numbers only
sequentialImageGenerationstringNo"disabled"Allow the model to generate a coherent image sequence. Values: "disabled", "auto" · Default: "disabled"
maxImagesnumberNo1Maximum number of images to generate in a sequence. Default: 1 · Minimum: 1 · Maximum: 15 · Multiple of: 1 · Whole numbers only
resolutionstringNoNot specifiedOptional output resolution tier; overrides width and height. Values: "2k", "4k"
Mode-specific fields & media limits
Text To Image rules
ControlMode-specific rule
promptRequired; minimum 5 characters; maximum 2000 characters
widthRange: 512 to 8192; Default: 2048
heightRange: 512 to 8192; Default: 2048
sequentialImageGenerationValues: "disabled", "auto"; Default: "disabled"
maxImagesRange: 1 to 15; Default: 1
resolutionValues: "2k", "4k"
Image Edit rules
ControlMode-specific rule
promptRequired; minimum 5 characters; maximum 2000 characters
imageUrlsImage input; up to 10 items
widthRange: 512 to 8192; Default: 2048
heightRange: 512 to 8192; Default: 2048
sequentialImageGenerationValues: "disabled", "auto"; Default: "disabled"
maxImagesRange: 1 to 15; Default: 1
resolutionValues: "2k", "4k"

Retrieve the result

Save taskId from the accepted submission and send it to this endpoint:

POST /api/v1/seedream-ai-image-generator/query

Use the same Bearer API key. On completion, read the imageUrl result field.

Task states and recovery ↗
Seedream AI Image Generator query
curl -X POST "https://vidmage.ai/api/v1/seedream-ai-image-generator/query" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "taskId": "TASK_ID_FROM_SUBMIT" }'
# -> { "success": true, "data": { "status": "...", "imageUrl": "https://..." } }

Pricing

See what one image, video, or generation costs in credits. Your API and website activity share the same credit balance.

API credit rates and calculated example request costs
API / workflowExample requestPrice (credits)
Seedream AI Image Generatorimage API1 image request: 10 creditsmaxImages: 1
How this is calculated
  • Base rate: 10 credits / generation

Base charge is per generation at the selected resolution.

maxImages multiplies the base charge by the selected output count.

Estimate your own request ↗
10 credits / generationSee calculation details
Billed in credits. Shared with the website.Active subscription required. Unit rates and examples follow current API credit rules.Billing details⌄

Examples show the charge for the inputs listed above. Resolution, duration, audio, output count and reference media can change the total. Minimum charges and rounding follow the selected API.

Use the Playground to estimate your request before submitting it. Estimates do not start a generation. Subscription and credit-pack prices are listed on the plans page.

Your task’s recorded usage is the source of truth for the final charge.

View plans ↗Billing guide ↗

About Seedream API

VidMage's Seedream API is an interface for generating images from text and editing compositions with image references. Numeric width and height define the canvas, and editing requests accept up to ten source images. Separate sequence and output-count settings describe the requested result set independently of the source reference count. To explore this model's browser workflow, open VidMage's Seedream AI Image Generator.

Seedream API capabilities

Generate on a defined canvas
Describe a new image and set numeric width and height using the selected mode's dimension rules.
Edit with image references
Supply up to ten source images and explain what each should contribute to the requested composition.
Configure a related image set
Use sequentialImageGeneration and maxImages to describe the requested output set separately from the source reference count.

What you can build

Storefront campaign banners

Design a banner around the storefront slot it needs to fill. An accepted canvas size sets the dimensions, and the prompt positions the product scene with space for copy. Add the exact offer and store branding in your layout editor.

Story sequence planning

Arrival, discovery, decision: three story beats can become a requested set of related images. Describe the shared subject and what changes between views. Arranging the results in a storyboard helps a writer and illustrator discuss the sequence and its continuity.

Interior product mood boards

Combine furniture, fabric, and room references into an interior proposal, describing their arrangement in the prompt. Keep source product images beside the generated composition to check shapes and materials.

How to use Seedream API

  1. Get an API key

    Create a key in the Developer Console and store it on your server. Use it in the Authorization: Bearer header.

  2. Prepare and submit your inputs

    Set up your inputs in the Playground, then copy the matching API request. Send it from your server with a unique Idempotency-Key.

  3. Track the task

    Save the returned taskId and query the same operation until it completes. Keep that identifier if your app stops waiting.

  4. Retrieve the result

    Read imageUrl from the completed task. Preview the result in your app and save a copy to your own storage for later use.

Input tips
Separate input and output counts
imageUrls supplies edit sources. maxImages is a numeric output limit from one to fifteen, used with sequentialImageGeneration; neither setting counts the source images you upload.
Check canvas settings in the reference
Width and height have mode-specific step rules. The reference metadata conflicts on resolution support, so avoid combining resolution with dimensions until the current contract clarifies their relationship.

Input requirementsUpload local files

Task fields and results

Keep the task identifier with its original request and Idempotency-Key. Query the same capability until it completes, then read the documented result field.

Task identifier
taskId
Query route
POST /api/v1/seedream-ai-image-generator/query
Completed result
imageUrl
Task states and response structure ↗
Errors, retries and limits

Retry transport failures with the same idempotency key only when the original submission may not have reached the server. For a confirmed task, keep querying the original task instead of submitting a duplicate.

Read error recovery guidance ↗

FAQs

Are failed or timed-out requests charged?

A client timeout is not a confirmed task failure. Confirmed failures are automatically refunded only when the refund outcome is certain. Unknown charges or refunds remain pending reconciliation.

Failure and refund handling ↗
How long should my app wait for a result?

The checked contract does not establish a fixed completion time. Choose a local wait budget for your app; it is not an API completion deadline.

Polling and wait budgets ↗
What are the rate and concurrency limits?

Request-rate limits control how often you can call the API; concurrency limits control simultaneous work. The documentation ties both to the stable API key but does not publish numeric limits for this operation. Confirm account limits before planning parallel jobs.

Rate-limit recovery ↗
Can I receive results through a webhook?

The checked request contract documents status queries and does not list a webhook or callback field for these routes. Check the current authenticated OpenAPI contract before making a callback part of your integration.

Query task results ↗Check the current contract ↗

Explore more APIs on VidMage

  • Midjourney Image API↗
  • Qwen Image API↗
  • GPT Image API↗
  • Nano Banana API↗
  • Wan Image API↗
  • Grok Image API↗
  • Z-Image API↗
  • AI Object Remover API for Masked Image Cleanup↗