Avaturn
    Avaturn
    • Create User
      POST
    • Delete User
      DELETE
    • New Session
      POST
    • List User Avatars
      GET
    • New Avatar
      POST
    • Get Customization
      GET
    • Set Customization
      PUT
    • Delete User Avatar
      DELETE
    • Render User Avatar Async
      POST
    • Create Export
      POST

      Render User Avatar Async

      开发环境
      http://dev-cn.your-api-server.com
      开发环境
      http://dev-cn.your-api-server.com
      POST
      /api/v1/renders/new
      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:
      1.
      You send a request to the /renders/new endpoint
      2.
      The endpoint creates a rendering task and responds with its id.
      3.
      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.
      请求示例请求示例
      Shell
      JavaScript
      Java
      Swift
      curl --location --request POST 'http://dev-cn.your-api-server.com/api/v1/renders/new?avatar_id&scene'
      响应示例响应示例
      200 - 示例 1
      {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "status": "pending",
          "render_url": "string"
      }

      请求参数

      Query 参数
      avatar_id
      string <uuid>
      Avatar Id
      必需
      ID of avatar to render
      scene
      string 
      Scene
      必需
      正则匹配:
      ^[a-zA-Z0-9_/]+$
      format
      enum<string> 
      Format
      可选
      Output image format. Use png or webp for transparency support. Default jpg.
      枚举值:
      jpgpngwebp
      默认值:
      jpg

      返回响应

      🟢200Successful Response
      application/json
      Body
      id
      string <uuid>
      Id
      必需
      status
      enum<string> 
      必需
      枚举值:
      pendingreadyfailed
      render_url
      Render Url
      必需
      Any of
      🟠422Validation Error
      修改于 2024-05-30 08:40:21
      上一页
      Delete User Avatar
      下一页
      Create Export
      Built with