Comprehensive documentation for all Yemaya API endpoints organized by category.
Endpoint Categories#
Core Platform#
| Documentation | Description |
|---|---|
| Authentication | Login, registration, OAuth, sessions, API keys |
| Projects | Project management, members, comments |
| Assets | Asset library, folders, versioning |
| Organizations | Organization management |
Content Generation#
| Documentation | Description |
|---|---|
| 3D Generation | Text-to-3D, image-to-3D, mesh processing, texturing, rigging |
| Audio | Music generation, voice synthesis, sound effects, DAW integration |
| Video | Video editing, effects, virtual production |
Game Development#
| Documentation | Description |
|---|---|
| Gameplay | Combat, physics, inventory, quests, dialogue, economy |
| NPC | AI-powered characters, conversations, memory, behavior |
| Creative Tools | Blender, Unreal, Godot, Houdini integration |
Real-Time & Collaboration#
| Documentation | Description |
|---|---|
| WebSocket | Real-time events, progress tracking, collaboration |
| Collaboration | Comments, reviews, real-time editing |
Infrastructure#
Quick Reference#
Authentication#
All endpoints (except health checks) require authentication via:
http
Authorization: Bearer <jwt_token>
Or:
http
X-API-Key: <api_key>
Base URLs#
| Environment | URL |
|---|---|
| Production | https://api.yemaya.io/v1 |
| Staging | https://api.staging.yemaya.io/v1 |
| Development | http://localhost:3000/v1 |
Response Format#
Success:
json
{
"success": true,
"data": { ... }
}
Error:
json
{
"success": false,
"error": {
"code": "ERROR_CODE",
"message": "Human readable message",
"details": { ... }
}
}
Pagination#
http
GET /endpoint?page=1&limit=20
Response includes metadata:
json
{
"data": [...],
"meta": {
"page": 1,
"limit": 20,
"total": 100,
"totalPages": 5,
"hasMore": true
}
}
Rate Limits#
| Type | Limit |
|---|---|
| Authenticated | 1000/minute |
| Unauthenticated | 60/minute |
| Generation endpoints | 10-30/minute |
| WebSocket subscriptions | 100/connection |
Interactive Documentation#
- Swagger UI:
/docs - Scalar Reference:
/reference - API Playground:
/playground - OpenAPI Spec:
/openapi.json
SDKs#
| Language | Package |
|---|---|
| TypeScript | @yemaya/sdk |
| Python | yemaya |
| C++ | yemaya-cpp |
See SDK Documentation for usage examples.