@athenaintel/sdk 4.3.2166 → 4.3.2168

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (75) hide show
  1. package/README.md +1 -1
  2. package/dist/cjs/BaseClient.js +2 -2
  3. package/dist/cjs/api/resources/aop/client/Client.d.ts +65 -8
  4. package/dist/cjs/api/resources/aop/client/Client.js +213 -11
  5. package/dist/cjs/api/resources/aop/client/requests/AopBatchExecuteRequestIn.d.ts +34 -0
  6. package/dist/cjs/api/resources/aop/client/requests/AopBatchExecuteRequestIn.js +3 -0
  7. package/dist/cjs/api/resources/aop/client/requests/ExecuteAsyncAopRequest.d.ts +22 -0
  8. package/dist/cjs/api/resources/aop/client/requests/ExecuteAsyncAopRequest.js +3 -0
  9. package/dist/cjs/api/resources/aop/client/requests/GetBatchStatusAopRequest.d.ts +18 -0
  10. package/dist/cjs/api/resources/aop/client/requests/GetBatchStatusAopRequest.js +3 -0
  11. package/dist/cjs/api/resources/aop/client/requests/index.d.ts +3 -0
  12. package/dist/cjs/api/resources/threads/client/Client.d.ts +17 -0
  13. package/dist/cjs/api/resources/threads/client/Client.js +81 -0
  14. package/dist/cjs/api/resources/threads/client/requests/ThreadStatusBatchRequestIn.d.ts +10 -0
  15. package/dist/cjs/api/resources/threads/client/requests/ThreadStatusBatchRequestIn.js +3 -0
  16. package/dist/cjs/api/resources/threads/client/requests/index.d.ts +1 -0
  17. package/dist/cjs/api/types/AopAsyncExecuteResponseOut.d.ts +2 -0
  18. package/dist/cjs/api/types/AopBatchExecuteResponseOut.d.ts +16 -0
  19. package/dist/cjs/api/types/AopBatchExecuteResponseOut.js +3 -0
  20. package/dist/cjs/api/types/AopBatchRunIn.d.ts +13 -0
  21. package/dist/cjs/api/types/AopBatchRunIn.js +3 -0
  22. package/dist/cjs/api/types/AopBatchRunLaunchOut.d.ts +17 -0
  23. package/dist/cjs/api/types/AopBatchRunLaunchOut.js +3 -0
  24. package/dist/cjs/api/types/AopBatchRunStatusOut.d.ts +21 -0
  25. package/dist/cjs/api/types/AopBatchRunStatusOut.js +3 -0
  26. package/dist/cjs/api/types/AopBatchStatusCountsOut.d.ts +12 -0
  27. package/dist/cjs/api/types/AopBatchStatusCountsOut.js +3 -0
  28. package/dist/cjs/api/types/AopBatchStatusResponseOut.d.ts +20 -0
  29. package/dist/cjs/api/types/AopBatchStatusResponseOut.js +3 -0
  30. package/dist/cjs/api/types/ThreadStatusBatchItemOut.d.ts +27 -0
  31. package/dist/cjs/api/types/ThreadStatusBatchItemOut.js +3 -0
  32. package/dist/cjs/api/types/ThreadStatusBatchResponseOut.d.ts +20 -0
  33. package/dist/cjs/api/types/ThreadStatusBatchResponseOut.js +3 -0
  34. package/dist/cjs/api/types/index.d.ts +8 -0
  35. package/dist/cjs/api/types/index.js +8 -0
  36. package/dist/cjs/version.d.ts +1 -1
  37. package/dist/cjs/version.js +1 -1
  38. package/dist/esm/BaseClient.mjs +2 -2
  39. package/dist/esm/api/resources/aop/client/Client.d.mts +65 -8
  40. package/dist/esm/api/resources/aop/client/Client.mjs +214 -12
  41. package/dist/esm/api/resources/aop/client/requests/AopBatchExecuteRequestIn.d.mts +34 -0
  42. package/dist/esm/api/resources/aop/client/requests/AopBatchExecuteRequestIn.mjs +2 -0
  43. package/dist/esm/api/resources/aop/client/requests/ExecuteAsyncAopRequest.d.mts +22 -0
  44. package/dist/esm/api/resources/aop/client/requests/ExecuteAsyncAopRequest.mjs +2 -0
  45. package/dist/esm/api/resources/aop/client/requests/GetBatchStatusAopRequest.d.mts +18 -0
  46. package/dist/esm/api/resources/aop/client/requests/GetBatchStatusAopRequest.mjs +2 -0
  47. package/dist/esm/api/resources/aop/client/requests/index.d.mts +3 -0
  48. package/dist/esm/api/resources/threads/client/Client.d.mts +17 -0
  49. package/dist/esm/api/resources/threads/client/Client.mjs +81 -0
  50. package/dist/esm/api/resources/threads/client/requests/ThreadStatusBatchRequestIn.d.mts +10 -0
  51. package/dist/esm/api/resources/threads/client/requests/ThreadStatusBatchRequestIn.mjs +2 -0
  52. package/dist/esm/api/resources/threads/client/requests/index.d.mts +1 -0
  53. package/dist/esm/api/types/AopAsyncExecuteResponseOut.d.mts +2 -0
  54. package/dist/esm/api/types/AopBatchExecuteResponseOut.d.mts +16 -0
  55. package/dist/esm/api/types/AopBatchExecuteResponseOut.mjs +2 -0
  56. package/dist/esm/api/types/AopBatchRunIn.d.mts +13 -0
  57. package/dist/esm/api/types/AopBatchRunIn.mjs +2 -0
  58. package/dist/esm/api/types/AopBatchRunLaunchOut.d.mts +17 -0
  59. package/dist/esm/api/types/AopBatchRunLaunchOut.mjs +2 -0
  60. package/dist/esm/api/types/AopBatchRunStatusOut.d.mts +21 -0
  61. package/dist/esm/api/types/AopBatchRunStatusOut.mjs +2 -0
  62. package/dist/esm/api/types/AopBatchStatusCountsOut.d.mts +12 -0
  63. package/dist/esm/api/types/AopBatchStatusCountsOut.mjs +2 -0
  64. package/dist/esm/api/types/AopBatchStatusResponseOut.d.mts +20 -0
  65. package/dist/esm/api/types/AopBatchStatusResponseOut.mjs +2 -0
  66. package/dist/esm/api/types/ThreadStatusBatchItemOut.d.mts +27 -0
  67. package/dist/esm/api/types/ThreadStatusBatchItemOut.mjs +2 -0
  68. package/dist/esm/api/types/ThreadStatusBatchResponseOut.d.mts +20 -0
  69. package/dist/esm/api/types/ThreadStatusBatchResponseOut.mjs +2 -0
  70. package/dist/esm/api/types/index.d.mts +8 -0
  71. package/dist/esm/api/types/index.mjs +8 -0
  72. package/dist/esm/version.d.mts +1 -1
  73. package/dist/esm/version.mjs +1 -1
  74. package/package.json +1 -1
  75. package/reference.md +220 -6
@@ -0,0 +1,20 @@
1
+ import type * as AthenaIntelligence from "../index.mjs";
2
+ /**
3
+ * Response model for the status of an execute-batch.
4
+ */
5
+ export interface AopBatchStatusResponseOut {
6
+ /** The batch handle that was checked */
7
+ batch_id: string;
8
+ /** Runs per canonical status */
9
+ counts: AthenaIntelligence.AopBatchStatusCountsOut;
10
+ /** True when every run in the batch has finished */
11
+ is_complete: boolean;
12
+ /** Opaque cursor for the next page of `runs`; null when this page is the last one. Pass it as `cursor` on the next call. */
13
+ next_cursor?: string | null;
14
+ /** One page of runs matching the `status` filter, ordered by cursor */
15
+ runs: AthenaIntelligence.AopBatchRunStatusOut[];
16
+ /** Runs that have finished (completed + failed + canceled) */
17
+ terminal: number;
18
+ /** Runs launched into the batch so far */
19
+ total: number;
20
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,27 @@
1
+ /**
2
+ * Lifecycle status of one thread (no messages).
3
+ */
4
+ export interface ThreadStatusBatchItemOut {
5
+ /** ID of the AOP asset the run executes */
6
+ aop_asset_id?: string | null;
7
+ /** Batch handle when the thread was launched via execute-batch */
8
+ batch_id?: string | null;
9
+ /** Caller-supplied correlation key from the launch request */
10
+ client_ref?: string | null;
11
+ /** ISO timestamp when the run reached a terminal state */
12
+ completed_at?: string | null;
13
+ /** When the run was queued */
14
+ created_at?: string | null;
15
+ /** Error message when the run failed */
16
+ error?: string | null;
17
+ /** True once the run is completed, failed or canceled */
18
+ is_terminal: boolean;
19
+ /** True once the run completed successfully and its result can be read from `GET /threads/{thread_id}/status` */
20
+ output_available: boolean;
21
+ /** Canonical run status: scheduled, queued, running, needs_input, completed, failed or canceled */
22
+ status: string;
23
+ /** Thread ID; use `GET /threads/{thread_id}/status` for the result */
24
+ thread_id: string;
25
+ /** When the thread's lifecycle state last changed */
26
+ updated_at?: string | null;
27
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,20 @@
1
+ import type * as AthenaIntelligence from "../index.mjs";
2
+ /**
3
+ * Response model for the status of many threads.
4
+ */
5
+ export interface ThreadStatusBatchResponseOut {
6
+ /** Found threads per canonical status */
7
+ counts: AthenaIntelligence.AopBatchStatusCountsOut;
8
+ /** Requested threads that exist and belong to you */
9
+ found: number;
10
+ /** True when every found thread has finished */
11
+ is_complete: boolean;
12
+ /** Requested thread IDs that do not exist or are not yours; the two cases are indistinguishable */
13
+ not_found: string[];
14
+ /** Distinct thread IDs in the request */
15
+ requested: number;
16
+ /** Found threads that have finished (completed + failed + canceled) */
17
+ terminal: number;
18
+ /** One entry per found thread, in request order */
19
+ threads: AthenaIntelligence.ThreadStatusBatchItemOut[];
20
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -2,6 +2,12 @@ export * from "./ActivityClockRangeIn.mjs";
2
2
  export * from "./ActivityDeltaOut.mjs";
3
3
  export * from "./ActivityItemOut.mjs";
4
4
  export * from "./AopAsyncExecuteResponseOut.mjs";
5
+ export * from "./AopBatchExecuteResponseOut.mjs";
6
+ export * from "./AopBatchRunIn.mjs";
7
+ export * from "./AopBatchRunLaunchOut.mjs";
8
+ export * from "./AopBatchRunStatusOut.mjs";
9
+ export * from "./AopBatchStatusCountsOut.mjs";
10
+ export * from "./AopBatchStatusResponseOut.mjs";
5
11
  export * from "./AopConfigResponseOut.mjs";
6
12
  export * from "./AopConfigUpdateResponseOut.mjs";
7
13
  export * from "./AopCreateResponseOut.mjs";
@@ -119,6 +125,8 @@ export * from "./ThinkingContent.mjs";
119
125
  export * from "./ThreadBatchStopRequest.mjs";
120
126
  export * from "./ThreadBatchStopResponseOut.mjs";
121
127
  export * from "./ThreadBatchStopResultItem.mjs";
128
+ export * from "./ThreadStatusBatchItemOut.mjs";
129
+ export * from "./ThreadStatusBatchResponseOut.mjs";
122
130
  export * from "./ThreadStatusResponseOut.mjs";
123
131
  export * from "./ThreadStopResponseOut.mjs";
124
132
  export * from "./ToolResultContent.mjs";
@@ -2,6 +2,12 @@ export * from "./ActivityClockRangeIn.mjs";
2
2
  export * from "./ActivityDeltaOut.mjs";
3
3
  export * from "./ActivityItemOut.mjs";
4
4
  export * from "./AopAsyncExecuteResponseOut.mjs";
5
+ export * from "./AopBatchExecuteResponseOut.mjs";
6
+ export * from "./AopBatchRunIn.mjs";
7
+ export * from "./AopBatchRunLaunchOut.mjs";
8
+ export * from "./AopBatchRunStatusOut.mjs";
9
+ export * from "./AopBatchStatusCountsOut.mjs";
10
+ export * from "./AopBatchStatusResponseOut.mjs";
5
11
  export * from "./AopConfigResponseOut.mjs";
6
12
  export * from "./AopConfigUpdateResponseOut.mjs";
7
13
  export * from "./AopCreateResponseOut.mjs";
@@ -119,6 +125,8 @@ export * from "./ThinkingContent.mjs";
119
125
  export * from "./ThreadBatchStopRequest.mjs";
120
126
  export * from "./ThreadBatchStopResponseOut.mjs";
121
127
  export * from "./ThreadBatchStopResultItem.mjs";
128
+ export * from "./ThreadStatusBatchItemOut.mjs";
129
+ export * from "./ThreadStatusBatchResponseOut.mjs";
122
130
  export * from "./ThreadStatusResponseOut.mjs";
123
131
  export * from "./ThreadStopResponseOut.mjs";
124
132
  export * from "./ToolResultContent.mjs";
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "4.3.2166";
1
+ export declare const SDK_VERSION = "4.3.2168";
@@ -1 +1 @@
1
- export const SDK_VERSION = "4.3.2166";
1
+ export const SDK_VERSION = "4.3.2168";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@athenaintel/sdk",
3
- "version": "4.3.2166",
3
+ "version": "4.3.2168",
4
4
  "private": false,
5
5
  "repository": "github:Athena-Intel/athena-typescript",
6
6
  "type": "commonjs",
package/reference.md CHANGED
@@ -1,5 +1,72 @@
1
1
  # Reference
2
2
  ## Aop
3
+ <details><summary><code>client.aop.<a href="/src/api/resources/aop/client/Client.ts">getBatchStatus</a>({ ...params }) -> AthenaIntelligence.AopBatchStatusResponseOut</code></summary>
4
+ <dl>
5
+ <dd>
6
+
7
+ #### 📝 Description
8
+
9
+ <dl>
10
+ <dd>
11
+
12
+ <dl>
13
+ <dd>
14
+
15
+ 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.
16
+ </dd>
17
+ </dl>
18
+ </dd>
19
+ </dl>
20
+
21
+ #### 🔌 Usage
22
+
23
+ <dl>
24
+ <dd>
25
+
26
+ <dl>
27
+ <dd>
28
+
29
+ ```typescript
30
+ await client.aop.getBatchStatus({
31
+ batch_id: "batch_0f4c3c3e-1c1a-4a3e-9a5f-0d3f1a2b3c4d",
32
+ status: "terminal",
33
+ limit: 200
34
+ });
35
+
36
+ ```
37
+ </dd>
38
+ </dl>
39
+ </dd>
40
+ </dl>
41
+
42
+ #### ⚙️ Parameters
43
+
44
+ <dl>
45
+ <dd>
46
+
47
+ <dl>
48
+ <dd>
49
+
50
+ **request:** `AthenaIntelligence.GetBatchStatusAopRequest`
51
+
52
+ </dd>
53
+ </dl>
54
+
55
+ <dl>
56
+ <dd>
57
+
58
+ **requestOptions:** `AopClient.RequestOptions`
59
+
60
+ </dd>
61
+ </dl>
62
+ </dd>
63
+ </dl>
64
+
65
+
66
+ </dd>
67
+ </dl>
68
+ </details>
69
+
3
70
  <details><summary><code>client.aop.<a href="/src/api/resources/aop/client/Client.ts">create</a>({ ...params }) -> AthenaIntelligence.AopCreateResponseOut</code></summary>
4
71
  <dl>
5
72
  <dd>
@@ -157,7 +224,7 @@ await client.aop.execute({
157
224
  <dl>
158
225
  <dd>
159
226
 
160
- Start execution of an Agent Operating Procedure (AOP) asset asynchronously. Returns immediately with a thread_id for tracking execution progress without waiting for completion.
227
+ Start execution of an Agent Operating Procedure (AOP) asset asynchronously. Returns immediately with a thread_id for tracking execution progress without waiting for completion. Send an `Idempotency-Key` header to make the launch safe to retry: if the response is lost, repeating the identical request with the same key returns the original `thread_id` (with `deduplicated: true`) instead of starting a second run. Keys are private to your account; reusing a key with different parameters is rejected with 422, and a retry that races the first attempt gets 409.
161
228
  </dd>
162
229
  </dl>
163
230
  </dd>
@@ -173,15 +240,97 @@ Start execution of an Agent Operating Procedure (AOP) asset asynchronously. Retu
173
240
 
174
241
  ```typescript
175
242
  await client.aop.executeAsync({
243
+ body: {
244
+ asset_id: "asset_9249292-d118-42d3-95b4-00eccfe0754f",
245
+ run_budget: {
246
+ max_cost_usd: 30,
247
+ max_model_calls: 80
248
+ },
249
+ user_inputs: {
250
+ "company": "Acme Corp",
251
+ "quarter": "Q1 2024"
252
+ }
253
+ }
254
+ });
255
+
256
+ ```
257
+ </dd>
258
+ </dl>
259
+ </dd>
260
+ </dl>
261
+
262
+ #### ⚙️ Parameters
263
+
264
+ <dl>
265
+ <dd>
266
+
267
+ <dl>
268
+ <dd>
269
+
270
+ **request:** `AthenaIntelligence.ExecuteAsyncAopRequest`
271
+
272
+ </dd>
273
+ </dl>
274
+
275
+ <dl>
276
+ <dd>
277
+
278
+ **requestOptions:** `AopClient.RequestOptions`
279
+
280
+ </dd>
281
+ </dl>
282
+ </dd>
283
+ </dl>
284
+
285
+
286
+ </dd>
287
+ </dl>
288
+ </details>
289
+
290
+ <details><summary><code>client.aop.<a href="/src/api/resources/aop/client/Client.ts">executeBatch</a>({ ...params }) -> AthenaIntelligence.AopBatchExecuteResponseOut</code></summary>
291
+ <dl>
292
+ <dd>
293
+
294
+ #### 📝 Description
295
+
296
+ <dl>
297
+ <dd>
298
+
299
+ <dl>
300
+ <dd>
301
+
302
+ 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. Runs are idempotent within a batch: a run whose `idempotency_key` (or, when omitted, `client_ref`) was already launched into the same batch with the same parameters is not started again; its original outcome is replayed with `deduplicated: true`.
303
+ </dd>
304
+ </dl>
305
+ </dd>
306
+ </dl>
307
+
308
+ #### 🔌 Usage
309
+
310
+ <dl>
311
+ <dd>
312
+
313
+ <dl>
314
+ <dd>
315
+
316
+ ```typescript
317
+ await client.aop.executeBatch({
176
318
  asset_id: "asset_9249292-d118-42d3-95b4-00eccfe0754f",
177
319
  run_budget: {
178
320
  max_cost_usd: 30,
179
321
  max_model_calls: 80
180
322
  },
181
- user_inputs: {
182
- "company": "Acme Corp",
183
- "quarter": "Q1 2024"
184
- }
323
+ runs: [{
324
+ client_ref: "row-1",
325
+ user_inputs: {
326
+ "company": "Acme Corp"
327
+ }
328
+ }, {
329
+ client_ref: "row-2",
330
+ user_inputs: {
331
+ "company": "Globex"
332
+ }
333
+ }]
185
334
  });
186
335
 
187
336
  ```
@@ -198,7 +347,7 @@ await client.aop.executeAsync({
198
347
  <dl>
199
348
  <dd>
200
349
 
201
- **request:** `AthenaIntelligence.AopExecuteRequestIn`
350
+ **request:** `AthenaIntelligence.AopBatchExecuteRequestIn`
202
351
 
203
352
  </dd>
204
353
  </dl>
@@ -3727,6 +3876,71 @@ await client.threads.batchStopByAssetId({
3727
3876
  </dl>
3728
3877
 
3729
3878
 
3879
+ </dd>
3880
+ </dl>
3881
+ </details>
3882
+
3883
+ <details><summary><code>client.threads.<a href="/src/api/resources/threads/client/Client.ts">getStatusBatch</a>({ ...params }) -> AthenaIntelligence.ThreadStatusBatchResponseOut</code></summary>
3884
+ <dl>
3885
+ <dd>
3886
+
3887
+ #### 📝 Description
3888
+
3889
+ <dl>
3890
+ <dd>
3891
+
3892
+ <dl>
3893
+ <dd>
3894
+
3895
+ Read the lifecycle status of up to 200 threads in one call, whether they were started by `POST /aop/execute-async` or `POST /aop/execute-batch`. Returns aggregate counts plus one compact entry per thread (status, terminal flag, output availability, timestamps) without loading any messages; fetch results with `GET /threads/{thread_id}/status` once `output_available` is true. Only threads you launched are returned: unknown IDs and other users' threads are listed in `not_found` and are indistinguishable.
3896
+ </dd>
3897
+ </dl>
3898
+ </dd>
3899
+ </dl>
3900
+
3901
+ #### 🔌 Usage
3902
+
3903
+ <dl>
3904
+ <dd>
3905
+
3906
+ <dl>
3907
+ <dd>
3908
+
3909
+ ```typescript
3910
+ await client.threads.getStatusBatch({
3911
+ thread_ids: ["thread_12345-6789-abcd-efgh", "thread_22345-6789-abcd-efgh"]
3912
+ });
3913
+
3914
+ ```
3915
+ </dd>
3916
+ </dl>
3917
+ </dd>
3918
+ </dl>
3919
+
3920
+ #### ⚙️ Parameters
3921
+
3922
+ <dl>
3923
+ <dd>
3924
+
3925
+ <dl>
3926
+ <dd>
3927
+
3928
+ **request:** `AthenaIntelligence.ThreadStatusBatchRequestIn`
3929
+
3930
+ </dd>
3931
+ </dl>
3932
+
3933
+ <dl>
3934
+ <dd>
3935
+
3936
+ **requestOptions:** `ThreadsClient.RequestOptions`
3937
+
3938
+ </dd>
3939
+ </dl>
3940
+ </dd>
3941
+ </dl>
3942
+
3943
+
3730
3944
  </dd>
3731
3945
  </dl>
3732
3946
  </details>