@athenaintel/sdk 4.3.2324 → 4.3.2326
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.
- package/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/api/resources/agents/resources/general/client/Client.d.ts +8 -1
- package/dist/cjs/api/resources/agents/resources/general/client/Client.js +8 -1
- package/dist/cjs/api/resources/aop/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/aop/client/Client.js +1 -1
- package/dist/cjs/api/resources/computer/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/computer/client/Client.js +1 -1
- package/dist/cjs/api/resources/tasks/client/requests/SetTaskStatusRequestIn.d.ts +1 -1
- package/dist/cjs/api/resources/tasks/client/requests/UpdateTaskRequestIn.d.ts +1 -1
- package/dist/cjs/api/types/SaveAssetRequestOut.d.ts +8 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/api/resources/agents/resources/general/client/Client.d.mts +8 -1
- package/dist/esm/api/resources/agents/resources/general/client/Client.mjs +8 -1
- package/dist/esm/api/resources/aop/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/aop/client/Client.mjs +1 -1
- package/dist/esm/api/resources/computer/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/computer/client/Client.mjs +1 -1
- package/dist/esm/api/resources/tasks/client/requests/SetTaskStatusRequestIn.d.mts +1 -1
- package/dist/esm/api/resources/tasks/client/requests/UpdateTaskRequestIn.d.mts +1 -1
- package/dist/esm/api/types/SaveAssetRequestOut.d.mts +8 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +10 -3
package/dist/cjs/BaseClient.js
CHANGED
|
@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
|
|
|
43
43
|
const headers = (0, headers_js_1.mergeHeaders)({
|
|
44
44
|
"X-Fern-Language": "JavaScript",
|
|
45
45
|
"X-Fern-SDK-Name": "@athenaintel/sdk",
|
|
46
|
-
"X-Fern-SDK-Version": "4.3.
|
|
47
|
-
"User-Agent": "@athenaintel/sdk/4.3.
|
|
46
|
+
"X-Fern-SDK-Version": "4.3.2326",
|
|
47
|
+
"User-Agent": "@athenaintel/sdk/4.3.2326",
|
|
48
48
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
49
49
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
50
50
|
"X-Athena-Session-Credential": options === null || options === void 0 ? void 0 : options.sessionCredential,
|
|
@@ -17,6 +17,13 @@ export declare class GeneralClient {
|
|
|
17
17
|
* Call the agent with the messages list, wait for the agent to complete,
|
|
18
18
|
* and return the result.
|
|
19
19
|
*
|
|
20
|
+
* A human message's `additional_kwargs.metadata` keeps the names the
|
|
21
|
+
* caller sets for itself. Names Athena reserves there for what it writes
|
|
22
|
+
* itself are not taken from the request; `source` is one of them only
|
|
23
|
+
* where it holds `voice`, `text` or `voice_delegation`. A message the
|
|
24
|
+
* thread already holds keeps the thread's value for each, and on any
|
|
25
|
+
* other human message none is taken from the request.
|
|
26
|
+
*
|
|
20
27
|
* @param {AthenaIntelligence.GeneralAgentRequest} request
|
|
21
28
|
* @param {GeneralClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
22
29
|
*
|
|
@@ -36,7 +43,7 @@ export declare class GeneralClient {
|
|
|
36
43
|
invoke(request: AthenaIntelligence.GeneralAgentRequest, requestOptions?: GeneralClient.RequestOptions): core.HttpResponsePromise<AthenaIntelligence.GeneralAgentResponse>;
|
|
37
44
|
private __invoke;
|
|
38
45
|
/**
|
|
39
|
-
* Start a general-agent run and return immediately with a `thread_id`. Use this instead of `/agents/general/invoke` for any call that may take more than a few seconds (tool use, multi-step work), so the HTTP connection is never held open past client or proxy timeouts. Poll `GET /threads/{thread_id}/status` until `status` is `completed` or `failed`; pass `include_messages=true` to read the agent's reply. Supply the `thread_id` of a general-agent thread you can access to continue it; 404/403 when it is unknown/not yours, 409 while a run is still in progress on it or while it is archived (restore it to continue it).
|
|
46
|
+
* Start a general-agent run and return immediately with a `thread_id`. Use this instead of `/agents/general/invoke` for any call that may take more than a few seconds (tool use, multi-step work), so the HTTP connection is never held open past client or proxy timeouts. Poll `GET /threads/{thread_id}/status` until `status` is `completed` or `failed`; pass `include_messages=true` to read the agent's reply. Supply the `thread_id` of a general-agent thread you can access to continue it; 404/403 when it is unknown/not yours, 409 while a run is still in progress on it or while it is archived (restore it to continue it). A human message's `additional_kwargs.metadata` keeps the names the caller sets for itself. Names Athena reserves there for what it writes itself are not taken from the request; `source` is one of them only where it holds `voice`, `text` or `voice_delegation`. A message the thread already holds keeps the thread's value for each, and on any other human message none is taken from the request.
|
|
40
47
|
*
|
|
41
48
|
* @param {AthenaIntelligence.GeneralAgentRequest} request
|
|
42
49
|
* @param {GeneralClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -60,6 +60,13 @@ class GeneralClient {
|
|
|
60
60
|
* Call the agent with the messages list, wait for the agent to complete,
|
|
61
61
|
* and return the result.
|
|
62
62
|
*
|
|
63
|
+
* A human message's `additional_kwargs.metadata` keeps the names the
|
|
64
|
+
* caller sets for itself. Names Athena reserves there for what it writes
|
|
65
|
+
* itself are not taken from the request; `source` is one of them only
|
|
66
|
+
* where it holds `voice`, `text` or `voice_delegation`. A message the
|
|
67
|
+
* thread already holds keeps the thread's value for each, and on any
|
|
68
|
+
* other human message none is taken from the request.
|
|
69
|
+
*
|
|
63
70
|
* @param {AthenaIntelligence.GeneralAgentRequest} request
|
|
64
71
|
* @param {GeneralClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
65
72
|
*
|
|
@@ -141,7 +148,7 @@ class GeneralClient {
|
|
|
141
148
|
});
|
|
142
149
|
}
|
|
143
150
|
/**
|
|
144
|
-
* Start a general-agent run and return immediately with a `thread_id`. Use this instead of `/agents/general/invoke` for any call that may take more than a few seconds (tool use, multi-step work), so the HTTP connection is never held open past client or proxy timeouts. Poll `GET /threads/{thread_id}/status` until `status` is `completed` or `failed`; pass `include_messages=true` to read the agent's reply. Supply the `thread_id` of a general-agent thread you can access to continue it; 404/403 when it is unknown/not yours, 409 while a run is still in progress on it or while it is archived (restore it to continue it).
|
|
151
|
+
* Start a general-agent run and return immediately with a `thread_id`. Use this instead of `/agents/general/invoke` for any call that may take more than a few seconds (tool use, multi-step work), so the HTTP connection is never held open past client or proxy timeouts. Poll `GET /threads/{thread_id}/status` until `status` is `completed` or `failed`; pass `include_messages=true` to read the agent's reply. Supply the `thread_id` of a general-agent thread you can access to continue it; 404/403 when it is unknown/not yours, 409 while a run is still in progress on it or while it is archived (restore it to continue it). A human message's `additional_kwargs.metadata` keeps the names the caller sets for itself. Names Athena reserves there for what it writes itself are not taken from the request; `source` is one of them only where it holds `voice`, `text` or `voice_delegation`. A message the thread already holds keeps the thread's value for each, and on any other human message none is taken from the request.
|
|
145
152
|
*
|
|
146
153
|
* @param {AthenaIntelligence.GeneralAgentRequest} request
|
|
147
154
|
* @param {GeneralClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -168,7 +168,7 @@ export declare class AopClient {
|
|
|
168
168
|
getConfig(request: AthenaIntelligence.GetConfigAopRequest, requestOptions?: AopClient.RequestOptions): core.HttpResponsePromise<AthenaIntelligence.AopConfigResponseOut>;
|
|
169
169
|
private __getConfig;
|
|
170
170
|
/**
|
|
171
|
-
* Overwrite the configuration of an existing AOP asset. Replaces the entire AOP configuration (prompt, agent config, structured output, etc.) with the provided values. Fields not included in the request body will be reset to their defaults, except user_notification_configs, which is preserved from the existing configuration when omitted; send an explicit null to clear it. The update is rejected with 400 when the configuration would enable more tools at run time than the per-run limit, counting every tool of each toolkit @mentioned in the prompt; the detail names toolkits to remove and the existing configuration is left untouched.
|
|
171
|
+
* Overwrite the configuration of an existing AOP asset. Replaces the entire AOP configuration (prompt, agent config, structured output, etc.) with the provided values. Fields not included in the request body will be reset to their defaults, except user_notification_configs, which is preserved from the existing configuration when omitted; send an explicit null to clear it. Parts of the AOP this request has no field for (its checks, for example) are not replaced and stay as they are. The update is rejected with 400 when the configuration would enable more tools at run time than the per-run limit, counting every tool of each toolkit @mentioned in the prompt; the detail names toolkits to remove and the existing configuration is left untouched. A person's update (a signed-in session or the person's own API key) publishes at once, so an update that would give runs tools the published version does not (resolved as runs resolve them, the assigned agent's tools included) is rejected with 409 and nothing is changed unless confirm_sensitive is true; the detail names the added tools. A caller that may not publish (a credential a runtime holds: a computer's, a session VM's, a notebook kernel's, a user interface preview's) gets its update saved as a draft and a 403 whose detail says so; a person publishes the draft from the AOP. For now a staff impersonation (dashboard or in-app) is refused the same way: its update is saved as a draft and the route answers 403, until the central staff-acts-for-customer verdict admits a verified staff impersonation.
|
|
172
172
|
*
|
|
173
173
|
* @param {AthenaIntelligence.AopConfigUpdateRequestIn} request
|
|
174
174
|
* @param {AopClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -650,7 +650,7 @@ class AopClient {
|
|
|
650
650
|
});
|
|
651
651
|
}
|
|
652
652
|
/**
|
|
653
|
-
* Overwrite the configuration of an existing AOP asset. Replaces the entire AOP configuration (prompt, agent config, structured output, etc.) with the provided values. Fields not included in the request body will be reset to their defaults, except user_notification_configs, which is preserved from the existing configuration when omitted; send an explicit null to clear it. The update is rejected with 400 when the configuration would enable more tools at run time than the per-run limit, counting every tool of each toolkit @mentioned in the prompt; the detail names toolkits to remove and the existing configuration is left untouched.
|
|
653
|
+
* Overwrite the configuration of an existing AOP asset. Replaces the entire AOP configuration (prompt, agent config, structured output, etc.) with the provided values. Fields not included in the request body will be reset to their defaults, except user_notification_configs, which is preserved from the existing configuration when omitted; send an explicit null to clear it. Parts of the AOP this request has no field for (its checks, for example) are not replaced and stay as they are. The update is rejected with 400 when the configuration would enable more tools at run time than the per-run limit, counting every tool of each toolkit @mentioned in the prompt; the detail names toolkits to remove and the existing configuration is left untouched. A person's update (a signed-in session or the person's own API key) publishes at once, so an update that would give runs tools the published version does not (resolved as runs resolve them, the assigned agent's tools included) is rejected with 409 and nothing is changed unless confirm_sensitive is true; the detail names the added tools. A caller that may not publish (a credential a runtime holds: a computer's, a session VM's, a notebook kernel's, a user interface preview's) gets its update saved as a draft and a 403 whose detail says so; a person publishes the draft from the AOP. For now a staff impersonation (dashboard or in-app) is refused the same way: its update is saved as a draft and the route answers 403, until the central staff-acts-for-customer verdict admits a verified staff impersonation.
|
|
654
654
|
*
|
|
655
655
|
* @param {AthenaIntelligence.AopConfigUpdateRequestIn} request
|
|
656
656
|
* @param {AopClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -12,7 +12,7 @@ export declare class ComputerClient {
|
|
|
12
12
|
protected readonly _options: NormalizedClientOptionsWithAuth<ComputerClient.Options>;
|
|
13
13
|
constructor(options?: ComputerClient.Options);
|
|
14
14
|
/**
|
|
15
|
-
* Deploy a computer asset's running application to a shareable, persistent preview URL — the same action the Deploy button in the Olympus UI performs. Auto-starts the computer if it is stopped, validates that the requested port is reachable, records the deployment in the asset's metadata (so the UI stays in sync), and returns the Marathon preview URL for the exposed port. Call it with different ports to deploy multiple services from the same computer. Ports reserved by the computer runtime (such as the internal developer-agent port) are rejected with a 400 and can never be deployed. A 409 means the port cannot be exposed on this computer's runtime as currently booted (the detail explains how to proceed); a 502 means the runtime's port validation failed.
|
|
15
|
+
* Deploy a computer asset's running application to a shareable, persistent preview URL — the same action the Deploy button in the Olympus UI performs. Auto-starts the computer if it is stopped, validates that the requested port is reachable, records the deployment in the asset's metadata (so the UI stays in sync), and returns the Marathon preview URL for the exposed port. Call it with different ports to deploy multiple services from the same computer. Ports reserved by the computer runtime (such as the internal developer-agent port) are rejected with a 400 and can never be deployed. A 409 means the port cannot be exposed on this computer's runtime as currently booted (the detail explains how to proceed); a 502 means the runtime's port validation failed; a 503 means the deploy couldn't be checked, so nothing was recorded and it can be sent again. A credential a runtime holds is refused with a 403 where the port would be served beyond the workspace (a public or SSO computer, a port in raw proxy mode, a public custom domain that would serve the port, whether pinned to it or a legacy one with no port, which follows the deployed port, or a stored policy or custom domains this server can't read), unless its workspace's decision_authority.agent_widening setting admits its agent. For now a staff impersonation (dashboard or in-app) is refused there too, whatever that setting says, until the central staff-acts-for-customer verdict admits a verified staff impersonation.
|
|
16
16
|
*
|
|
17
17
|
* @param {AthenaIntelligence.DeployComputerRequestIn} request
|
|
18
18
|
* @param {ComputerClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -66,7 +66,7 @@ class ComputerClient {
|
|
|
66
66
|
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
67
67
|
}
|
|
68
68
|
/**
|
|
69
|
-
* Deploy a computer asset's running application to a shareable, persistent preview URL — the same action the Deploy button in the Olympus UI performs. Auto-starts the computer if it is stopped, validates that the requested port is reachable, records the deployment in the asset's metadata (so the UI stays in sync), and returns the Marathon preview URL for the exposed port. Call it with different ports to deploy multiple services from the same computer. Ports reserved by the computer runtime (such as the internal developer-agent port) are rejected with a 400 and can never be deployed. A 409 means the port cannot be exposed on this computer's runtime as currently booted (the detail explains how to proceed); a 502 means the runtime's port validation failed.
|
|
69
|
+
* Deploy a computer asset's running application to a shareable, persistent preview URL — the same action the Deploy button in the Olympus UI performs. Auto-starts the computer if it is stopped, validates that the requested port is reachable, records the deployment in the asset's metadata (so the UI stays in sync), and returns the Marathon preview URL for the exposed port. Call it with different ports to deploy multiple services from the same computer. Ports reserved by the computer runtime (such as the internal developer-agent port) are rejected with a 400 and can never be deployed. A 409 means the port cannot be exposed on this computer's runtime as currently booted (the detail explains how to proceed); a 502 means the runtime's port validation failed; a 503 means the deploy couldn't be checked, so nothing was recorded and it can be sent again. A credential a runtime holds is refused with a 403 where the port would be served beyond the workspace (a public or SSO computer, a port in raw proxy mode, a public custom domain that would serve the port, whether pinned to it or a legacy one with no port, which follows the deployed port, or a stored policy or custom domains this server can't read), unless its workspace's decision_authority.agent_widening setting admits its agent. For now a staff impersonation (dashboard or in-app) is refused there too, whatever that setting says, until the central staff-acts-for-customer verdict admits a verified staff impersonation.
|
|
70
70
|
*
|
|
71
71
|
* @param {AthenaIntelligence.DeployComputerRequestIn} request
|
|
72
72
|
* @param {ComputerClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
export interface SetTaskStatusRequestIn {
|
|
10
10
|
/** The task's asset id. */
|
|
11
11
|
asset_id: string;
|
|
12
|
-
/** Why it is done, with status done: completed (when left out) or not_planned (won't do). Refused with status open. */
|
|
12
|
+
/** Why it is done, with status done: completed (when left out) or not_planned (won't do). Refused with status open. Also taken as completion_reason, the name PATCH and the task itself use. */
|
|
13
13
|
reason?: SetTaskStatusRequestIn.Reason | null;
|
|
14
14
|
/** open or done. */
|
|
15
15
|
status: SetTaskStatusRequestIn.Status;
|
|
@@ -11,7 +11,7 @@ export interface UpdateTaskRequestIn {
|
|
|
11
11
|
asset_id: string;
|
|
12
12
|
/** user_…, agent_asset_… or me; null assigns it to nobody. The assignee must already be able to open the task. */
|
|
13
13
|
assignee_ref?: string | null;
|
|
14
|
-
/** Why it is done: completed or not_planned (won't do), with status done or on a task already done; left out or null when marking it done, completed. Refused on a task left open. */
|
|
14
|
+
/** Why it is done: completed or not_planned (won't do), with status done or on a task already done; left out or null when marking it done, completed. Refused on a task left open. Also taken as reason, the name the status route uses. */
|
|
15
15
|
completion_reason?: UpdateTaskRequestIn.CompletionReason | null;
|
|
16
16
|
/** New details (markdown); null clears them. */
|
|
17
17
|
description?: string | null;
|
|
@@ -3,4 +3,12 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export interface SaveAssetRequestOut {
|
|
5
5
|
asset_id: string;
|
|
6
|
+
/** Size in bytes of the file received */
|
|
7
|
+
file_size?: number | null;
|
|
8
|
+
/** Folder the asset was filed into */
|
|
9
|
+
parent_folder_id?: string | null;
|
|
10
|
+
/** Lowercase hex SHA-256 of the file received, to check the upload without downloading it again; null when it was not computed */
|
|
11
|
+
sha256?: string | null;
|
|
12
|
+
/** Workspace the asset was saved into */
|
|
13
|
+
workspace_id?: string | null;
|
|
6
14
|
}
|
package/dist/cjs/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "4.3.
|
|
1
|
+
export declare const SDK_VERSION = "4.3.2326";
|
package/dist/cjs/version.js
CHANGED
package/dist/esm/BaseClient.mjs
CHANGED
|
@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
|
|
|
6
6
|
const headers = mergeHeaders({
|
|
7
7
|
"X-Fern-Language": "JavaScript",
|
|
8
8
|
"X-Fern-SDK-Name": "@athenaintel/sdk",
|
|
9
|
-
"X-Fern-SDK-Version": "4.3.
|
|
10
|
-
"User-Agent": "@athenaintel/sdk/4.3.
|
|
9
|
+
"X-Fern-SDK-Version": "4.3.2326",
|
|
10
|
+
"User-Agent": "@athenaintel/sdk/4.3.2326",
|
|
11
11
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
12
12
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
13
13
|
"X-Athena-Session-Credential": options === null || options === void 0 ? void 0 : options.sessionCredential,
|
|
@@ -17,6 +17,13 @@ export declare class GeneralClient {
|
|
|
17
17
|
* Call the agent with the messages list, wait for the agent to complete,
|
|
18
18
|
* and return the result.
|
|
19
19
|
*
|
|
20
|
+
* A human message's `additional_kwargs.metadata` keeps the names the
|
|
21
|
+
* caller sets for itself. Names Athena reserves there for what it writes
|
|
22
|
+
* itself are not taken from the request; `source` is one of them only
|
|
23
|
+
* where it holds `voice`, `text` or `voice_delegation`. A message the
|
|
24
|
+
* thread already holds keeps the thread's value for each, and on any
|
|
25
|
+
* other human message none is taken from the request.
|
|
26
|
+
*
|
|
20
27
|
* @param {AthenaIntelligence.GeneralAgentRequest} request
|
|
21
28
|
* @param {GeneralClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
22
29
|
*
|
|
@@ -36,7 +43,7 @@ export declare class GeneralClient {
|
|
|
36
43
|
invoke(request: AthenaIntelligence.GeneralAgentRequest, requestOptions?: GeneralClient.RequestOptions): core.HttpResponsePromise<AthenaIntelligence.GeneralAgentResponse>;
|
|
37
44
|
private __invoke;
|
|
38
45
|
/**
|
|
39
|
-
* Start a general-agent run and return immediately with a `thread_id`. Use this instead of `/agents/general/invoke` for any call that may take more than a few seconds (tool use, multi-step work), so the HTTP connection is never held open past client or proxy timeouts. Poll `GET /threads/{thread_id}/status` until `status` is `completed` or `failed`; pass `include_messages=true` to read the agent's reply. Supply the `thread_id` of a general-agent thread you can access to continue it; 404/403 when it is unknown/not yours, 409 while a run is still in progress on it or while it is archived (restore it to continue it).
|
|
46
|
+
* Start a general-agent run and return immediately with a `thread_id`. Use this instead of `/agents/general/invoke` for any call that may take more than a few seconds (tool use, multi-step work), so the HTTP connection is never held open past client or proxy timeouts. Poll `GET /threads/{thread_id}/status` until `status` is `completed` or `failed`; pass `include_messages=true` to read the agent's reply. Supply the `thread_id` of a general-agent thread you can access to continue it; 404/403 when it is unknown/not yours, 409 while a run is still in progress on it or while it is archived (restore it to continue it). A human message's `additional_kwargs.metadata` keeps the names the caller sets for itself. Names Athena reserves there for what it writes itself are not taken from the request; `source` is one of them only where it holds `voice`, `text` or `voice_delegation`. A message the thread already holds keeps the thread's value for each, and on any other human message none is taken from the request.
|
|
40
47
|
*
|
|
41
48
|
* @param {AthenaIntelligence.GeneralAgentRequest} request
|
|
42
49
|
* @param {GeneralClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -24,6 +24,13 @@ export class GeneralClient {
|
|
|
24
24
|
* Call the agent with the messages list, wait for the agent to complete,
|
|
25
25
|
* and return the result.
|
|
26
26
|
*
|
|
27
|
+
* A human message's `additional_kwargs.metadata` keeps the names the
|
|
28
|
+
* caller sets for itself. Names Athena reserves there for what it writes
|
|
29
|
+
* itself are not taken from the request; `source` is one of them only
|
|
30
|
+
* where it holds `voice`, `text` or `voice_delegation`. A message the
|
|
31
|
+
* thread already holds keeps the thread's value for each, and on any
|
|
32
|
+
* other human message none is taken from the request.
|
|
33
|
+
*
|
|
27
34
|
* @param {AthenaIntelligence.GeneralAgentRequest} request
|
|
28
35
|
* @param {GeneralClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
29
36
|
*
|
|
@@ -105,7 +112,7 @@ export class GeneralClient {
|
|
|
105
112
|
});
|
|
106
113
|
}
|
|
107
114
|
/**
|
|
108
|
-
* Start a general-agent run and return immediately with a `thread_id`. Use this instead of `/agents/general/invoke` for any call that may take more than a few seconds (tool use, multi-step work), so the HTTP connection is never held open past client or proxy timeouts. Poll `GET /threads/{thread_id}/status` until `status` is `completed` or `failed`; pass `include_messages=true` to read the agent's reply. Supply the `thread_id` of a general-agent thread you can access to continue it; 404/403 when it is unknown/not yours, 409 while a run is still in progress on it or while it is archived (restore it to continue it).
|
|
115
|
+
* Start a general-agent run and return immediately with a `thread_id`. Use this instead of `/agents/general/invoke` for any call that may take more than a few seconds (tool use, multi-step work), so the HTTP connection is never held open past client or proxy timeouts. Poll `GET /threads/{thread_id}/status` until `status` is `completed` or `failed`; pass `include_messages=true` to read the agent's reply. Supply the `thread_id` of a general-agent thread you can access to continue it; 404/403 when it is unknown/not yours, 409 while a run is still in progress on it or while it is archived (restore it to continue it). A human message's `additional_kwargs.metadata` keeps the names the caller sets for itself. Names Athena reserves there for what it writes itself are not taken from the request; `source` is one of them only where it holds `voice`, `text` or `voice_delegation`. A message the thread already holds keeps the thread's value for each, and on any other human message none is taken from the request.
|
|
109
116
|
*
|
|
110
117
|
* @param {AthenaIntelligence.GeneralAgentRequest} request
|
|
111
118
|
* @param {GeneralClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -168,7 +168,7 @@ export declare class AopClient {
|
|
|
168
168
|
getConfig(request: AthenaIntelligence.GetConfigAopRequest, requestOptions?: AopClient.RequestOptions): core.HttpResponsePromise<AthenaIntelligence.AopConfigResponseOut>;
|
|
169
169
|
private __getConfig;
|
|
170
170
|
/**
|
|
171
|
-
* Overwrite the configuration of an existing AOP asset. Replaces the entire AOP configuration (prompt, agent config, structured output, etc.) with the provided values. Fields not included in the request body will be reset to their defaults, except user_notification_configs, which is preserved from the existing configuration when omitted; send an explicit null to clear it. The update is rejected with 400 when the configuration would enable more tools at run time than the per-run limit, counting every tool of each toolkit @mentioned in the prompt; the detail names toolkits to remove and the existing configuration is left untouched.
|
|
171
|
+
* Overwrite the configuration of an existing AOP asset. Replaces the entire AOP configuration (prompt, agent config, structured output, etc.) with the provided values. Fields not included in the request body will be reset to their defaults, except user_notification_configs, which is preserved from the existing configuration when omitted; send an explicit null to clear it. Parts of the AOP this request has no field for (its checks, for example) are not replaced and stay as they are. The update is rejected with 400 when the configuration would enable more tools at run time than the per-run limit, counting every tool of each toolkit @mentioned in the prompt; the detail names toolkits to remove and the existing configuration is left untouched. A person's update (a signed-in session or the person's own API key) publishes at once, so an update that would give runs tools the published version does not (resolved as runs resolve them, the assigned agent's tools included) is rejected with 409 and nothing is changed unless confirm_sensitive is true; the detail names the added tools. A caller that may not publish (a credential a runtime holds: a computer's, a session VM's, a notebook kernel's, a user interface preview's) gets its update saved as a draft and a 403 whose detail says so; a person publishes the draft from the AOP. For now a staff impersonation (dashboard or in-app) is refused the same way: its update is saved as a draft and the route answers 403, until the central staff-acts-for-customer verdict admits a verified staff impersonation.
|
|
172
172
|
*
|
|
173
173
|
* @param {AthenaIntelligence.AopConfigUpdateRequestIn} request
|
|
174
174
|
* @param {AopClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -614,7 +614,7 @@ export class AopClient {
|
|
|
614
614
|
});
|
|
615
615
|
}
|
|
616
616
|
/**
|
|
617
|
-
* Overwrite the configuration of an existing AOP asset. Replaces the entire AOP configuration (prompt, agent config, structured output, etc.) with the provided values. Fields not included in the request body will be reset to their defaults, except user_notification_configs, which is preserved from the existing configuration when omitted; send an explicit null to clear it. The update is rejected with 400 when the configuration would enable more tools at run time than the per-run limit, counting every tool of each toolkit @mentioned in the prompt; the detail names toolkits to remove and the existing configuration is left untouched.
|
|
617
|
+
* Overwrite the configuration of an existing AOP asset. Replaces the entire AOP configuration (prompt, agent config, structured output, etc.) with the provided values. Fields not included in the request body will be reset to their defaults, except user_notification_configs, which is preserved from the existing configuration when omitted; send an explicit null to clear it. Parts of the AOP this request has no field for (its checks, for example) are not replaced and stay as they are. The update is rejected with 400 when the configuration would enable more tools at run time than the per-run limit, counting every tool of each toolkit @mentioned in the prompt; the detail names toolkits to remove and the existing configuration is left untouched. A person's update (a signed-in session or the person's own API key) publishes at once, so an update that would give runs tools the published version does not (resolved as runs resolve them, the assigned agent's tools included) is rejected with 409 and nothing is changed unless confirm_sensitive is true; the detail names the added tools. A caller that may not publish (a credential a runtime holds: a computer's, a session VM's, a notebook kernel's, a user interface preview's) gets its update saved as a draft and a 403 whose detail says so; a person publishes the draft from the AOP. For now a staff impersonation (dashboard or in-app) is refused the same way: its update is saved as a draft and the route answers 403, until the central staff-acts-for-customer verdict admits a verified staff impersonation.
|
|
618
618
|
*
|
|
619
619
|
* @param {AthenaIntelligence.AopConfigUpdateRequestIn} request
|
|
620
620
|
* @param {AopClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -12,7 +12,7 @@ export declare class ComputerClient {
|
|
|
12
12
|
protected readonly _options: NormalizedClientOptionsWithAuth<ComputerClient.Options>;
|
|
13
13
|
constructor(options?: ComputerClient.Options);
|
|
14
14
|
/**
|
|
15
|
-
* Deploy a computer asset's running application to a shareable, persistent preview URL — the same action the Deploy button in the Olympus UI performs. Auto-starts the computer if it is stopped, validates that the requested port is reachable, records the deployment in the asset's metadata (so the UI stays in sync), and returns the Marathon preview URL for the exposed port. Call it with different ports to deploy multiple services from the same computer. Ports reserved by the computer runtime (such as the internal developer-agent port) are rejected with a 400 and can never be deployed. A 409 means the port cannot be exposed on this computer's runtime as currently booted (the detail explains how to proceed); a 502 means the runtime's port validation failed.
|
|
15
|
+
* Deploy a computer asset's running application to a shareable, persistent preview URL — the same action the Deploy button in the Olympus UI performs. Auto-starts the computer if it is stopped, validates that the requested port is reachable, records the deployment in the asset's metadata (so the UI stays in sync), and returns the Marathon preview URL for the exposed port. Call it with different ports to deploy multiple services from the same computer. Ports reserved by the computer runtime (such as the internal developer-agent port) are rejected with a 400 and can never be deployed. A 409 means the port cannot be exposed on this computer's runtime as currently booted (the detail explains how to proceed); a 502 means the runtime's port validation failed; a 503 means the deploy couldn't be checked, so nothing was recorded and it can be sent again. A credential a runtime holds is refused with a 403 where the port would be served beyond the workspace (a public or SSO computer, a port in raw proxy mode, a public custom domain that would serve the port, whether pinned to it or a legacy one with no port, which follows the deployed port, or a stored policy or custom domains this server can't read), unless its workspace's decision_authority.agent_widening setting admits its agent. For now a staff impersonation (dashboard or in-app) is refused there too, whatever that setting says, until the central staff-acts-for-customer verdict admits a verified staff impersonation.
|
|
16
16
|
*
|
|
17
17
|
* @param {AthenaIntelligence.DeployComputerRequestIn} request
|
|
18
18
|
* @param {ComputerClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -30,7 +30,7 @@ export class ComputerClient {
|
|
|
30
30
|
this._options = normalizeClientOptionsWithAuth(options);
|
|
31
31
|
}
|
|
32
32
|
/**
|
|
33
|
-
* Deploy a computer asset's running application to a shareable, persistent preview URL — the same action the Deploy button in the Olympus UI performs. Auto-starts the computer if it is stopped, validates that the requested port is reachable, records the deployment in the asset's metadata (so the UI stays in sync), and returns the Marathon preview URL for the exposed port. Call it with different ports to deploy multiple services from the same computer. Ports reserved by the computer runtime (such as the internal developer-agent port) are rejected with a 400 and can never be deployed. A 409 means the port cannot be exposed on this computer's runtime as currently booted (the detail explains how to proceed); a 502 means the runtime's port validation failed.
|
|
33
|
+
* Deploy a computer asset's running application to a shareable, persistent preview URL — the same action the Deploy button in the Olympus UI performs. Auto-starts the computer if it is stopped, validates that the requested port is reachable, records the deployment in the asset's metadata (so the UI stays in sync), and returns the Marathon preview URL for the exposed port. Call it with different ports to deploy multiple services from the same computer. Ports reserved by the computer runtime (such as the internal developer-agent port) are rejected with a 400 and can never be deployed. A 409 means the port cannot be exposed on this computer's runtime as currently booted (the detail explains how to proceed); a 502 means the runtime's port validation failed; a 503 means the deploy couldn't be checked, so nothing was recorded and it can be sent again. A credential a runtime holds is refused with a 403 where the port would be served beyond the workspace (a public or SSO computer, a port in raw proxy mode, a public custom domain that would serve the port, whether pinned to it or a legacy one with no port, which follows the deployed port, or a stored policy or custom domains this server can't read), unless its workspace's decision_authority.agent_widening setting admits its agent. For now a staff impersonation (dashboard or in-app) is refused there too, whatever that setting says, until the central staff-acts-for-customer verdict admits a verified staff impersonation.
|
|
34
34
|
*
|
|
35
35
|
* @param {AthenaIntelligence.DeployComputerRequestIn} request
|
|
36
36
|
* @param {ComputerClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
export interface SetTaskStatusRequestIn {
|
|
10
10
|
/** The task's asset id. */
|
|
11
11
|
asset_id: string;
|
|
12
|
-
/** Why it is done, with status done: completed (when left out) or not_planned (won't do). Refused with status open. */
|
|
12
|
+
/** Why it is done, with status done: completed (when left out) or not_planned (won't do). Refused with status open. Also taken as completion_reason, the name PATCH and the task itself use. */
|
|
13
13
|
reason?: SetTaskStatusRequestIn.Reason | null;
|
|
14
14
|
/** open or done. */
|
|
15
15
|
status: SetTaskStatusRequestIn.Status;
|
|
@@ -11,7 +11,7 @@ export interface UpdateTaskRequestIn {
|
|
|
11
11
|
asset_id: string;
|
|
12
12
|
/** user_…, agent_asset_… or me; null assigns it to nobody. The assignee must already be able to open the task. */
|
|
13
13
|
assignee_ref?: string | null;
|
|
14
|
-
/** Why it is done: completed or not_planned (won't do), with status done or on a task already done; left out or null when marking it done, completed. Refused on a task left open. */
|
|
14
|
+
/** Why it is done: completed or not_planned (won't do), with status done or on a task already done; left out or null when marking it done, completed. Refused on a task left open. Also taken as reason, the name the status route uses. */
|
|
15
15
|
completion_reason?: UpdateTaskRequestIn.CompletionReason | null;
|
|
16
16
|
/** New details (markdown); null clears them. */
|
|
17
17
|
description?: string | null;
|
|
@@ -3,4 +3,12 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export interface SaveAssetRequestOut {
|
|
5
5
|
asset_id: string;
|
|
6
|
+
/** Size in bytes of the file received */
|
|
7
|
+
file_size?: number | null;
|
|
8
|
+
/** Folder the asset was filed into */
|
|
9
|
+
parent_folder_id?: string | null;
|
|
10
|
+
/** Lowercase hex SHA-256 of the file received, to check the upload without downloading it again; null when it was not computed */
|
|
11
|
+
sha256?: string | null;
|
|
12
|
+
/** Workspace the asset was saved into */
|
|
13
|
+
workspace_id?: string | null;
|
|
6
14
|
}
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "4.3.
|
|
1
|
+
export declare const SDK_VERSION = "4.3.2326";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "4.3.
|
|
1
|
+
export const SDK_VERSION = "4.3.2326";
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -444,7 +444,7 @@ await client.aop.getConfig({
|
|
|
444
444
|
<dl>
|
|
445
445
|
<dd>
|
|
446
446
|
|
|
447
|
-
Overwrite the configuration of an existing AOP asset. Replaces the entire AOP configuration (prompt, agent config, structured output, etc.) with the provided values. Fields not included in the request body will be reset to their defaults, except user_notification_configs, which is preserved from the existing configuration when omitted; send an explicit null to clear it. The update is rejected with 400 when the configuration would enable more tools at run time than the per-run limit, counting every tool of each toolkit @mentioned in the prompt; the detail names toolkits to remove and the existing configuration is left untouched.
|
|
447
|
+
Overwrite the configuration of an existing AOP asset. Replaces the entire AOP configuration (prompt, agent config, structured output, etc.) with the provided values. Fields not included in the request body will be reset to their defaults, except user_notification_configs, which is preserved from the existing configuration when omitted; send an explicit null to clear it. Parts of the AOP this request has no field for (its checks, for example) are not replaced and stay as they are. The update is rejected with 400 when the configuration would enable more tools at run time than the per-run limit, counting every tool of each toolkit @mentioned in the prompt; the detail names toolkits to remove and the existing configuration is left untouched. A person's update (a signed-in session or the person's own API key) publishes at once, so an update that would give runs tools the published version does not (resolved as runs resolve them, the assigned agent's tools included) is rejected with 409 and nothing is changed unless confirm_sensitive is true; the detail names the added tools. A caller that may not publish (a credential a runtime holds: a computer's, a session VM's, a notebook kernel's, a user interface preview's) gets its update saved as a draft and a 403 whose detail says so; a person publishes the draft from the AOP. For now a staff impersonation (dashboard or in-app) is refused the same way: its update is saved as a draft and the route answers 403, until the central staff-acts-for-customer verdict admits a verified staff impersonation.
|
|
448
448
|
</dd>
|
|
449
449
|
</dl>
|
|
450
450
|
</dd>
|
|
@@ -2446,7 +2446,7 @@ await client.collabAgents.sendMessage({
|
|
|
2446
2446
|
<dl>
|
|
2447
2447
|
<dd>
|
|
2448
2448
|
|
|
2449
|
-
Deploy a computer asset's running application to a shareable, persistent preview URL — the same action the Deploy button in the Olympus UI performs. Auto-starts the computer if it is stopped, validates that the requested port is reachable, records the deployment in the asset's metadata (so the UI stays in sync), and returns the Marathon preview URL for the exposed port. Call it with different ports to deploy multiple services from the same computer. Ports reserved by the computer runtime (such as the internal developer-agent port) are rejected with a 400 and can never be deployed. A 409 means the port cannot be exposed on this computer's runtime as currently booted (the detail explains how to proceed); a 502 means the runtime's port validation failed.
|
|
2449
|
+
Deploy a computer asset's running application to a shareable, persistent preview URL — the same action the Deploy button in the Olympus UI performs. Auto-starts the computer if it is stopped, validates that the requested port is reachable, records the deployment in the asset's metadata (so the UI stays in sync), and returns the Marathon preview URL for the exposed port. Call it with different ports to deploy multiple services from the same computer. Ports reserved by the computer runtime (such as the internal developer-agent port) are rejected with a 400 and can never be deployed. A 409 means the port cannot be exposed on this computer's runtime as currently booted (the detail explains how to proceed); a 502 means the runtime's port validation failed; a 503 means the deploy couldn't be checked, so nothing was recorded and it can be sent again. A credential a runtime holds is refused with a 403 where the port would be served beyond the workspace (a public or SSO computer, a port in raw proxy mode, a public custom domain that would serve the port, whether pinned to it or a legacy one with no port, which follows the deployed port, or a stored policy or custom domains this server can't read), unless its workspace's decision_authority.agent_widening setting admits its agent. For now a staff impersonation (dashboard or in-app) is refused there too, whatever that setting says, until the central staff-acts-for-customer verdict admits a verified staff impersonation.
|
|
2450
2450
|
</dd>
|
|
2451
2451
|
</dl>
|
|
2452
2452
|
</dd>
|
|
@@ -7066,6 +7066,13 @@ Call the general Athena agent synchronously.
|
|
|
7066
7066
|
|
|
7067
7067
|
Call the agent with the messages list, wait for the agent to complete,
|
|
7068
7068
|
and return the result.
|
|
7069
|
+
|
|
7070
|
+
A human message's `additional_kwargs.metadata` keeps the names the
|
|
7071
|
+
caller sets for itself. Names Athena reserves there for what it writes
|
|
7072
|
+
itself are not taken from the request; `source` is one of them only
|
|
7073
|
+
where it holds `voice`, `text` or `voice_delegation`. A message the
|
|
7074
|
+
thread already holds keeps the thread's value for each, and on any
|
|
7075
|
+
other human message none is taken from the request.
|
|
7069
7076
|
</dd>
|
|
7070
7077
|
</dl>
|
|
7071
7078
|
</dd>
|
|
@@ -7136,7 +7143,7 @@ await client.agents.general.invoke({
|
|
|
7136
7143
|
<dl>
|
|
7137
7144
|
<dd>
|
|
7138
7145
|
|
|
7139
|
-
Start a general-agent run and return immediately with a `thread_id`. Use this instead of `/agents/general/invoke` for any call that may take more than a few seconds (tool use, multi-step work), so the HTTP connection is never held open past client or proxy timeouts. Poll `GET /threads/{thread_id}/status` until `status` is `completed` or `failed`; pass `include_messages=true` to read the agent's reply. Supply the `thread_id` of a general-agent thread you can access to continue it; 404/403 when it is unknown/not yours, 409 while a run is still in progress on it or while it is archived (restore it to continue it).
|
|
7146
|
+
Start a general-agent run and return immediately with a `thread_id`. Use this instead of `/agents/general/invoke` for any call that may take more than a few seconds (tool use, multi-step work), so the HTTP connection is never held open past client or proxy timeouts. Poll `GET /threads/{thread_id}/status` until `status` is `completed` or `failed`; pass `include_messages=true` to read the agent's reply. Supply the `thread_id` of a general-agent thread you can access to continue it; 404/403 when it is unknown/not yours, 409 while a run is still in progress on it or while it is archived (restore it to continue it). A human message's `additional_kwargs.metadata` keeps the names the caller sets for itself. Names Athena reserves there for what it writes itself are not taken from the request; `source` is one of them only where it holds `voice`, `text` or `voice_delegation`. A message the thread already holds keeps the thread's value for each, and on any other human message none is taken from the request.
|
|
7140
7147
|
</dd>
|
|
7141
7148
|
</dl>
|
|
7142
7149
|
</dd>
|