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/AI Text to Music API for Musical Briefs

AI Text to Music API for Musical Briefs

Integrate music generation into your app using a text description. Supply an optional title, set the instrumental flag, and retrieve the generated track as an audio URL.

Get API keyView API docs
Abstract illustration for AI Text to Music API for Musical Briefs
PlaygroundAPIPricingGuideFAQs

AI Text to Music 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

3 parameters

Describe the music style / mood / scene in plain text (1-400 chars).

Song title (0-80 chars). Auto-generated if empty.(Optional)

Generate instrumental music without vocals.(Optional)

Default: false

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/text-to-music/submit" \
  -H "Authorization: Bearer ${VIDMAGE_API_KEY}" \
  -H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "description": "ambient electronic music for a calm evening",
  "makeInstrumental": false
}')"
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/text-to-music/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 // .["audioUrl"] // .data["audioUrl"] // 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
description
Output
Audio·audioUrl
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.

Text to Music

Requireddescription
Request controls
  • description: see parameter rules
  • title: see parameter rules
  • makeInstrumental: default false

Output dimensions and format are not specified in this reference.

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

Text to Music

POST /api/v1/text-to-music/submit

Full API documentation ↗

description is required.

Required inputs

descriptionstring
Describe the music style / mood / scene in plain text (1-400 chars).

Edit the sample inputs for your own task before submitting.

Text to Music 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/text-to-music/submit" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
  -H "Content-Type: application/json" \
  -d '{"description":"ambient electronic music for a calm evening","makeInstrumental":false}'
# -> { "success": true, "taskId": "...", "creditsConsumed": ... }
Parameters and input rules3 fields
FieldTypeRequiredDefaultMeaning and limits
descriptionstringYesNot specifiedDescribe the music style / mood / scene in plain text (1-400 chars). Minimum length: 1 · Maximum length: 400
titlestringNoNot specifiedSong title (0-80 chars). Auto-generated if empty. Maximum length: 80
makeInstrumentalbooleanNofalseGenerate instrumental music without vocals. Default: false

Retrieve the result

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

POST /api/v1/text-to-music/query

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

Task states and recovery ↗
Text to Music query
curl -X POST "https://vidmage.ai/api/v1/text-to-music/query" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "taskId": "TASK_ID_FROM_SUBMIT" }'
# -> { "success": true, "data": { "status": "...", "audioUrl": "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)
Text to Musicaudio API1 generation request: 50 credits
How this is calculated
  • Per request: 50 credits / request

A fixed credit charge applies to this API request.

Estimate your own request ↗
50 credits / requestSee 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 AI Text to Music API

VidMage's AI Text to Music API is a music generation interface that creates audio from a written brief. It accepts a description of the intended sound, with an optional title and an instrumental setting. The resulting track can be reviewed for use in videos, presentations, or music development. To try this API in your browser, open the API Playground.

AI Text to Music API capabilities

Music from a description
Describe the mood, instrumentation, energy, and intended placement of the music in the required description field.
Instrumental requests
Set the optional makeInstrumental boolean to request an instrumental track for the musical brief your application supplies.
Track naming and output
Add an optional title and retrieve the generated audio to compare with the brief or intended scene.

What you can build

Mood music for short dramas

Quiet tension before a reveal calls for a different score than a reunion scene. Describe the mood and instruments, request an instrumental track, and audition it against the dialogue. Trimming and mixing happen in your episode editor.

Product launch soundtracks

Electronic percussion and a bright synth melody could set the pace for a product reveal. Turn that musical brief into a soundtrack candidate to edit against the campaign footage.

Podcast theme exploration

A food podcast might open with playful acoustic music, while a history show could call for a more restrained theme. Describe that musical direction and choose instrumental output to explore tracks from which an audio editor can cut an intro.

How to use AI Text to Music 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 audioUrl from the completed task. Preview the result in your app and save a copy to your own storage for later use.

Input tips
Write a focused musical brief
Keep description within 1 to 400 characters and an optional title within 80. Describe mood and instrumentation without treating them as exact structured controls. There is no dedicated lyrics field.
Request instrumental audio explicitly
Send makeInstrumental as the boolean true for an instrumental request. Review the resulting track in context; the contract does not expose duration, BPM, or stem controls.

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/text-to-music/query
Completed result
audioUrl
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

  • AI Voice Design API for Described Speech↗
  • AI Voice Clone API for Reference-Based Speech↗
  • Seedance 2.5 API↗
  • AI Video Extender API for Clip Continuations↗
  • Seedance API↗
  • AI Video Generation API for Text and Images↗
  • AI Subtitle Generator API for Video Captions↗
  • AI Lip Sync API for Photos and Videos↗