Render User Avatar Async
Renders a scene with specified avatar.
By default, use scene common/preview. Other available scenes can be found in render docs. Contact avaturn support for detailed instructions how to provide your own scenes.
The endpoint works the following way:
- You send a request to the /renders/new endpoint
- The endpoint creates a rendering task and responds with its id.
- After rendering is completed, avaturn sends a render.ready webhook, which contains a task ID and a link to the rendering result.
NOTE: Behavior of this endpoint for avatars created by direct photo upload and not yet opened via browser UNDEFINED and can be changed in the future. Set customization via corresponding endpoint to get predictable behaviour.
post/api/v1/renders/new
Request
- Base URL: https://api.avaturn.me
- URL: https://api.avaturn.me/api/v1/renders/new
- Auth: HTTP bearer
Query parameters
avatar_idstring uuid required
ID of avatar to render
scenestring required
format'jpg' | 'png' | 'webp'
Output image format. Use png or webp for transparency support. Default jpg.
Response
Successful Response
Changes
No recorded changes to this operation across all 1 revision of this API.