@alfe.ai/agent-api-client 0.13.0 → 0.15.0

package/README.md

@@ -1,6 +1,8 @@
 # @alfe.ai/agent-api-client
 
-Agent self-service API client — agents calling /agents/ endpoints
+Agent self-service API client for Alfe's agent-authenticated endpoints. It
+resolves identity from the bearer token, so callers never place their own
+`agentId` in a self-service path.
 
 Part of [**Alfe**](https://alfe.ai) — the operating system for AI agents: build, deploy, and run agents with persistent memory, identity, integrations, and channels. See the [documentation](https://docs.alfe.ai) to get started.
 
@@ -10,6 +12,26 @@ Part of [**Alfe**](https://alfe.ai) — the operating system for AI agents: buil
 npm install @alfe.ai/agent-api-client
 ```
 
+## Usage
+
+```ts
+import { AgentApiClient } from "@alfe.ai/agent-api-client";
+
+const client = new AgentApiClient({ apiKey, apiUrl });
+const manifest = await client.syncGetManifest();
+```
+
+Construct one client for the daemon/plugin lifetime and reuse it. JSON methods
+unwrap Alfe's `{ data }` response envelope and attach the HTTP status to thrown
+errors. Safe reads retry one transient failure; mutations do not retry unless a
+method has an explicit server-side idempotency contract. S3 presigned URLs and
+raw voice audio use their dedicated binary/direct-transfer paths.
+
+The flat `AgentApiClient` surface is assembled from domain modules for chat,
+Connect credentials, database, identity, integrations, knowledge, memory,
+mobile, search, secrets, sync/shared files, voice, webhooks, and workspace
+configuration.
+
 ## Links
 
 - 🌐 Website: <https://alfe.ai>