@athenaintel/sdk 4.3.2165 → 4.3.2167

package/reference.md

@@ -1,5 +1,72 @@
 # Reference
 ## Aop
+<details><summary><code>client.aop.<a href="/src/api/resources/aop/client/Client.ts">getBatchStatus</a>({ ...params }) -> AthenaIntelligence.AopBatchStatusResponseOut</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Aggregate lifecycle status of every run launched under a batch handle from `POST /aop/execute-batch`: counts per canonical run status, an `is_complete` flag, and a cursor-paged list of runs. Poll this once per batch instead of `GET /threads/{thread_id}/status` per thread; fetch a run's messages from the thread status endpoint only once it is terminal. This read never loads transcripts.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.aop.getBatchStatus({
+    batch_id: "batch_0f4c3c3e-1c1a-4a3e-9a5f-0d3f1a2b3c4d",
+    status: "terminal",
+    limit: 200
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `AthenaIntelligence.GetBatchStatusAopRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AopClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.aop.<a href="/src/api/resources/aop/client/Client.ts">create</a>({ ...params }) -> AthenaIntelligence.AopCreateResponseOut</code></summary>
 <dl>
 <dd>
@@ -214,6 +281,86 @@ await client.aop.executeAsync({
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.aop.<a href="/src/api/resources/aop/client/Client.ts">executeBatch</a>({ ...params }) -> AthenaIntelligence.AopBatchExecuteResponseOut</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Start many Agent Operating Procedure (AOP) runs under one batch handle. Each run is queued exactly like `POST /aop/execute-async`; the response returns a `batch_id` so the caller polls `GET /aop/batches/{batch_id}` once per batch instead of once per thread. Pass the `batch_id` back to append more runs to the same batch. Runs are launched independently: a run that fails to launch is reported with an error and does not stop the others.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.aop.executeBatch({
+    asset_id: "asset_9249292-d118-42d3-95b4-00eccfe0754f",
+    run_budget: {
+        max_cost_usd: 30,
+        max_model_calls: 80
+    },
+    runs: [{
+            client_ref: "row-1",
+            user_inputs: {
+                "company": "Acme Corp"
+            }
+        }, {
+            client_ref: "row-2",
+            user_inputs: {
+                "company": "Globex"
+            }
+        }]
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `AthenaIntelligence.AopBatchExecuteRequestIn` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AopClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -3135,7 +3282,7 @@ await client.query.executeSnippet({
 <dl>
 <dd>
 
-Generate a short-lived JWT token for direct access to the semantic model's Cube REST API. Use this token to query /cubejs-api/v1/load and /cubejs-api/v1/meta directly. Token expires after 1 hour. The token carries only a credential-free, user/workspace/schema-scoped authorization grant — database credentials are NOT included and are resolved server-side by Cube via callback. Dataset-backed models must use the authenticated query endpoint instead so source Dataset permissions are checked per query.
+Generate a short-lived JWT token for direct access to the semantic model's Cube REST API. Use this token to query /cubejs-api/v1/load and /cubejs-api/v1/meta directly. Token expires after 1 hour. The token carries only a credential-free, user/workspace/schema-scoped authorization grant — database credentials are NOT included and are resolved server-side by Cube via callback. Lakehouse-backed models must use the authenticated query endpoint instead so namespace permissions are checked per query.
 </dd>
 </dl>
 </dd>