Playground
Sora 2 AI Video Generator
Available through the REST API and MCP. Review the request parameters and accepted values below.
POST /api/v1/sora-2-ai-video-generator/submit → /queryAPI access is available to subscribers only. Your subscription credits are shared across the website and the API.
View plansParameter
5 parametersRequired request parameter. Follow the type and accepted values shown in this table.
Optional request parameter. Follow the type, default, and accepted values shown in this table.(Optional)
Optional request parameter. Follow the type, default, and accepted values shown in this table.(Optional)
Default: 10
Optional request parameter. Follow the type, default, and accepted values shown in this table.(Optional)
Default: 9:16
Optional request parameter. Follow the type, default, and accepted values shown in this table.(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/sora-2-ai-video-generator/submit" \
-H "Authorization: Bearer ${VIDMAGE_API_KEY}" \
-H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
-H "Content-Type: application/json" \
--data-raw '{
"prompt": "An astronaut explores a greenhouse on Mars while dust moves softly outside the glass walls",
"duration": "10",
"aspectRatio": "9:16",
"storyboard": 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/sora-2-ai-video-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 // .["videoUrl"] // .data["videoUrl"] // 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