@elizaos/api-client 1.0.12

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Shaw Walters and elizaOS Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,102 @@
+# @elizaos/api-client
+
+Type-safe API client for ElizaOS server.
+
+## Installation
+
+```bash
+bun add @elizaos/api-client
+```
+
+## Usage
+
+```typescript
+import { ElizaClient } from '@elizaos/api-client';
+
+// Create client instance
+const client = ElizaClient.create({
+  baseUrl: 'http://localhost:3000',
+  apiKey: 'your-api-key', // optional
+});
+
+// List all agents
+const { agents } = await client.agents.listAgents();
+
+// Create a new agent
+const agent = await client.agents.createAgent({
+  name: 'My Agent',
+  description: 'A helpful assistant',
+});
+
+// Send a message
+const message = await client.messaging.postMessage(channelId, 'Hello, world!');
+
+// Upload media
+const upload = await client.media.uploadAgentMedia(agentId, {
+  file: myFile,
+  filename: 'image.png',
+});
+```
+
+## API Domains
+
+### Agents
+
+- CRUD operations for agents
+- Agent lifecycle management (start/stop)
+- World management
+- Plugin panels and logs
+
+### Messaging
+
+- Message submission and management
+- Channel operations
+- Server management
+- Message search
+
+### Memory
+
+- Agent memory management
+- Room operations
+- World management
+
+### Audio
+
+- Speech processing
+- Text-to-speech
+- Audio transcription
+
+### Media
+
+- File uploads for agents and channels
+
+### Server
+
+- Health checks and status
+- Runtime debugging
+- Log management
+
+### System
+
+- Environment configuration
+
+## Error Handling
+
+```typescript
+import { ApiError } from '@elizaos/api-client';
+
+try {
+  await client.agents.getAgent(agentId);
+} catch (error) {
+  if (error instanceof ApiError) {
+    console.error(`Error ${error.code}: ${error.message}`);
+    if (error.details) {
+      console.error('Details:', error.details);
+    }
+  }
+}
+```
+
+## TypeScript Support
+
+This package is written in TypeScript and provides full type definitions for all API endpoints, request parameters, and responses.