Reference
Rendering & output
Check platform support, follow background jobs, and locate the finished video.
On this page
Check the rendering environmentValidate before startingFollow the render sessionRetrieve the outputIf a render failsCheck the rendering environment
Call get_capabilities on the machine running the MCP server before designing a project around globe rendering or hardware encoding. Local rendering support is narrower than Python package installation support.
- Published rendering wheels cover Apple silicon macOS, Windows x64, and Linux x86-64 / arm64.
- Linux needs a working system graphics driver or software rendering environment.
- Map assets require network access during rendering.
- Ask the server whether fallback rendering is available if local rendering is unsupported.
Validate before starting
Review the route, duration, map, vehicle, resolution, and framing. estimate_render gives an estimate without spending credits. Exporting the video requires premium access and one purchased credit. Call get_credit_balance and purchase credits if your balance is zero.
Follow the render session
Store the session ID returned by render_video. Use await_render to wait. If it returns timed_out, relay its progress message and call it again. A timeout while waiting is not automatically a failed job.
Retrieve the output
Use the completed result to obtain the actual video location. A local file path belongs to the server’s computer; it is not automatically a public download URL. Open it there or transfer it using your normal file-sharing workflow.
If a render fails
Read the full diagnostic before retrying. One credit is consumed when the render service prepares the video, even if rendering later fails on your computer. Every export costs one credit, including re-rendering the same video. Resolve the reported settings, account, network, or graphics error before retrying.
