Avatar API

📋 Table of Contents

Overview

The Avatar API provides comprehensive avatar management services for the OASIS ecosystem. It handles avatar creation, customization, management, and analytics with support for multiple avatar types, real-time updates, and advanced security features.

Avatar Management

Get All Avatars

GET /api/avatar
Authorization: Bearer YOUR_TOKEN

Query Parameters:

  • limit (int, optional): Number of results (default: 50)

  • offset (int, optional): Number to skip (default: 0)

  • type (string, optional): Filter by type (Human, Animal, Robot, Fantasy)

  • status (string, optional): Filter by status (Active, Inactive, Archived, Deleted)

  • category (string, optional): Filter by category (Gaming, Social, Professional, Creative)

  • sortBy (string, optional): Sort field (name, createdAt, lastModified, popularity)

  • sortOrder (string, optional): Sort order (asc/desc, default: desc)

Response:

Get Avatar by ID

Parameters:

  • avatarId (string): Avatar UUID

Response:

Create Avatar

Request Body:

Response:

Update Avatar

Parameters:

  • avatarId (string): Avatar UUID

Request Body:

Delete Avatar

Parameters:

  • avatarId (string): Avatar UUID

Avatar Operations

Customize Avatar

Parameters:

  • avatarId (string): Avatar UUID

Request Body:

Response:

Change Avatar Appearance

Parameters:

  • avatarId (string): Avatar UUID

Request Body:

Get Avatar Outfits

Parameters:

  • avatarId (string): Avatar UUID

Response:

Save Avatar Outfit

Parameters:

  • avatarId (string): Avatar UUID

Request Body:

Get Avatar History

Parameters:

  • avatarId (string): Avatar UUID

Query Parameters:

  • limit (int, optional): Number of results (default: 50)

  • offset (int, optional): Number to skip (default: 0)

  • type (string, optional): Filter by type (Created, Updated, Customized, Outfit)

  • startDate (string, optional): Start date (ISO 8601)

  • endDate (string, optional): End date (ISO 8601)

Response:

Avatar Analytics

Get Avatar Statistics

Query Parameters:

  • timeframe (string, optional): Timeframe (hour, day, week, month)

  • type (string, optional): Filter by avatar type

Response:

Get Avatar Performance

Response:

Get Avatar Health

Response:

Avatar Security

Get Avatar Security

Parameters:

  • avatarId (string): Avatar UUID

Response:

Update Avatar Security

Parameters:

  • avatarId (string): Avatar UUID

Request Body:

Error Responses

Avatar Not Found

Invalid Avatar Type

Customization Failed

Outfit Not Found

Permission Denied


← Previous: ONET API | Next: Missions APIarrow-up-right

Last updated