API documentation
Build a request, submit a task, and retrieve its result. Start with the shared guides, then use the reference for your chosen model or tool.
Choose your starting point
| You want to | Start here |
|---|---|
| Make a first REST request | Follow the API quickstart |
| Connect an AI client | Set up VidMage MCP |
| Send a file from your computer | Upload local media |
| Recover an unfinished request | Find and query an existing task |
| Understand a failed response | Use the error recovery guide |
One task, two requests
Generation runs asynchronously. Send the capability input to its /submit endpoint and save the returned task identifier. Use that ID and its documented field name at the matching /query endpoint to check progress and retrieve the output.
The API may change and is currently intended for testing and experimentation. Production use is not yet recommended. An active subscription is required, and API tasks share your website credit balance.
Set up authentication and review billing behavior before your first task.
Model and tool references
Browse the complete endpoint directory by output type. Each reference documents its own fields, modes and example body.
Check the enabled capability set
Use authenticated discovery for the capability set available to your account and deployment. The OpenAPI 3.1 document describes the request contract and can be imported into an API client.
curl --fail-with-body --silent --show-error \
-H "Authorization: Bearer ${VIDMAGE_API_KEY}" \
"https://vidmage.ai/api/v1/capabilities"
curl --fail-with-body --silent --show-error \
-H "Authorization: Bearer ${VIDMAGE_API_KEY}" \
"https://vidmage.ai/api/v1/openapi.json" \
--output vidmage-openapi.jsonShared integration guides
Contact us
If you have any questions about the API or need help with your integration, get in touch with our team.
[email protected]