API operational59 capabilities

Beta

The Developer APIs are still in beta and may change at any time. At this stage, they are better suited to personal testing and experimentation and are not yet recommended for production use.

Playground

Text to 3D

Generate downloadable 3D models from text prompts.

POST /api/v1/ai-text-to-3d-model/submit → /query

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

View plans

Parameter

1 parameters

prompt*string

Required request parameter. Follow the type and accepted values shown in this table.

API keyThe API key is used only in this browser tab and is never saved to local storage or sent to another service.

Request code

#!/usr/bin/env bash
set -euo pipefail

SUBMIT_RESPONSE="$(curl --fail-with-body --silent --show-error -X POST "https://vidmage.ai/api/v1/ai-text-to-3d-model/submit" \
  -H "Authorization: Bearer ${VIDMAGE_API_KEY}" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "prompt": "A stylized low-poly camping lantern with a metal handle, glass chamber, and production-ready proportions"
}')"
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/ai-text-to-3d-model/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)
      printf '%s' "$QUERY_RESPONSE" | jq -r '(.result // .["modelUrl"] // .data["modelUrl"] // empty)'
      break
      ;;
    failed|error)
      printf '%s' "$QUERY_RESPONSE" | jq -r '(.message // .error // .data.error // "Task failed")' >&2
      exit 1
      ;;
  esac
  sleep 5
done

#!/usr/bin/env bash set -euo pipefail SUBMIT_RESPONSE="$(curl --fail-with-body --silent --show-error -X POST "https://vidmage.ai/api/v1/ai-text-to-3d-model/submit" \ -H "Authorization: Bearer ${VIDMAGE_API_KEY}" \ -H "Content-Type: application/json" \ --data-raw '{ "prompt": "A stylized low-poly camping lantern with a metal handle, glass chamber, and production-ready proportions" }')" 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/ai-text-to-3d-model/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) printf '%s' "$QUERY_RESPONSE" | jq -r '(.result // .["modelUrl"] // .data["modelUrl"] // empty)' break ;; failed|error) printf '%s' "$QUERY_RESPONSE" | jq -r '(.message // .error // .data.error // "Task failed")' >&2 exit 1 ;; esac sleep 5 done