@aui.io/aui-client 3.1.2 → 3.2.0

package/reference.md

@@ -3,6 +3,20 @@
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Liveness probe. Returns ``{"status": "ok"}`` when the service is up.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -42,10 +56,24 @@ await client.health();
 
 ## 
 ## Agents
-<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">listAgents</a>(projectId, { ...params }) -> Apollo.ExternalPageExternalAgent</code></summary>
+<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">listAgents</a>(projectId, { ...params }) -> Apollo.PageAgent</code></summary>
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+List the project's agents, optionally filtered by name.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -101,10 +129,25 @@ await client.agents.listAgents("projectId", {
 </dl>
 </details>
 
-<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">createAgent</a>(projectId, { ...params }) -> Apollo.ExternalAgentCreateResponse</code></summary>
+<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">createAgent</a>(projectId, { ...params }) -> Apollo.AgentCreateResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
 <dl>
 <dd>
 
+<dl>
+<dd>
+
+Create an agent in the project. New agents start without a live version
+— create and publish a version to make the agent answer.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -140,7 +183,7 @@ await client.agents.createAgent("projectId", {
 <dl>
 <dd>
 
-**request:** `Apollo.ExternalAgentCreateRequest` 
+**request:** `Apollo.AgentCreateRequest` 
     
 </dd>
 </dl>
@@ -160,10 +203,24 @@ await client.agents.createAgent("projectId", {
 </dl>
 </details>
 
-<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">getAgent</a>(agentId) -> Apollo.ExternalAgent</code></summary>
+<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">getAgent</a>(agentId) -> Apollo.Agent</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
 <dl>
 <dd>
 
+Fetch one agent, including which version is currently live.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -213,6 +270,20 @@ await client.agents.getAgent("agentId");
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Delete an agent and all of its versions. This cannot be undone.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -258,10 +329,25 @@ await client.agents.deleteAgent("agentId");
 </dl>
 </details>
 
-<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">updateAgent</a>(agentId, { ...params }) -> Apollo.ExternalAgentUpdateResponse</code></summary>
+<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">updateAgent</a>(agentId, { ...params }) -> Apollo.AgentUpdateResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
 <dl>
 <dd>
 
+<dl>
+<dd>
+
+Rename an agent. To change which version is live, publish a version
+instead.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -295,7 +381,7 @@ await client.agents.updateAgent("agentId");
 <dl>
 <dd>
 
-**request:** `Apollo.ExternalAgentUpdateRequest` 
+**request:** `Apollo.AgentUpdateRequest` 
     
 </dd>
 </dl>
@@ -319,6 +405,20 @@ await client.agents.updateAgent("agentId");
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Usage metrics for one agent, optionally bounded by a date range.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -376,10 +476,25 @@ await client.agents.getAgentUsage("agentId", {
 </details>
 
 ## AgentVersions
-<details><summary><code>client.agentVersions.<a href="/src/api/resources/agentVersions/client/Client.ts">listVersions</a>(agentId, { ...params }) -> Apollo.ExternalPageAgentVersion</code></summary>
+<details><summary><code>client.agentVersions.<a href="/src/api/resources/agentVersions/client/Client.ts">listVersions</a>(agentId, { ...params }) -> Apollo.PageAgentVersion</code></summary>
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+List an agent's versions, newest first. Filter by status, tag, label,
+or version number; set ``exclude_revisions`` to see only base versions.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -439,6 +554,22 @@ await client.agentVersions.listVersions("agentId", {
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Create a new draft version — empty, from a template, or cloned from an
+existing version (``source`` selects which). Drafts stay editable until
+published.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -498,6 +629,21 @@ await client.agentVersions.createVersion("agentId", {
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Update a version's metadata: label, tags, and notes. The configuration
+itself changes through push, never here.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -563,6 +709,22 @@ await client.agentVersions.updateVersion("agentId", "versionId");
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Make this version the agent's live version. Publishing a draft freezes
+it first; publishing an already-published version re-activates it — the
+same call handles shipping, switching, and rolling back.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -620,6 +782,21 @@ await client.agentVersions.publishVersion("agentId", "versionId");
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Archive a version to retire it from everyday use. The agent's live
+version can't be archived — publish another version first.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -677,6 +854,21 @@ await client.agentVersions.archiveVersion("agentId", "versionId");
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Upload a configuration bundle to a version, committing a new revision.
+The response carries the new revision's tag and content digest.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -747,6 +939,21 @@ await client.agentVersions.pushVersion("agentId", "versionId", {
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Download a version's configuration bundle — the current revision, or a
+specific one via ``version_tag``.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -811,10 +1018,24 @@ await client.agentVersions.pullVersion("agentId", "versionId", {
 </details>
 
 ## Projects
-<details><summary><code>client.projects.<a href="/src/api/resources/projects/client/Client.ts">listProjects</a>({ ...params }) -> Apollo.ExternalPageProject</code></summary>
+<details><summary><code>client.projects.<a href="/src/api/resources/projects/client/Client.ts">listProjects</a>({ ...params }) -> Apollo.PageProject</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
 <dl>
 <dd>
 
+List your organization's projects.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -870,6 +1091,20 @@ await client.projects.listProjects({
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Create a project in your organization. Projects group agents.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -921,6 +1156,20 @@ await client.projects.createProject({
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Fetch one project.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -970,6 +1219,20 @@ await client.projects.getProject("projectId");
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Delete a project. It disappears from listings immediately.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -1019,6 +1282,21 @@ await client.projects.deleteProject("projectId");
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Usage metrics aggregated across every agent in the project, optionally
+bounded by a date range.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -1076,10 +1354,26 @@ await client.projects.getProjectUsage("projectId", {
 </details>
 
 ## Threads
-<details><summary><code>client.threads.<a href="/src/api/resources/threads/client/Client.ts">listThreads</a>({ ...params }) -> Apollo.ExternalPageThreadListItem</code></summary>
+<details><summary><code>client.threads.<a href="/src/api/resources/threads/client/Client.ts">listThreads</a>({ ...params }) -> Apollo.PageThreadListItem</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
 <dl>
 <dd>
 
+List your organization's conversation threads, newest first. Repeatable
+filters (``tool``, ``rule``, ``param``, ``created``) OR within a field and
+AND across fields.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -1131,6 +1425,20 @@ await client.threads.listThreads({
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Fetch one thread's details — title, participants, and status.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -1172,6 +1480,78 @@ await client.threads.getThread("threadId");
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.threads.<a href="/src/api/resources/threads/client/Client.ts">updateThread</a>(threadId, { ...params }) -> Apollo.Thread</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Partial update — only ``title`` is updatable for now. Omitted fields are
+left unchanged; the full updated thread is returned.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.threads.updateThread("threadId");
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**threadId:** `string` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Apollo.UpdateThreadRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Threads.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -1180,6 +1560,21 @@ await client.threads.getThread("threadId");
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+The reasoning trace of every interaction in the thread — what the agent
+understood, which rules fired, and the decisions it took.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -1229,6 +1624,20 @@ await client.threads.getThreadTrace("threadId");
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+The reasoning trace of a single interaction, resolved by its id.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -1278,6 +1687,20 @@ await client.threads.getInteractionTrace("interactionId");
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+The thread's full transcript, in chronological order.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -1354,7 +1777,6 @@ returned in the body.
 
 ```typescript
 await client.messaging.sendMessage({
-    agent_id: "agent_id",
     text: "text",
     user_id: "user_id"
 });
@@ -1405,11 +1827,11 @@ await client.messaging.sendMessage({
 <dl>
 <dd>
 
-Send a message and stream tokens over Server-Sent Events. Auto-creates the
-thread when ``thread_id`` is omitted — the resolved id arrives as the first
-``thread`` event (an SSE client can't read response headers). Resume a dropped
-stream with the standard ``Last-Event-ID`` header: buffered frames replay, no
-fresh turn. FastAPI owns the wire format, keep-alive pings, and OpenAPI docs.
+Send a message and stream the reply token-by-token over Server-Sent
+Events. The thread is created automatically when ``thread_id`` is omitted —
+the resolved id arrives as the first ``thread`` event. Resume a dropped
+stream with the standard ``Last-Event-ID`` header: missed events replay
+without running the turn again.
 </dd>
 </dl>
 </dd>
@@ -1427,7 +1849,6 @@ fresh turn. FastAPI owns the wire format, keep-alive pings, and OpenAPI docs.
 const response = await client.messaging.streamMessage({
     "Last-Event-ID": "Last-Event-ID",
     body: {
-        agent_id: "agent_id",
         text: "text",
         user_id: "user_id"
     }
@@ -1482,10 +1903,9 @@ for await (const item of response) {
 <dl>
 <dd>
 
-Regenerate ``interaction_id`` on the thread against the live version, then
-replay ``text`` onto the clone. The acting user is optional — absent for the
-agent-scoped publishable-key flow, where IA attributes the thread's own user.
-``thread_id`` in the response is the clone's id, not the original.
+Regenerate ``interaction_id`` on the thread against the agent's live
+version, then replay ``text`` onto the resulting new thread. The response's
+``thread_id`` is the new thread's id, not the original.
 </dd>
 </dl>
 </dd>
@@ -1501,7 +1921,6 @@ agent-scoped publishable-key flow, where IA attributes the thread's own user.
 
 ```typescript
 await client.messaging.rerun("threadId", {
-    agent_id: "agent_id",
     interaction_id: "interaction_id",
     text: "text"
 });
@@ -1560,7 +1979,7 @@ await client.messaging.rerun("threadId", {
 <dl>
 <dd>
 
-The thread transcript, scoped to the key's agent.
+The thread's full transcript, in chronological order.
 </dd>
 </dl>
 </dd>
@@ -1686,7 +2105,7 @@ await client.messaging.threadTrace("threadId");
 <dl>
 <dd>
 
-One interaction's trace, resolved directly by interaction id.
+The reasoning trace of a single interaction, resolved by its id.
 </dd>
 </dl>
 </dd>
@@ -1733,6 +2152,126 @@ await client.messaging.interactionTrace("interactionId");
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.messaging.<a href="/src/api/resources/messaging/client/Client.ts">generateFollowupSuggestions</a>({ ...params }) -> Apollo.GenerateFollowupSuggestionsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Generate suggested follow-up prompts from a context you provide —
+useful for offering the end user quick next questions.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.messaging.generateFollowupSuggestions();
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Apollo.GenerateFollowupSuggestionsRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Messaging.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.messaging.<a href="/src/api/resources/messaging/client/Client.ts">getWelcomeMessage</a>() -> Apollo.AgentVersionWelcomeMessageResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+The welcome message of the agent's live version — what to show before
+the first user message.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.messaging.getWelcomeMessage();
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `Messaging.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -1750,9 +2289,10 @@ await client.messaging.interactionTrace("interactionId");
 <dl>
 <dd>
 
-Send the opener on ``channel`` and bind the recipient's phone to a thread.
-Omit ``thread_id`` to start a new thread (its id is returned); pass it to
-continue an existing one. Template fields apply to WhatsApp only.
+Send the opening message on ``channel`` and bind the recipient's phone
+number to a conversation thread. The agent is identified by your access
+token. Omit ``thread_id`` to start a new thread (its id is returned); pass
+it to continue an existing one. Template fields apply to WhatsApp only.
 </dd>
 </dl>
 </dd>
@@ -1768,8 +2308,7 @@ continue an existing one. Template fields apply to WhatsApp only.
 
 ```typescript
 await client.channels.initiateThread("channel", {
-    phone_number: "phone_number",
-    agent_id: "agent_id"
+    phone_number: "phone_number"
 });
 
 ```
@@ -1827,7 +2366,7 @@ await client.channels.initiateThread("channel", {
 <dl>
 <dd>
 
-Exchange a credential for a short-lived access token. Supported grant types: `publishable_key`. Refresh and other grants will be added on the same endpoint.
+Exchange a credential for a short-lived access token (OAuth 2.0, RFC 6749). Supported grant types: `publishable_key`. Refresh and other grants will be added on the same endpoint.
 </dd>
 </dl>
 </dd>