@archastro/sdk 0.20.0 → 0.22.0
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/channels/api_artifact_channel.d.ts +48 -0
- package/dist/channels/api_artifact_channel.d.ts.map +1 -0
- package/dist/channels/api_artifact_channel.js +85 -0
- package/dist/channels/api_artifact_channel.js.map +1 -0
- package/dist/channels/api_chat_channel.d.ts +3 -1
- package/dist/channels/api_chat_channel.d.ts.map +1 -1
- package/dist/channels/api_chat_channel.js +6 -2
- package/dist/channels/api_chat_channel.js.map +1 -1
- package/dist/client.d.ts +10 -0
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +11 -1
- package/dist/client.js.map +1 -1
- package/dist/index.d.ts +1 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +2 -1
- package/dist/index.js.map +1 -1
- package/dist/types/ai.d.ts +124 -10
- package/dist/types/ai.d.ts.map +1 -1
- package/dist/types/ai.js +27 -7
- package/dist/types/ai.js.map +1 -1
- package/dist/types/artifacts.d.ts +448 -0
- package/dist/types/artifacts.d.ts.map +1 -1
- package/dist/types/artifacts.js +65 -1
- package/dist/types/artifacts.js.map +1 -1
- package/dist/types/automations.d.ts +26 -26
- package/dist/types/automations.d.ts.map +1 -1
- package/dist/types/automations.js +10 -10
- package/dist/types/automations.js.map +1 -1
- package/dist/types/chat.d.ts +4150 -0
- package/dist/types/chat.d.ts.map +1 -1
- package/dist/types/common.d.ts +3635 -357
- package/dist/types/common.d.ts.map +1 -1
- package/dist/types/common.js +186 -32
- package/dist/types/common.js.map +1 -1
- package/dist/types/computers.d.ts +42 -0
- package/dist/types/computers.d.ts.map +1 -0
- package/dist/types/computers.js +19 -0
- package/dist/types/computers.js.map +1 -0
- package/dist/types/events.d.ts +34 -16
- package/dist/types/events.d.ts.map +1 -1
- package/dist/types/events.js +3 -1
- package/dist/types/events.js.map +1 -1
- package/dist/types/index.d.ts +2 -0
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/index.js +3 -1
- package/dist/types/index.js.map +1 -1
- package/dist/types/relays.d.ts +22 -0
- package/dist/types/relays.d.ts.map +1 -0
- package/dist/types/relays.js +12 -0
- package/dist/types/relays.js.map +1 -0
- package/dist/types/tasks.d.ts +839 -14
- package/dist/types/tasks.d.ts.map +1 -1
- package/dist/types/tasks.js +85 -11
- package/dist/types/tasks.js.map +1 -1
- package/dist/types/teams.d.ts +381 -0
- package/dist/types/teams.d.ts.map +1 -1
- package/dist/types/threads.d.ts +421 -0
- package/dist/types/threads.d.ts.map +1 -1
- package/dist/types/threads.js +3 -1
- package/dist/types/threads.js.map +1 -1
- package/dist/v1/resources/activity_feed.d.ts +15 -0
- package/dist/v1/resources/activity_feed.d.ts.map +1 -1
- package/dist/v1/resources/activity_feed.js +1 -1
- package/dist/v1/resources/agent_computers.d.ts +48 -1
- package/dist/v1/resources/agent_computers.d.ts.map +1 -1
- package/dist/v1/resources/agent_computers.js +17 -1
- package/dist/v1/resources/agent_computers.js.map +1 -1
- package/dist/v1/resources/agent_requests.d.ts +62 -0
- package/dist/v1/resources/agent_requests.d.ts.map +1 -0
- package/dist/v1/resources/agent_requests.js +79 -0
- package/dist/v1/resources/agent_requests.js.map +1 -0
- package/dist/v1/resources/agent_routines.d.ts +15 -0
- package/dist/v1/resources/agent_routines.d.ts.map +1 -1
- package/dist/v1/resources/agent_routines.js +1 -1
- package/dist/v1/resources/agent_routines.js.map +1 -1
- package/dist/v1/resources/agent_sessions.d.ts +23 -1
- package/dist/v1/resources/agent_sessions.d.ts.map +1 -1
- package/dist/v1/resources/agent_sessions.js +26 -1
- package/dist/v1/resources/agent_sessions.js.map +1 -1
- package/dist/v1/resources/agents.d.ts +96 -1
- package/dist/v1/resources/agents.d.ts.map +1 -1
- package/dist/v1/resources/agents.js +13 -2
- package/dist/v1/resources/agents.js.map +1 -1
- package/dist/v1/resources/ai.d.ts +55 -4
- package/dist/v1/resources/ai.d.ts.map +1 -1
- package/dist/v1/resources/ai.js +44 -4
- package/dist/v1/resources/ai.js.map +1 -1
- package/dist/v1/resources/artifacts.d.ts +64 -2
- package/dist/v1/resources/artifacts.d.ts.map +1 -1
- package/dist/v1/resources/artifacts.js +3 -2
- package/dist/v1/resources/artifacts.js.map +1 -1
- package/dist/v1/resources/automation_runs.d.ts +6 -2
- package/dist/v1/resources/automation_runs.d.ts.map +1 -1
- package/dist/v1/resources/automation_runs.js +10 -4
- package/dist/v1/resources/automation_runs.js.map +1 -1
- package/dist/v1/resources/computers.d.ts +113 -0
- package/dist/v1/resources/computers.d.ts.map +1 -0
- package/dist/v1/resources/computers.js +113 -0
- package/dist/v1/resources/computers.js.map +1 -0
- package/dist/v1/resources/custom_objects.d.ts +154 -0
- package/dist/v1/resources/custom_objects.d.ts.map +1 -1
- package/dist/v1/resources/custom_objects.js +60 -1
- package/dist/v1/resources/custom_objects.js.map +1 -1
- package/dist/v1/resources/event_subscriptions.d.ts +12 -0
- package/dist/v1/resources/event_subscriptions.d.ts.map +1 -1
- package/dist/v1/resources/event_subscriptions.js +7 -1
- package/dist/v1/resources/event_subscriptions.js.map +1 -1
- package/dist/v1/resources/files.d.ts +56 -10
- package/dist/v1/resources/files.d.ts.map +1 -1
- package/dist/v1/resources/files.js +39 -11
- package/dist/v1/resources/files.js.map +1 -1
- package/dist/v1/resources/index.d.ts +5 -0
- package/dist/v1/resources/index.d.ts.map +1 -1
- package/dist/v1/resources/index.js +6 -1
- package/dist/v1/resources/index.js.map +1 -1
- package/dist/v1/resources/knowledge_sources.d.ts +4 -0
- package/dist/v1/resources/knowledge_sources.d.ts.map +1 -1
- package/dist/v1/resources/knowledge_sources.js +1 -1
- package/dist/v1/resources/kv.d.ts +75 -31
- package/dist/v1/resources/kv.d.ts.map +1 -1
- package/dist/v1/resources/kv.js +79 -32
- package/dist/v1/resources/kv.js.map +1 -1
- package/dist/v1/resources/notifications.d.ts +14 -0
- package/dist/v1/resources/notifications.d.ts.map +1 -1
- package/dist/v1/resources/notifications.js +13 -1
- package/dist/v1/resources/notifications.js.map +1 -1
- package/dist/v1/resources/oauth.d.ts +2 -0
- package/dist/v1/resources/oauth.d.ts.map +1 -1
- package/dist/v1/resources/oauth.js +2 -1
- package/dist/v1/resources/oauth.js.map +1 -1
- package/dist/v1/resources/orgs.d.ts +907 -1
- package/dist/v1/resources/orgs.d.ts.map +1 -1
- package/dist/v1/resources/orgs.js +471 -2
- package/dist/v1/resources/orgs.js.map +1 -1
- package/dist/v1/resources/private_service_enrollments.d.ts +7 -0
- package/dist/v1/resources/private_service_enrollments.d.ts.map +1 -1
- package/dist/v1/resources/private_service_enrollments.js +10 -1
- package/dist/v1/resources/private_service_enrollments.js.map +1 -1
- package/dist/v1/resources/relays.d.ts +38 -0
- package/dist/v1/resources/relays.d.ts.map +1 -0
- package/dist/v1/resources/relays.js +44 -0
- package/dist/v1/resources/relays.js.map +1 -0
- package/dist/v1/resources/scripts.d.ts +20 -9
- package/dist/v1/resources/scripts.d.ts.map +1 -1
- package/dist/v1/resources/scripts.js +18 -10
- package/dist/v1/resources/scripts.js.map +1 -1
- package/dist/v1/resources/solutions.d.ts +15 -0
- package/dist/v1/resources/solutions.d.ts.map +1 -1
- package/dist/v1/resources/solutions.js +1 -1
- package/dist/v1/resources/solutions.js.map +1 -1
- package/dist/v1/resources/task_epics.d.ts +85 -0
- package/dist/v1/resources/task_epics.d.ts.map +1 -0
- package/dist/v1/resources/task_epics.js +71 -0
- package/dist/v1/resources/task_epics.js.map +1 -0
- package/dist/v1/resources/task_ownership_conversions.d.ts +14 -0
- package/dist/v1/resources/task_ownership_conversions.d.ts.map +1 -0
- package/dist/v1/resources/task_ownership_conversions.js +19 -0
- package/dist/v1/resources/task_ownership_conversions.js.map +1 -0
- package/dist/v1/resources/tasks.d.ts +122 -1
- package/dist/v1/resources/tasks.d.ts.map +1 -1
- package/dist/v1/resources/tasks.js +73 -1
- package/dist/v1/resources/tasks.js.map +1 -1
- package/dist/v1/resources/teams.d.ts +415 -1
- package/dist/v1/resources/teams.d.ts.map +1 -1
- package/dist/v1/resources/teams.js +137 -1
- package/dist/v1/resources/teams.js.map +1 -1
- package/dist/v1/resources/thread_messages.d.ts +15 -0
- package/dist/v1/resources/thread_messages.d.ts.map +1 -1
- package/dist/v1/resources/thread_messages.js +1 -1
- package/dist/v1/resources/thread_messages.js.map +1 -1
- package/dist/v1/resources/threads.d.ts +126 -0
- package/dist/v1/resources/threads.d.ts.map +1 -1
- package/dist/v1/resources/threads.js +43 -1
- package/dist/v1/resources/threads.js.map +1 -1
- package/dist/v1/resources/users.d.ts +372 -3
- package/dist/v1/resources/users.d.ts.map +1 -1
- package/dist/v1/resources/users.js +167 -3
- package/dist/v1/resources/users.js.map +1 -1
- package/dist/v1/resources/workflows.d.ts +5 -1
- package/dist/v1/resources/workflows.d.ts.map +1 -1
- package/dist/v1/resources/workflows.js +6 -2
- package/dist/v1/resources/workflows.js.map +1 -1
- package/dist/v1.d.ts +10 -0
- package/dist/v1.d.ts.map +1 -1
- package/dist/v1.js +16 -1
- package/dist/v1.js.map +1 -1
- package/package.json +1 -1
package/dist/types/common.js
CHANGED
|
@@ -1,12 +1,18 @@
|
|
|
1
1
|
// Copyright (c) 2026 ArchAstro Inc. Licensed under the MIT License.
|
|
2
2
|
// This file is auto-generated by @archastro/sdk-generator. Do not edit.
|
|
3
|
-
// Content hash:
|
|
3
|
+
// Content hash: e322067d3dcd
|
|
4
4
|
import { z } from "zod";
|
|
5
5
|
import { automationParticipantSlotSchema, automationPrefillsSchema } from "./automations.js";
|
|
6
|
+
import { computerRepositorySchema } from "./computers.js";
|
|
6
7
|
import { configSchema } from "./config.js";
|
|
7
8
|
import { imageSourceSchema } from "./image.js";
|
|
8
9
|
import { userSchema } from "./users.js";
|
|
9
10
|
import { workflowJournalSchema, workflowJournalEntrySchema } from "./workflows.js";
|
|
11
|
+
/** Runtime validator for {@link Refusal}. */
|
|
12
|
+
export const refusalSchema = z.object({
|
|
13
|
+
id: z.string(),
|
|
14
|
+
type: z.literal("refusal"),
|
|
15
|
+
}).describe("The model declined to judge this question.");
|
|
10
16
|
/** Runtime validator for {@link AclGrant}. */
|
|
11
17
|
export const aclGrantSchema = z.object({
|
|
12
18
|
/** Array of action strings the principal is permitted to perform, e.g. `["read", "write"]`. Must contain at least one entry. */
|
|
@@ -27,15 +33,23 @@ export const aclRemoveTargetSchema = z.object({
|
|
|
27
33
|
export const aclSchema = z.object({
|
|
28
34
|
/** Patch mode: grants to add or merge into the existing list. Cannot be combined with `grants`. */
|
|
29
35
|
add: z.array(aclGrantSchema).optional().describe("Patch mode: grants to add or merge into the existing list. Cannot be combined with `grants`."),
|
|
36
|
+
/** Patch mode: denies to add or merge, replacing any grant for the same principal. */
|
|
37
|
+
add_denies: z.array(aclGrantSchema).optional().describe("Patch mode: denies to add or merge, replacing any grant for the same principal."),
|
|
38
|
+
/** Replace mode: the complete deny list. Supplying grants or denies replaces both lists. Requires schema deny support. */
|
|
39
|
+
denies: z.array(aclGrantSchema).optional().describe("Replace mode: the complete deny list. Supplying grants or denies replaces both lists. Requires schema deny support."),
|
|
30
40
|
/** Replace mode: the complete new list of grants that replaces all existing entries. Send an empty array (`[]`) to clear all grants. Cannot be combined with `add` or `remove`. */
|
|
31
41
|
grants: z.array(aclGrantSchema).optional().describe("Replace mode: the complete new list of grants that replaces all existing entries. Send an empty array (`[]`) to clear all grants. Cannot be combined with `add` or `remove`."),
|
|
42
|
+
/** Retain current server denies atomically in replacement or patch mode; current denies win. */
|
|
43
|
+
preserve_denies: z.boolean().optional().describe("Retain current server denies atomically in replacement or patch mode; current denies win."),
|
|
32
44
|
/** Patch mode: principals whose grants should be removed from the existing list. Cannot be combined with `grants`. */
|
|
33
45
|
remove: z.array(aclRemoveTargetSchema).optional().describe("Patch mode: principals whose grants should be removed from the existing list. Cannot be combined with `grants`."),
|
|
46
|
+
/** Patch mode: principals whose denies should be removed. */
|
|
47
|
+
remove_denies: z.array(aclRemoveTargetSchema).optional().describe("Patch mode: principals whose denies should be removed."),
|
|
34
48
|
}).describe("An access-control list payload that supports either full replacement or targeted patch operations on a resource's grants.");
|
|
35
49
|
/** Runtime validator for {@link ActivityFeedEntry}. */
|
|
36
50
|
export const activityFeedEntrySchema = z.object({
|
|
37
51
|
/** The agent that produced this event. Returns an agent ID (`agi_...`) by default, or an expanded agent object when the association is loaded. `null` if no agent is associated. */
|
|
38
|
-
agent: z.union([z.string(), z.object({ acl: z.object({ add: z.array(z.object({ actions: z.array(z.string()), principal: z.string().optional(), principal_type: z.string() })).optional(), grants: z.array(z.object({ actions: z.array(z.string()), principal: z.string().optional(), principal_type: z.string() })).optional(), remove: z.array(z.object({ principal: z.string().optional(), principal_type: z.string() })).optional() }).nullable().optional(), app: z.string().optional(), created_at: z.string().optional(), default_model: z.string().nullable().optional(), description: z.string().nullable().optional(), email: z.string().nullable().optional(), id: z.string(), identity: z.string().nullable().optional(), last_applied_template_config: z.string().nullable().optional(), lookup_key: z.string().nullable().optional(), metadata: z.record(z.custom((value) => value !== undefined)).optional(), name: z.string().optional(), org: z.string().nullable().optional(), org_name: z.string().nullable().optional(), originator: z.string().nullable().optional(), phone_number: z.string().nullable().optional(), sandbox: z.string().nullable().optional(), source_solution: z.object({ current_solution: z.object({ category_keys: z.array(z.string()).optional(), created_at: z.string().optional(), description: z.string().nullable().optional(), events: z.record(z.custom((value) => value !== undefined)).optional(), id: z.string(), image_url: z.string().nullable().optional(), installed_config_ids: z.array(z.string()), kind: z.string(), latest_solution: z.string().nullable().optional(), latest_version: z.string().nullable().optional(), lookup_key: z.string().nullable().optional(), metadata: z.record(z.custom((value) => value !== undefined)).optional(), name: z.string().nullable().optional(), org: z.string().nullable().optional(), org_logo: z.object({ file: z.string().nullable().optional(), height: z.number().int().nullable().optional(), media: z.string().nullable().optional(), mime_type: z.string().nullable().optional(), refresh_url: z.string().nullable().optional(), url: z.string().nullable().optional(), width: z.number().int().nullable().optional() }).nullable().optional(), org_name: z.string().nullable().optional(), org_slug: z.string().nullable().optional(), owners: z.array(z.string()), readme_url: z.string().nullable().optional(), screenshot_urls: z.array(z.string()).optional(), solution_id: z.string().nullable().optional(), solution_version: z.string().nullable().optional(), tag_keys: z.array(z.string()).optional(), template_kind: z.string().nullable().optional(), templates: z.array(z.object({ description: z.string().nullable().optional(), details: z.object({ automation_type: z.string().nullable().optional(), invoke_contract: z.object({ input_schema: z.record(z.custom((value) => value !== undefined)).nullable().optional(), participants: z.array(z.object({ description: z.string().nullable().optional(), name: z.string(), required: z.boolean(), type: z.string() })).nullable().optional(), prefills: z.object({ participants: z.record(z.custom((value) => value !== undefined)).optional(), payload: z.record(z.custom((value) => value !== undefined)).optional() }) }).nullable().optional(), type: z.literal("automation") }).nullable().optional(), display_name: z.string().nullable().optional(), id: z.string().nullable().optional(), kind: z.string(), lookup_key: z.string().nullable().optional(), name: z.string().nullable().optional(), readme_url: z.string().nullable().optional(), virtual_path: z.string().nullable().optional() })), updated_at: z.string().optional(), upgrade_available: z.boolean(), virtual_path: z.string().nullable().optional() }).optional(), solution: z.object({ category_keys: z.array(z.string()).optional(), created_at: z.string().optional(), description: z.string().nullable().optional(), events: z.record(z.custom((value) => value !== undefined)).optional(), id: z.string(), image_url: z.string().nullable().optional(), installed_config_ids: z.array(z.string()), kind: z.string(), latest_solution: z.string().nullable().optional(), latest_version: z.string().nullable().optional(), lookup_key: z.string().nullable().optional(), metadata: z.record(z.custom((value) => value !== undefined)).optional(), name: z.string().nullable().optional(), org: z.string().nullable().optional(), org_logo: z.object({ file: z.string().nullable().optional(), height: z.number().int().nullable().optional(), media: z.string().nullable().optional(), mime_type: z.string().nullable().optional(), refresh_url: z.string().nullable().optional(), url: z.string().nullable().optional(), width: z.number().int().nullable().optional() }).nullable().optional(), org_name: z.string().nullable().optional(), org_slug: z.string().nullable().optional(), owners: z.array(z.string()), readme_url: z.string().nullable().optional(), screenshot_urls: z.array(z.string()).optional(), solution_id: z.string().nullable().optional(), solution_version: z.string().nullable().optional(), tag_keys: z.array(z.string()).optional(), template_kind: z.string().nullable().optional(), templates: z.array(z.object({ description: z.string().nullable().optional(), details: z.object({ automation_type: z.string().nullable().optional(), invoke_contract: z.object({ input_schema: z.record(z.custom((value) => value !== undefined)).nullable().optional(), participants: z.array(z.object({ description: z.string().nullable().optional(), name: z.string(), required: z.boolean(), type: z.string() })).nullable().optional(), prefills: z.object({ participants: z.record(z.custom((value) => value !== undefined)).optional(), payload: z.record(z.custom((value) => value !== undefined)).optional() }) }).nullable().optional(), type: z.literal("automation") }).nullable().optional(), display_name: z.string().nullable().optional(), id: z.string().nullable().optional(), kind: z.string(), lookup_key: z.string().nullable().optional(), name: z.string().nullable().optional(), readme_url: z.string().nullable().optional(), virtual_path: z.string().nullable().optional() })), updated_at: z.string().optional(), upgrade_available: z.boolean(), virtual_path: z.string().nullable().optional() }), template: z.object({ created_at: z.string().optional(), description: z.string().nullable().optional(), display_name: z.string().nullable().optional(), id: z.string(), kind: z.string(), lookup_key: z.string().nullable().optional(), name: z.string().nullable().optional(), updated_at: z.string().optional(), virtual_path: z.string().nullable().optional() }) }).nullable().optional(), team: z.string().nullable().optional(), template_upgrade_available: z.boolean().nullable().optional(), updated_at: z.string().optional(), user: z.string().nullable().optional() })]).optional().describe("The agent that produced this event. Returns an agent ID (`agi_...`) by default, or an expanded agent object when the association is loaded. `null` if no agent is associated."),
|
|
52
|
+
agent: z.union([z.string(), z.object({ acl: z.object({ add: z.array(z.object({ actions: z.array(z.string()), principal: z.string().optional(), principal_type: z.string() })).optional(), add_denies: z.array(z.object({ actions: z.array(z.string()), principal: z.string().optional(), principal_type: z.string() })).optional(), denies: z.array(z.object({ actions: z.array(z.string()), principal: z.string().optional(), principal_type: z.string() })).optional(), grants: z.array(z.object({ actions: z.array(z.string()), principal: z.string().optional(), principal_type: z.string() })).optional(), preserve_denies: z.boolean().optional(), remove: z.array(z.object({ principal: z.string().optional(), principal_type: z.string() })).optional(), remove_denies: z.array(z.object({ principal: z.string().optional(), principal_type: z.string() })).optional() }).nullable().optional(), app: z.string().optional(), created_at: z.string().optional(), default_model: z.string().nullable().optional(), description: z.string().nullable().optional(), email: z.string().nullable().optional(), id: z.string(), identity: z.string().nullable().optional(), last_applied_template_config: z.string().nullable().optional(), lookup_key: z.string().nullable().optional(), metadata: z.record(z.custom((value) => value !== undefined)).optional(), name: z.string().optional(), org: z.string().nullable().optional(), org_name: z.string().nullable().optional(), originator: z.string().nullable().optional(), phone_number: z.string().nullable().optional(), sandbox: z.string().nullable().optional(), source_solution: z.object({ current_solution: z.object({ category_keys: z.array(z.string()).optional(), created_at: z.string().optional(), description: z.string().nullable().optional(), events: z.record(z.custom((value) => value !== undefined)).optional(), id: z.string(), image_url: z.string().nullable().optional(), installed_config_ids: z.array(z.string()), kind: z.string(), latest_solution: z.string().nullable().optional(), latest_version: z.string().nullable().optional(), lookup_key: z.string().nullable().optional(), metadata: z.record(z.custom((value) => value !== undefined)).optional(), name: z.string().nullable().optional(), org: z.string().nullable().optional(), org_logo: z.object({ file: z.string().nullable().optional(), height: z.number().int().nullable().optional(), media: z.string().nullable().optional(), mime_type: z.string().nullable().optional(), refresh_url: z.string().nullable().optional(), url: z.string().nullable().optional(), width: z.number().int().nullable().optional() }).nullable().optional(), org_name: z.string().nullable().optional(), org_slug: z.string().nullable().optional(), owners: z.array(z.string()), readme_url: z.string().nullable().optional(), screenshot_urls: z.array(z.string()).optional(), solution_id: z.string().nullable().optional(), solution_version: z.string().nullable().optional(), tag_keys: z.array(z.string()).optional(), template_kind: z.string().nullable().optional(), templates: z.array(z.object({ description: z.string().nullable().optional(), details: z.object({ automation_type: z.string().nullable().optional(), invoke_contract: z.object({ input_schema: z.record(z.custom((value) => value !== undefined)).nullable().optional(), participants: z.array(z.object({ description: z.string().nullable().optional(), name: z.string(), required: z.boolean(), type: z.string() })).nullable().optional(), prefills: z.object({ participants: z.record(z.custom((value) => value !== undefined)).optional(), payload: z.record(z.custom((value) => value !== undefined)).optional() }) }).nullable().optional(), type: z.literal("automation") }).nullable().optional(), display_name: z.string().nullable().optional(), id: z.string().nullable().optional(), kind: z.string(), lookup_key: z.string().nullable().optional(), name: z.string().nullable().optional(), readme_url: z.string().nullable().optional(), virtual_path: z.string().nullable().optional() })), updated_at: z.string().optional(), upgrade_available: z.boolean(), virtual_path: z.string().nullable().optional() }).optional(), solution: z.object({ category_keys: z.array(z.string()).optional(), created_at: z.string().optional(), description: z.string().nullable().optional(), events: z.record(z.custom((value) => value !== undefined)).optional(), id: z.string(), image_url: z.string().nullable().optional(), installed_config_ids: z.array(z.string()), kind: z.string(), latest_solution: z.string().nullable().optional(), latest_version: z.string().nullable().optional(), lookup_key: z.string().nullable().optional(), metadata: z.record(z.custom((value) => value !== undefined)).optional(), name: z.string().nullable().optional(), org: z.string().nullable().optional(), org_logo: z.object({ file: z.string().nullable().optional(), height: z.number().int().nullable().optional(), media: z.string().nullable().optional(), mime_type: z.string().nullable().optional(), refresh_url: z.string().nullable().optional(), url: z.string().nullable().optional(), width: z.number().int().nullable().optional() }).nullable().optional(), org_name: z.string().nullable().optional(), org_slug: z.string().nullable().optional(), owners: z.array(z.string()), readme_url: z.string().nullable().optional(), screenshot_urls: z.array(z.string()).optional(), solution_id: z.string().nullable().optional(), solution_version: z.string().nullable().optional(), tag_keys: z.array(z.string()).optional(), template_kind: z.string().nullable().optional(), templates: z.array(z.object({ description: z.string().nullable().optional(), details: z.object({ automation_type: z.string().nullable().optional(), invoke_contract: z.object({ input_schema: z.record(z.custom((value) => value !== undefined)).nullable().optional(), participants: z.array(z.object({ description: z.string().nullable().optional(), name: z.string(), required: z.boolean(), type: z.string() })).nullable().optional(), prefills: z.object({ participants: z.record(z.custom((value) => value !== undefined)).optional(), payload: z.record(z.custom((value) => value !== undefined)).optional() }) }).nullable().optional(), type: z.literal("automation") }).nullable().optional(), display_name: z.string().nullable().optional(), id: z.string().nullable().optional(), kind: z.string(), lookup_key: z.string().nullable().optional(), name: z.string().nullable().optional(), readme_url: z.string().nullable().optional(), virtual_path: z.string().nullable().optional() })), updated_at: z.string().optional(), upgrade_available: z.boolean(), virtual_path: z.string().nullable().optional() }), template: z.object({ created_at: z.string().optional(), description: z.string().nullable().optional(), display_name: z.string().nullable().optional(), id: z.string(), kind: z.string(), lookup_key: z.string().nullable().optional(), name: z.string().nullable().optional(), updated_at: z.string().optional(), virtual_path: z.string().nullable().optional() }) }).nullable().optional(), team: z.string().nullable().optional(), template_upgrade_available: z.boolean().nullable().optional(), updated_at: z.string().optional(), user: z.string().nullable().optional() })]).optional().describe("The agent that produced this event. Returns an agent ID (`agi_...`) by default, or an expanded agent object when the association is loaded. `null` if no agent is associated."),
|
|
39
53
|
/** ID of the application that produced this entry (`dap_...`). `null` if not scoped to an app. */
|
|
40
54
|
app: z.string().optional().describe("ID of the application that produced this entry (`dap_...`). `null` if not scoped to an app."),
|
|
41
55
|
/** Array of attachment objects associated with this entry. Each attachment has a `type` field (e.g. `"file"`, `"task"`, `"artifact"`) and type-specific additional fields. Empty array when there are no attachments. */
|
|
@@ -129,6 +143,51 @@ export const installedConfigEntrySchema = z.object({
|
|
|
129
143
|
/** Stored `lookup_key` for this config after any suffix has been applied. `null` for `File` children inside a skill bundle, which are keyed by `(parent_id, relative_path)` rather than by `lookup_key`. */
|
|
130
144
|
lookup_key: z.string().nullable().optional().describe("Stored `lookup_key` for this config after any suffix has been applied. `null` for `File` children inside a skill bundle, which are keyed by `(parent_id, relative_path)` rather than by `lookup_key`."),
|
|
131
145
|
}).describe("A slim summary of a single config record created during an agent install transaction. Returned as an entry in `AgentCreateResponse.installed_configs`.");
|
|
146
|
+
/** Runtime validator for {@link Approvers}. */
|
|
147
|
+
export const approversSchema = z.object({
|
|
148
|
+
mode: z.string(),
|
|
149
|
+
}).describe("Approval policy, excluding user IDs.");
|
|
150
|
+
/** Runtime validator for {@link Origin}. */
|
|
151
|
+
export const originSchema = z.object({
|
|
152
|
+
routine_id: z.string().nullable().optional(),
|
|
153
|
+
session_id: z.string().nullable().optional(),
|
|
154
|
+
thread_id: z.string().nullable().optional(),
|
|
155
|
+
}).describe("Origin references.");
|
|
156
|
+
/** Runtime validator for {@link SelfUpdateChange}. */
|
|
157
|
+
export const selfUpdateChangeSchema = z.object({
|
|
158
|
+
action: z.string().optional(),
|
|
159
|
+
class: z.string().optional(),
|
|
160
|
+
path: z.string().optional(),
|
|
161
|
+
tier: z.string().optional(),
|
|
162
|
+
}).describe("Public review fields for one proposed self-update change.");
|
|
163
|
+
/** Runtime validator for {@link Payload}. */
|
|
164
|
+
export const payloadSchema = z.object({
|
|
165
|
+
changes: z.array(selfUpdateChangeSchema).optional(),
|
|
166
|
+
from_version: z.string().optional(),
|
|
167
|
+
instructions_md: z.string().optional(),
|
|
168
|
+
key: z.string().optional(),
|
|
169
|
+
overwrite: z.boolean().optional(),
|
|
170
|
+
prompt: z.string().optional(),
|
|
171
|
+
proposal_id: z.string().optional(),
|
|
172
|
+
question: z.string().optional(),
|
|
173
|
+
rationale: z.string().optional(),
|
|
174
|
+
to_version: z.string().optional(),
|
|
175
|
+
validate_script: z.string().optional(),
|
|
176
|
+
}).describe("Kind-safe request payload.");
|
|
177
|
+
/** Runtime validator for {@link Resolution}. */
|
|
178
|
+
export const resolutionSchema = z.object({
|
|
179
|
+
answer: z.string().optional(),
|
|
180
|
+
key: z.string().optional(),
|
|
181
|
+
reason: z.string().optional(),
|
|
182
|
+
set: z.boolean().optional(),
|
|
183
|
+
status: z.string().optional(),
|
|
184
|
+
to_version: z.string().optional(),
|
|
185
|
+
}).describe("Answer or rejection reason; null before resolution.");
|
|
186
|
+
/** Runtime validator for {@link Summary}. */
|
|
187
|
+
export const summarySchema = z.object({
|
|
188
|
+
lines: z.array(z.string()),
|
|
189
|
+
title: z.string(),
|
|
190
|
+
}).describe("Kind-provided summary.");
|
|
132
191
|
/** Runtime validator for {@link MessagePolicy}. */
|
|
133
192
|
export const messagePolicySchema = z.object({
|
|
134
193
|
/** Required and non-empty for private visibility. Sources are additive. Routine owner includes the agent owner and optional user co-owner. */
|
|
@@ -174,10 +233,14 @@ export const setupSchema = z.object({
|
|
|
174
233
|
}).describe("Current MCP setup assessment, not a historical downgrade reason or upstream protocol probe.");
|
|
175
234
|
/** Runtime validator for {@link MediaVariant}. */
|
|
176
235
|
export const mediaVariantSchema = z.object({
|
|
236
|
+
/** Size of the stored bytes. */
|
|
237
|
+
byte_size: z.number().int().nullable().optional().describe("Size of the stored bytes."),
|
|
177
238
|
/** MIME type of this variant's file (e.g., `"image/jpeg"`, `"video/mp4"`). `null` if the file is not loaded. */
|
|
178
239
|
content_type: z.string().nullable().optional().describe("MIME type of this variant's file (e.g., `\"image/jpeg\"`, `\"video/mp4\"`). `null` if the file is not loaded."),
|
|
179
240
|
/** When this variant was created (ISO 8601). */
|
|
180
241
|
created_at: z.string().optional().describe("When this variant was created (ISO 8601)."),
|
|
242
|
+
/** Client-declared video duration in milliseconds; not server-probed. */
|
|
243
|
+
duration_ms: z.number().int().nullable().optional().describe("Client-declared video duration in milliseconds; not server-probed."),
|
|
181
244
|
/** ID of the underlying storage file that backs this variant (`fil_...`). */
|
|
182
245
|
file: z.string().optional().describe("ID of the underlying storage file that backs this variant (`fil_...`)."),
|
|
183
246
|
/** Original filename of the uploaded file for this variant. `null` if the file is not loaded. */
|
|
@@ -188,10 +251,14 @@ export const mediaVariantSchema = z.object({
|
|
|
188
251
|
id: z.string().describe("Media variant ID (`mvr_...`)."),
|
|
189
252
|
/** Resolved image delivery metadata for this variant, including dimensions and CDN URL. `null` for non-image content types. */
|
|
190
253
|
image_source: imageSourceSchema.nullable().optional().describe("Resolved image delivery metadata for this variant, including dimensions and CDN URL. `null` for non-image content types."),
|
|
254
|
+
/** Lowercase SHA-256 of the stored bytes. */
|
|
255
|
+
sha256: z.string().nullable().optional().describe("Lowercase SHA-256 of the stored bytes."),
|
|
191
256
|
/** When this variant was last updated (ISO 8601). */
|
|
192
257
|
updated_at: z.string().optional().describe("When this variant was last updated (ISO 8601)."),
|
|
193
258
|
/** Signed download URL for this variant, resolved at request time. `null` if the file is unavailable. */
|
|
194
259
|
url: z.string().nullable().optional().describe("Signed download URL for this variant, resolved at request time. `null` if the file is unavailable."),
|
|
260
|
+
/** Expiry of this variant's playable URL. */
|
|
261
|
+
url_expires_at: z.string().nullable().optional().describe("Expiry of this variant's playable URL."),
|
|
195
262
|
/** Identifier for this variant's processing tier. Common values include `"original"` (the unmodified upload) and `"thumbnail"` (a resized preview). */
|
|
196
263
|
variant_key: z.string().optional().describe("Identifier for this variant's processing tier. Common values include `\"original\"` (the unmodified upload) and `\"thumbnail\"` (a resized preview)."),
|
|
197
264
|
/** Width of this variant in pixels. `null` if not recorded. */
|
|
@@ -422,13 +489,6 @@ export const commandSchema = z.object({
|
|
|
422
489
|
/** JSON Schema describing the shape of a successful output. `null` if the command produces no output on success. */
|
|
423
490
|
successOutput: z.record(z.custom((value) => value !== undefined)).optional().describe("JSON Schema describing the shape of a successful output. `null` if the command produces no output on success."),
|
|
424
491
|
}).describe("A workflow command that a workflow node can invoke, including its identifier, human-readable name, and JSON schemas for its inputs and outputs.");
|
|
425
|
-
/** Runtime validator for {@link ComputerExecResult}. */
|
|
426
|
-
export const computerExecResultSchema = z.object({
|
|
427
|
-
/** The UNIX exit code returned by the process. `0` indicates success; any non-zero value indicates an error. `null` if the process did not terminate normally. */
|
|
428
|
-
exit_code: z.number().int().optional().describe("The UNIX exit code returned by the process. `0` indicates success; any non-zero value indicates an error. `null` if the process did not terminate normally."),
|
|
429
|
-
/** The combined stdout and stderr output produced by the command. `null` if the command produced no output. */
|
|
430
|
-
output: z.string().optional().describe("The combined stdout and stderr output produced by the command. `null` if the command produced no output."),
|
|
431
|
-
}).describe("The result of executing a shell command on an agent's computer environment. Contains the captured output and the process exit code.");
|
|
432
492
|
/** Runtime validator for {@link ContextDocument}. */
|
|
433
493
|
export const contextDocumentSchema = z.object({
|
|
434
494
|
/** ID of the agent that owns this document (`agi_...`). `null` if owned by a user or team. */
|
|
@@ -547,12 +607,20 @@ export const effectiveAccessEntitlementSchema = z.object({
|
|
|
547
607
|
granted: z.boolean().describe("Whether any eligible source grants the key."),
|
|
548
608
|
/** Stable entitlement catalog key. */
|
|
549
609
|
key: z.string().describe("Stable entitlement catalog key."),
|
|
610
|
+
/** Unexpired metered allowance, including exhausted grants; null for boolean entitlements. */
|
|
611
|
+
limit: z.number().int().nullable().optional().describe("Unexpired metered allowance, including exhausted grants; null for boolean entitlements."),
|
|
550
612
|
/** Privacy-safe principal kinds that contribute to the effective value. */
|
|
551
613
|
provided_by: z.array(z.enum(["personal", "organization"])).describe("Privacy-safe principal kinds that contribute to the effective value."),
|
|
614
|
+
/** Effective purchased quantity from the recurring terms linked to this key (for example seats), summed across granting principals. `null` when the key is not granted or no granting plan links a term to it. */
|
|
615
|
+
quantity: z.number().int().nullable().optional().describe("Effective purchased quantity from the recurring terms linked to this key (for example seats), summed across granting principals. `null` when the key is not granted or no granting plan links a term to it."),
|
|
616
|
+
/** Remaining metered allowance credits; null for boolean entitlements. */
|
|
617
|
+
remaining: z.number().int().nullable().optional().describe("Remaining metered allowance credits; null for boolean entitlements."),
|
|
618
|
+
/** Signed metered consumption in the allowance window; may be negative after reversals. Null for boolean entitlements. */
|
|
619
|
+
used: z.number().int().nullable().optional().describe("Signed metered consumption in the allowance window; may be negative after reversals. Null for boolean entitlements."),
|
|
552
620
|
/** Merged entitlement value, or `null` when the key is not granted. */
|
|
553
621
|
value: z.boolean().nullable().optional().describe("Merged entitlement value, or `null` when the key is not granted."),
|
|
554
622
|
/** Catalog type used to interpret `value`. */
|
|
555
|
-
value_type: z.
|
|
623
|
+
value_type: z.enum(["boolean", "metered"]).describe("Catalog type used to interpret `value`."),
|
|
556
624
|
}).describe("A billing-derived effective entitlement for the authenticated user.");
|
|
557
625
|
/** Runtime validator for {@link EffectiveAccess}. */
|
|
558
626
|
export const effectiveAccessSchema = z.object({
|
|
@@ -569,6 +637,8 @@ export const currentUserSchema = z.object({
|
|
|
569
637
|
app: z.string().nullable().optional().describe("ID of the token-scoped app (`dap_...`)."),
|
|
570
638
|
/** Display name of the token-scoped app. */
|
|
571
639
|
app_name: z.string().nullable().optional().describe("Display name of the token-scoped app."),
|
|
640
|
+
/** Stable public URL of the profile picture. Unlike `profile_picture.url` it does not expire, so clients can store it; it stops resolving when the picture is replaced. `null` when the user has no profile picture. */
|
|
641
|
+
avatar_url: z.string().nullable().optional().describe("Stable public URL of the profile picture. Unlike `profile_picture.url` it does not expire, so clients can store it; it stops resolving when the picture is replaced. `null` when the user has no profile picture."),
|
|
572
642
|
/** Present only when the request supplies one or more `entitlement[]` values. */
|
|
573
643
|
effective_access: effectiveAccessSchema.optional().describe("Present only when the request supplies one or more `entitlement[]` values."),
|
|
574
644
|
/** Email address of the user. */
|
|
@@ -583,6 +653,8 @@ export const currentUserSchema = z.object({
|
|
|
583
653
|
name: z.string().nullable().optional().describe("Full display name of the user."),
|
|
584
654
|
/** The authenticated user's notification preferences. */
|
|
585
655
|
notification_settings: z.record(z.custom((value) => value !== undefined)).describe("The authenticated user's notification preferences."),
|
|
656
|
+
/** Registered display name of the verified OAuth client, when available. Not a verified vendor identity. */
|
|
657
|
+
oauth_client_name: z.string().optional().describe("Registered display name of the verified OAuth client, when available. Not a verified vendor identity."),
|
|
586
658
|
/** ID of the current organization (`org_...`). */
|
|
587
659
|
org: z.string().nullable().optional().describe("ID of the current organization (`org_...`)."),
|
|
588
660
|
/** Whether the current organization is company-domain or person-owned. */
|
|
@@ -606,8 +678,12 @@ export const currentUserSchema = z.object({
|
|
|
606
678
|
export const customObjectSchema = z.object({
|
|
607
679
|
/** Access control list governing read and write access to this custom object. Only returned to resource owners and privileged or organization-admin viewers; `null` for everyone else. */
|
|
608
680
|
acl: aclSchema.optional().describe("Access control list governing read and write access to this custom object. Only returned to resource owners and privileged or organization-admin viewers; `null` for everyone else."),
|
|
681
|
+
/** ID of the agent that owns this object (`agt_...`). `null` for other ownership types. */
|
|
682
|
+
agent: z.string().optional().describe("ID of the agent that owns this object (`agt_...`). `null` for other ownership types."),
|
|
609
683
|
/** When the custom object was created (ISO 8601). */
|
|
610
684
|
created_at: z.string().optional().describe("When the custom object was created (ISO 8601)."),
|
|
685
|
+
/** Absolute expiry time (RFC 3339). Null when no expiry is set. */
|
|
686
|
+
expires_at: z.string().nullable().optional().describe("Absolute expiry time (RFC 3339). Null when no expiry is set."),
|
|
611
687
|
/** Map of field names to their current values as defined by the object's schema type. */
|
|
612
688
|
fields: z.record(z.custom((value) => value !== undefined)).optional().describe("Map of field names to their current values as defined by the object's schema type."),
|
|
613
689
|
/** Unique identifier for the custom object (`cobj_...`). */
|
|
@@ -654,10 +730,10 @@ export const customObjectListResponseSchema = z.object({
|
|
|
654
730
|
page: z.number().int().describe("The current page number (1-indexed)."),
|
|
655
731
|
/** Maximum number of results returned per page. */
|
|
656
732
|
page_size: z.number().int().describe("Maximum number of results returned per page."),
|
|
657
|
-
/** Total number of custom objects matching the query across all pages. */
|
|
658
|
-
total_entries: z.number().int().describe("Total number of custom objects matching the query across all pages."),
|
|
659
|
-
/** Total number of pages available for the current query. */
|
|
660
|
-
total_pages: z.number().int().describe("Total number of pages available for the current query."),
|
|
733
|
+
/** Total number of custom objects matching the query across all pages; null when include_count is false. */
|
|
734
|
+
total_entries: z.number().int().nullable().describe("Total number of custom objects matching the query across all pages; null when include_count is false."),
|
|
735
|
+
/** Total number of pages available for the current query; null when include_count is false. */
|
|
736
|
+
total_pages: z.number().int().nullable().describe("Total number of pages available for the current query; null when include_count is false."),
|
|
661
737
|
}).describe("A paginated page of custom objects returned by a list operation. Use the pagination fields to navigate through result sets.");
|
|
662
738
|
/** Runtime validator for {@link CustomObjectPresenceAck}. */
|
|
663
739
|
export const customObjectPresenceAckSchema = z.object({
|
|
@@ -898,27 +974,43 @@ export const installationSourceListResponseSchema = z.object({
|
|
|
898
974
|
}).describe("Paginated list response containing installation source objects attached to an installation.");
|
|
899
975
|
/** Runtime validator for {@link KeyValueStorageEntry}. */
|
|
900
976
|
export const keyValueStorageEntrySchema = z.object({
|
|
977
|
+
/** Agent owner, if any. */
|
|
978
|
+
agent: z.string().optional().describe("Agent owner, if any."),
|
|
901
979
|
/** When this storage entry was first created (ISO 8601). `null` if not yet persisted. */
|
|
902
980
|
created_at: z.string().optional().describe("When this storage entry was first created (ISO 8601). `null` if not yet persisted."),
|
|
981
|
+
/** Expiry deadline, or null for entries without expiry. */
|
|
982
|
+
expires_at: z.string().optional().describe("Expiry deadline, or null for entries without expiry."),
|
|
903
983
|
/** The string key used to store and look up this entry. */
|
|
904
984
|
key: z.string().describe("The string key used to store and look up this entry."),
|
|
985
|
+
/** Organization scope. */
|
|
986
|
+
org: z.string().optional().describe("Organization scope."),
|
|
987
|
+
/** Team owner, if any. */
|
|
988
|
+
team: z.string().optional().describe("Team owner, if any."),
|
|
905
989
|
/** When this storage entry was last updated (ISO 8601). `null` if not yet persisted. */
|
|
906
990
|
updated_at: z.string().optional().describe("When this storage entry was last updated (ISO 8601). `null` if not yet persisted."),
|
|
907
|
-
/** ID of the user
|
|
908
|
-
user: z.string().describe("ID of the user
|
|
991
|
+
/** ID of the user owner, or null for non-user ownership. */
|
|
992
|
+
user: z.string().optional().describe("ID of the user owner, or null for non-user ownership."),
|
|
909
993
|
/** The string value stored under `key` for this user. */
|
|
910
994
|
value: z.string().describe("The string value stored under `key` for this user."),
|
|
911
|
-
}).describe("
|
|
995
|
+
}).describe("An owner-scoped key/value pair within an app, optionally expiring.");
|
|
912
996
|
/** Runtime validator for {@link KeyValueStorageEntryWithUser}. */
|
|
913
997
|
export const keyValueStorageEntryWithUserSchema = z.object({
|
|
998
|
+
/** Agent owner, if any. */
|
|
999
|
+
agent: z.string().optional().describe("Agent owner, if any."),
|
|
914
1000
|
/** When this storage entry was first created (ISO 8601). */
|
|
915
1001
|
created_at: z.string().describe("When this storage entry was first created (ISO 8601)."),
|
|
1002
|
+
/** Expiry deadline, or null for entries without expiry. */
|
|
1003
|
+
expires_at: z.string().optional().describe("Expiry deadline, or null for entries without expiry."),
|
|
916
1004
|
/** The string key used to store and look up this entry. */
|
|
917
1005
|
key: z.string().describe("The string key used to store and look up this entry."),
|
|
1006
|
+
/** Organization scope. */
|
|
1007
|
+
org: z.string().optional().describe("Organization scope."),
|
|
1008
|
+
/** Team owner, if any. */
|
|
1009
|
+
team: z.string().optional().describe("Team owner, if any."),
|
|
918
1010
|
/** When this storage entry was last updated (ISO 8601). */
|
|
919
1011
|
updated_at: z.string().describe("When this storage entry was last updated (ISO 8601)."),
|
|
920
|
-
/** ID of the user
|
|
921
|
-
user: z.string().describe("ID of the user
|
|
1012
|
+
/** ID of the user owner, or null for non-user ownership. */
|
|
1013
|
+
user: z.string().optional().describe("ID of the user owner, or null for non-user ownership."),
|
|
922
1014
|
/** Email address of the owning user. `null` for end-user (user-JWT) callers; populated for developer and server-to-server callers. */
|
|
923
1015
|
user_email: z.string().optional().describe("Email address of the owning user. `null` for end-user (user-JWT) callers; populated for developer and server-to-server callers."),
|
|
924
1016
|
/** Display name of the owning user. `null` for end-user (user-JWT) callers; populated for developer and server-to-server callers. */
|
|
@@ -1517,33 +1609,41 @@ export const agentSchema = z.object({
|
|
|
1517
1609
|
/** Runtime validator for {@link AgentComputer}. */
|
|
1518
1610
|
export const agentComputerSchema = z.object({
|
|
1519
1611
|
/** ID of the agent that owns this computer (`agi_...`). `null` if the computer is not yet assigned to an agent. */
|
|
1520
|
-
agent: z.string().optional().describe("ID of the agent that owns this computer (`agi_...`). `null` if the computer is not yet assigned to an agent."),
|
|
1612
|
+
agent: z.string().nullable().optional().describe("ID of the agent that owns this computer (`agi_...`). `null` if the computer is not yet assigned to an agent."),
|
|
1521
1613
|
/** ID of the app this computer belongs to (`dap_...`). */
|
|
1522
1614
|
app: z.string().optional().describe("ID of the app this computer belongs to (`dap_...`)."),
|
|
1615
|
+
/** Bootstrap results, including each repository's status, commit and error. */
|
|
1616
|
+
bootstrap: z.record(z.custom((value) => value !== undefined)).optional().describe("Bootstrap results, including each repository's status, commit and error."),
|
|
1523
1617
|
/** Provider-specific configuration key-value pairs for the computer. Structure depends on the underlying compute provider. */
|
|
1524
1618
|
config: z.record(z.custom((value) => value !== undefined)).optional().describe("Provider-specific configuration key-value pairs for the computer. Structure depends on the underlying compute provider."),
|
|
1525
1619
|
/** When the computer was created (ISO 8601). */
|
|
1526
1620
|
created_at: z.string().optional().describe("When the computer was created (ISO 8601)."),
|
|
1527
1621
|
/** Human-readable error description when `status` is `"error"`. `null` otherwise. */
|
|
1528
|
-
error_message: z.string().optional().describe("Human-readable error description when `status` is `\"error\"`. `null` otherwise."),
|
|
1622
|
+
error_message: z.string().nullable().optional().describe("Human-readable error description when `status` is `\"error\"`. `null` otherwise."),
|
|
1529
1623
|
/** Computer ID (`cmp_...`). */
|
|
1530
1624
|
id: z.string().describe("Computer ID (`cmp_...`)."),
|
|
1625
|
+
/** Stable key unique within the thread, or null if unset. */
|
|
1626
|
+
key: z.string().nullable().optional().describe("Stable key unique within the thread, or null if unset."),
|
|
1531
1627
|
/** When the computer last reported activity or received a command. `null` if the computer has never been active. */
|
|
1532
|
-
last_active_at: z.string().optional().describe("When the computer last reported activity or received a command. `null` if the computer has never been active."),
|
|
1628
|
+
last_active_at: z.string().nullable().optional().describe("When the computer last reported activity or received a command. `null` if the computer has never been active."),
|
|
1533
1629
|
/** Unique, stable identifier you assign to this computer within its app. `null` if not set. */
|
|
1534
|
-
lookup_key: z.string().optional().describe("Unique, stable identifier you assign to this computer within its app. `null` if not set."),
|
|
1630
|
+
lookup_key: z.string().nullable().optional().describe("Unique, stable identifier you assign to this computer within its app. `null` if not set."),
|
|
1535
1631
|
/** Arbitrary key-value metadata you attached to the computer. `null` if none was provided. */
|
|
1536
1632
|
metadata: z.record(z.custom((value) => value !== undefined)).optional().describe("Arbitrary key-value metadata you attached to the computer. `null` if none was provided."),
|
|
1537
1633
|
/** Human-readable display name for the computer. `null` if not set. */
|
|
1538
1634
|
name: z.string().optional().describe("Human-readable display name for the computer. `null` if not set."),
|
|
1539
|
-
/** Compute backend powering this computer: `"sprites"` (Fly Sprites)
|
|
1540
|
-
provider: z.string().optional().describe("Compute backend powering this computer: `\"sprites\"` (Fly Sprites)
|
|
1541
|
-
/** Cloud region where the computer is hosted, e.g. `"us-east-1"`. `null` if not yet assigned or when the provider has no region concept (e.g. `"vercel"`). */
|
|
1542
|
-
region: z.string().optional().describe("Cloud region where the computer is hosted, e.g. `\"us-east-1\"`. `null` if not yet assigned or when the provider has no region concept (e.g. `\"vercel\"`)."),
|
|
1635
|
+
/** Compute backend powering this computer: `"sprites"` (Fly Sprites), `"vercel"` (Vercel Sandbox), `"e2b"` (E2B) or `"devbox"` (an ArchAstro devbox owned by the computer's user). */
|
|
1636
|
+
provider: z.string().optional().describe("Compute backend powering this computer: `\"sprites\"` (Fly Sprites), `\"vercel\"` (Vercel Sandbox), `\"e2b\"` (E2B) or `\"devbox\"` (an ArchAstro devbox owned by the computer's user)."),
|
|
1637
|
+
/** Cloud region where the computer is hosted, e.g. `"us-east-1"`. `null` if not yet assigned or when the provider has no region concept (e.g. `"vercel"`, `"e2b"`). */
|
|
1638
|
+
region: z.string().nullable().optional().describe("Cloud region where the computer is hosted, e.g. `\"us-east-1\"`. `null` if not yet assigned or when the provider has no region concept (e.g. `\"vercel\"`, `\"e2b\"`)."),
|
|
1639
|
+
/** Ordered GitHub checkouts with repository and nullable ref; the first checkout is primary. */
|
|
1640
|
+
repositories: z.array(computerRepositorySchema).optional().describe("Ordered GitHub checkouts with repository and nullable ref; the first checkout is primary."),
|
|
1543
1641
|
/** URL of the live screenshot sprite used to render a real-time preview of the computer's screen. `null` when no sprite is available. */
|
|
1544
|
-
sprite_url: z.string().optional().describe("URL of the live screenshot sprite used to render a real-time preview of the computer's screen. `null` when no sprite is available."),
|
|
1545
|
-
/** Current lifecycle state of the computer. Common values include `"provisioning"`, `"ready"`, `"error"`, and `"
|
|
1546
|
-
status: z.string().optional().describe("Current lifecycle state of the computer. Common values include `\"provisioning\"`, `\"ready\"`, `\"error\"`, and `\"
|
|
1642
|
+
sprite_url: z.string().nullable().optional().describe("URL of the live screenshot sprite used to render a real-time preview of the computer's screen. `null` when no sprite is available."),
|
|
1643
|
+
/** Current lifecycle state of the computer. Common values include `"provisioning"`, `"ready"`, `"paused"` (resumes on use), `"error"`, and `"destroyed"`. */
|
|
1644
|
+
status: z.string().nullable().optional().describe("Current lifecycle state of the computer. Common values include `\"provisioning\"`, `\"ready\"`, `\"paused\"` (resumes on use), `\"error\"`, and `\"destroyed\"`."),
|
|
1645
|
+
/** Thread this computer belongs to, or null for a non-thread computer. */
|
|
1646
|
+
thread_id: z.string().nullable().optional().describe("Thread this computer belongs to, or null for a non-thread computer."),
|
|
1547
1647
|
/** When the computer record was last modified (ISO 8601). */
|
|
1548
1648
|
updated_at: z.string().optional().describe("When the computer record was last modified (ISO 8601)."),
|
|
1549
1649
|
}).describe("A cloud computer resource provisioned for an agent to use for browser and desktop automation tasks.");
|
|
@@ -1658,6 +1758,47 @@ export const agentListResponseSchema = z.object({
|
|
|
1658
1758
|
/** Total number of pages available given the current `page_size`. */
|
|
1659
1759
|
total_pages: z.number().int().optional().describe("Total number of pages available given the current `page_size`."),
|
|
1660
1760
|
}).describe("Paginated list of agent objects. Use the pagination fields to traverse multiple pages of results.");
|
|
1761
|
+
/** Runtime validator for {@link AgentRequestAgent}. */
|
|
1762
|
+
export const agentRequestAgentSchema = z.object({
|
|
1763
|
+
id: z.string(),
|
|
1764
|
+
name: z.string().nullable().optional(),
|
|
1765
|
+
}).describe("Originating agent.");
|
|
1766
|
+
/** Runtime validator for {@link AgentRequest}. */
|
|
1767
|
+
export const agentRequestSchema = z.object({
|
|
1768
|
+
/** Originating agent. */
|
|
1769
|
+
agent: agentRequestAgentSchema.optional().describe("Originating agent."),
|
|
1770
|
+
/** Approval policy, excluding user IDs. */
|
|
1771
|
+
approvers: approversSchema.optional().describe("Approval policy, excluding user IDs."),
|
|
1772
|
+
/** Expiration time. */
|
|
1773
|
+
expires_at: z.string().optional().describe("Expiration time."),
|
|
1774
|
+
/** Request ID (`arq_...`). */
|
|
1775
|
+
id: z.string().describe("Request ID (`arq_...`)."),
|
|
1776
|
+
/** Whether the authenticated caller is an approver, regardless of request status. */
|
|
1777
|
+
is_approver: z.boolean().optional().describe("Whether the authenticated caller is an approver, regardless of request status."),
|
|
1778
|
+
/** Registered request kind. */
|
|
1779
|
+
kind: z.string().optional().describe("Registered request kind."),
|
|
1780
|
+
/** Origin references. */
|
|
1781
|
+
origin: originSchema.optional().describe("Origin references."),
|
|
1782
|
+
/** Kind-safe request payload. */
|
|
1783
|
+
payload: payloadSchema.optional().describe("Kind-safe request payload."),
|
|
1784
|
+
/** Answer or rejection reason; null before resolution. */
|
|
1785
|
+
resolution: resolutionSchema.nullable().optional().describe("Answer or rejection reason; null before resolution."),
|
|
1786
|
+
/** Resolution time. */
|
|
1787
|
+
resolved_at: z.string().optional().describe("Resolution time."),
|
|
1788
|
+
/** Resolving user ID. */
|
|
1789
|
+
resolved_by: z.string().optional().describe("Resolving user ID."),
|
|
1790
|
+
/** Request status. */
|
|
1791
|
+
status: z.string().optional().describe("Request status."),
|
|
1792
|
+
/** Kind-provided summary. */
|
|
1793
|
+
summary: summarySchema.optional().describe("Kind-provided summary."),
|
|
1794
|
+
}).describe("A request for human approval or input. Secret input is never returned.");
|
|
1795
|
+
/** Runtime validator for {@link AgentRequestListResponse}. */
|
|
1796
|
+
export const agentRequestListResponseSchema = z.object({
|
|
1797
|
+
/** Visible requests. */
|
|
1798
|
+
data: z.array(agentRequestSchema).describe("Visible requests."),
|
|
1799
|
+
/** Pass as cursor for the next page; null at the end. */
|
|
1800
|
+
next_cursor: z.string().optional().describe("Pass as cursor for the next page; null at the end."),
|
|
1801
|
+
}).describe("A page of visible agent requests.");
|
|
1661
1802
|
/** Runtime validator for {@link AgentRoutine}. */
|
|
1662
1803
|
export const agentRoutineSchema = z.object({
|
|
1663
1804
|
/** Access control list for the routine. Contains a `grants` array where each entry specifies `principal_type`, `principal`, and `actions` (`"read"`, `"invoke"`, or `"assign"` — an `"assign"` grant names the agents or orgs that may be handed this routine's embedded work items). `null` when no ACL restrictions are applied and the routine is accessible to all members of its scope. */
|
|
@@ -1851,6 +1992,19 @@ export const agentSessionSchema = z.object({
|
|
|
1851
1992
|
/** ID of the trajectory that records the full message history for this session (`trj_...`). `null` until the session has started. */
|
|
1852
1993
|
trajectory: z.string().optional().describe("ID of the trajectory that records the full message history for this session (`trj_...`). `null` until the session has started."),
|
|
1853
1994
|
}).describe("A durable agent session record representing a single AI task execution. Tracks status, trajectory, result, and any inbox messages delivered to the session.");
|
|
1995
|
+
/** Runtime validator for {@link AgentSessionEvent}. */
|
|
1996
|
+
export const agentSessionEventSchema = z.object({
|
|
1997
|
+
/** Event name: `session_started`, `message`, `tool_use`, `needs_input`, `activity`, `error`, `turn_complete`, `finished`, `adopted`, or `harness_raw`. */
|
|
1998
|
+
event: z.string().optional().describe("Event name: `session_started`, `message`, `tool_use`, `needs_input`, `activity`, `error`, `turn_complete`, `finished`, `adopted`, or `harness_raw`."),
|
|
1999
|
+
/** Harness that emitted it. */
|
|
2000
|
+
harness: z.string().nullable().optional().describe("Harness that emitted it."),
|
|
2001
|
+
/** Event ID; pass as `after` to page. */
|
|
2002
|
+
id: z.string().optional().describe("Event ID; pass as `after` to page."),
|
|
2003
|
+
/** When the event happened in the sandbox. */
|
|
2004
|
+
occurred_at: z.string().optional().describe("When the event happened in the sandbox."),
|
|
2005
|
+
/** Harness-specific event data. */
|
|
2006
|
+
payload: z.record(z.custom((value) => value !== undefined)).nullable().optional().describe("Harness-specific event data."),
|
|
2007
|
+
}).describe("One event from the coding harness running an agent session on a computer.");
|
|
1854
2008
|
/** Runtime validator for {@link AgentSessionListResponse}. */
|
|
1855
2009
|
export const agentSessionListResponseSchema = z.object({
|
|
1856
2010
|
/** Array of agent session objects for the current page. */
|
|
@@ -1967,8 +2121,8 @@ export const agentUpgradeChangeSchema = z.object({
|
|
|
1967
2121
|
parent_template_config: upgradeTemplateSummarySchema.describe("Summary of the parent AgentTemplate config (`cfg_...`) being applied in this upgrade."),
|
|
1968
2122
|
/** Resource-type-specific identity details. Tools: `tool_type`, `builtin_tool_key`, `name_prefix`, `handler_type`, `instruction`. Routines: `handler_type`, `preset_name`, `event_type`, `schedule`, `trigger_context`. Skills: `instruction`. Computers: `region`. Knowledge: `mode`, `knowledge_key`, `extraction_output_ref`. Only populated keys are present; `null` when nothing is known. */
|
|
1969
2123
|
resource: z.record(z.custom((value) => value !== undefined)).optional().describe("Resource-type-specific identity details. Tools: `tool_type`, `builtin_tool_key`, `name_prefix`, `handler_type`, `instruction`. Routines: `handler_type`, `preset_name`, `event_type`, `schedule`, `trigger_context`. Skills: `instruction`. Computers: `region`. Knowledge: `mode`, `knowledge_key`, `extraction_output_ref`. Only populated keys are present; `null` when nothing is known."),
|
|
1970
|
-
/** Type of the resource being changed. One of `"agent"`, `"tool"`, `"routine"`, `"skill"`, `"computer"`, or `"knowledge"`. */
|
|
1971
|
-
resource_type: z.string().describe("Type of the resource being changed. One of `\"agent\"`, `\"tool\"`, `\"routine\"`, `\"skill\"`, `\"computer\"`, or `\"knowledge\"`."),
|
|
2124
|
+
/** Type of the resource being changed. One of `"agent"`, `"tool"`, `"routine"`, `"skill"`, `"computer"`, `"endpoint"`, or `"knowledge"`. */
|
|
2125
|
+
resource_type: z.string().describe("Type of the resource being changed. One of `\"agent\"`, `\"tool\"`, `\"routine\"`, `\"skill\"`, `\"computer\"`, `\"endpoint\"`, or `\"knowledge\"`."),
|
|
1972
2126
|
/** Summary of the specific child template config (`cfg_...`) that defines this resource. `null` when no source template is resolvable. */
|
|
1973
2127
|
source_template_config: upgradeTemplateSummarySchema.optional().describe("Summary of the specific child template config (`cfg_...`) that defines this resource. `null` when no source template is resolvable."),
|
|
1974
2128
|
}).describe("One child-resource change produced by an agent upgrade, describing the action to be taken on a single resource.");
|