Estimate the credits a generation will cost before submitting, using the same formula as the actual charge. Omit resolution to price the model default.
Beta: available to allowlisted API keys; standard per-key rate limits apply.
Headers
X-API-KeystringrequiredYour VisionStory API key (sk-vs-...), kept server-side. Create or manage keys in API keys (Pro plan and up).
Query parameters
model_idstringrequiredModel to price for. Use an id from GET /api/v1/ai_video/models, e.g. seedance-2.0.
duration_secintegerrequiredClip length in seconds to price. Must be an allowed value for the model (see GET /api/v1/ai_video/models).
resolutionstring | nullOutput resolution to price, e.g. 720p / 1080p. Allowed values vary by model; omit to use the model default.
generate_audioboolean | nullWhether the estimate should include a native audio track. Omit to use the model default.
Responses
200Successful Response
application/json
dataAiVideoCostResponse | nullrequirednullableThe endpoint payload. Its shape is specific to each endpoint (see that endpoint's response schema); null for operations that return no body, such as delete.
creditintegerrequiredEstimated credits the generation will cost with the given parameters. Uses the same formula as the actual charge.
messagestringHuman-readable status message; "success" on a successful call.
server_timestring · date-timerequiredServer-side timestamp when the response was produced, in ISO 8601 format (UTC).
defaultError response. All failures share one envelope: an error object with a numeric code, a human-readable message, an optional details string, and an optional hint giving an actionable next step (useful for AI agents).
application/json
errorErrorDetailrequiredcodeintegerrequiredMachine-readable error code. Mirrors the HTTP status for transport-level failures (e.g. 401, 404, 422, 500) and may carry a business-specific code otherwise.
detailsstring | nullnullableOptional structured detail about the failure, e.g. a JSON string of per-field validation errors on a 422. Absent when there is nothing extra to report.
hintstring | nullnullableActionable next step for resolving the error, written for both humans and AI agents (e.g. how to fix the request, or where to obtain an API key). May be absent.
messagestringrequiredHuman-readable explanation of what went wrong. Safe to log or surface to end users; not localized.