@athenaintel/sdk 4.3.2265 → 4.3.2267
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/assets/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/assets/client/Client.js +2 -2
- package/dist/cjs/api/resources/assets/client/requests/CreateAssetRequestIn.d.ts +3 -1
- package/dist/cjs/api/types/CreatableAssetType.d.ts +1 -0
- package/dist/cjs/api/types/CreatableAssetType.js +1 -0
- package/dist/cjs/api/types/PublicFigureConfigIn.d.ts +28 -0
- package/dist/cjs/api/types/PublicFigureConfigIn.js +3 -0
- package/dist/cjs/api/types/index.d.ts +1 -0
- package/dist/cjs/api/types/index.js +1 -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/assets/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/assets/client/Client.mjs +2 -2
- package/dist/esm/api/resources/assets/client/requests/CreateAssetRequestIn.d.mts +3 -1
- package/dist/esm/api/types/CreatableAssetType.d.mts +1 -0
- package/dist/esm/api/types/CreatableAssetType.mjs +1 -0
- package/dist/esm/api/types/PublicFigureConfigIn.d.mts +28 -0
- package/dist/esm/api/types/PublicFigureConfigIn.mjs +2 -0
- package/dist/esm/api/types/index.d.mts +1 -0
- package/dist/esm/api/types/index.mjs +1 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +2 -2
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.2267",
|
|
47
|
+
"User-Agent": "@athenaintel/sdk/4.3.2267",
|
|
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,
|
|
@@ -50,7 +50,7 @@ export declare class AssetsClient {
|
|
|
50
50
|
convertExcelToSheet(request: AthenaIntelligence.ConvertExcelToSheetRequestIn, requestOptions?: AssetsClient.RequestOptions): core.HttpResponsePromise<AthenaIntelligence.ConvertExcelToSheetResponseOut>;
|
|
51
51
|
private __convertExcelToSheet;
|
|
52
52
|
/**
|
|
53
|
-
* Create a new asset such as a spreadsheet, document, folder, database, computer, user interface, skill, collab agent, or generic doc (admin-only) in your workspace with your current permissions. Computer assets return 202 after durable submission, which commits the asset and initialization delivery intent together. Runtime provisioning continues asynchronously. Inspect the returned asset ID for progress instead of repeating creation. Computers accept the same configuration as the Athena UI's creation dialog: template, provider, cpu, memory (GiB), disk (GiB) and env_vars. Sizes must be offered by the environment's computer resource policy, and only admins may pick a size other than the template default (403 otherwise). In capability enforce mode, computer creation requires computer.create and returns 403 when denied. Databases accept suspend_timeout_seconds, the auto-suspend window from the database's Settings in Athena: 0 keeps the database running (it never suspends, and keeps using capacity), otherwise 60 to 86400 seconds. A database is provisioned in the background: poll GET /api/v0/databases/{asset_id}/compute-status until it reports running or suspended. Without workspace_id the asset is created in the workspace of parent_folder_id when one is given, otherwise in your current workspace; you must be a member of that workspace.
|
|
53
|
+
* Create a new asset such as a spreadsheet, document, folder, database, computer, user interface, skill, collab agent, figure, or generic doc (admin-only) in your workspace with your current permissions. Computer assets return 202 after durable submission, which commits the asset and initialization delivery intent together. Runtime provisioning continues asynchronously. Inspect the returned asset ID for progress instead of repeating creation. Computers accept the same configuration as the Athena UI's creation dialog: template, provider, cpu, memory (GiB), disk (GiB) and env_vars. Sizes must be offered by the environment's computer resource policy, and only admins may pick a size other than the template default (403 otherwise). In capability enforce mode, computer creation requires computer.create and returns 403 when denied. Databases accept suspend_timeout_seconds, the auto-suspend window from the database's Settings in Athena: 0 keeps the database running (it never suspends, and keeps using capacity), otherwise 60 to 86400 seconds. A database is provisioned in the background: poll GET /api/v0/databases/{asset_id}/compute-status until it reports running or suspended. Figures take figure_config, a FigureSpec (kind, rendered and provenance, plus spec or chart), validated as the Athena UI's figures are. Without workspace_id the asset is created in the workspace of parent_folder_id when one is given, otherwise in your current workspace; you must be a member of that workspace.
|
|
54
54
|
*
|
|
55
55
|
* @param {AthenaIntelligence.CreateAssetRequestIn} request
|
|
56
56
|
* @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -242,7 +242,7 @@ export declare class AssetsClient {
|
|
|
242
242
|
getActivityDeltas(request: AthenaIntelligence.AssetActivityDeltaBatchRequestIn, requestOptions?: AssetsClient.RequestOptions): core.HttpResponsePromise<AthenaIntelligence.AssetActivityDeltaResponseOut>;
|
|
243
243
|
private __getActivityDeltas;
|
|
244
244
|
/**
|
|
245
|
-
* Write a collab agent's configuration (system prompt, model, tools, sources, behavior and channel settings) to its draft. Only the fields you send change; an omitted field keeps its current value, and a list or text field you send replaces the old one whole. The write goes to the live draft, the same draft the Athena editor shows, under the asset's existing id. Once the asset has been published, runs keep using the published version until you publish the draft with POST /api/v0/assets/{asset_id}/publish; one never published runs from its draft. Requires edit access to the asset; an archived asset is refused with 409. Unknown fields are refused with 422. A model must be available in the agent's workspace (422 otherwise). Tool or toolkit IDs the registry does not know are written and reported under warnings. A new name also becomes the asset title. The agent's email address and its outbound approval recipients are not set here.
|
|
245
|
+
* Write a collab agent's configuration (system prompt, model, tools, sources, behavior and channel settings) to its draft. Only the fields you send change; an omitted field keeps its current value, and a list or text field you send replaces the old one whole. The write goes to the live draft, the same draft the Athena editor shows, under the asset's existing id. Once the asset has been published, runs keep using the published version until you publish the draft with POST /api/v0/assets/{asset_id}/publish; one never published runs from its draft. Requires edit access to the asset; an archived asset is refused with 409. Unknown fields are refused with 422. A model must be available in the agent's workspace (422 otherwise). Tool or toolkit IDs the registry does not know are written and reported under warnings. A source (collab_source:<asset_id>) or Tool Asset (tool:<asset_id>) the agent does not already hold must be one the caller can open: one they cannot open, or an archived one, is refused with 403 naming it, and nothing is written. A new name also becomes the asset title. The agent's email address and its outbound approval recipients are not set here.
|
|
246
246
|
*
|
|
247
247
|
* @param {AthenaIntelligence.UpdateAgentConfigRequestIn} request
|
|
248
248
|
* @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -255,7 +255,7 @@ class AssetsClient {
|
|
|
255
255
|
});
|
|
256
256
|
}
|
|
257
257
|
/**
|
|
258
|
-
* Create a new asset such as a spreadsheet, document, folder, database, computer, user interface, skill, collab agent, or generic doc (admin-only) in your workspace with your current permissions. Computer assets return 202 after durable submission, which commits the asset and initialization delivery intent together. Runtime provisioning continues asynchronously. Inspect the returned asset ID for progress instead of repeating creation. Computers accept the same configuration as the Athena UI's creation dialog: template, provider, cpu, memory (GiB), disk (GiB) and env_vars. Sizes must be offered by the environment's computer resource policy, and only admins may pick a size other than the template default (403 otherwise). In capability enforce mode, computer creation requires computer.create and returns 403 when denied. Databases accept suspend_timeout_seconds, the auto-suspend window from the database's Settings in Athena: 0 keeps the database running (it never suspends, and keeps using capacity), otherwise 60 to 86400 seconds. A database is provisioned in the background: poll GET /api/v0/databases/{asset_id}/compute-status until it reports running or suspended. Without workspace_id the asset is created in the workspace of parent_folder_id when one is given, otherwise in your current workspace; you must be a member of that workspace.
|
|
258
|
+
* Create a new asset such as a spreadsheet, document, folder, database, computer, user interface, skill, collab agent, figure, or generic doc (admin-only) in your workspace with your current permissions. Computer assets return 202 after durable submission, which commits the asset and initialization delivery intent together. Runtime provisioning continues asynchronously. Inspect the returned asset ID for progress instead of repeating creation. Computers accept the same configuration as the Athena UI's creation dialog: template, provider, cpu, memory (GiB), disk (GiB) and env_vars. Sizes must be offered by the environment's computer resource policy, and only admins may pick a size other than the template default (403 otherwise). In capability enforce mode, computer creation requires computer.create and returns 403 when denied. Databases accept suspend_timeout_seconds, the auto-suspend window from the database's Settings in Athena: 0 keeps the database running (it never suspends, and keeps using capacity), otherwise 60 to 86400 seconds. A database is provisioned in the background: poll GET /api/v0/databases/{asset_id}/compute-status until it reports running or suspended. Figures take figure_config, a FigureSpec (kind, rendered and provenance, plus spec or chart), validated as the Athena UI's figures are. Without workspace_id the asset is created in the workspace of parent_folder_id when one is given, otherwise in your current workspace; you must be a member of that workspace.
|
|
259
259
|
*
|
|
260
260
|
* @param {AthenaIntelligence.CreateAssetRequestIn} request
|
|
261
261
|
* @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -1071,7 +1071,7 @@ class AssetsClient {
|
|
|
1071
1071
|
});
|
|
1072
1072
|
}
|
|
1073
1073
|
/**
|
|
1074
|
-
* Write a collab agent's configuration (system prompt, model, tools, sources, behavior and channel settings) to its draft. Only the fields you send change; an omitted field keeps its current value, and a list or text field you send replaces the old one whole. The write goes to the live draft, the same draft the Athena editor shows, under the asset's existing id. Once the asset has been published, runs keep using the published version until you publish the draft with POST /api/v0/assets/{asset_id}/publish; one never published runs from its draft. Requires edit access to the asset; an archived asset is refused with 409. Unknown fields are refused with 422. A model must be available in the agent's workspace (422 otherwise). Tool or toolkit IDs the registry does not know are written and reported under warnings. A new name also becomes the asset title. The agent's email address and its outbound approval recipients are not set here.
|
|
1074
|
+
* Write a collab agent's configuration (system prompt, model, tools, sources, behavior and channel settings) to its draft. Only the fields you send change; an omitted field keeps its current value, and a list or text field you send replaces the old one whole. The write goes to the live draft, the same draft the Athena editor shows, under the asset's existing id. Once the asset has been published, runs keep using the published version until you publish the draft with POST /api/v0/assets/{asset_id}/publish; one never published runs from its draft. Requires edit access to the asset; an archived asset is refused with 409. Unknown fields are refused with 422. A model must be available in the agent's workspace (422 otherwise). Tool or toolkit IDs the registry does not know are written and reported under warnings. A source (collab_source:<asset_id>) or Tool Asset (tool:<asset_id>) the agent does not already hold must be one the caller can open: one they cannot open, or an archived one, is refused with 403 naming it, and nothing is written. A new name also becomes the asset title. The agent's email address and its outbound approval recipients are not set here.
|
|
1075
1075
|
*
|
|
1076
1076
|
* @param {AthenaIntelligence.UpdateAgentConfigRequestIn} request
|
|
1077
1077
|
* @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -10,7 +10,7 @@ import type * as AthenaIntelligence from "../../../../index.js";
|
|
|
10
10
|
export interface CreateAssetRequestIn {
|
|
11
11
|
/** collab_agent only. Initial agent configuration. Created as a draft; publish it with POST /api/v0/assets/{asset_id}/publish. */
|
|
12
12
|
agent_config?: AthenaIntelligence.PublicCollabAgentConfigIn | null;
|
|
13
|
-
/** Type of asset to create. Supported types: 'spreadsheet' (or 'sheet'), 'document' (or 'doc'), 'folder', 'database' (or 'db'), 'computer', 'generic_doc', 'user_interface' (or 'ui'), 'skill', 'collab_agent' (or 'agent') */
|
|
13
|
+
/** Type of asset to create. Supported types: 'spreadsheet' (or 'sheet'), 'document' (or 'doc'), 'folder', 'database' (or 'db'), 'computer', 'generic_doc', 'user_interface' (or 'ui'), 'skill', 'collab_agent' (or 'agent'), 'figure' */
|
|
14
14
|
asset_type: AthenaIntelligence.CreatableAssetType;
|
|
15
15
|
/** Computer only. vCPU count. Defaults to the template's default. Must be a size the environment's computer resource policy offers; sizes other than the template default require an admin. */
|
|
16
16
|
cpu?: number | null;
|
|
@@ -18,6 +18,8 @@ export interface CreateAssetRequestIn {
|
|
|
18
18
|
disk?: number | null;
|
|
19
19
|
/** Computer only. Environment variables to set on the computer. Must include every key the template or environment requires. Also accepted as 'envVars'. */
|
|
20
20
|
env_vars?: Record<string, string | null> | null;
|
|
21
|
+
/** figure only. The figure's FigureSpec: kind, rendered and provenance, plus spec (plotly, vega-lite) or chart (chart, mixed) and the optional fields. */
|
|
22
|
+
figure_config?: AthenaIntelligence.PublicFigureConfigIn | null;
|
|
21
23
|
/** user_interface only. HTML used as the interface's initial index.html; without it the interface starts from Athena's starter page. */
|
|
22
24
|
html_content?: string | null;
|
|
23
25
|
/** Computer only. Memory in GiB. Defaults to the template's default. Same policy and admin rules as cpu. */
|
|
@@ -9,5 +9,6 @@ export declare const CreatableAssetType: {
|
|
|
9
9
|
readonly UserInterface: "user_interface";
|
|
10
10
|
readonly Skill: "skill";
|
|
11
11
|
readonly CollabAgent: "collab_agent";
|
|
12
|
+
readonly Figure: "figure";
|
|
12
13
|
};
|
|
13
14
|
export type CreatableAssetType = (typeof CreatableAssetType)[keyof typeof CreatableAssetType];
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* A figure's FigureSpec for ``POST /api/v0/assets/create``.
|
|
3
|
+
*
|
|
4
|
+
* The unified shape only (``kind`` set); the create service validates it
|
|
5
|
+
* against the FigureSpec union, the same check ``createFigureTyped`` runs.
|
|
6
|
+
*/
|
|
7
|
+
export interface PublicFigureConfigIn {
|
|
8
|
+
/** Alt text (image figures) */
|
|
9
|
+
alt_text?: string | null;
|
|
10
|
+
/** chart / mixed only: the chart spec */
|
|
11
|
+
chart?: Record<string, unknown> | null;
|
|
12
|
+
/** Optional tabular snapshot supporting edit-later flows */
|
|
13
|
+
data_snapshot?: Record<string, unknown> | null;
|
|
14
|
+
/** Description */
|
|
15
|
+
description?: string | null;
|
|
16
|
+
/** FigureSpec discriminator: plotly, vega-lite, chart, mixed or image */
|
|
17
|
+
kind: string;
|
|
18
|
+
/** Where the figure came from (runtime, library, versions) */
|
|
19
|
+
provenance: Record<string, unknown>;
|
|
20
|
+
/** The rendered preview every FigureSpec carries */
|
|
21
|
+
rendered: Record<string, unknown>;
|
|
22
|
+
/** Where the data came from */
|
|
23
|
+
source?: Record<string, unknown> | null;
|
|
24
|
+
/** plotly / vega-lite only: the library spec */
|
|
25
|
+
spec?: Record<string, unknown> | null;
|
|
26
|
+
/** Overrides a person applied on top of the spec */
|
|
27
|
+
user_overrides?: Record<string, unknown> | null;
|
|
28
|
+
}
|
|
@@ -113,6 +113,7 @@ export * from "./PresenceTokenResponseOut.js";
|
|
|
113
113
|
export * from "./PromptMessage.js";
|
|
114
114
|
export * from "./PublicAssetOut.js";
|
|
115
115
|
export * from "./PublicCollabAgentConfigIn.js";
|
|
116
|
+
export * from "./PublicFigureConfigIn.js";
|
|
116
117
|
export * from "./PublicSessionComputerIn.js";
|
|
117
118
|
export * from "./PublicSessionSetupStepIn.js";
|
|
118
119
|
export * from "./PublicSkillConfigIn.js";
|
|
@@ -129,6 +129,7 @@ __exportStar(require("./PresenceTokenResponseOut.js"), exports);
|
|
|
129
129
|
__exportStar(require("./PromptMessage.js"), exports);
|
|
130
130
|
__exportStar(require("./PublicAssetOut.js"), exports);
|
|
131
131
|
__exportStar(require("./PublicCollabAgentConfigIn.js"), exports);
|
|
132
|
+
__exportStar(require("./PublicFigureConfigIn.js"), exports);
|
|
132
133
|
__exportStar(require("./PublicSessionComputerIn.js"), exports);
|
|
133
134
|
__exportStar(require("./PublicSessionSetupStepIn.js"), exports);
|
|
134
135
|
__exportStar(require("./PublicSkillConfigIn.js"), exports);
|
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.2267";
|
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.2267",
|
|
10
|
+
"User-Agent": "@athenaintel/sdk/4.3.2267",
|
|
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,
|
|
@@ -50,7 +50,7 @@ export declare class AssetsClient {
|
|
|
50
50
|
convertExcelToSheet(request: AthenaIntelligence.ConvertExcelToSheetRequestIn, requestOptions?: AssetsClient.RequestOptions): core.HttpResponsePromise<AthenaIntelligence.ConvertExcelToSheetResponseOut>;
|
|
51
51
|
private __convertExcelToSheet;
|
|
52
52
|
/**
|
|
53
|
-
* Create a new asset such as a spreadsheet, document, folder, database, computer, user interface, skill, collab agent, or generic doc (admin-only) in your workspace with your current permissions. Computer assets return 202 after durable submission, which commits the asset and initialization delivery intent together. Runtime provisioning continues asynchronously. Inspect the returned asset ID for progress instead of repeating creation. Computers accept the same configuration as the Athena UI's creation dialog: template, provider, cpu, memory (GiB), disk (GiB) and env_vars. Sizes must be offered by the environment's computer resource policy, and only admins may pick a size other than the template default (403 otherwise). In capability enforce mode, computer creation requires computer.create and returns 403 when denied. Databases accept suspend_timeout_seconds, the auto-suspend window from the database's Settings in Athena: 0 keeps the database running (it never suspends, and keeps using capacity), otherwise 60 to 86400 seconds. A database is provisioned in the background: poll GET /api/v0/databases/{asset_id}/compute-status until it reports running or suspended. Without workspace_id the asset is created in the workspace of parent_folder_id when one is given, otherwise in your current workspace; you must be a member of that workspace.
|
|
53
|
+
* Create a new asset such as a spreadsheet, document, folder, database, computer, user interface, skill, collab agent, figure, or generic doc (admin-only) in your workspace with your current permissions. Computer assets return 202 after durable submission, which commits the asset and initialization delivery intent together. Runtime provisioning continues asynchronously. Inspect the returned asset ID for progress instead of repeating creation. Computers accept the same configuration as the Athena UI's creation dialog: template, provider, cpu, memory (GiB), disk (GiB) and env_vars. Sizes must be offered by the environment's computer resource policy, and only admins may pick a size other than the template default (403 otherwise). In capability enforce mode, computer creation requires computer.create and returns 403 when denied. Databases accept suspend_timeout_seconds, the auto-suspend window from the database's Settings in Athena: 0 keeps the database running (it never suspends, and keeps using capacity), otherwise 60 to 86400 seconds. A database is provisioned in the background: poll GET /api/v0/databases/{asset_id}/compute-status until it reports running or suspended. Figures take figure_config, a FigureSpec (kind, rendered and provenance, plus spec or chart), validated as the Athena UI's figures are. Without workspace_id the asset is created in the workspace of parent_folder_id when one is given, otherwise in your current workspace; you must be a member of that workspace.
|
|
54
54
|
*
|
|
55
55
|
* @param {AthenaIntelligence.CreateAssetRequestIn} request
|
|
56
56
|
* @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -242,7 +242,7 @@ export declare class AssetsClient {
|
|
|
242
242
|
getActivityDeltas(request: AthenaIntelligence.AssetActivityDeltaBatchRequestIn, requestOptions?: AssetsClient.RequestOptions): core.HttpResponsePromise<AthenaIntelligence.AssetActivityDeltaResponseOut>;
|
|
243
243
|
private __getActivityDeltas;
|
|
244
244
|
/**
|
|
245
|
-
* Write a collab agent's configuration (system prompt, model, tools, sources, behavior and channel settings) to its draft. Only the fields you send change; an omitted field keeps its current value, and a list or text field you send replaces the old one whole. The write goes to the live draft, the same draft the Athena editor shows, under the asset's existing id. Once the asset has been published, runs keep using the published version until you publish the draft with POST /api/v0/assets/{asset_id}/publish; one never published runs from its draft. Requires edit access to the asset; an archived asset is refused with 409. Unknown fields are refused with 422. A model must be available in the agent's workspace (422 otherwise). Tool or toolkit IDs the registry does not know are written and reported under warnings. A new name also becomes the asset title. The agent's email address and its outbound approval recipients are not set here.
|
|
245
|
+
* Write a collab agent's configuration (system prompt, model, tools, sources, behavior and channel settings) to its draft. Only the fields you send change; an omitted field keeps its current value, and a list or text field you send replaces the old one whole. The write goes to the live draft, the same draft the Athena editor shows, under the asset's existing id. Once the asset has been published, runs keep using the published version until you publish the draft with POST /api/v0/assets/{asset_id}/publish; one never published runs from its draft. Requires edit access to the asset; an archived asset is refused with 409. Unknown fields are refused with 422. A model must be available in the agent's workspace (422 otherwise). Tool or toolkit IDs the registry does not know are written and reported under warnings. A source (collab_source:<asset_id>) or Tool Asset (tool:<asset_id>) the agent does not already hold must be one the caller can open: one they cannot open, or an archived one, is refused with 403 naming it, and nothing is written. A new name also becomes the asset title. The agent's email address and its outbound approval recipients are not set here.
|
|
246
246
|
*
|
|
247
247
|
* @param {AthenaIntelligence.UpdateAgentConfigRequestIn} request
|
|
248
248
|
* @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -219,7 +219,7 @@ export class AssetsClient {
|
|
|
219
219
|
});
|
|
220
220
|
}
|
|
221
221
|
/**
|
|
222
|
-
* Create a new asset such as a spreadsheet, document, folder, database, computer, user interface, skill, collab agent, or generic doc (admin-only) in your workspace with your current permissions. Computer assets return 202 after durable submission, which commits the asset and initialization delivery intent together. Runtime provisioning continues asynchronously. Inspect the returned asset ID for progress instead of repeating creation. Computers accept the same configuration as the Athena UI's creation dialog: template, provider, cpu, memory (GiB), disk (GiB) and env_vars. Sizes must be offered by the environment's computer resource policy, and only admins may pick a size other than the template default (403 otherwise). In capability enforce mode, computer creation requires computer.create and returns 403 when denied. Databases accept suspend_timeout_seconds, the auto-suspend window from the database's Settings in Athena: 0 keeps the database running (it never suspends, and keeps using capacity), otherwise 60 to 86400 seconds. A database is provisioned in the background: poll GET /api/v0/databases/{asset_id}/compute-status until it reports running or suspended. Without workspace_id the asset is created in the workspace of parent_folder_id when one is given, otherwise in your current workspace; you must be a member of that workspace.
|
|
222
|
+
* Create a new asset such as a spreadsheet, document, folder, database, computer, user interface, skill, collab agent, figure, or generic doc (admin-only) in your workspace with your current permissions. Computer assets return 202 after durable submission, which commits the asset and initialization delivery intent together. Runtime provisioning continues asynchronously. Inspect the returned asset ID for progress instead of repeating creation. Computers accept the same configuration as the Athena UI's creation dialog: template, provider, cpu, memory (GiB), disk (GiB) and env_vars. Sizes must be offered by the environment's computer resource policy, and only admins may pick a size other than the template default (403 otherwise). In capability enforce mode, computer creation requires computer.create and returns 403 when denied. Databases accept suspend_timeout_seconds, the auto-suspend window from the database's Settings in Athena: 0 keeps the database running (it never suspends, and keeps using capacity), otherwise 60 to 86400 seconds. A database is provisioned in the background: poll GET /api/v0/databases/{asset_id}/compute-status until it reports running or suspended. Figures take figure_config, a FigureSpec (kind, rendered and provenance, plus spec or chart), validated as the Athena UI's figures are. Without workspace_id the asset is created in the workspace of parent_folder_id when one is given, otherwise in your current workspace; you must be a member of that workspace.
|
|
223
223
|
*
|
|
224
224
|
* @param {AthenaIntelligence.CreateAssetRequestIn} request
|
|
225
225
|
* @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -1035,7 +1035,7 @@ export class AssetsClient {
|
|
|
1035
1035
|
});
|
|
1036
1036
|
}
|
|
1037
1037
|
/**
|
|
1038
|
-
* Write a collab agent's configuration (system prompt, model, tools, sources, behavior and channel settings) to its draft. Only the fields you send change; an omitted field keeps its current value, and a list or text field you send replaces the old one whole. The write goes to the live draft, the same draft the Athena editor shows, under the asset's existing id. Once the asset has been published, runs keep using the published version until you publish the draft with POST /api/v0/assets/{asset_id}/publish; one never published runs from its draft. Requires edit access to the asset; an archived asset is refused with 409. Unknown fields are refused with 422. A model must be available in the agent's workspace (422 otherwise). Tool or toolkit IDs the registry does not know are written and reported under warnings. A new name also becomes the asset title. The agent's email address and its outbound approval recipients are not set here.
|
|
1038
|
+
* Write a collab agent's configuration (system prompt, model, tools, sources, behavior and channel settings) to its draft. Only the fields you send change; an omitted field keeps its current value, and a list or text field you send replaces the old one whole. The write goes to the live draft, the same draft the Athena editor shows, under the asset's existing id. Once the asset has been published, runs keep using the published version until you publish the draft with POST /api/v0/assets/{asset_id}/publish; one never published runs from its draft. Requires edit access to the asset; an archived asset is refused with 409. Unknown fields are refused with 422. A model must be available in the agent's workspace (422 otherwise). Tool or toolkit IDs the registry does not know are written and reported under warnings. A source (collab_source:<asset_id>) or Tool Asset (tool:<asset_id>) the agent does not already hold must be one the caller can open: one they cannot open, or an archived one, is refused with 403 naming it, and nothing is written. A new name also becomes the asset title. The agent's email address and its outbound approval recipients are not set here.
|
|
1039
1039
|
*
|
|
1040
1040
|
* @param {AthenaIntelligence.UpdateAgentConfigRequestIn} request
|
|
1041
1041
|
* @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -10,7 +10,7 @@ import type * as AthenaIntelligence from "../../../../index.mjs";
|
|
|
10
10
|
export interface CreateAssetRequestIn {
|
|
11
11
|
/** collab_agent only. Initial agent configuration. Created as a draft; publish it with POST /api/v0/assets/{asset_id}/publish. */
|
|
12
12
|
agent_config?: AthenaIntelligence.PublicCollabAgentConfigIn | null;
|
|
13
|
-
/** Type of asset to create. Supported types: 'spreadsheet' (or 'sheet'), 'document' (or 'doc'), 'folder', 'database' (or 'db'), 'computer', 'generic_doc', 'user_interface' (or 'ui'), 'skill', 'collab_agent' (or 'agent') */
|
|
13
|
+
/** Type of asset to create. Supported types: 'spreadsheet' (or 'sheet'), 'document' (or 'doc'), 'folder', 'database' (or 'db'), 'computer', 'generic_doc', 'user_interface' (or 'ui'), 'skill', 'collab_agent' (or 'agent'), 'figure' */
|
|
14
14
|
asset_type: AthenaIntelligence.CreatableAssetType;
|
|
15
15
|
/** Computer only. vCPU count. Defaults to the template's default. Must be a size the environment's computer resource policy offers; sizes other than the template default require an admin. */
|
|
16
16
|
cpu?: number | null;
|
|
@@ -18,6 +18,8 @@ export interface CreateAssetRequestIn {
|
|
|
18
18
|
disk?: number | null;
|
|
19
19
|
/** Computer only. Environment variables to set on the computer. Must include every key the template or environment requires. Also accepted as 'envVars'. */
|
|
20
20
|
env_vars?: Record<string, string | null> | null;
|
|
21
|
+
/** figure only. The figure's FigureSpec: kind, rendered and provenance, plus spec (plotly, vega-lite) or chart (chart, mixed) and the optional fields. */
|
|
22
|
+
figure_config?: AthenaIntelligence.PublicFigureConfigIn | null;
|
|
21
23
|
/** user_interface only. HTML used as the interface's initial index.html; without it the interface starts from Athena's starter page. */
|
|
22
24
|
html_content?: string | null;
|
|
23
25
|
/** Computer only. Memory in GiB. Defaults to the template's default. Same policy and admin rules as cpu. */
|
|
@@ -9,5 +9,6 @@ export declare const CreatableAssetType: {
|
|
|
9
9
|
readonly UserInterface: "user_interface";
|
|
10
10
|
readonly Skill: "skill";
|
|
11
11
|
readonly CollabAgent: "collab_agent";
|
|
12
|
+
readonly Figure: "figure";
|
|
12
13
|
};
|
|
13
14
|
export type CreatableAssetType = (typeof CreatableAssetType)[keyof typeof CreatableAssetType];
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* A figure's FigureSpec for ``POST /api/v0/assets/create``.
|
|
3
|
+
*
|
|
4
|
+
* The unified shape only (``kind`` set); the create service validates it
|
|
5
|
+
* against the FigureSpec union, the same check ``createFigureTyped`` runs.
|
|
6
|
+
*/
|
|
7
|
+
export interface PublicFigureConfigIn {
|
|
8
|
+
/** Alt text (image figures) */
|
|
9
|
+
alt_text?: string | null;
|
|
10
|
+
/** chart / mixed only: the chart spec */
|
|
11
|
+
chart?: Record<string, unknown> | null;
|
|
12
|
+
/** Optional tabular snapshot supporting edit-later flows */
|
|
13
|
+
data_snapshot?: Record<string, unknown> | null;
|
|
14
|
+
/** Description */
|
|
15
|
+
description?: string | null;
|
|
16
|
+
/** FigureSpec discriminator: plotly, vega-lite, chart, mixed or image */
|
|
17
|
+
kind: string;
|
|
18
|
+
/** Where the figure came from (runtime, library, versions) */
|
|
19
|
+
provenance: Record<string, unknown>;
|
|
20
|
+
/** The rendered preview every FigureSpec carries */
|
|
21
|
+
rendered: Record<string, unknown>;
|
|
22
|
+
/** Where the data came from */
|
|
23
|
+
source?: Record<string, unknown> | null;
|
|
24
|
+
/** plotly / vega-lite only: the library spec */
|
|
25
|
+
spec?: Record<string, unknown> | null;
|
|
26
|
+
/** Overrides a person applied on top of the spec */
|
|
27
|
+
user_overrides?: Record<string, unknown> | null;
|
|
28
|
+
}
|
|
@@ -113,6 +113,7 @@ export * from "./PresenceTokenResponseOut.mjs";
|
|
|
113
113
|
export * from "./PromptMessage.mjs";
|
|
114
114
|
export * from "./PublicAssetOut.mjs";
|
|
115
115
|
export * from "./PublicCollabAgentConfigIn.mjs";
|
|
116
|
+
export * from "./PublicFigureConfigIn.mjs";
|
|
116
117
|
export * from "./PublicSessionComputerIn.mjs";
|
|
117
118
|
export * from "./PublicSessionSetupStepIn.mjs";
|
|
118
119
|
export * from "./PublicSkillConfigIn.mjs";
|
|
@@ -113,6 +113,7 @@ export * from "./PresenceTokenResponseOut.mjs";
|
|
|
113
113
|
export * from "./PromptMessage.mjs";
|
|
114
114
|
export * from "./PublicAssetOut.mjs";
|
|
115
115
|
export * from "./PublicCollabAgentConfigIn.mjs";
|
|
116
|
+
export * from "./PublicFigureConfigIn.mjs";
|
|
116
117
|
export * from "./PublicSessionComputerIn.mjs";
|
|
117
118
|
export * from "./PublicSessionSetupStepIn.mjs";
|
|
118
119
|
export * from "./PublicSkillConfigIn.mjs";
|
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.2267";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "4.3.
|
|
1
|
+
export const SDK_VERSION = "4.3.2267";
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -648,7 +648,7 @@ await client.assets.convertExcelToSheet({
|
|
|
648
648
|
<dl>
|
|
649
649
|
<dd>
|
|
650
650
|
|
|
651
|
-
Create a new asset such as a spreadsheet, document, folder, database, computer, user interface, skill, collab agent, or generic doc (admin-only) in your workspace with your current permissions. Computer assets return 202 after durable submission, which commits the asset and initialization delivery intent together. Runtime provisioning continues asynchronously. Inspect the returned asset ID for progress instead of repeating creation. Computers accept the same configuration as the Athena UI's creation dialog: template, provider, cpu, memory (GiB), disk (GiB) and env_vars. Sizes must be offered by the environment's computer resource policy, and only admins may pick a size other than the template default (403 otherwise). In capability enforce mode, computer creation requires computer.create and returns 403 when denied. Databases accept suspend_timeout_seconds, the auto-suspend window from the database's Settings in Athena: 0 keeps the database running (it never suspends, and keeps using capacity), otherwise 60 to 86400 seconds. A database is provisioned in the background: poll GET /api/v0/databases/{asset_id}/compute-status until it reports running or suspended. Without workspace_id the asset is created in the workspace of parent_folder_id when one is given, otherwise in your current workspace; you must be a member of that workspace.
|
|
651
|
+
Create a new asset such as a spreadsheet, document, folder, database, computer, user interface, skill, collab agent, figure, or generic doc (admin-only) in your workspace with your current permissions. Computer assets return 202 after durable submission, which commits the asset and initialization delivery intent together. Runtime provisioning continues asynchronously. Inspect the returned asset ID for progress instead of repeating creation. Computers accept the same configuration as the Athena UI's creation dialog: template, provider, cpu, memory (GiB), disk (GiB) and env_vars. Sizes must be offered by the environment's computer resource policy, and only admins may pick a size other than the template default (403 otherwise). In capability enforce mode, computer creation requires computer.create and returns 403 when denied. Databases accept suspend_timeout_seconds, the auto-suspend window from the database's Settings in Athena: 0 keeps the database running (it never suspends, and keeps using capacity), otherwise 60 to 86400 seconds. A database is provisioned in the background: poll GET /api/v0/databases/{asset_id}/compute-status until it reports running or suspended. Figures take figure_config, a FigureSpec (kind, rendered and provenance, plus spec or chart), validated as the Athena UI's figures are. Without workspace_id the asset is created in the workspace of parent_folder_id when one is given, otherwise in your current workspace; you must be a member of that workspace.
|
|
652
652
|
</dd>
|
|
653
653
|
</dl>
|
|
654
654
|
</dd>
|
|
@@ -1258,7 +1258,7 @@ await client.assets.getActivityDeltas({
|
|
|
1258
1258
|
<dl>
|
|
1259
1259
|
<dd>
|
|
1260
1260
|
|
|
1261
|
-
Write a collab agent's configuration (system prompt, model, tools, sources, behavior and channel settings) to its draft. Only the fields you send change; an omitted field keeps its current value, and a list or text field you send replaces the old one whole. The write goes to the live draft, the same draft the Athena editor shows, under the asset's existing id. Once the asset has been published, runs keep using the published version until you publish the draft with POST /api/v0/assets/{asset_id}/publish; one never published runs from its draft. Requires edit access to the asset; an archived asset is refused with 409. Unknown fields are refused with 422. A model must be available in the agent's workspace (422 otherwise). Tool or toolkit IDs the registry does not know are written and reported under warnings. A new name also becomes the asset title. The agent's email address and its outbound approval recipients are not set here.
|
|
1261
|
+
Write a collab agent's configuration (system prompt, model, tools, sources, behavior and channel settings) to its draft. Only the fields you send change; an omitted field keeps its current value, and a list or text field you send replaces the old one whole. The write goes to the live draft, the same draft the Athena editor shows, under the asset's existing id. Once the asset has been published, runs keep using the published version until you publish the draft with POST /api/v0/assets/{asset_id}/publish; one never published runs from its draft. Requires edit access to the asset; an archived asset is refused with 409. Unknown fields are refused with 422. A model must be available in the agent's workspace (422 otherwise). Tool or toolkit IDs the registry does not know are written and reported under warnings. A source (collab_source:<asset_id>) or Tool Asset (tool:<asset_id>) the agent does not already hold must be one the caller can open: one they cannot open, or an archived one, is refused with 403 naming it, and nothing is written. A new name also becomes the asset title. The agent's email address and its outbound approval recipients are not set here.
|
|
1262
1262
|
</dd>
|
|
1263
1263
|
</dl>
|
|
1264
1264
|
</dd>
|