API Documentation

Base URL

The base URL is automatically detected from your current domain. Works seamlessly on Vercel and other hosting platforms.

Getting Started

The AvatarKit API provides endpoints for generating random avatars. All endpoints are prefixed with /api.

The API uses meaningful configuration names instead of indices. For example, instead of base: 4, you'll see skinTone: "neutral". This makes the API more intuitive and easier to use.

Start by exploring the endpoints in the sidebar to learn how to generate single or multiple random avatars.

Error Handling

All endpoints return appropriate HTTP status codes:

• 200 - Success
• 400 - Bad Request (invalid parameters)
• 404 - Not Found (avatar doesn't exist)
• 500 - Internal Server Error