asteroid-odyssey 1.3.11 → 1.6.17

package/README.md

@@ -1,17 +1,44 @@
-# Agents SDK, TypeScript
+# Asteroid Odyssey TypeScript SDK
 
-The official TypeScript SDK for interacting with the Asteroid Agents API.
+TypeScript SDK for the Asteroid Agents API.
 
 ## Installation
 
 ```bash
 npm install asteroid-odyssey
+# or
+pnpm add asteroid-odyssey
 ```
 
 ## Usage
 
-Please head to our documentation at https://docs.asteroid.ai/sdk/typescript
+```typescript
+import { client, agentExecutePost, executionGet } from 'asteroid-odyssey';
 
-## License
+// Configure the client
+client.setConfig({
+  baseUrl: 'https://odyssey.asteroid.ai/agents/v2',
+  headers: {
+    'X-Asteroid-Agents-Api-Key': 'your-api-key',
+  },
+});
 
-The Asteroid Odyssey SDK is available under the MIT License.
+// Execute an agent
+const { data } = await agentExecutePost({
+  path: { agentId: 'your-agent-id' },
+  body: { dynamicData: { input: 'value' } },
+});
+
+console.log(`Execution ID: ${data?.executionId}`);
+
+// Get execution status
+const { data: execution } = await executionGet({
+  path: { executionId: data?.executionId },
+});
+
+console.log(`Status: ${execution?.status}`);
+```
+
+## Documentation
+
+See [docs.asteroid.ai](https://docs.asteroid.ai) for full documentation.