Ready Player Me Avatars API — Lifecycle

naftiko: 1.0.0-alpha2
info:
  label: Ready Player Me Avatars API — Lifecycle
  description: Ready Player Me Avatars API lifecycle operations. Self-contained Naftiko capability covering
    avatar creation from scratch and from templates, retrieval, asset updates, saving drafts, deleting drafts
    and avatars, and warming the render cache.
  tags:
  - Ready Player Me
  - Avatars
  - Lifecycle
  created: '2026-05-25'
  modified: '2026-05-25'
binds:
- namespace: env
  keys:
    RPM_APP_ID: RPM_APP_ID
capability:
  consumes:
  - type: http
    namespace: avatars-lifecycle
    baseUri: https://api.readyplayer.me
    description: Ready Player Me Avatars API lifecycle business capability.
    headers:
      X-APP-ID: ${env.RPM_APP_ID}
    resources:
    - name: avatars
      path: /v2/avatars
      operations:
      - name: createavatar
        method: POST
        description: Create a draft avatar.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          required: true
    - name: avatar-templates
      path: /v2/avatars/templates
      operations:
      - name: listavatartemplates
        method: GET
        description: List available avatar templates.
        outputRawFormat: json
    - name: avatar-template
      path: /v2/avatars/templates/{templateId}
      operations:
      - name: createavatarfromtemplate
        method: POST
        description: Create an avatar from a template.
        inputParameters:
        - name: templateId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          required: true
    - name: avatar
      path: /v2/avatars/{avatarId}
      operations:
      - name: getavatarmetadata
        method: GET
        description: Get avatar metadata.
        inputParameters:
        - name: avatarId
          in: path
          type: string
          required: true
      - name: updateavatar
        method: PATCH
        description: Update equipped assets on an avatar.
        inputParameters:
        - name: avatarId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          required: true
      - name: saveavatar
        method: PUT
        description: Save a draft avatar as a permanent avatar.
        inputParameters:
        - name: avatarId
          in: path
          type: string
          required: true
      - name: deleteavatar
        method: DELETE
        description: Delete an avatar.
        inputParameters:
        - name: avatarId
          in: path
          type: string
          required: true
    - name: avatar-draft
      path: /v2/avatars/{avatarId}/draft
      operations:
      - name: deleteavatardraft
        method: DELETE
        description: Discard an avatar draft.
        inputParameters:
        - name: avatarId
          in: path
          type: string
          required: true
    - name: avatar-precompile
      path: /v2/avatars/{avatarId}/precompile
      operations:
      - name: precompileavatar
        method: POST
        description: Warm the render cache for an avatar parameter combination.
        inputParameters:
        - name: avatarId
          in: path
          type: string
          required: true