# API Endpoints Reference

Comprehensive documentation for all Yemaya API endpoints organized by category.

## Endpoint Categories

### Core Platform

| Documentation                                           | Description                                    |
| ------------------------------------------------------- | ---------------------------------------------- |
| [Authentication](../README.md#authentication-endpoints) | Login, registration, OAuth, sessions, API keys |
| [Projects](../README.md#projects)                       | Project management, members, comments          |
| [Assets](../README.md#assets)                           | Asset library, folders, versioning             |
| [Organizations](../README.md#organizations)             | Organization management                        |

### Content Generation

| Documentation                       | Description                                                       |
| ----------------------------------- | ----------------------------------------------------------------- |
| [3D Generation](./3d-generation.md) | Text-to-3D, image-to-3D, mesh processing, texturing, rigging      |
| [Audio](./audio.md)                 | Music generation, voice synthesis, sound effects, DAW integration |
| [Video](./video.md)                 | Video editing, effects, virtual production                        |

### Game Development

| Documentation                         | Description                                            |
| ------------------------------------- | ------------------------------------------------------ |
| [Gameplay](./gameplay.md)             | Combat, physics, inventory, quests, dialogue, economy  |
| [NPC](./npc.md)                       | AI-powered characters, conversations, memory, behavior |
| [Creative Tools](./creative-tools.md) | Blender, Unreal, Godot, Houdini integration            |

### Real-Time & Collaboration

| Documentation                                  | Description                                        |
| ---------------------------------------------- | -------------------------------------------------- |
| [WebSocket](./websocket.md)                    | Real-time events, progress tracking, collaboration |
| [Collaboration](../README.md#project-comments) | Comments, reviews, real-time editing               |

### Infrastructure

| Documentation                        | Description              |
| ------------------------------------ | ------------------------ |
| [Webhooks](../README.md#webhooks)    | Event notifications      |
| [Health](../README.md#health-checks) | System health monitoring |

---

## 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](../README.md#sdk-examples) for usage examples.
