# Bulk Workspace Resources ## Apply a workspace resource bundle `bulk_workspace_resources.apply(workspace_id, **kwargs) -> BulkWorkspaceApply` **post** `/v1/workspaces/{workspaceId}/bulk_workspace_applies` Asynchronously applies a declarative bundle of workspace resources. Returns the operation immediately in PENDING; clients poll Get to track progress. ### Parameters - `workspace_id: String` - `data: BulkWorkspaceApplyData` - `bundle_key: String` Required. Bundle ownership key. Resources created or updated by an Apply have their `metadata.bundle_key` set to this value. On subsequent applies with the same bundle_key, resources currently bearing this bundle_key but absent from the spec are soft-deleted. - `agents: Hash[Symbol, AgentEntry]` Agents to upsert, keyed by external_id. - `name: String` - `spec: AgentSpec` Agent specification (user-provided configuration) - `status: :AGENT_STATUS_UNSPECIFIED | :AGENT_STATUS_DRAFT | :AGENT_STATUS_PUBLISHED | :AGENT_STATUS_ARCHIVED` Status of the agent - `:AGENT_STATUS_UNSPECIFIED` - `:AGENT_STATUS_DRAFT` - `:AGENT_STATUS_PUBLISHED` - `:AGENT_STATUS_ARCHIVED` - `variation_selection_mode: :VARIATION_SELECTION_MODE_UNSPECIFIED | :VARIATION_SELECTION_MODE_RANDOM | :VARIATION_SELECTION_MODE_WEIGHTED` Controls how variations are automatically selected when creating objectives Defaults to RANDOM when unspecified - `:VARIATION_SELECTION_MODE_UNSPECIFIED` - `:VARIATION_SELECTION_MODE_RANDOM` - `:VARIATION_SELECTION_MODE_WEIGHTED` - `description: String` Description of the agent's purpose - `input_data_schema: Hash[Symbol, untyped]` InputDataSchema is used for enforcing a data input when objectives are created. This is valuable when using liquid formatting in agent variation prompts. Input data schema is also valuable when using an agent as a sub-agent, as the schema is used as the tool's input parameter schema. If omitted, the sub-agent schema will be loaded with a simple "prompt" free text string as its schema. - `output_definition: Hash[Symbol, untyped]` Optional output definition for objectives created for this agent. When provided, Cadenya will append a tool to that will be called by the LLM in use by the variant to extract information in the format provided here. Use this option when you want structured data to be created by your objectives. - `webhook_events_url: String` The URL that Cadenya will send events for any objective assigned to the agent. - `labels: Hash[Symbol, String]` - `schedules: Hash[Symbol, AgentScheduleEntry]` Schedules under this agent, keyed by external_id. - `name: String` - `spec: AgentScheduleSpec` AgentScheduleSpec is the user-provided configuration for a schedule. - `initial_message: String` The initial message passed to CreateObjective on each fire. Becomes the first user message in the objective's chat history. - `schedule: AgentScheduleSpecSchedule` Schedule defines WHEN the schedule fires. Temporal-style structured form: a list of calendar rules (wall-clock) and/or interval rules (duration), OR'd together. At least one rule is required. - `calendars: Array[ScheduleCalendar]` Wall-clock rules. May be empty if `intervals` is non-empty. - `comment: String` - `day_of_month: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `day_of_week: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `hour: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `minute: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `month: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `second: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `intervals: Array[ScheduleInterval]` Duration-based rules. May be empty if `calendars` is non-empty. - `every: String` - `offset: String` Phase shift within `every`. Must be < `every` (enforced at runtime). - `timezone: String` IANA tz name (e.g. "America/New_York"). Required. Applies to calendars; intervals fire on wall-clock cadence anchored in this zone. - `data: untyped` Optional input data passed to the objective. If the agent has an input_data_schema, this must satisfy it. - `overlap_policy: :OVERLAP_POLICY_UNSPECIFIED | :OVERLAP_POLICY_ALLOW | :OVERLAP_POLICY_SKIP` What to do when the previous run is still in flight. Defaults to SKIP. - `:OVERLAP_POLICY_UNSPECIFIED` - `:OVERLAP_POLICY_ALLOW` - `:OVERLAP_POLICY_SKIP` - `status: :AGENT_SCHEDULE_STATUS_UNSPECIFIED | :AGENT_SCHEDULE_STATUS_ACTIVE | :AGENT_SCHEDULE_STATUS_PAUSED | :AGENT_SCHEDULE_STATUS_ARCHIVED` Lifecycle. Defaults to ACTIVE on create when unspecified. - `:AGENT_SCHEDULE_STATUS_UNSPECIFIED` - `:AGENT_SCHEDULE_STATUS_ACTIVE` - `:AGENT_SCHEDULE_STATUS_PAUSED` - `:AGENT_SCHEDULE_STATUS_ARCHIVED` - `variation_id: String` Optional explicit variation. When unset, the agent's variation_selection_mode chooses per fire. - `labels: Hash[Symbol, String]` - `variations: Hash[Symbol, AgentVariationEntry]` Variations under this agent, keyed by external_id. - `name: String` - `spec: AgentVariationSpec` AgentVariationSpec defines the operational configuration for a variation - `compaction_config: AgentVariationSpecCompactionConfig` CompactionConfig defines how context window compaction behaves for objectives using this variation. - `summarization: CompactionConfigSummarizationStrategy` SummarizationStrategy configures LLM-powered summarization of older conversation turns. - `instructions: String` Custom instructions that guide what the summarizer preserves. Replaces the default summarization prompt entirely. Example: "Preserve all code snippets, variable names, and technical decisions." - `tool_result_clearing: CompactionConfigToolResultClearingStrategy` ToolResultClearingStrategy configures clearing of older tool result content. - `preserve_recent_results: Integer` Number of most recent tool call results to keep intact. Older tool results have their content replaced with "[result cleared]" while preserving the assistant tool call message (function name, arguments). Default: 2 - `trigger_threshold: Float` Trigger threshold as a percentage of the model's context window (0.0 to 1.0). When input tokens reach this percentage of the model's limit, compaction triggers. Default: 0.75 (75%) - `constraints: AgentVariationSpecConstraints` Execution constraints - `max_sub_objectives: Integer` The maximum number of sub-objectives that can be created. 0 means no limit. - `max_tool_calls: Integer` The maximum number of tool calls that can be made. 0 means no limit. - `description: String` Human-readable description of what this variation does or when it should be used - `enable_episodic_memory: bool` Enable episodic memory for objectives using this variation. When true, the system automatically creates a document namespace for each objective using the objective's episodic_key as the external_id, allowing the agent to store and retrieve documents specific to that episode. - `episodic_memory_ttl: Integer` How long episodic memories should be retained. After this duration, episodic document namespaces can be automatically cleaned up. If not set, episodic memories are retained indefinitely. - `model_config: AgentVariationSpecModelConfig` ModelConfig defines the model configuration for a variation - `model_id: String` The model identifier in family/model format (e.g., "claude/opus-4.6", "claude/sonnet-4.5") - `temperature: Float` Sampling temperature for model inference (0.0 to 1.0) Lower values produce more deterministic outputs, higher values increase randomness - `progressive_discovery: AgentVariationSpecProgressiveDiscovery` ProgressiveDiscovery is used to indicate that the agent should automatically discover tools that are not explicitly assigned to it. Max tools is the maximum number of tools that can be discovered per search. Hints are optional hints for tool search. These are used in conjunction with the context-aware tool search and can help select the best tools for the task. - `hints: Array[String]` - `max_tools: Integer` - `rerank_threshold: Float` Rerank Threshold is an optional value that instructs whether or not to run a search result through a embedding/reranker process which can improve performance and reduce context bloat when tools reach the configured threshold. If a tool match must exceed 0.8, for example, the tool very closely match the query the tool search performed. - `prompt: String` The system prompt for this variation - `weight: Integer` Weight for weighted random selection (>= 0). P(v) = v.weight / sum(all_weights). Only used when the agent's variation_selection_mode is WEIGHTED. A weight of 0 means never auto-selected, but can still be chosen explicitly via variation_id on CreateObjectiveRequest. - `assignments: Array[VariationAssignmentEntry]` Reconciled list — server adjusts the variation's assignments to exactly this set when the variation is bundle-owned. - `sub_agent_id: String` - `tool_id: String` - `tool_set_id: String` - `labels: Hash[Symbol, String]` - `memory_layers: Array[VariationMemoryLayerEntry]` Reconciled list of memory layer assignments. Up to 10 entries. - `memory_layer_id: String` external_id: form. Canonical IDs are rejected. - `position: Integer` - `automatically_publish_agents: bool` When true, every agent created or updated by this Apply has its status forced to AGENT_STATUS_PUBLISHED, regardless of the status declared in the agent's AgentSpec. Useful when the bundle represents a production configuration and you want all of its agents live without setting status: AGENT_STATUS_PUBLISHED on each entry. Default false: each agent's AgentSpec.status controls (which is AGENT_STATUS_DRAFT on create when unspecified). - `memory_layers: Hash[Symbol, MemoryLayerEntry]` Memory layers to upsert, keyed by external_id. - `name: String` - `spec: MemoryLayerSpec` - `type: :MEMORY_LAYER_TYPE_UNSPECIFIED | :MEMORY_LAYER_TYPE_EPISODIC | :MEMORY_LAYER_TYPE_SKILLS` - `:MEMORY_LAYER_TYPE_UNSPECIFIED` - `:MEMORY_LAYER_TYPE_EPISODIC` - `:MEMORY_LAYER_TYPE_SKILLS` - `description: String` Human-readable description of the layer's purpose. Encouraged for user-created layers; system-managed layers may have a generated description. - `expires_at: Time` For layers with a finite lifetime (e.g., episodic), the time at which the layer becomes eligible for cleanup. Set by the system; unset for persistent layers. - `system_managed: bool` Server-set. True for layers managed by the system (e.g., episodic layers created automatically when an objective uses an episodic_key). System-managed layers cannot be assigned to objective stacks via the API and cannot be mutated by clients — their lifecycle is controlled entirely by the runtime. - `entries: Hash[Symbol, MemoryEntryItem]` Memory entries in this layer, keyed by external_id. - `key: String` - `content: String` - `description: String` - `upload_id: String` - `labels: Hash[Symbol, String]` - `source_url: String` Optional URL pointing to the source of this apply (GitHub PR, Jenkins build, GitLab pipeline, etc.). Surfaced in the dashboard so users can jump from an apply back to the change that produced it. Free-form HTTPS URI; not interpreted by the server. - `tool_sets: Hash[Symbol, ToolSetEntry]` Tool sets to upsert, keyed by external_id. - `name: String` - `spec: ToolSetSpec` - `adapter: ToolSetAdapter` - `http: ToolSetAdapterHTTP` - `base_url: String` - `headers: Hash[Symbol, String]` - `mcp: ToolSetAdapterMcp` - `exclude_tools: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `operator: :OPERATOR_UNSPECIFIED | :OPERATOR_AND | :OPERATOR_OR` - `:OPERATOR_UNSPECIFIED` - `:OPERATOR_AND` - `:OPERATOR_OR` - `filters: Array[AttributeFilter]` - `attribute: :ATTRIBUTE_UNSPECIFIED | :ATTRIBUTE_NAME | :ATTRIBUTE_TITLE | :ATTRIBUTE_DESCRIPTION` - `:ATTRIBUTE_UNSPECIFIED` - `:ATTRIBUTE_NAME` - `:ATTRIBUTE_TITLE` - `:ATTRIBUTE_DESCRIPTION` - `matcher: StringMatcher` String matching operations - `case_sensitive: bool` - `contains: String` - `ends_with: String` - `exact: String` - `regex: String` - `starts_with: String` - `headers: Hash[Symbol, String]` - `include_tools: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `tool_approvals: ApprovalRequirementFilter` Approval filters that will automatically set the approval requirement on tools synced from an external source - `always: bool` - `only: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `url: String` - `openapi: ToolSetAdapterOpenAPI` - `base_url: String` Base URL for dispatching tool calls. If set, overrides the server resolved from the spec's servers array. - `exclude_tools: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `headers: Hash[Symbol, String]` Headers sent when fetching the spec from a URL and when dispatching tool calls. - `include_tools: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `server_name: String` Name of the server entry in the spec's servers array (OpenAPI 3.2 server.name field). Used to select which server URL to dispatch to when base_url is not set. If unset, the first server is used. Ignored when base_url is set. - `tool_approvals: ApprovalRequirementFilter` Approval filters that will automatically set the approval requirement on tools synced from an external source - `upload_id: String` ID of a COMPLETE Upload containing the OpenAPI spec document. - `url: String` URL to fetch the OpenAPI spec from. Synced automatically every hour. - `description: String` - `labels: Hash[Symbol, String]` - `tools: Hash[Symbol, ToolEntry]` Tools in this tool set, keyed by external_id. - `name: String` - `spec: ToolSpec` - `config: ToolSpecConfig` Config defines the adapter to use for the tool. This is used to determine how the tool is called. For example, if the tool is an HTTP tool, the adapter will be Http. If the tool is an inline tool, the adapter will be Inline. - `http: ConfigHTTP` - `request_method: :HTTP_METHOD_UNSPECIFIED | :GET | :POST | 3 more` - `:HTTP_METHOD_UNSPECIFIED` - `:GET` - `:POST` - `:PUT` - `:PATCH` - `:DELETE` - `headers: Hash[Symbol, String]` - `path: String` - `query: String` - `request_body_content_type: String` - `request_body_template: String` These are only used when the request method is a POST, PUT, or PATCH - `tool_name: String` The tool name (commonly an "operation id" in OpenAPI specs) to call on the HTTP adapter. This is used to match the tool spec to the correct endpoint on the HTTP adapter. it will be derived from the name of the tool if not provided. - `mcp: ConfigMcp` - `tool_description: String` - `tool_name: String` - `tool_title: String` - `openapi: ConfigOpenAPI` - `method_: String` - `operation_id: String` - `path: String` - `description: String` - `parameters: Hash[Symbol, untyped]` - `status: :TOOL_STATUS_UNSPECIFIED | :TOOL_STATUS_AVAILABLE | :TOOL_STATUS_OMITTED | :TOOL_STATUS_ARCHIVED` - `:TOOL_STATUS_UNSPECIFIED` - `:TOOL_STATUS_AVAILABLE` - `:TOOL_STATUS_OMITTED` - `:TOOL_STATUS_ARCHIVED` - `requires_approval: bool` - `labels: Hash[Symbol, String]` ### Returns - `class BulkWorkspaceApply` The operation resource produced by a call to BulkWorkspaceResources.Apply. It carries the input bundle in `data`, the lifecycle state in `status`, and aggregate counts in `info`. - `data: BulkWorkspaceApplyData` - `bundle_key: String` Required. Bundle ownership key. Resources created or updated by an Apply have their `metadata.bundle_key` set to this value. On subsequent applies with the same bundle_key, resources currently bearing this bundle_key but absent from the spec are soft-deleted. - `agents: Hash[Symbol, AgentEntry]` Agents to upsert, keyed by external_id. - `name: String` - `spec: AgentSpec` Agent specification (user-provided configuration) - `status: :AGENT_STATUS_UNSPECIFIED | :AGENT_STATUS_DRAFT | :AGENT_STATUS_PUBLISHED | :AGENT_STATUS_ARCHIVED` Status of the agent - `:AGENT_STATUS_UNSPECIFIED` - `:AGENT_STATUS_DRAFT` - `:AGENT_STATUS_PUBLISHED` - `:AGENT_STATUS_ARCHIVED` - `variation_selection_mode: :VARIATION_SELECTION_MODE_UNSPECIFIED | :VARIATION_SELECTION_MODE_RANDOM | :VARIATION_SELECTION_MODE_WEIGHTED` Controls how variations are automatically selected when creating objectives Defaults to RANDOM when unspecified - `:VARIATION_SELECTION_MODE_UNSPECIFIED` - `:VARIATION_SELECTION_MODE_RANDOM` - `:VARIATION_SELECTION_MODE_WEIGHTED` - `description: String` Description of the agent's purpose - `input_data_schema: Hash[Symbol, untyped]` InputDataSchema is used for enforcing a data input when objectives are created. This is valuable when using liquid formatting in agent variation prompts. Input data schema is also valuable when using an agent as a sub-agent, as the schema is used as the tool's input parameter schema. If omitted, the sub-agent schema will be loaded with a simple "prompt" free text string as its schema. - `output_definition: Hash[Symbol, untyped]` Optional output definition for objectives created for this agent. When provided, Cadenya will append a tool to that will be called by the LLM in use by the variant to extract information in the format provided here. Use this option when you want structured data to be created by your objectives. - `webhook_events_url: String` The URL that Cadenya will send events for any objective assigned to the agent. - `labels: Hash[Symbol, String]` - `schedules: Hash[Symbol, AgentScheduleEntry]` Schedules under this agent, keyed by external_id. - `name: String` - `spec: AgentScheduleSpec` AgentScheduleSpec is the user-provided configuration for a schedule. - `initial_message: String` The initial message passed to CreateObjective on each fire. Becomes the first user message in the objective's chat history. - `schedule: AgentScheduleSpecSchedule` Schedule defines WHEN the schedule fires. Temporal-style structured form: a list of calendar rules (wall-clock) and/or interval rules (duration), OR'd together. At least one rule is required. - `calendars: Array[ScheduleCalendar]` Wall-clock rules. May be empty if `intervals` is non-empty. - `comment: String` - `day_of_month: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `day_of_week: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `hour: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `minute: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `month: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `second: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `intervals: Array[ScheduleInterval]` Duration-based rules. May be empty if `calendars` is non-empty. - `every: String` - `offset: String` Phase shift within `every`. Must be < `every` (enforced at runtime). - `timezone: String` IANA tz name (e.g. "America/New_York"). Required. Applies to calendars; intervals fire on wall-clock cadence anchored in this zone. - `data: untyped` Optional input data passed to the objective. If the agent has an input_data_schema, this must satisfy it. - `overlap_policy: :OVERLAP_POLICY_UNSPECIFIED | :OVERLAP_POLICY_ALLOW | :OVERLAP_POLICY_SKIP` What to do when the previous run is still in flight. Defaults to SKIP. - `:OVERLAP_POLICY_UNSPECIFIED` - `:OVERLAP_POLICY_ALLOW` - `:OVERLAP_POLICY_SKIP` - `status: :AGENT_SCHEDULE_STATUS_UNSPECIFIED | :AGENT_SCHEDULE_STATUS_ACTIVE | :AGENT_SCHEDULE_STATUS_PAUSED | :AGENT_SCHEDULE_STATUS_ARCHIVED` Lifecycle. Defaults to ACTIVE on create when unspecified. - `:AGENT_SCHEDULE_STATUS_UNSPECIFIED` - `:AGENT_SCHEDULE_STATUS_ACTIVE` - `:AGENT_SCHEDULE_STATUS_PAUSED` - `:AGENT_SCHEDULE_STATUS_ARCHIVED` - `variation_id: String` Optional explicit variation. When unset, the agent's variation_selection_mode chooses per fire. - `labels: Hash[Symbol, String]` - `variations: Hash[Symbol, AgentVariationEntry]` Variations under this agent, keyed by external_id. - `name: String` - `spec: AgentVariationSpec` AgentVariationSpec defines the operational configuration for a variation - `compaction_config: AgentVariationSpecCompactionConfig` CompactionConfig defines how context window compaction behaves for objectives using this variation. - `summarization: CompactionConfigSummarizationStrategy` SummarizationStrategy configures LLM-powered summarization of older conversation turns. - `instructions: String` Custom instructions that guide what the summarizer preserves. Replaces the default summarization prompt entirely. Example: "Preserve all code snippets, variable names, and technical decisions." - `tool_result_clearing: CompactionConfigToolResultClearingStrategy` ToolResultClearingStrategy configures clearing of older tool result content. - `preserve_recent_results: Integer` Number of most recent tool call results to keep intact. Older tool results have their content replaced with "[result cleared]" while preserving the assistant tool call message (function name, arguments). Default: 2 - `trigger_threshold: Float` Trigger threshold as a percentage of the model's context window (0.0 to 1.0). When input tokens reach this percentage of the model's limit, compaction triggers. Default: 0.75 (75%) - `constraints: AgentVariationSpecConstraints` Execution constraints - `max_sub_objectives: Integer` The maximum number of sub-objectives that can be created. 0 means no limit. - `max_tool_calls: Integer` The maximum number of tool calls that can be made. 0 means no limit. - `description: String` Human-readable description of what this variation does or when it should be used - `enable_episodic_memory: bool` Enable episodic memory for objectives using this variation. When true, the system automatically creates a document namespace for each objective using the objective's episodic_key as the external_id, allowing the agent to store and retrieve documents specific to that episode. - `episodic_memory_ttl: Integer` How long episodic memories should be retained. After this duration, episodic document namespaces can be automatically cleaned up. If not set, episodic memories are retained indefinitely. - `model_config: AgentVariationSpecModelConfig` ModelConfig defines the model configuration for a variation - `model_id: String` The model identifier in family/model format (e.g., "claude/opus-4.6", "claude/sonnet-4.5") - `temperature: Float` Sampling temperature for model inference (0.0 to 1.0) Lower values produce more deterministic outputs, higher values increase randomness - `progressive_discovery: AgentVariationSpecProgressiveDiscovery` ProgressiveDiscovery is used to indicate that the agent should automatically discover tools that are not explicitly assigned to it. Max tools is the maximum number of tools that can be discovered per search. Hints are optional hints for tool search. These are used in conjunction with the context-aware tool search and can help select the best tools for the task. - `hints: Array[String]` - `max_tools: Integer` - `rerank_threshold: Float` Rerank Threshold is an optional value that instructs whether or not to run a search result through a embedding/reranker process which can improve performance and reduce context bloat when tools reach the configured threshold. If a tool match must exceed 0.8, for example, the tool very closely match the query the tool search performed. - `prompt: String` The system prompt for this variation - `weight: Integer` Weight for weighted random selection (>= 0). P(v) = v.weight / sum(all_weights). Only used when the agent's variation_selection_mode is WEIGHTED. A weight of 0 means never auto-selected, but can still be chosen explicitly via variation_id on CreateObjectiveRequest. - `assignments: Array[VariationAssignmentEntry]` Reconciled list — server adjusts the variation's assignments to exactly this set when the variation is bundle-owned. - `sub_agent_id: String` - `tool_id: String` - `tool_set_id: String` - `labels: Hash[Symbol, String]` - `memory_layers: Array[VariationMemoryLayerEntry]` Reconciled list of memory layer assignments. Up to 10 entries. - `memory_layer_id: String` external_id: form. Canonical IDs are rejected. - `position: Integer` - `automatically_publish_agents: bool` When true, every agent created or updated by this Apply has its status forced to AGENT_STATUS_PUBLISHED, regardless of the status declared in the agent's AgentSpec. Useful when the bundle represents a production configuration and you want all of its agents live without setting status: AGENT_STATUS_PUBLISHED on each entry. Default false: each agent's AgentSpec.status controls (which is AGENT_STATUS_DRAFT on create when unspecified). - `memory_layers: Hash[Symbol, MemoryLayerEntry]` Memory layers to upsert, keyed by external_id. - `name: String` - `spec: MemoryLayerSpec` - `type: :MEMORY_LAYER_TYPE_UNSPECIFIED | :MEMORY_LAYER_TYPE_EPISODIC | :MEMORY_LAYER_TYPE_SKILLS` - `:MEMORY_LAYER_TYPE_UNSPECIFIED` - `:MEMORY_LAYER_TYPE_EPISODIC` - `:MEMORY_LAYER_TYPE_SKILLS` - `description: String` Human-readable description of the layer's purpose. Encouraged for user-created layers; system-managed layers may have a generated description. - `expires_at: Time` For layers with a finite lifetime (e.g., episodic), the time at which the layer becomes eligible for cleanup. Set by the system; unset for persistent layers. - `system_managed: bool` Server-set. True for layers managed by the system (e.g., episodic layers created automatically when an objective uses an episodic_key). System-managed layers cannot be assigned to objective stacks via the API and cannot be mutated by clients — their lifecycle is controlled entirely by the runtime. - `entries: Hash[Symbol, MemoryEntryItem]` Memory entries in this layer, keyed by external_id. - `key: String` - `content: String` - `description: String` - `upload_id: String` - `labels: Hash[Symbol, String]` - `source_url: String` Optional URL pointing to the source of this apply (GitHub PR, Jenkins build, GitLab pipeline, etc.). Surfaced in the dashboard so users can jump from an apply back to the change that produced it. Free-form HTTPS URI; not interpreted by the server. - `tool_sets: Hash[Symbol, ToolSetEntry]` Tool sets to upsert, keyed by external_id. - `name: String` - `spec: ToolSetSpec` - `adapter: ToolSetAdapter` - `http: ToolSetAdapterHTTP` - `base_url: String` - `headers: Hash[Symbol, String]` - `mcp: ToolSetAdapterMcp` - `exclude_tools: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `operator: :OPERATOR_UNSPECIFIED | :OPERATOR_AND | :OPERATOR_OR` - `:OPERATOR_UNSPECIFIED` - `:OPERATOR_AND` - `:OPERATOR_OR` - `filters: Array[AttributeFilter]` - `attribute: :ATTRIBUTE_UNSPECIFIED | :ATTRIBUTE_NAME | :ATTRIBUTE_TITLE | :ATTRIBUTE_DESCRIPTION` - `:ATTRIBUTE_UNSPECIFIED` - `:ATTRIBUTE_NAME` - `:ATTRIBUTE_TITLE` - `:ATTRIBUTE_DESCRIPTION` - `matcher: StringMatcher` String matching operations - `case_sensitive: bool` - `contains: String` - `ends_with: String` - `exact: String` - `regex: String` - `starts_with: String` - `headers: Hash[Symbol, String]` - `include_tools: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `tool_approvals: ApprovalRequirementFilter` Approval filters that will automatically set the approval requirement on tools synced from an external source - `always: bool` - `only: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `url: String` - `openapi: ToolSetAdapterOpenAPI` - `base_url: String` Base URL for dispatching tool calls. If set, overrides the server resolved from the spec's servers array. - `exclude_tools: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `headers: Hash[Symbol, String]` Headers sent when fetching the spec from a URL and when dispatching tool calls. - `include_tools: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `server_name: String` Name of the server entry in the spec's servers array (OpenAPI 3.2 server.name field). Used to select which server URL to dispatch to when base_url is not set. If unset, the first server is used. Ignored when base_url is set. - `tool_approvals: ApprovalRequirementFilter` Approval filters that will automatically set the approval requirement on tools synced from an external source - `upload_id: String` ID of a COMPLETE Upload containing the OpenAPI spec document. - `url: String` URL to fetch the OpenAPI spec from. Synced automatically every hour. - `description: String` - `labels: Hash[Symbol, String]` - `tools: Hash[Symbol, ToolEntry]` Tools in this tool set, keyed by external_id. - `name: String` - `spec: ToolSpec` - `config: ToolSpecConfig` Config defines the adapter to use for the tool. This is used to determine how the tool is called. For example, if the tool is an HTTP tool, the adapter will be Http. If the tool is an inline tool, the adapter will be Inline. - `http: ConfigHTTP` - `request_method: :HTTP_METHOD_UNSPECIFIED | :GET | :POST | 3 more` - `:HTTP_METHOD_UNSPECIFIED` - `:GET` - `:POST` - `:PUT` - `:PATCH` - `:DELETE` - `headers: Hash[Symbol, String]` - `path: String` - `query: String` - `request_body_content_type: String` - `request_body_template: String` These are only used when the request method is a POST, PUT, or PATCH - `tool_name: String` The tool name (commonly an "operation id" in OpenAPI specs) to call on the HTTP adapter. This is used to match the tool spec to the correct endpoint on the HTTP adapter. it will be derived from the name of the tool if not provided. - `mcp: ConfigMcp` - `tool_description: String` - `tool_name: String` - `tool_title: String` - `openapi: ConfigOpenAPI` - `method_: String` - `operation_id: String` - `path: String` - `description: String` - `parameters: Hash[Symbol, untyped]` - `status: :TOOL_STATUS_UNSPECIFIED | :TOOL_STATUS_AVAILABLE | :TOOL_STATUS_OMITTED | :TOOL_STATUS_ARCHIVED` - `:TOOL_STATUS_UNSPECIFIED` - `:TOOL_STATUS_AVAILABLE` - `:TOOL_STATUS_OMITTED` - `:TOOL_STATUS_ARCHIVED` - `requires_approval: bool` - `labels: Hash[Symbol, String]` - `metadata: OperationMetadata` Metadata for ephemeral operations and activities (e.g., objectives, executions, runs) - `id: String` Unique identifier for the operation (prefixed ULID, e.g., "obj_01HXK...") - `account_id: String` Account this operation belongs to for multi-tenant isolation (prefixed ULID) - `created_at: Time` Timestamp when this operation was created ULID includes timestamp information, but this explicit field enables easier querying - `profile_id: String` ID of the actor (user or service account) that created this operation - `workspace_id: String` Workspace this operation belongs to for organizational grouping (prefixed ULID) - `external_id: String` External ID for the operation (e.g., a workflow ID from an external system) - `labels: Hash[Symbol, String]` Arbitrary key-value pairs for categorization and filtering Examples: {"priority": "high", "source": "api", "workflow": "onboarding"} - `status: BulkWorkspaceApplyStatus` - `state: :STATE_UNSPECIFIED | :STATE_PENDING | :STATE_VALIDATING | 5 more` - `:STATE_UNSPECIFIED` - `:STATE_PENDING` - `:STATE_VALIDATING` - `:STATE_RUNNING` - `:STATE_SUCCEEDED` - `:STATE_PARTIALLY_APPLIED` - `:STATE_FAILED` - `:STATE_CANCELLED` - `message: String` - `preflight_error: PreflightError{ code, details, message}` The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code: Integer` The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. - `details: Array[Detail{ type}]` A list of messages that carry the error details. There is a common set of message types for APIs to use. - `type: String` The type of the serialized message. - `message: String` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. - `info: BulkWorkspaceApplyInfo` - `completed_at: Time` - `created_by: Profile` A profile identifies a user or non-human principal (such as an API key) at the account level. Profiles are account-scoped and can be granted access to multiple workspaces. - `metadata: AccountResourceMetadata` AccountResourceMetadata is used to represent a resource that is associated to an account but not to a workspace. - `id: String` Unique identifier for the resource (prefixed ULID, e.g., "apikey_01HXK...") - `account_id: String` Account this resource belongs to for multi-tenant isolation (prefixed ULID) - `name: String` Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool") Required for resources that users interact with directly - `profile_id: String` - `external_id: String` External ID for the resource (e.g., a workflow ID from an external system) - `labels: Hash[Symbol, String]` Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"} - `spec: ProfileSpec` Configuration for a profile. - `type: :PROFILE_TYPE_UNSPECIFIED | :PROFILE_TYPE_USER | :PROFILE_TYPE_API_KEY | :PROFILE_TYPE_SYSTEM` Whether this profile represents a human user, an API key, or a system principal. - `:PROFILE_TYPE_UNSPECIFIED` - `:PROFILE_TYPE_USER` - `:PROFILE_TYPE_API_KEY` - `:PROFILE_TYPE_SYSTEM` - `email: String` Email address of the profile. Required and unique within an account for user profiles. - `name: String` Display name (e.g., "Bobby Tables"). - `created_count: Integer` - `deleted_count: Integer` - `failed_count: Integer` - `started_at: Time` - `total_count: Integer` - `unchanged_count: Integer` - `updated_count: Integer` ### Example ```ruby require "cadenya" cadenya = Cadenya::Client.new(api_key: "My API Key") bulk_workspace_apply = cadenya.bulk_workspace_resources.apply("workspaceId", data: {bundleKey: "bundleKey"}) puts(bulk_workspace_apply) ``` #### Response ```json { "data": { "bundleKey": "bundleKey", "agents": { "foo": { "name": "name", "spec": { "status": "AGENT_STATUS_UNSPECIFIED", "variationSelectionMode": "VARIATION_SELECTION_MODE_UNSPECIFIED", "description": "description", "inputDataSchema": { "foo": "bar" }, "outputDefinition": { "foo": "bar" }, "webhookEventsUrl": "webhookEventsUrl" }, "labels": { "foo": "string" }, "schedules": { "foo": { "name": "name", "spec": { "initialMessage": "initialMessage", "schedule": { "calendars": [ { "comment": "comment", "dayOfMonth": [ { "end": 0, "start": 0, "step": 0 } ], "dayOfWeek": [ { "end": 0, "start": 0, "step": 0 } ], "hour": [ { "end": 0, "start": 0, "step": 0 } ], "minute": [ { "end": 0, "start": 0, "step": 0 } ], "month": [ { "end": 0, "start": 0, "step": 0 } ], "second": [ { "end": 0, "start": 0, "step": 0 } ] } ], "intervals": [ { "every": "-160513s", "offset": "-160513s" } ], "timezone": "timezone" }, "data": {}, "overlapPolicy": "OVERLAP_POLICY_UNSPECIFIED", "status": "AGENT_SCHEDULE_STATUS_UNSPECIFIED", "variationId": "variationId" }, "labels": { "foo": "string" } } }, "variations": { "foo": { "name": "name", "spec": { "compactionConfig": { "summarization": { "instructions": "instructions" }, "toolResultClearing": { "preserveRecentResults": 0 }, "triggerThreshold": 0 }, "constraints": { "maxSubObjectives": 0, "maxToolCalls": 0 }, "description": "description", "enableEpisodicMemory": true, "episodicMemoryTtl": 0, "modelConfig": { "modelId": "modelId", "temperature": 0 }, "progressiveDiscovery": { "hints": [ "string" ], "maxTools": 0, "rerankThreshold": 0 }, "prompt": "prompt", "weight": 0 }, "assignments": [ { "subAgentId": "subAgentId", "toolId": "toolId", "toolSetId": "toolSetId" } ], "labels": { "foo": "string" }, "memoryLayers": [ { "memoryLayerId": "memoryLayerId", "position": 0 } ] } } } }, "automaticallyPublishAgents": true, "memoryLayers": { "foo": { "name": "name", "spec": { "type": "MEMORY_LAYER_TYPE_UNSPECIFIED", "description": "description", "expiresAt": "2019-12-27T18:11:19.117Z", "systemManaged": true }, "entries": { "foo": { "key": "key", "content": "content", "description": "description", "uploadId": "uploadId" } }, "labels": { "foo": "string" } } }, "sourceUrl": "sourceUrl", "toolSets": { "foo": { "name": "name", "spec": { "adapter": { "http": { "baseUrl": "baseUrl", "headers": { "foo": "string" } }, "mcp": { "excludeTools": { "operator": "OPERATOR_UNSPECIFIED", "filters": [ { "attribute": "ATTRIBUTE_UNSPECIFIED", "matcher": { "caseSensitive": true, "contains": "contains", "endsWith": "endsWith", "exact": "exact", "regex": "regex", "startsWith": "startsWith" } } ] }, "headers": { "foo": "string" }, "includeTools": { "operator": "OPERATOR_UNSPECIFIED", "filters": [ { "attribute": "ATTRIBUTE_UNSPECIFIED", "matcher": { "caseSensitive": true, "contains": "contains", "endsWith": "endsWith", "exact": "exact", "regex": "regex", "startsWith": "startsWith" } } ] }, "toolApprovals": { "always": true, "only": { "operator": "OPERATOR_UNSPECIFIED", "filters": [ { "attribute": "ATTRIBUTE_UNSPECIFIED", "matcher": { "caseSensitive": true, "contains": "contains", "endsWith": "endsWith", "exact": "exact", "regex": "regex", "startsWith": "startsWith" } } ] } }, "url": "url" }, "openapi": { "baseUrl": "baseUrl", "excludeTools": { "operator": "OPERATOR_UNSPECIFIED", "filters": [ { "attribute": "ATTRIBUTE_UNSPECIFIED", "matcher": { "caseSensitive": true, "contains": "contains", "endsWith": "endsWith", "exact": "exact", "regex": "regex", "startsWith": "startsWith" } } ] }, "headers": { "foo": "string" }, "includeTools": { "operator": "OPERATOR_UNSPECIFIED", "filters": [ { "attribute": "ATTRIBUTE_UNSPECIFIED", "matcher": { "caseSensitive": true, "contains": "contains", "endsWith": "endsWith", "exact": "exact", "regex": "regex", "startsWith": "startsWith" } } ] }, "serverName": "serverName", "toolApprovals": { "always": true, "only": { "operator": "OPERATOR_UNSPECIFIED", "filters": [ { "attribute": "ATTRIBUTE_UNSPECIFIED", "matcher": { "caseSensitive": true, "contains": "contains", "endsWith": "endsWith", "exact": "exact", "regex": "regex", "startsWith": "startsWith" } } ] } }, "uploadId": "uploadId", "url": "url" } }, "description": "description" }, "labels": { "foo": "string" }, "tools": { "foo": { "name": "name", "spec": { "config": { "http": { "requestMethod": "HTTP_METHOD_UNSPECIFIED", "headers": { "foo": "string" }, "path": "path", "query": "query", "requestBodyContentType": "requestBodyContentType", "requestBodyTemplate": "requestBodyTemplate", "toolName": "toolName" }, "mcp": { "toolDescription": "toolDescription", "toolName": "toolName", "toolTitle": "toolTitle" }, "openapi": { "method": "method", "operationId": "operationId", "path": "path" } }, "description": "description", "parameters": { "foo": "bar" }, "status": "TOOL_STATUS_UNSPECIFIED", "requiresApproval": true }, "labels": { "foo": "string" } } } } } }, "metadata": { "id": "id", "accountId": "accountId", "createdAt": "2019-12-27T18:11:19.117Z", "profileId": "profileId", "workspaceId": "workspaceId", "externalId": "externalId", "labels": { "foo": "string" } }, "status": { "state": "STATE_UNSPECIFIED", "message": "message", "preflightError": { "code": 0, "details": [ { "@type": "@type" } ], "message": "message" } }, "info": { "completedAt": "2019-12-27T18:11:19.117Z", "createdBy": { "metadata": { "id": "id", "accountId": "accountId", "name": "name", "profileId": "profileId", "externalId": "externalId", "labels": { "foo": "string" } }, "spec": { "type": "PROFILE_TYPE_UNSPECIFIED", "email": "email", "name": "name" } }, "createdCount": 0, "deletedCount": 0, "failedCount": 0, "startedAt": "2019-12-27T18:11:19.117Z", "totalCount": 0, "unchangedCount": 0, "updatedCount": 0 } } ``` ## Get a bulk workspace apply operation `bulk_workspace_resources.retrieve(id, **kwargs) -> BulkWorkspaceApply` **get** `/v1/workspaces/{workspaceId}/bulk_workspace_applies/{id}` Retrieves a bulk workspace apply operation by ID. ### Parameters - `workspace_id: String` - `id: String` ### Returns - `class BulkWorkspaceApply` The operation resource produced by a call to BulkWorkspaceResources.Apply. It carries the input bundle in `data`, the lifecycle state in `status`, and aggregate counts in `info`. - `data: BulkWorkspaceApplyData` - `bundle_key: String` Required. Bundle ownership key. Resources created or updated by an Apply have their `metadata.bundle_key` set to this value. On subsequent applies with the same bundle_key, resources currently bearing this bundle_key but absent from the spec are soft-deleted. - `agents: Hash[Symbol, AgentEntry]` Agents to upsert, keyed by external_id. - `name: String` - `spec: AgentSpec` Agent specification (user-provided configuration) - `status: :AGENT_STATUS_UNSPECIFIED | :AGENT_STATUS_DRAFT | :AGENT_STATUS_PUBLISHED | :AGENT_STATUS_ARCHIVED` Status of the agent - `:AGENT_STATUS_UNSPECIFIED` - `:AGENT_STATUS_DRAFT` - `:AGENT_STATUS_PUBLISHED` - `:AGENT_STATUS_ARCHIVED` - `variation_selection_mode: :VARIATION_SELECTION_MODE_UNSPECIFIED | :VARIATION_SELECTION_MODE_RANDOM | :VARIATION_SELECTION_MODE_WEIGHTED` Controls how variations are automatically selected when creating objectives Defaults to RANDOM when unspecified - `:VARIATION_SELECTION_MODE_UNSPECIFIED` - `:VARIATION_SELECTION_MODE_RANDOM` - `:VARIATION_SELECTION_MODE_WEIGHTED` - `description: String` Description of the agent's purpose - `input_data_schema: Hash[Symbol, untyped]` InputDataSchema is used for enforcing a data input when objectives are created. This is valuable when using liquid formatting in agent variation prompts. Input data schema is also valuable when using an agent as a sub-agent, as the schema is used as the tool's input parameter schema. If omitted, the sub-agent schema will be loaded with a simple "prompt" free text string as its schema. - `output_definition: Hash[Symbol, untyped]` Optional output definition for objectives created for this agent. When provided, Cadenya will append a tool to that will be called by the LLM in use by the variant to extract information in the format provided here. Use this option when you want structured data to be created by your objectives. - `webhook_events_url: String` The URL that Cadenya will send events for any objective assigned to the agent. - `labels: Hash[Symbol, String]` - `schedules: Hash[Symbol, AgentScheduleEntry]` Schedules under this agent, keyed by external_id. - `name: String` - `spec: AgentScheduleSpec` AgentScheduleSpec is the user-provided configuration for a schedule. - `initial_message: String` The initial message passed to CreateObjective on each fire. Becomes the first user message in the objective's chat history. - `schedule: AgentScheduleSpecSchedule` Schedule defines WHEN the schedule fires. Temporal-style structured form: a list of calendar rules (wall-clock) and/or interval rules (duration), OR'd together. At least one rule is required. - `calendars: Array[ScheduleCalendar]` Wall-clock rules. May be empty if `intervals` is non-empty. - `comment: String` - `day_of_month: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `day_of_week: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `hour: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `minute: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `month: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `second: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `intervals: Array[ScheduleInterval]` Duration-based rules. May be empty if `calendars` is non-empty. - `every: String` - `offset: String` Phase shift within `every`. Must be < `every` (enforced at runtime). - `timezone: String` IANA tz name (e.g. "America/New_York"). Required. Applies to calendars; intervals fire on wall-clock cadence anchored in this zone. - `data: untyped` Optional input data passed to the objective. If the agent has an input_data_schema, this must satisfy it. - `overlap_policy: :OVERLAP_POLICY_UNSPECIFIED | :OVERLAP_POLICY_ALLOW | :OVERLAP_POLICY_SKIP` What to do when the previous run is still in flight. Defaults to SKIP. - `:OVERLAP_POLICY_UNSPECIFIED` - `:OVERLAP_POLICY_ALLOW` - `:OVERLAP_POLICY_SKIP` - `status: :AGENT_SCHEDULE_STATUS_UNSPECIFIED | :AGENT_SCHEDULE_STATUS_ACTIVE | :AGENT_SCHEDULE_STATUS_PAUSED | :AGENT_SCHEDULE_STATUS_ARCHIVED` Lifecycle. Defaults to ACTIVE on create when unspecified. - `:AGENT_SCHEDULE_STATUS_UNSPECIFIED` - `:AGENT_SCHEDULE_STATUS_ACTIVE` - `:AGENT_SCHEDULE_STATUS_PAUSED` - `:AGENT_SCHEDULE_STATUS_ARCHIVED` - `variation_id: String` Optional explicit variation. When unset, the agent's variation_selection_mode chooses per fire. - `labels: Hash[Symbol, String]` - `variations: Hash[Symbol, AgentVariationEntry]` Variations under this agent, keyed by external_id. - `name: String` - `spec: AgentVariationSpec` AgentVariationSpec defines the operational configuration for a variation - `compaction_config: AgentVariationSpecCompactionConfig` CompactionConfig defines how context window compaction behaves for objectives using this variation. - `summarization: CompactionConfigSummarizationStrategy` SummarizationStrategy configures LLM-powered summarization of older conversation turns. - `instructions: String` Custom instructions that guide what the summarizer preserves. Replaces the default summarization prompt entirely. Example: "Preserve all code snippets, variable names, and technical decisions." - `tool_result_clearing: CompactionConfigToolResultClearingStrategy` ToolResultClearingStrategy configures clearing of older tool result content. - `preserve_recent_results: Integer` Number of most recent tool call results to keep intact. Older tool results have their content replaced with "[result cleared]" while preserving the assistant tool call message (function name, arguments). Default: 2 - `trigger_threshold: Float` Trigger threshold as a percentage of the model's context window (0.0 to 1.0). When input tokens reach this percentage of the model's limit, compaction triggers. Default: 0.75 (75%) - `constraints: AgentVariationSpecConstraints` Execution constraints - `max_sub_objectives: Integer` The maximum number of sub-objectives that can be created. 0 means no limit. - `max_tool_calls: Integer` The maximum number of tool calls that can be made. 0 means no limit. - `description: String` Human-readable description of what this variation does or when it should be used - `enable_episodic_memory: bool` Enable episodic memory for objectives using this variation. When true, the system automatically creates a document namespace for each objective using the objective's episodic_key as the external_id, allowing the agent to store and retrieve documents specific to that episode. - `episodic_memory_ttl: Integer` How long episodic memories should be retained. After this duration, episodic document namespaces can be automatically cleaned up. If not set, episodic memories are retained indefinitely. - `model_config: AgentVariationSpecModelConfig` ModelConfig defines the model configuration for a variation - `model_id: String` The model identifier in family/model format (e.g., "claude/opus-4.6", "claude/sonnet-4.5") - `temperature: Float` Sampling temperature for model inference (0.0 to 1.0) Lower values produce more deterministic outputs, higher values increase randomness - `progressive_discovery: AgentVariationSpecProgressiveDiscovery` ProgressiveDiscovery is used to indicate that the agent should automatically discover tools that are not explicitly assigned to it. Max tools is the maximum number of tools that can be discovered per search. Hints are optional hints for tool search. These are used in conjunction with the context-aware tool search and can help select the best tools for the task. - `hints: Array[String]` - `max_tools: Integer` - `rerank_threshold: Float` Rerank Threshold is an optional value that instructs whether or not to run a search result through a embedding/reranker process which can improve performance and reduce context bloat when tools reach the configured threshold. If a tool match must exceed 0.8, for example, the tool very closely match the query the tool search performed. - `prompt: String` The system prompt for this variation - `weight: Integer` Weight for weighted random selection (>= 0). P(v) = v.weight / sum(all_weights). Only used when the agent's variation_selection_mode is WEIGHTED. A weight of 0 means never auto-selected, but can still be chosen explicitly via variation_id on CreateObjectiveRequest. - `assignments: Array[VariationAssignmentEntry]` Reconciled list — server adjusts the variation's assignments to exactly this set when the variation is bundle-owned. - `sub_agent_id: String` - `tool_id: String` - `tool_set_id: String` - `labels: Hash[Symbol, String]` - `memory_layers: Array[VariationMemoryLayerEntry]` Reconciled list of memory layer assignments. Up to 10 entries. - `memory_layer_id: String` external_id: form. Canonical IDs are rejected. - `position: Integer` - `automatically_publish_agents: bool` When true, every agent created or updated by this Apply has its status forced to AGENT_STATUS_PUBLISHED, regardless of the status declared in the agent's AgentSpec. Useful when the bundle represents a production configuration and you want all of its agents live without setting status: AGENT_STATUS_PUBLISHED on each entry. Default false: each agent's AgentSpec.status controls (which is AGENT_STATUS_DRAFT on create when unspecified). - `memory_layers: Hash[Symbol, MemoryLayerEntry]` Memory layers to upsert, keyed by external_id. - `name: String` - `spec: MemoryLayerSpec` - `type: :MEMORY_LAYER_TYPE_UNSPECIFIED | :MEMORY_LAYER_TYPE_EPISODIC | :MEMORY_LAYER_TYPE_SKILLS` - `:MEMORY_LAYER_TYPE_UNSPECIFIED` - `:MEMORY_LAYER_TYPE_EPISODIC` - `:MEMORY_LAYER_TYPE_SKILLS` - `description: String` Human-readable description of the layer's purpose. Encouraged for user-created layers; system-managed layers may have a generated description. - `expires_at: Time` For layers with a finite lifetime (e.g., episodic), the time at which the layer becomes eligible for cleanup. Set by the system; unset for persistent layers. - `system_managed: bool` Server-set. True for layers managed by the system (e.g., episodic layers created automatically when an objective uses an episodic_key). System-managed layers cannot be assigned to objective stacks via the API and cannot be mutated by clients — their lifecycle is controlled entirely by the runtime. - `entries: Hash[Symbol, MemoryEntryItem]` Memory entries in this layer, keyed by external_id. - `key: String` - `content: String` - `description: String` - `upload_id: String` - `labels: Hash[Symbol, String]` - `source_url: String` Optional URL pointing to the source of this apply (GitHub PR, Jenkins build, GitLab pipeline, etc.). Surfaced in the dashboard so users can jump from an apply back to the change that produced it. Free-form HTTPS URI; not interpreted by the server. - `tool_sets: Hash[Symbol, ToolSetEntry]` Tool sets to upsert, keyed by external_id. - `name: String` - `spec: ToolSetSpec` - `adapter: ToolSetAdapter` - `http: ToolSetAdapterHTTP` - `base_url: String` - `headers: Hash[Symbol, String]` - `mcp: ToolSetAdapterMcp` - `exclude_tools: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `operator: :OPERATOR_UNSPECIFIED | :OPERATOR_AND | :OPERATOR_OR` - `:OPERATOR_UNSPECIFIED` - `:OPERATOR_AND` - `:OPERATOR_OR` - `filters: Array[AttributeFilter]` - `attribute: :ATTRIBUTE_UNSPECIFIED | :ATTRIBUTE_NAME | :ATTRIBUTE_TITLE | :ATTRIBUTE_DESCRIPTION` - `:ATTRIBUTE_UNSPECIFIED` - `:ATTRIBUTE_NAME` - `:ATTRIBUTE_TITLE` - `:ATTRIBUTE_DESCRIPTION` - `matcher: StringMatcher` String matching operations - `case_sensitive: bool` - `contains: String` - `ends_with: String` - `exact: String` - `regex: String` - `starts_with: String` - `headers: Hash[Symbol, String]` - `include_tools: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `tool_approvals: ApprovalRequirementFilter` Approval filters that will automatically set the approval requirement on tools synced from an external source - `always: bool` - `only: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `url: String` - `openapi: ToolSetAdapterOpenAPI` - `base_url: String` Base URL for dispatching tool calls. If set, overrides the server resolved from the spec's servers array. - `exclude_tools: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `headers: Hash[Symbol, String]` Headers sent when fetching the spec from a URL and when dispatching tool calls. - `include_tools: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `server_name: String` Name of the server entry in the spec's servers array (OpenAPI 3.2 server.name field). Used to select which server URL to dispatch to when base_url is not set. If unset, the first server is used. Ignored when base_url is set. - `tool_approvals: ApprovalRequirementFilter` Approval filters that will automatically set the approval requirement on tools synced from an external source - `upload_id: String` ID of a COMPLETE Upload containing the OpenAPI spec document. - `url: String` URL to fetch the OpenAPI spec from. Synced automatically every hour. - `description: String` - `labels: Hash[Symbol, String]` - `tools: Hash[Symbol, ToolEntry]` Tools in this tool set, keyed by external_id. - `name: String` - `spec: ToolSpec` - `config: ToolSpecConfig` Config defines the adapter to use for the tool. This is used to determine how the tool is called. For example, if the tool is an HTTP tool, the adapter will be Http. If the tool is an inline tool, the adapter will be Inline. - `http: ConfigHTTP` - `request_method: :HTTP_METHOD_UNSPECIFIED | :GET | :POST | 3 more` - `:HTTP_METHOD_UNSPECIFIED` - `:GET` - `:POST` - `:PUT` - `:PATCH` - `:DELETE` - `headers: Hash[Symbol, String]` - `path: String` - `query: String` - `request_body_content_type: String` - `request_body_template: String` These are only used when the request method is a POST, PUT, or PATCH - `tool_name: String` The tool name (commonly an "operation id" in OpenAPI specs) to call on the HTTP adapter. This is used to match the tool spec to the correct endpoint on the HTTP adapter. it will be derived from the name of the tool if not provided. - `mcp: ConfigMcp` - `tool_description: String` - `tool_name: String` - `tool_title: String` - `openapi: ConfigOpenAPI` - `method_: String` - `operation_id: String` - `path: String` - `description: String` - `parameters: Hash[Symbol, untyped]` - `status: :TOOL_STATUS_UNSPECIFIED | :TOOL_STATUS_AVAILABLE | :TOOL_STATUS_OMITTED | :TOOL_STATUS_ARCHIVED` - `:TOOL_STATUS_UNSPECIFIED` - `:TOOL_STATUS_AVAILABLE` - `:TOOL_STATUS_OMITTED` - `:TOOL_STATUS_ARCHIVED` - `requires_approval: bool` - `labels: Hash[Symbol, String]` - `metadata: OperationMetadata` Metadata for ephemeral operations and activities (e.g., objectives, executions, runs) - `id: String` Unique identifier for the operation (prefixed ULID, e.g., "obj_01HXK...") - `account_id: String` Account this operation belongs to for multi-tenant isolation (prefixed ULID) - `created_at: Time` Timestamp when this operation was created ULID includes timestamp information, but this explicit field enables easier querying - `profile_id: String` ID of the actor (user or service account) that created this operation - `workspace_id: String` Workspace this operation belongs to for organizational grouping (prefixed ULID) - `external_id: String` External ID for the operation (e.g., a workflow ID from an external system) - `labels: Hash[Symbol, String]` Arbitrary key-value pairs for categorization and filtering Examples: {"priority": "high", "source": "api", "workflow": "onboarding"} - `status: BulkWorkspaceApplyStatus` - `state: :STATE_UNSPECIFIED | :STATE_PENDING | :STATE_VALIDATING | 5 more` - `:STATE_UNSPECIFIED` - `:STATE_PENDING` - `:STATE_VALIDATING` - `:STATE_RUNNING` - `:STATE_SUCCEEDED` - `:STATE_PARTIALLY_APPLIED` - `:STATE_FAILED` - `:STATE_CANCELLED` - `message: String` - `preflight_error: PreflightError{ code, details, message}` The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code: Integer` The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. - `details: Array[Detail{ type}]` A list of messages that carry the error details. There is a common set of message types for APIs to use. - `type: String` The type of the serialized message. - `message: String` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. - `info: BulkWorkspaceApplyInfo` - `completed_at: Time` - `created_by: Profile` A profile identifies a user or non-human principal (such as an API key) at the account level. Profiles are account-scoped and can be granted access to multiple workspaces. - `metadata: AccountResourceMetadata` AccountResourceMetadata is used to represent a resource that is associated to an account but not to a workspace. - `id: String` Unique identifier for the resource (prefixed ULID, e.g., "apikey_01HXK...") - `account_id: String` Account this resource belongs to for multi-tenant isolation (prefixed ULID) - `name: String` Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool") Required for resources that users interact with directly - `profile_id: String` - `external_id: String` External ID for the resource (e.g., a workflow ID from an external system) - `labels: Hash[Symbol, String]` Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"} - `spec: ProfileSpec` Configuration for a profile. - `type: :PROFILE_TYPE_UNSPECIFIED | :PROFILE_TYPE_USER | :PROFILE_TYPE_API_KEY | :PROFILE_TYPE_SYSTEM` Whether this profile represents a human user, an API key, or a system principal. - `:PROFILE_TYPE_UNSPECIFIED` - `:PROFILE_TYPE_USER` - `:PROFILE_TYPE_API_KEY` - `:PROFILE_TYPE_SYSTEM` - `email: String` Email address of the profile. Required and unique within an account for user profiles. - `name: String` Display name (e.g., "Bobby Tables"). - `created_count: Integer` - `deleted_count: Integer` - `failed_count: Integer` - `started_at: Time` - `total_count: Integer` - `unchanged_count: Integer` - `updated_count: Integer` ### Example ```ruby require "cadenya" cadenya = Cadenya::Client.new(api_key: "My API Key") bulk_workspace_apply = cadenya.bulk_workspace_resources.retrieve("id", workspace_id: "workspaceId") puts(bulk_workspace_apply) ``` #### Response ```json { "data": { "bundleKey": "bundleKey", "agents": { "foo": { "name": "name", "spec": { "status": "AGENT_STATUS_UNSPECIFIED", "variationSelectionMode": "VARIATION_SELECTION_MODE_UNSPECIFIED", "description": "description", "inputDataSchema": { "foo": "bar" }, "outputDefinition": { "foo": "bar" }, "webhookEventsUrl": "webhookEventsUrl" }, "labels": { "foo": "string" }, "schedules": { "foo": { "name": "name", "spec": { "initialMessage": "initialMessage", "schedule": { "calendars": [ { "comment": "comment", "dayOfMonth": [ { "end": 0, "start": 0, "step": 0 } ], "dayOfWeek": [ { "end": 0, "start": 0, "step": 0 } ], "hour": [ { "end": 0, "start": 0, "step": 0 } ], "minute": [ { "end": 0, "start": 0, "step": 0 } ], "month": [ { "end": 0, "start": 0, "step": 0 } ], "second": [ { "end": 0, "start": 0, "step": 0 } ] } ], "intervals": [ { "every": "-160513s", "offset": "-160513s" } ], "timezone": "timezone" }, "data": {}, "overlapPolicy": "OVERLAP_POLICY_UNSPECIFIED", "status": "AGENT_SCHEDULE_STATUS_UNSPECIFIED", "variationId": "variationId" }, "labels": { "foo": "string" } } }, "variations": { "foo": { "name": "name", "spec": { "compactionConfig": { "summarization": { "instructions": "instructions" }, "toolResultClearing": { "preserveRecentResults": 0 }, "triggerThreshold": 0 }, "constraints": { "maxSubObjectives": 0, "maxToolCalls": 0 }, "description": "description", "enableEpisodicMemory": true, "episodicMemoryTtl": 0, "modelConfig": { "modelId": "modelId", "temperature": 0 }, "progressiveDiscovery": { "hints": [ "string" ], "maxTools": 0, "rerankThreshold": 0 }, "prompt": "prompt", "weight": 0 }, "assignments": [ { "subAgentId": "subAgentId", "toolId": "toolId", "toolSetId": "toolSetId" } ], "labels": { "foo": "string" }, "memoryLayers": [ { "memoryLayerId": "memoryLayerId", "position": 0 } ] } } } }, "automaticallyPublishAgents": true, "memoryLayers": { "foo": { "name": "name", "spec": { "type": "MEMORY_LAYER_TYPE_UNSPECIFIED", "description": "description", "expiresAt": "2019-12-27T18:11:19.117Z", "systemManaged": true }, "entries": { "foo": { "key": "key", "content": "content", "description": "description", "uploadId": "uploadId" } }, "labels": { "foo": "string" } } }, "sourceUrl": "sourceUrl", "toolSets": { "foo": { "name": "name", "spec": { "adapter": { "http": { "baseUrl": "baseUrl", "headers": { "foo": "string" } }, "mcp": { "excludeTools": { "operator": "OPERATOR_UNSPECIFIED", "filters": [ { "attribute": "ATTRIBUTE_UNSPECIFIED", "matcher": { "caseSensitive": true, "contains": "contains", "endsWith": "endsWith", "exact": "exact", "regex": "regex", "startsWith": "startsWith" } } ] }, "headers": { "foo": "string" }, "includeTools": { "operator": "OPERATOR_UNSPECIFIED", "filters": [ { "attribute": "ATTRIBUTE_UNSPECIFIED", "matcher": { "caseSensitive": true, "contains": "contains", "endsWith": "endsWith", "exact": "exact", "regex": "regex", "startsWith": "startsWith" } } ] }, "toolApprovals": { "always": true, "only": { "operator": "OPERATOR_UNSPECIFIED", "filters": [ { "attribute": "ATTRIBUTE_UNSPECIFIED", "matcher": { "caseSensitive": true, "contains": "contains", "endsWith": "endsWith", "exact": "exact", "regex": "regex", "startsWith": "startsWith" } } ] } }, "url": "url" }, "openapi": { "baseUrl": "baseUrl", "excludeTools": { "operator": "OPERATOR_UNSPECIFIED", "filters": [ { "attribute": "ATTRIBUTE_UNSPECIFIED", "matcher": { "caseSensitive": true, "contains": "contains", "endsWith": "endsWith", "exact": "exact", "regex": "regex", "startsWith": "startsWith" } } ] }, "headers": { "foo": "string" }, "includeTools": { "operator": "OPERATOR_UNSPECIFIED", "filters": [ { "attribute": "ATTRIBUTE_UNSPECIFIED", "matcher": { "caseSensitive": true, "contains": "contains", "endsWith": "endsWith", "exact": "exact", "regex": "regex", "startsWith": "startsWith" } } ] }, "serverName": "serverName", "toolApprovals": { "always": true, "only": { "operator": "OPERATOR_UNSPECIFIED", "filters": [ { "attribute": "ATTRIBUTE_UNSPECIFIED", "matcher": { "caseSensitive": true, "contains": "contains", "endsWith": "endsWith", "exact": "exact", "regex": "regex", "startsWith": "startsWith" } } ] } }, "uploadId": "uploadId", "url": "url" } }, "description": "description" }, "labels": { "foo": "string" }, "tools": { "foo": { "name": "name", "spec": { "config": { "http": { "requestMethod": "HTTP_METHOD_UNSPECIFIED", "headers": { "foo": "string" }, "path": "path", "query": "query", "requestBodyContentType": "requestBodyContentType", "requestBodyTemplate": "requestBodyTemplate", "toolName": "toolName" }, "mcp": { "toolDescription": "toolDescription", "toolName": "toolName", "toolTitle": "toolTitle" }, "openapi": { "method": "method", "operationId": "operationId", "path": "path" } }, "description": "description", "parameters": { "foo": "bar" }, "status": "TOOL_STATUS_UNSPECIFIED", "requiresApproval": true }, "labels": { "foo": "string" } } } } } }, "metadata": { "id": "id", "accountId": "accountId", "createdAt": "2019-12-27T18:11:19.117Z", "profileId": "profileId", "workspaceId": "workspaceId", "externalId": "externalId", "labels": { "foo": "string" } }, "status": { "state": "STATE_UNSPECIFIED", "message": "message", "preflightError": { "code": 0, "details": [ { "@type": "@type" } ], "message": "message" } }, "info": { "completedAt": "2019-12-27T18:11:19.117Z", "createdBy": { "metadata": { "id": "id", "accountId": "accountId", "name": "name", "profileId": "profileId", "externalId": "externalId", "labels": { "foo": "string" } }, "spec": { "type": "PROFILE_TYPE_UNSPECIFIED", "email": "email", "name": "name" } }, "createdCount": 0, "deletedCount": 0, "failedCount": 0, "startedAt": "2019-12-27T18:11:19.117Z", "totalCount": 0, "unchangedCount": 0, "updatedCount": 0 } } ``` ## List bulk workspace apply operations `bulk_workspace_resources.list(workspace_id, **kwargs) -> CursorPagination` **get** `/v1/workspaces/{workspaceId}/bulk_workspace_applies` Lists past and in-flight bulk workspace apply operations in the workspace. ### Parameters - `workspace_id: String` - `bundle_key: String` Filter by bundle_key — list every apply for a given bundle. - `cursor: String` Pagination cursor from previous response - `limit: Integer` Maximum number of results to return - `sort_order: String` Sort order for results (asc or desc by creation time) - `state: :STATE_UNSPECIFIED | :STATE_PENDING | :STATE_VALIDATING | 5 more` Filter by lifecycle state. - `:STATE_UNSPECIFIED` - `:STATE_PENDING` - `:STATE_VALIDATING` - `:STATE_RUNNING` - `:STATE_SUCCEEDED` - `:STATE_PARTIALLY_APPLIED` - `:STATE_FAILED` - `:STATE_CANCELLED` ### Returns - `class BulkWorkspaceApply` The operation resource produced by a call to BulkWorkspaceResources.Apply. It carries the input bundle in `data`, the lifecycle state in `status`, and aggregate counts in `info`. - `data: BulkWorkspaceApplyData` - `bundle_key: String` Required. Bundle ownership key. Resources created or updated by an Apply have their `metadata.bundle_key` set to this value. On subsequent applies with the same bundle_key, resources currently bearing this bundle_key but absent from the spec are soft-deleted. - `agents: Hash[Symbol, AgentEntry]` Agents to upsert, keyed by external_id. - `name: String` - `spec: AgentSpec` Agent specification (user-provided configuration) - `status: :AGENT_STATUS_UNSPECIFIED | :AGENT_STATUS_DRAFT | :AGENT_STATUS_PUBLISHED | :AGENT_STATUS_ARCHIVED` Status of the agent - `:AGENT_STATUS_UNSPECIFIED` - `:AGENT_STATUS_DRAFT` - `:AGENT_STATUS_PUBLISHED` - `:AGENT_STATUS_ARCHIVED` - `variation_selection_mode: :VARIATION_SELECTION_MODE_UNSPECIFIED | :VARIATION_SELECTION_MODE_RANDOM | :VARIATION_SELECTION_MODE_WEIGHTED` Controls how variations are automatically selected when creating objectives Defaults to RANDOM when unspecified - `:VARIATION_SELECTION_MODE_UNSPECIFIED` - `:VARIATION_SELECTION_MODE_RANDOM` - `:VARIATION_SELECTION_MODE_WEIGHTED` - `description: String` Description of the agent's purpose - `input_data_schema: Hash[Symbol, untyped]` InputDataSchema is used for enforcing a data input when objectives are created. This is valuable when using liquid formatting in agent variation prompts. Input data schema is also valuable when using an agent as a sub-agent, as the schema is used as the tool's input parameter schema. If omitted, the sub-agent schema will be loaded with a simple "prompt" free text string as its schema. - `output_definition: Hash[Symbol, untyped]` Optional output definition for objectives created for this agent. When provided, Cadenya will append a tool to that will be called by the LLM in use by the variant to extract information in the format provided here. Use this option when you want structured data to be created by your objectives. - `webhook_events_url: String` The URL that Cadenya will send events for any objective assigned to the agent. - `labels: Hash[Symbol, String]` - `schedules: Hash[Symbol, AgentScheduleEntry]` Schedules under this agent, keyed by external_id. - `name: String` - `spec: AgentScheduleSpec` AgentScheduleSpec is the user-provided configuration for a schedule. - `initial_message: String` The initial message passed to CreateObjective on each fire. Becomes the first user message in the objective's chat history. - `schedule: AgentScheduleSpecSchedule` Schedule defines WHEN the schedule fires. Temporal-style structured form: a list of calendar rules (wall-clock) and/or interval rules (duration), OR'd together. At least one rule is required. - `calendars: Array[ScheduleCalendar]` Wall-clock rules. May be empty if `intervals` is non-empty. - `comment: String` - `day_of_month: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `day_of_week: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `hour: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `minute: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `month: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `second: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `intervals: Array[ScheduleInterval]` Duration-based rules. May be empty if `calendars` is non-empty. - `every: String` - `offset: String` Phase shift within `every`. Must be < `every` (enforced at runtime). - `timezone: String` IANA tz name (e.g. "America/New_York"). Required. Applies to calendars; intervals fire on wall-clock cadence anchored in this zone. - `data: untyped` Optional input data passed to the objective. If the agent has an input_data_schema, this must satisfy it. - `overlap_policy: :OVERLAP_POLICY_UNSPECIFIED | :OVERLAP_POLICY_ALLOW | :OVERLAP_POLICY_SKIP` What to do when the previous run is still in flight. Defaults to SKIP. - `:OVERLAP_POLICY_UNSPECIFIED` - `:OVERLAP_POLICY_ALLOW` - `:OVERLAP_POLICY_SKIP` - `status: :AGENT_SCHEDULE_STATUS_UNSPECIFIED | :AGENT_SCHEDULE_STATUS_ACTIVE | :AGENT_SCHEDULE_STATUS_PAUSED | :AGENT_SCHEDULE_STATUS_ARCHIVED` Lifecycle. Defaults to ACTIVE on create when unspecified. - `:AGENT_SCHEDULE_STATUS_UNSPECIFIED` - `:AGENT_SCHEDULE_STATUS_ACTIVE` - `:AGENT_SCHEDULE_STATUS_PAUSED` - `:AGENT_SCHEDULE_STATUS_ARCHIVED` - `variation_id: String` Optional explicit variation. When unset, the agent's variation_selection_mode chooses per fire. - `labels: Hash[Symbol, String]` - `variations: Hash[Symbol, AgentVariationEntry]` Variations under this agent, keyed by external_id. - `name: String` - `spec: AgentVariationSpec` AgentVariationSpec defines the operational configuration for a variation - `compaction_config: AgentVariationSpecCompactionConfig` CompactionConfig defines how context window compaction behaves for objectives using this variation. - `summarization: CompactionConfigSummarizationStrategy` SummarizationStrategy configures LLM-powered summarization of older conversation turns. - `instructions: String` Custom instructions that guide what the summarizer preserves. Replaces the default summarization prompt entirely. Example: "Preserve all code snippets, variable names, and technical decisions." - `tool_result_clearing: CompactionConfigToolResultClearingStrategy` ToolResultClearingStrategy configures clearing of older tool result content. - `preserve_recent_results: Integer` Number of most recent tool call results to keep intact. Older tool results have their content replaced with "[result cleared]" while preserving the assistant tool call message (function name, arguments). Default: 2 - `trigger_threshold: Float` Trigger threshold as a percentage of the model's context window (0.0 to 1.0). When input tokens reach this percentage of the model's limit, compaction triggers. Default: 0.75 (75%) - `constraints: AgentVariationSpecConstraints` Execution constraints - `max_sub_objectives: Integer` The maximum number of sub-objectives that can be created. 0 means no limit. - `max_tool_calls: Integer` The maximum number of tool calls that can be made. 0 means no limit. - `description: String` Human-readable description of what this variation does or when it should be used - `enable_episodic_memory: bool` Enable episodic memory for objectives using this variation. When true, the system automatically creates a document namespace for each objective using the objective's episodic_key as the external_id, allowing the agent to store and retrieve documents specific to that episode. - `episodic_memory_ttl: Integer` How long episodic memories should be retained. After this duration, episodic document namespaces can be automatically cleaned up. If not set, episodic memories are retained indefinitely. - `model_config: AgentVariationSpecModelConfig` ModelConfig defines the model configuration for a variation - `model_id: String` The model identifier in family/model format (e.g., "claude/opus-4.6", "claude/sonnet-4.5") - `temperature: Float` Sampling temperature for model inference (0.0 to 1.0) Lower values produce more deterministic outputs, higher values increase randomness - `progressive_discovery: AgentVariationSpecProgressiveDiscovery` ProgressiveDiscovery is used to indicate that the agent should automatically discover tools that are not explicitly assigned to it. Max tools is the maximum number of tools that can be discovered per search. Hints are optional hints for tool search. These are used in conjunction with the context-aware tool search and can help select the best tools for the task. - `hints: Array[String]` - `max_tools: Integer` - `rerank_threshold: Float` Rerank Threshold is an optional value that instructs whether or not to run a search result through a embedding/reranker process which can improve performance and reduce context bloat when tools reach the configured threshold. If a tool match must exceed 0.8, for example, the tool very closely match the query the tool search performed. - `prompt: String` The system prompt for this variation - `weight: Integer` Weight for weighted random selection (>= 0). P(v) = v.weight / sum(all_weights). Only used when the agent's variation_selection_mode is WEIGHTED. A weight of 0 means never auto-selected, but can still be chosen explicitly via variation_id on CreateObjectiveRequest. - `assignments: Array[VariationAssignmentEntry]` Reconciled list — server adjusts the variation's assignments to exactly this set when the variation is bundle-owned. - `sub_agent_id: String` - `tool_id: String` - `tool_set_id: String` - `labels: Hash[Symbol, String]` - `memory_layers: Array[VariationMemoryLayerEntry]` Reconciled list of memory layer assignments. Up to 10 entries. - `memory_layer_id: String` external_id: form. Canonical IDs are rejected. - `position: Integer` - `automatically_publish_agents: bool` When true, every agent created or updated by this Apply has its status forced to AGENT_STATUS_PUBLISHED, regardless of the status declared in the agent's AgentSpec. Useful when the bundle represents a production configuration and you want all of its agents live without setting status: AGENT_STATUS_PUBLISHED on each entry. Default false: each agent's AgentSpec.status controls (which is AGENT_STATUS_DRAFT on create when unspecified). - `memory_layers: Hash[Symbol, MemoryLayerEntry]` Memory layers to upsert, keyed by external_id. - `name: String` - `spec: MemoryLayerSpec` - `type: :MEMORY_LAYER_TYPE_UNSPECIFIED | :MEMORY_LAYER_TYPE_EPISODIC | :MEMORY_LAYER_TYPE_SKILLS` - `:MEMORY_LAYER_TYPE_UNSPECIFIED` - `:MEMORY_LAYER_TYPE_EPISODIC` - `:MEMORY_LAYER_TYPE_SKILLS` - `description: String` Human-readable description of the layer's purpose. Encouraged for user-created layers; system-managed layers may have a generated description. - `expires_at: Time` For layers with a finite lifetime (e.g., episodic), the time at which the layer becomes eligible for cleanup. Set by the system; unset for persistent layers. - `system_managed: bool` Server-set. True for layers managed by the system (e.g., episodic layers created automatically when an objective uses an episodic_key). System-managed layers cannot be assigned to objective stacks via the API and cannot be mutated by clients — their lifecycle is controlled entirely by the runtime. - `entries: Hash[Symbol, MemoryEntryItem]` Memory entries in this layer, keyed by external_id. - `key: String` - `content: String` - `description: String` - `upload_id: String` - `labels: Hash[Symbol, String]` - `source_url: String` Optional URL pointing to the source of this apply (GitHub PR, Jenkins build, GitLab pipeline, etc.). Surfaced in the dashboard so users can jump from an apply back to the change that produced it. Free-form HTTPS URI; not interpreted by the server. - `tool_sets: Hash[Symbol, ToolSetEntry]` Tool sets to upsert, keyed by external_id. - `name: String` - `spec: ToolSetSpec` - `adapter: ToolSetAdapter` - `http: ToolSetAdapterHTTP` - `base_url: String` - `headers: Hash[Symbol, String]` - `mcp: ToolSetAdapterMcp` - `exclude_tools: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `operator: :OPERATOR_UNSPECIFIED | :OPERATOR_AND | :OPERATOR_OR` - `:OPERATOR_UNSPECIFIED` - `:OPERATOR_AND` - `:OPERATOR_OR` - `filters: Array[AttributeFilter]` - `attribute: :ATTRIBUTE_UNSPECIFIED | :ATTRIBUTE_NAME | :ATTRIBUTE_TITLE | :ATTRIBUTE_DESCRIPTION` - `:ATTRIBUTE_UNSPECIFIED` - `:ATTRIBUTE_NAME` - `:ATTRIBUTE_TITLE` - `:ATTRIBUTE_DESCRIPTION` - `matcher: StringMatcher` String matching operations - `case_sensitive: bool` - `contains: String` - `ends_with: String` - `exact: String` - `regex: String` - `starts_with: String` - `headers: Hash[Symbol, String]` - `include_tools: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `tool_approvals: ApprovalRequirementFilter` Approval filters that will automatically set the approval requirement on tools synced from an external source - `always: bool` - `only: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `url: String` - `openapi: ToolSetAdapterOpenAPI` - `base_url: String` Base URL for dispatching tool calls. If set, overrides the server resolved from the spec's servers array. - `exclude_tools: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `headers: Hash[Symbol, String]` Headers sent when fetching the spec from a URL and when dispatching tool calls. - `include_tools: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `server_name: String` Name of the server entry in the spec's servers array (OpenAPI 3.2 server.name field). Used to select which server URL to dispatch to when base_url is not set. If unset, the first server is used. Ignored when base_url is set. - `tool_approvals: ApprovalRequirementFilter` Approval filters that will automatically set the approval requirement on tools synced from an external source - `upload_id: String` ID of a COMPLETE Upload containing the OpenAPI spec document. - `url: String` URL to fetch the OpenAPI spec from. Synced automatically every hour. - `description: String` - `labels: Hash[Symbol, String]` - `tools: Hash[Symbol, ToolEntry]` Tools in this tool set, keyed by external_id. - `name: String` - `spec: ToolSpec` - `config: ToolSpecConfig` Config defines the adapter to use for the tool. This is used to determine how the tool is called. For example, if the tool is an HTTP tool, the adapter will be Http. If the tool is an inline tool, the adapter will be Inline. - `http: ConfigHTTP` - `request_method: :HTTP_METHOD_UNSPECIFIED | :GET | :POST | 3 more` - `:HTTP_METHOD_UNSPECIFIED` - `:GET` - `:POST` - `:PUT` - `:PATCH` - `:DELETE` - `headers: Hash[Symbol, String]` - `path: String` - `query: String` - `request_body_content_type: String` - `request_body_template: String` These are only used when the request method is a POST, PUT, or PATCH - `tool_name: String` The tool name (commonly an "operation id" in OpenAPI specs) to call on the HTTP adapter. This is used to match the tool spec to the correct endpoint on the HTTP adapter. it will be derived from the name of the tool if not provided. - `mcp: ConfigMcp` - `tool_description: String` - `tool_name: String` - `tool_title: String` - `openapi: ConfigOpenAPI` - `method_: String` - `operation_id: String` - `path: String` - `description: String` - `parameters: Hash[Symbol, untyped]` - `status: :TOOL_STATUS_UNSPECIFIED | :TOOL_STATUS_AVAILABLE | :TOOL_STATUS_OMITTED | :TOOL_STATUS_ARCHIVED` - `:TOOL_STATUS_UNSPECIFIED` - `:TOOL_STATUS_AVAILABLE` - `:TOOL_STATUS_OMITTED` - `:TOOL_STATUS_ARCHIVED` - `requires_approval: bool` - `labels: Hash[Symbol, String]` - `metadata: OperationMetadata` Metadata for ephemeral operations and activities (e.g., objectives, executions, runs) - `id: String` Unique identifier for the operation (prefixed ULID, e.g., "obj_01HXK...") - `account_id: String` Account this operation belongs to for multi-tenant isolation (prefixed ULID) - `created_at: Time` Timestamp when this operation was created ULID includes timestamp information, but this explicit field enables easier querying - `profile_id: String` ID of the actor (user or service account) that created this operation - `workspace_id: String` Workspace this operation belongs to for organizational grouping (prefixed ULID) - `external_id: String` External ID for the operation (e.g., a workflow ID from an external system) - `labels: Hash[Symbol, String]` Arbitrary key-value pairs for categorization and filtering Examples: {"priority": "high", "source": "api", "workflow": "onboarding"} - `status: BulkWorkspaceApplyStatus` - `state: :STATE_UNSPECIFIED | :STATE_PENDING | :STATE_VALIDATING | 5 more` - `:STATE_UNSPECIFIED` - `:STATE_PENDING` - `:STATE_VALIDATING` - `:STATE_RUNNING` - `:STATE_SUCCEEDED` - `:STATE_PARTIALLY_APPLIED` - `:STATE_FAILED` - `:STATE_CANCELLED` - `message: String` - `preflight_error: PreflightError{ code, details, message}` The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code: Integer` The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. - `details: Array[Detail{ type}]` A list of messages that carry the error details. There is a common set of message types for APIs to use. - `type: String` The type of the serialized message. - `message: String` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. - `info: BulkWorkspaceApplyInfo` - `completed_at: Time` - `created_by: Profile` A profile identifies a user or non-human principal (such as an API key) at the account level. Profiles are account-scoped and can be granted access to multiple workspaces. - `metadata: AccountResourceMetadata` AccountResourceMetadata is used to represent a resource that is associated to an account but not to a workspace. - `id: String` Unique identifier for the resource (prefixed ULID, e.g., "apikey_01HXK...") - `account_id: String` Account this resource belongs to for multi-tenant isolation (prefixed ULID) - `name: String` Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool") Required for resources that users interact with directly - `profile_id: String` - `external_id: String` External ID for the resource (e.g., a workflow ID from an external system) - `labels: Hash[Symbol, String]` Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"} - `spec: ProfileSpec` Configuration for a profile. - `type: :PROFILE_TYPE_UNSPECIFIED | :PROFILE_TYPE_USER | :PROFILE_TYPE_API_KEY | :PROFILE_TYPE_SYSTEM` Whether this profile represents a human user, an API key, or a system principal. - `:PROFILE_TYPE_UNSPECIFIED` - `:PROFILE_TYPE_USER` - `:PROFILE_TYPE_API_KEY` - `:PROFILE_TYPE_SYSTEM` - `email: String` Email address of the profile. Required and unique within an account for user profiles. - `name: String` Display name (e.g., "Bobby Tables"). - `created_count: Integer` - `deleted_count: Integer` - `failed_count: Integer` - `started_at: Time` - `total_count: Integer` - `unchanged_count: Integer` - `updated_count: Integer` ### Example ```ruby require "cadenya" cadenya = Cadenya::Client.new(api_key: "My API Key") page = cadenya.bulk_workspace_resources.list("workspaceId") puts(page) ``` #### Response ```json { "items": [ { "data": { "bundleKey": "bundleKey", "agents": { "foo": { "name": "name", "spec": { "status": "AGENT_STATUS_UNSPECIFIED", "variationSelectionMode": "VARIATION_SELECTION_MODE_UNSPECIFIED", "description": "description", "inputDataSchema": { "foo": "bar" }, "outputDefinition": { "foo": "bar" }, "webhookEventsUrl": "webhookEventsUrl" }, "labels": { "foo": "string" }, "schedules": { "foo": { "name": "name", "spec": { "initialMessage": "initialMessage", "schedule": { "calendars": [ { "comment": "comment", "dayOfMonth": [ { "end": 0, "start": 0, "step": 0 } ], "dayOfWeek": [ { "end": 0, "start": 0, "step": 0 } ], "hour": [ { "end": 0, "start": 0, "step": 0 } ], "minute": [ { "end": 0, "start": 0, "step": 0 } ], "month": [ { "end": 0, "start": 0, "step": 0 } ], "second": [ { "end": 0, "start": 0, "step": 0 } ] } ], "intervals": [ { "every": "-160513s", "offset": "-160513s" } ], "timezone": "timezone" }, "data": {}, "overlapPolicy": "OVERLAP_POLICY_UNSPECIFIED", "status": "AGENT_SCHEDULE_STATUS_UNSPECIFIED", "variationId": "variationId" }, "labels": { "foo": "string" } } }, "variations": { "foo": { "name": "name", "spec": { "compactionConfig": { "summarization": { "instructions": "instructions" }, "toolResultClearing": { "preserveRecentResults": 0 }, "triggerThreshold": 0 }, "constraints": { "maxSubObjectives": 0, "maxToolCalls": 0 }, "description": "description", "enableEpisodicMemory": true, "episodicMemoryTtl": 0, "modelConfig": { "modelId": "modelId", "temperature": 0 }, "progressiveDiscovery": { "hints": [ "string" ], "maxTools": 0, "rerankThreshold": 0 }, "prompt": "prompt", "weight": 0 }, "assignments": [ { "subAgentId": "subAgentId", "toolId": "toolId", "toolSetId": "toolSetId" } ], "labels": { "foo": "string" }, "memoryLayers": [ { "memoryLayerId": "memoryLayerId", "position": 0 } ] } } } }, "automaticallyPublishAgents": true, "memoryLayers": { "foo": { "name": "name", "spec": { "type": "MEMORY_LAYER_TYPE_UNSPECIFIED", "description": "description", "expiresAt": "2019-12-27T18:11:19.117Z", "systemManaged": true }, "entries": { "foo": { "key": "key", "content": "content", "description": "description", "uploadId": "uploadId" } }, "labels": { "foo": "string" } } }, "sourceUrl": "sourceUrl", "toolSets": { "foo": { "name": "name", "spec": { "adapter": { "http": { "baseUrl": "baseUrl", "headers": { "foo": "string" } }, "mcp": { "excludeTools": { "operator": "OPERATOR_UNSPECIFIED", "filters": [ { "attribute": "ATTRIBUTE_UNSPECIFIED", "matcher": { "caseSensitive": true, "contains": "contains", "endsWith": "endsWith", "exact": "exact", "regex": "regex", "startsWith": "startsWith" } } ] }, "headers": { "foo": "string" }, "includeTools": { "operator": "OPERATOR_UNSPECIFIED", "filters": [ { "attribute": "ATTRIBUTE_UNSPECIFIED", "matcher": { "caseSensitive": true, "contains": "contains", "endsWith": "endsWith", "exact": "exact", "regex": "regex", "startsWith": "startsWith" } } ] }, "toolApprovals": { "always": true, "only": { "operator": "OPERATOR_UNSPECIFIED", "filters": [ { "attribute": "ATTRIBUTE_UNSPECIFIED", "matcher": { "caseSensitive": true, "contains": "contains", "endsWith": "endsWith", "exact": "exact", "regex": "regex", "startsWith": "startsWith" } } ] } }, "url": "url" }, "openapi": { "baseUrl": "baseUrl", "excludeTools": { "operator": "OPERATOR_UNSPECIFIED", "filters": [ { "attribute": "ATTRIBUTE_UNSPECIFIED", "matcher": { "caseSensitive": true, "contains": "contains", "endsWith": "endsWith", "exact": "exact", "regex": "regex", "startsWith": "startsWith" } } ] }, "headers": { "foo": "string" }, "includeTools": { "operator": "OPERATOR_UNSPECIFIED", "filters": [ { "attribute": "ATTRIBUTE_UNSPECIFIED", "matcher": { "caseSensitive": true, "contains": "contains", "endsWith": "endsWith", "exact": "exact", "regex": "regex", "startsWith": "startsWith" } } ] }, "serverName": "serverName", "toolApprovals": { "always": true, "only": { "operator": "OPERATOR_UNSPECIFIED", "filters": [ { "attribute": "ATTRIBUTE_UNSPECIFIED", "matcher": { "caseSensitive": true, "contains": "contains", "endsWith": "endsWith", "exact": "exact", "regex": "regex", "startsWith": "startsWith" } } ] } }, "uploadId": "uploadId", "url": "url" } }, "description": "description" }, "labels": { "foo": "string" }, "tools": { "foo": { "name": "name", "spec": { "config": { "http": { "requestMethod": "HTTP_METHOD_UNSPECIFIED", "headers": { "foo": "string" }, "path": "path", "query": "query", "requestBodyContentType": "requestBodyContentType", "requestBodyTemplate": "requestBodyTemplate", "toolName": "toolName" }, "mcp": { "toolDescription": "toolDescription", "toolName": "toolName", "toolTitle": "toolTitle" }, "openapi": { "method": "method", "operationId": "operationId", "path": "path" } }, "description": "description", "parameters": { "foo": "bar" }, "status": "TOOL_STATUS_UNSPECIFIED", "requiresApproval": true }, "labels": { "foo": "string" } } } } } }, "metadata": { "id": "id", "accountId": "accountId", "createdAt": "2019-12-27T18:11:19.117Z", "profileId": "profileId", "workspaceId": "workspaceId", "externalId": "externalId", "labels": { "foo": "string" } }, "status": { "state": "STATE_UNSPECIFIED", "message": "message", "preflightError": { "code": 0, "details": [ { "@type": "@type" } ], "message": "message" } }, "info": { "completedAt": "2019-12-27T18:11:19.117Z", "createdBy": { "metadata": { "id": "id", "accountId": "accountId", "name": "name", "profileId": "profileId", "externalId": "externalId", "labels": { "foo": "string" } }, "spec": { "type": "PROFILE_TYPE_UNSPECIFIED", "email": "email", "name": "name" } }, "createdCount": 0, "deletedCount": 0, "failedCount": 0, "startedAt": "2019-12-27T18:11:19.117Z", "totalCount": 0, "unchangedCount": 0, "updatedCount": 0 } } ], "pagination": { "nextCursor": "nextCursor", "total": 0 } } ``` ## Domain Types ### Agent Entry - `class AgentEntry` - `name: String` - `spec: AgentSpec` Agent specification (user-provided configuration) - `status: :AGENT_STATUS_UNSPECIFIED | :AGENT_STATUS_DRAFT | :AGENT_STATUS_PUBLISHED | :AGENT_STATUS_ARCHIVED` Status of the agent - `:AGENT_STATUS_UNSPECIFIED` - `:AGENT_STATUS_DRAFT` - `:AGENT_STATUS_PUBLISHED` - `:AGENT_STATUS_ARCHIVED` - `variation_selection_mode: :VARIATION_SELECTION_MODE_UNSPECIFIED | :VARIATION_SELECTION_MODE_RANDOM | :VARIATION_SELECTION_MODE_WEIGHTED` Controls how variations are automatically selected when creating objectives Defaults to RANDOM when unspecified - `:VARIATION_SELECTION_MODE_UNSPECIFIED` - `:VARIATION_SELECTION_MODE_RANDOM` - `:VARIATION_SELECTION_MODE_WEIGHTED` - `description: String` Description of the agent's purpose - `input_data_schema: Hash[Symbol, untyped]` InputDataSchema is used for enforcing a data input when objectives are created. This is valuable when using liquid formatting in agent variation prompts. Input data schema is also valuable when using an agent as a sub-agent, as the schema is used as the tool's input parameter schema. If omitted, the sub-agent schema will be loaded with a simple "prompt" free text string as its schema. - `output_definition: Hash[Symbol, untyped]` Optional output definition for objectives created for this agent. When provided, Cadenya will append a tool to that will be called by the LLM in use by the variant to extract information in the format provided here. Use this option when you want structured data to be created by your objectives. - `webhook_events_url: String` The URL that Cadenya will send events for any objective assigned to the agent. - `labels: Hash[Symbol, String]` - `schedules: Hash[Symbol, AgentScheduleEntry]` Schedules under this agent, keyed by external_id. - `name: String` - `spec: AgentScheduleSpec` AgentScheduleSpec is the user-provided configuration for a schedule. - `initial_message: String` The initial message passed to CreateObjective on each fire. Becomes the first user message in the objective's chat history. - `schedule: AgentScheduleSpecSchedule` Schedule defines WHEN the schedule fires. Temporal-style structured form: a list of calendar rules (wall-clock) and/or interval rules (duration), OR'd together. At least one rule is required. - `calendars: Array[ScheduleCalendar]` Wall-clock rules. May be empty if `intervals` is non-empty. - `comment: String` - `day_of_month: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `day_of_week: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `hour: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `minute: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `month: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `second: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `intervals: Array[ScheduleInterval]` Duration-based rules. May be empty if `calendars` is non-empty. - `every: String` - `offset: String` Phase shift within `every`. Must be < `every` (enforced at runtime). - `timezone: String` IANA tz name (e.g. "America/New_York"). Required. Applies to calendars; intervals fire on wall-clock cadence anchored in this zone. - `data: untyped` Optional input data passed to the objective. If the agent has an input_data_schema, this must satisfy it. - `overlap_policy: :OVERLAP_POLICY_UNSPECIFIED | :OVERLAP_POLICY_ALLOW | :OVERLAP_POLICY_SKIP` What to do when the previous run is still in flight. Defaults to SKIP. - `:OVERLAP_POLICY_UNSPECIFIED` - `:OVERLAP_POLICY_ALLOW` - `:OVERLAP_POLICY_SKIP` - `status: :AGENT_SCHEDULE_STATUS_UNSPECIFIED | :AGENT_SCHEDULE_STATUS_ACTIVE | :AGENT_SCHEDULE_STATUS_PAUSED | :AGENT_SCHEDULE_STATUS_ARCHIVED` Lifecycle. Defaults to ACTIVE on create when unspecified. - `:AGENT_SCHEDULE_STATUS_UNSPECIFIED` - `:AGENT_SCHEDULE_STATUS_ACTIVE` - `:AGENT_SCHEDULE_STATUS_PAUSED` - `:AGENT_SCHEDULE_STATUS_ARCHIVED` - `variation_id: String` Optional explicit variation. When unset, the agent's variation_selection_mode chooses per fire. - `labels: Hash[Symbol, String]` - `variations: Hash[Symbol, AgentVariationEntry]` Variations under this agent, keyed by external_id. - `name: String` - `spec: AgentVariationSpec` AgentVariationSpec defines the operational configuration for a variation - `compaction_config: AgentVariationSpecCompactionConfig` CompactionConfig defines how context window compaction behaves for objectives using this variation. - `summarization: CompactionConfigSummarizationStrategy` SummarizationStrategy configures LLM-powered summarization of older conversation turns. - `instructions: String` Custom instructions that guide what the summarizer preserves. Replaces the default summarization prompt entirely. Example: "Preserve all code snippets, variable names, and technical decisions." - `tool_result_clearing: CompactionConfigToolResultClearingStrategy` ToolResultClearingStrategy configures clearing of older tool result content. - `preserve_recent_results: Integer` Number of most recent tool call results to keep intact. Older tool results have their content replaced with "[result cleared]" while preserving the assistant tool call message (function name, arguments). Default: 2 - `trigger_threshold: Float` Trigger threshold as a percentage of the model's context window (0.0 to 1.0). When input tokens reach this percentage of the model's limit, compaction triggers. Default: 0.75 (75%) - `constraints: AgentVariationSpecConstraints` Execution constraints - `max_sub_objectives: Integer` The maximum number of sub-objectives that can be created. 0 means no limit. - `max_tool_calls: Integer` The maximum number of tool calls that can be made. 0 means no limit. - `description: String` Human-readable description of what this variation does or when it should be used - `enable_episodic_memory: bool` Enable episodic memory for objectives using this variation. When true, the system automatically creates a document namespace for each objective using the objective's episodic_key as the external_id, allowing the agent to store and retrieve documents specific to that episode. - `episodic_memory_ttl: Integer` How long episodic memories should be retained. After this duration, episodic document namespaces can be automatically cleaned up. If not set, episodic memories are retained indefinitely. - `model_config: AgentVariationSpecModelConfig` ModelConfig defines the model configuration for a variation - `model_id: String` The model identifier in family/model format (e.g., "claude/opus-4.6", "claude/sonnet-4.5") - `temperature: Float` Sampling temperature for model inference (0.0 to 1.0) Lower values produce more deterministic outputs, higher values increase randomness - `progressive_discovery: AgentVariationSpecProgressiveDiscovery` ProgressiveDiscovery is used to indicate that the agent should automatically discover tools that are not explicitly assigned to it. Max tools is the maximum number of tools that can be discovered per search. Hints are optional hints for tool search. These are used in conjunction with the context-aware tool search and can help select the best tools for the task. - `hints: Array[String]` - `max_tools: Integer` - `rerank_threshold: Float` Rerank Threshold is an optional value that instructs whether or not to run a search result through a embedding/reranker process which can improve performance and reduce context bloat when tools reach the configured threshold. If a tool match must exceed 0.8, for example, the tool very closely match the query the tool search performed. - `prompt: String` The system prompt for this variation - `weight: Integer` Weight for weighted random selection (>= 0). P(v) = v.weight / sum(all_weights). Only used when the agent's variation_selection_mode is WEIGHTED. A weight of 0 means never auto-selected, but can still be chosen explicitly via variation_id on CreateObjectiveRequest. - `assignments: Array[VariationAssignmentEntry]` Reconciled list — server adjusts the variation's assignments to exactly this set when the variation is bundle-owned. - `sub_agent_id: String` - `tool_id: String` - `tool_set_id: String` - `labels: Hash[Symbol, String]` - `memory_layers: Array[VariationMemoryLayerEntry]` Reconciled list of memory layer assignments. Up to 10 entries. - `memory_layer_id: String` external_id: form. Canonical IDs are rejected. - `position: Integer` ### Agent Schedule Entry - `class AgentScheduleEntry` - `name: String` - `spec: AgentScheduleSpec` AgentScheduleSpec is the user-provided configuration for a schedule. - `initial_message: String` The initial message passed to CreateObjective on each fire. Becomes the first user message in the objective's chat history. - `schedule: AgentScheduleSpecSchedule` Schedule defines WHEN the schedule fires. Temporal-style structured form: a list of calendar rules (wall-clock) and/or interval rules (duration), OR'd together. At least one rule is required. - `calendars: Array[ScheduleCalendar]` Wall-clock rules. May be empty if `intervals` is non-empty. - `comment: String` - `day_of_month: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `day_of_week: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `hour: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `minute: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `month: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `second: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `intervals: Array[ScheduleInterval]` Duration-based rules. May be empty if `calendars` is non-empty. - `every: String` - `offset: String` Phase shift within `every`. Must be < `every` (enforced at runtime). - `timezone: String` IANA tz name (e.g. "America/New_York"). Required. Applies to calendars; intervals fire on wall-clock cadence anchored in this zone. - `data: untyped` Optional input data passed to the objective. If the agent has an input_data_schema, this must satisfy it. - `overlap_policy: :OVERLAP_POLICY_UNSPECIFIED | :OVERLAP_POLICY_ALLOW | :OVERLAP_POLICY_SKIP` What to do when the previous run is still in flight. Defaults to SKIP. - `:OVERLAP_POLICY_UNSPECIFIED` - `:OVERLAP_POLICY_ALLOW` - `:OVERLAP_POLICY_SKIP` - `status: :AGENT_SCHEDULE_STATUS_UNSPECIFIED | :AGENT_SCHEDULE_STATUS_ACTIVE | :AGENT_SCHEDULE_STATUS_PAUSED | :AGENT_SCHEDULE_STATUS_ARCHIVED` Lifecycle. Defaults to ACTIVE on create when unspecified. - `:AGENT_SCHEDULE_STATUS_UNSPECIFIED` - `:AGENT_SCHEDULE_STATUS_ACTIVE` - `:AGENT_SCHEDULE_STATUS_PAUSED` - `:AGENT_SCHEDULE_STATUS_ARCHIVED` - `variation_id: String` Optional explicit variation. When unset, the agent's variation_selection_mode chooses per fire. - `labels: Hash[Symbol, String]` ### Agent Variation Entry - `class AgentVariationEntry` - `name: String` - `spec: AgentVariationSpec` AgentVariationSpec defines the operational configuration for a variation - `compaction_config: AgentVariationSpecCompactionConfig` CompactionConfig defines how context window compaction behaves for objectives using this variation. - `summarization: CompactionConfigSummarizationStrategy` SummarizationStrategy configures LLM-powered summarization of older conversation turns. - `instructions: String` Custom instructions that guide what the summarizer preserves. Replaces the default summarization prompt entirely. Example: "Preserve all code snippets, variable names, and technical decisions." - `tool_result_clearing: CompactionConfigToolResultClearingStrategy` ToolResultClearingStrategy configures clearing of older tool result content. - `preserve_recent_results: Integer` Number of most recent tool call results to keep intact. Older tool results have their content replaced with "[result cleared]" while preserving the assistant tool call message (function name, arguments). Default: 2 - `trigger_threshold: Float` Trigger threshold as a percentage of the model's context window (0.0 to 1.0). When input tokens reach this percentage of the model's limit, compaction triggers. Default: 0.75 (75%) - `constraints: AgentVariationSpecConstraints` Execution constraints - `max_sub_objectives: Integer` The maximum number of sub-objectives that can be created. 0 means no limit. - `max_tool_calls: Integer` The maximum number of tool calls that can be made. 0 means no limit. - `description: String` Human-readable description of what this variation does or when it should be used - `enable_episodic_memory: bool` Enable episodic memory for objectives using this variation. When true, the system automatically creates a document namespace for each objective using the objective's episodic_key as the external_id, allowing the agent to store and retrieve documents specific to that episode. - `episodic_memory_ttl: Integer` How long episodic memories should be retained. After this duration, episodic document namespaces can be automatically cleaned up. If not set, episodic memories are retained indefinitely. - `model_config: AgentVariationSpecModelConfig` ModelConfig defines the model configuration for a variation - `model_id: String` The model identifier in family/model format (e.g., "claude/opus-4.6", "claude/sonnet-4.5") - `temperature: Float` Sampling temperature for model inference (0.0 to 1.0) Lower values produce more deterministic outputs, higher values increase randomness - `progressive_discovery: AgentVariationSpecProgressiveDiscovery` ProgressiveDiscovery is used to indicate that the agent should automatically discover tools that are not explicitly assigned to it. Max tools is the maximum number of tools that can be discovered per search. Hints are optional hints for tool search. These are used in conjunction with the context-aware tool search and can help select the best tools for the task. - `hints: Array[String]` - `max_tools: Integer` - `rerank_threshold: Float` Rerank Threshold is an optional value that instructs whether or not to run a search result through a embedding/reranker process which can improve performance and reduce context bloat when tools reach the configured threshold. If a tool match must exceed 0.8, for example, the tool very closely match the query the tool search performed. - `prompt: String` The system prompt for this variation - `weight: Integer` Weight for weighted random selection (>= 0). P(v) = v.weight / sum(all_weights). Only used when the agent's variation_selection_mode is WEIGHTED. A weight of 0 means never auto-selected, but can still be chosen explicitly via variation_id on CreateObjectiveRequest. - `assignments: Array[VariationAssignmentEntry]` Reconciled list — server adjusts the variation's assignments to exactly this set when the variation is bundle-owned. - `sub_agent_id: String` - `tool_id: String` - `tool_set_id: String` - `labels: Hash[Symbol, String]` - `memory_layers: Array[VariationMemoryLayerEntry]` Reconciled list of memory layer assignments. Up to 10 entries. - `memory_layer_id: String` external_id: form. Canonical IDs are rejected. - `position: Integer` ### Bulk Workspace Apply - `class BulkWorkspaceApply` The operation resource produced by a call to BulkWorkspaceResources.Apply. It carries the input bundle in `data`, the lifecycle state in `status`, and aggregate counts in `info`. - `data: BulkWorkspaceApplyData` - `bundle_key: String` Required. Bundle ownership key. Resources created or updated by an Apply have their `metadata.bundle_key` set to this value. On subsequent applies with the same bundle_key, resources currently bearing this bundle_key but absent from the spec are soft-deleted. - `agents: Hash[Symbol, AgentEntry]` Agents to upsert, keyed by external_id. - `name: String` - `spec: AgentSpec` Agent specification (user-provided configuration) - `status: :AGENT_STATUS_UNSPECIFIED | :AGENT_STATUS_DRAFT | :AGENT_STATUS_PUBLISHED | :AGENT_STATUS_ARCHIVED` Status of the agent - `:AGENT_STATUS_UNSPECIFIED` - `:AGENT_STATUS_DRAFT` - `:AGENT_STATUS_PUBLISHED` - `:AGENT_STATUS_ARCHIVED` - `variation_selection_mode: :VARIATION_SELECTION_MODE_UNSPECIFIED | :VARIATION_SELECTION_MODE_RANDOM | :VARIATION_SELECTION_MODE_WEIGHTED` Controls how variations are automatically selected when creating objectives Defaults to RANDOM when unspecified - `:VARIATION_SELECTION_MODE_UNSPECIFIED` - `:VARIATION_SELECTION_MODE_RANDOM` - `:VARIATION_SELECTION_MODE_WEIGHTED` - `description: String` Description of the agent's purpose - `input_data_schema: Hash[Symbol, untyped]` InputDataSchema is used for enforcing a data input when objectives are created. This is valuable when using liquid formatting in agent variation prompts. Input data schema is also valuable when using an agent as a sub-agent, as the schema is used as the tool's input parameter schema. If omitted, the sub-agent schema will be loaded with a simple "prompt" free text string as its schema. - `output_definition: Hash[Symbol, untyped]` Optional output definition for objectives created for this agent. When provided, Cadenya will append a tool to that will be called by the LLM in use by the variant to extract information in the format provided here. Use this option when you want structured data to be created by your objectives. - `webhook_events_url: String` The URL that Cadenya will send events for any objective assigned to the agent. - `labels: Hash[Symbol, String]` - `schedules: Hash[Symbol, AgentScheduleEntry]` Schedules under this agent, keyed by external_id. - `name: String` - `spec: AgentScheduleSpec` AgentScheduleSpec is the user-provided configuration for a schedule. - `initial_message: String` The initial message passed to CreateObjective on each fire. Becomes the first user message in the objective's chat history. - `schedule: AgentScheduleSpecSchedule` Schedule defines WHEN the schedule fires. Temporal-style structured form: a list of calendar rules (wall-clock) and/or interval rules (duration), OR'd together. At least one rule is required. - `calendars: Array[ScheduleCalendar]` Wall-clock rules. May be empty if `intervals` is non-empty. - `comment: String` - `day_of_month: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `day_of_week: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `hour: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `minute: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `month: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `second: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `intervals: Array[ScheduleInterval]` Duration-based rules. May be empty if `calendars` is non-empty. - `every: String` - `offset: String` Phase shift within `every`. Must be < `every` (enforced at runtime). - `timezone: String` IANA tz name (e.g. "America/New_York"). Required. Applies to calendars; intervals fire on wall-clock cadence anchored in this zone. - `data: untyped` Optional input data passed to the objective. If the agent has an input_data_schema, this must satisfy it. - `overlap_policy: :OVERLAP_POLICY_UNSPECIFIED | :OVERLAP_POLICY_ALLOW | :OVERLAP_POLICY_SKIP` What to do when the previous run is still in flight. Defaults to SKIP. - `:OVERLAP_POLICY_UNSPECIFIED` - `:OVERLAP_POLICY_ALLOW` - `:OVERLAP_POLICY_SKIP` - `status: :AGENT_SCHEDULE_STATUS_UNSPECIFIED | :AGENT_SCHEDULE_STATUS_ACTIVE | :AGENT_SCHEDULE_STATUS_PAUSED | :AGENT_SCHEDULE_STATUS_ARCHIVED` Lifecycle. Defaults to ACTIVE on create when unspecified. - `:AGENT_SCHEDULE_STATUS_UNSPECIFIED` - `:AGENT_SCHEDULE_STATUS_ACTIVE` - `:AGENT_SCHEDULE_STATUS_PAUSED` - `:AGENT_SCHEDULE_STATUS_ARCHIVED` - `variation_id: String` Optional explicit variation. When unset, the agent's variation_selection_mode chooses per fire. - `labels: Hash[Symbol, String]` - `variations: Hash[Symbol, AgentVariationEntry]` Variations under this agent, keyed by external_id. - `name: String` - `spec: AgentVariationSpec` AgentVariationSpec defines the operational configuration for a variation - `compaction_config: AgentVariationSpecCompactionConfig` CompactionConfig defines how context window compaction behaves for objectives using this variation. - `summarization: CompactionConfigSummarizationStrategy` SummarizationStrategy configures LLM-powered summarization of older conversation turns. - `instructions: String` Custom instructions that guide what the summarizer preserves. Replaces the default summarization prompt entirely. Example: "Preserve all code snippets, variable names, and technical decisions." - `tool_result_clearing: CompactionConfigToolResultClearingStrategy` ToolResultClearingStrategy configures clearing of older tool result content. - `preserve_recent_results: Integer` Number of most recent tool call results to keep intact. Older tool results have their content replaced with "[result cleared]" while preserving the assistant tool call message (function name, arguments). Default: 2 - `trigger_threshold: Float` Trigger threshold as a percentage of the model's context window (0.0 to 1.0). When input tokens reach this percentage of the model's limit, compaction triggers. Default: 0.75 (75%) - `constraints: AgentVariationSpecConstraints` Execution constraints - `max_sub_objectives: Integer` The maximum number of sub-objectives that can be created. 0 means no limit. - `max_tool_calls: Integer` The maximum number of tool calls that can be made. 0 means no limit. - `description: String` Human-readable description of what this variation does or when it should be used - `enable_episodic_memory: bool` Enable episodic memory for objectives using this variation. When true, the system automatically creates a document namespace for each objective using the objective's episodic_key as the external_id, allowing the agent to store and retrieve documents specific to that episode. - `episodic_memory_ttl: Integer` How long episodic memories should be retained. After this duration, episodic document namespaces can be automatically cleaned up. If not set, episodic memories are retained indefinitely. - `model_config: AgentVariationSpecModelConfig` ModelConfig defines the model configuration for a variation - `model_id: String` The model identifier in family/model format (e.g., "claude/opus-4.6", "claude/sonnet-4.5") - `temperature: Float` Sampling temperature for model inference (0.0 to 1.0) Lower values produce more deterministic outputs, higher values increase randomness - `progressive_discovery: AgentVariationSpecProgressiveDiscovery` ProgressiveDiscovery is used to indicate that the agent should automatically discover tools that are not explicitly assigned to it. Max tools is the maximum number of tools that can be discovered per search. Hints are optional hints for tool search. These are used in conjunction with the context-aware tool search and can help select the best tools for the task. - `hints: Array[String]` - `max_tools: Integer` - `rerank_threshold: Float` Rerank Threshold is an optional value that instructs whether or not to run a search result through a embedding/reranker process which can improve performance and reduce context bloat when tools reach the configured threshold. If a tool match must exceed 0.8, for example, the tool very closely match the query the tool search performed. - `prompt: String` The system prompt for this variation - `weight: Integer` Weight for weighted random selection (>= 0). P(v) = v.weight / sum(all_weights). Only used when the agent's variation_selection_mode is WEIGHTED. A weight of 0 means never auto-selected, but can still be chosen explicitly via variation_id on CreateObjectiveRequest. - `assignments: Array[VariationAssignmentEntry]` Reconciled list — server adjusts the variation's assignments to exactly this set when the variation is bundle-owned. - `sub_agent_id: String` - `tool_id: String` - `tool_set_id: String` - `labels: Hash[Symbol, String]` - `memory_layers: Array[VariationMemoryLayerEntry]` Reconciled list of memory layer assignments. Up to 10 entries. - `memory_layer_id: String` external_id: form. Canonical IDs are rejected. - `position: Integer` - `automatically_publish_agents: bool` When true, every agent created or updated by this Apply has its status forced to AGENT_STATUS_PUBLISHED, regardless of the status declared in the agent's AgentSpec. Useful when the bundle represents a production configuration and you want all of its agents live without setting status: AGENT_STATUS_PUBLISHED on each entry. Default false: each agent's AgentSpec.status controls (which is AGENT_STATUS_DRAFT on create when unspecified). - `memory_layers: Hash[Symbol, MemoryLayerEntry]` Memory layers to upsert, keyed by external_id. - `name: String` - `spec: MemoryLayerSpec` - `type: :MEMORY_LAYER_TYPE_UNSPECIFIED | :MEMORY_LAYER_TYPE_EPISODIC | :MEMORY_LAYER_TYPE_SKILLS` - `:MEMORY_LAYER_TYPE_UNSPECIFIED` - `:MEMORY_LAYER_TYPE_EPISODIC` - `:MEMORY_LAYER_TYPE_SKILLS` - `description: String` Human-readable description of the layer's purpose. Encouraged for user-created layers; system-managed layers may have a generated description. - `expires_at: Time` For layers with a finite lifetime (e.g., episodic), the time at which the layer becomes eligible for cleanup. Set by the system; unset for persistent layers. - `system_managed: bool` Server-set. True for layers managed by the system (e.g., episodic layers created automatically when an objective uses an episodic_key). System-managed layers cannot be assigned to objective stacks via the API and cannot be mutated by clients — their lifecycle is controlled entirely by the runtime. - `entries: Hash[Symbol, MemoryEntryItem]` Memory entries in this layer, keyed by external_id. - `key: String` - `content: String` - `description: String` - `upload_id: String` - `labels: Hash[Symbol, String]` - `source_url: String` Optional URL pointing to the source of this apply (GitHub PR, Jenkins build, GitLab pipeline, etc.). Surfaced in the dashboard so users can jump from an apply back to the change that produced it. Free-form HTTPS URI; not interpreted by the server. - `tool_sets: Hash[Symbol, ToolSetEntry]` Tool sets to upsert, keyed by external_id. - `name: String` - `spec: ToolSetSpec` - `adapter: ToolSetAdapter` - `http: ToolSetAdapterHTTP` - `base_url: String` - `headers: Hash[Symbol, String]` - `mcp: ToolSetAdapterMcp` - `exclude_tools: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `operator: :OPERATOR_UNSPECIFIED | :OPERATOR_AND | :OPERATOR_OR` - `:OPERATOR_UNSPECIFIED` - `:OPERATOR_AND` - `:OPERATOR_OR` - `filters: Array[AttributeFilter]` - `attribute: :ATTRIBUTE_UNSPECIFIED | :ATTRIBUTE_NAME | :ATTRIBUTE_TITLE | :ATTRIBUTE_DESCRIPTION` - `:ATTRIBUTE_UNSPECIFIED` - `:ATTRIBUTE_NAME` - `:ATTRIBUTE_TITLE` - `:ATTRIBUTE_DESCRIPTION` - `matcher: StringMatcher` String matching operations - `case_sensitive: bool` - `contains: String` - `ends_with: String` - `exact: String` - `regex: String` - `starts_with: String` - `headers: Hash[Symbol, String]` - `include_tools: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `tool_approvals: ApprovalRequirementFilter` Approval filters that will automatically set the approval requirement on tools synced from an external source - `always: bool` - `only: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `url: String` - `openapi: ToolSetAdapterOpenAPI` - `base_url: String` Base URL for dispatching tool calls. If set, overrides the server resolved from the spec's servers array. - `exclude_tools: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `headers: Hash[Symbol, String]` Headers sent when fetching the spec from a URL and when dispatching tool calls. - `include_tools: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `server_name: String` Name of the server entry in the spec's servers array (OpenAPI 3.2 server.name field). Used to select which server URL to dispatch to when base_url is not set. If unset, the first server is used. Ignored when base_url is set. - `tool_approvals: ApprovalRequirementFilter` Approval filters that will automatically set the approval requirement on tools synced from an external source - `upload_id: String` ID of a COMPLETE Upload containing the OpenAPI spec document. - `url: String` URL to fetch the OpenAPI spec from. Synced automatically every hour. - `description: String` - `labels: Hash[Symbol, String]` - `tools: Hash[Symbol, ToolEntry]` Tools in this tool set, keyed by external_id. - `name: String` - `spec: ToolSpec` - `config: ToolSpecConfig` Config defines the adapter to use for the tool. This is used to determine how the tool is called. For example, if the tool is an HTTP tool, the adapter will be Http. If the tool is an inline tool, the adapter will be Inline. - `http: ConfigHTTP` - `request_method: :HTTP_METHOD_UNSPECIFIED | :GET | :POST | 3 more` - `:HTTP_METHOD_UNSPECIFIED` - `:GET` - `:POST` - `:PUT` - `:PATCH` - `:DELETE` - `headers: Hash[Symbol, String]` - `path: String` - `query: String` - `request_body_content_type: String` - `request_body_template: String` These are only used when the request method is a POST, PUT, or PATCH - `tool_name: String` The tool name (commonly an "operation id" in OpenAPI specs) to call on the HTTP adapter. This is used to match the tool spec to the correct endpoint on the HTTP adapter. it will be derived from the name of the tool if not provided. - `mcp: ConfigMcp` - `tool_description: String` - `tool_name: String` - `tool_title: String` - `openapi: ConfigOpenAPI` - `method_: String` - `operation_id: String` - `path: String` - `description: String` - `parameters: Hash[Symbol, untyped]` - `status: :TOOL_STATUS_UNSPECIFIED | :TOOL_STATUS_AVAILABLE | :TOOL_STATUS_OMITTED | :TOOL_STATUS_ARCHIVED` - `:TOOL_STATUS_UNSPECIFIED` - `:TOOL_STATUS_AVAILABLE` - `:TOOL_STATUS_OMITTED` - `:TOOL_STATUS_ARCHIVED` - `requires_approval: bool` - `labels: Hash[Symbol, String]` - `metadata: OperationMetadata` Metadata for ephemeral operations and activities (e.g., objectives, executions, runs) - `id: String` Unique identifier for the operation (prefixed ULID, e.g., "obj_01HXK...") - `account_id: String` Account this operation belongs to for multi-tenant isolation (prefixed ULID) - `created_at: Time` Timestamp when this operation was created ULID includes timestamp information, but this explicit field enables easier querying - `profile_id: String` ID of the actor (user or service account) that created this operation - `workspace_id: String` Workspace this operation belongs to for organizational grouping (prefixed ULID) - `external_id: String` External ID for the operation (e.g., a workflow ID from an external system) - `labels: Hash[Symbol, String]` Arbitrary key-value pairs for categorization and filtering Examples: {"priority": "high", "source": "api", "workflow": "onboarding"} - `status: BulkWorkspaceApplyStatus` - `state: :STATE_UNSPECIFIED | :STATE_PENDING | :STATE_VALIDATING | 5 more` - `:STATE_UNSPECIFIED` - `:STATE_PENDING` - `:STATE_VALIDATING` - `:STATE_RUNNING` - `:STATE_SUCCEEDED` - `:STATE_PARTIALLY_APPLIED` - `:STATE_FAILED` - `:STATE_CANCELLED` - `message: String` - `preflight_error: PreflightError{ code, details, message}` The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code: Integer` The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. - `details: Array[Detail{ type}]` A list of messages that carry the error details. There is a common set of message types for APIs to use. - `type: String` The type of the serialized message. - `message: String` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. - `info: BulkWorkspaceApplyInfo` - `completed_at: Time` - `created_by: Profile` A profile identifies a user or non-human principal (such as an API key) at the account level. Profiles are account-scoped and can be granted access to multiple workspaces. - `metadata: AccountResourceMetadata` AccountResourceMetadata is used to represent a resource that is associated to an account but not to a workspace. - `id: String` Unique identifier for the resource (prefixed ULID, e.g., "apikey_01HXK...") - `account_id: String` Account this resource belongs to for multi-tenant isolation (prefixed ULID) - `name: String` Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool") Required for resources that users interact with directly - `profile_id: String` - `external_id: String` External ID for the resource (e.g., a workflow ID from an external system) - `labels: Hash[Symbol, String]` Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"} - `spec: ProfileSpec` Configuration for a profile. - `type: :PROFILE_TYPE_UNSPECIFIED | :PROFILE_TYPE_USER | :PROFILE_TYPE_API_KEY | :PROFILE_TYPE_SYSTEM` Whether this profile represents a human user, an API key, or a system principal. - `:PROFILE_TYPE_UNSPECIFIED` - `:PROFILE_TYPE_USER` - `:PROFILE_TYPE_API_KEY` - `:PROFILE_TYPE_SYSTEM` - `email: String` Email address of the profile. Required and unique within an account for user profiles. - `name: String` Display name (e.g., "Bobby Tables"). - `created_count: Integer` - `deleted_count: Integer` - `failed_count: Integer` - `started_at: Time` - `total_count: Integer` - `unchanged_count: Integer` - `updated_count: Integer` ### Bulk Workspace Apply Data - `class BulkWorkspaceApplyData` - `bundle_key: String` Required. Bundle ownership key. Resources created or updated by an Apply have their `metadata.bundle_key` set to this value. On subsequent applies with the same bundle_key, resources currently bearing this bundle_key but absent from the spec are soft-deleted. - `agents: Hash[Symbol, AgentEntry]` Agents to upsert, keyed by external_id. - `name: String` - `spec: AgentSpec` Agent specification (user-provided configuration) - `status: :AGENT_STATUS_UNSPECIFIED | :AGENT_STATUS_DRAFT | :AGENT_STATUS_PUBLISHED | :AGENT_STATUS_ARCHIVED` Status of the agent - `:AGENT_STATUS_UNSPECIFIED` - `:AGENT_STATUS_DRAFT` - `:AGENT_STATUS_PUBLISHED` - `:AGENT_STATUS_ARCHIVED` - `variation_selection_mode: :VARIATION_SELECTION_MODE_UNSPECIFIED | :VARIATION_SELECTION_MODE_RANDOM | :VARIATION_SELECTION_MODE_WEIGHTED` Controls how variations are automatically selected when creating objectives Defaults to RANDOM when unspecified - `:VARIATION_SELECTION_MODE_UNSPECIFIED` - `:VARIATION_SELECTION_MODE_RANDOM` - `:VARIATION_SELECTION_MODE_WEIGHTED` - `description: String` Description of the agent's purpose - `input_data_schema: Hash[Symbol, untyped]` InputDataSchema is used for enforcing a data input when objectives are created. This is valuable when using liquid formatting in agent variation prompts. Input data schema is also valuable when using an agent as a sub-agent, as the schema is used as the tool's input parameter schema. If omitted, the sub-agent schema will be loaded with a simple "prompt" free text string as its schema. - `output_definition: Hash[Symbol, untyped]` Optional output definition for objectives created for this agent. When provided, Cadenya will append a tool to that will be called by the LLM in use by the variant to extract information in the format provided here. Use this option when you want structured data to be created by your objectives. - `webhook_events_url: String` The URL that Cadenya will send events for any objective assigned to the agent. - `labels: Hash[Symbol, String]` - `schedules: Hash[Symbol, AgentScheduleEntry]` Schedules under this agent, keyed by external_id. - `name: String` - `spec: AgentScheduleSpec` AgentScheduleSpec is the user-provided configuration for a schedule. - `initial_message: String` The initial message passed to CreateObjective on each fire. Becomes the first user message in the objective's chat history. - `schedule: AgentScheduleSpecSchedule` Schedule defines WHEN the schedule fires. Temporal-style structured form: a list of calendar rules (wall-clock) and/or interval rules (duration), OR'd together. At least one rule is required. - `calendars: Array[ScheduleCalendar]` Wall-clock rules. May be empty if `intervals` is non-empty. - `comment: String` - `day_of_month: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `day_of_week: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `hour: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `minute: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `month: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `second: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `intervals: Array[ScheduleInterval]` Duration-based rules. May be empty if `calendars` is non-empty. - `every: String` - `offset: String` Phase shift within `every`. Must be < `every` (enforced at runtime). - `timezone: String` IANA tz name (e.g. "America/New_York"). Required. Applies to calendars; intervals fire on wall-clock cadence anchored in this zone. - `data: untyped` Optional input data passed to the objective. If the agent has an input_data_schema, this must satisfy it. - `overlap_policy: :OVERLAP_POLICY_UNSPECIFIED | :OVERLAP_POLICY_ALLOW | :OVERLAP_POLICY_SKIP` What to do when the previous run is still in flight. Defaults to SKIP. - `:OVERLAP_POLICY_UNSPECIFIED` - `:OVERLAP_POLICY_ALLOW` - `:OVERLAP_POLICY_SKIP` - `status: :AGENT_SCHEDULE_STATUS_UNSPECIFIED | :AGENT_SCHEDULE_STATUS_ACTIVE | :AGENT_SCHEDULE_STATUS_PAUSED | :AGENT_SCHEDULE_STATUS_ARCHIVED` Lifecycle. Defaults to ACTIVE on create when unspecified. - `:AGENT_SCHEDULE_STATUS_UNSPECIFIED` - `:AGENT_SCHEDULE_STATUS_ACTIVE` - `:AGENT_SCHEDULE_STATUS_PAUSED` - `:AGENT_SCHEDULE_STATUS_ARCHIVED` - `variation_id: String` Optional explicit variation. When unset, the agent's variation_selection_mode chooses per fire. - `labels: Hash[Symbol, String]` - `variations: Hash[Symbol, AgentVariationEntry]` Variations under this agent, keyed by external_id. - `name: String` - `spec: AgentVariationSpec` AgentVariationSpec defines the operational configuration for a variation - `compaction_config: AgentVariationSpecCompactionConfig` CompactionConfig defines how context window compaction behaves for objectives using this variation. - `summarization: CompactionConfigSummarizationStrategy` SummarizationStrategy configures LLM-powered summarization of older conversation turns. - `instructions: String` Custom instructions that guide what the summarizer preserves. Replaces the default summarization prompt entirely. Example: "Preserve all code snippets, variable names, and technical decisions." - `tool_result_clearing: CompactionConfigToolResultClearingStrategy` ToolResultClearingStrategy configures clearing of older tool result content. - `preserve_recent_results: Integer` Number of most recent tool call results to keep intact. Older tool results have their content replaced with "[result cleared]" while preserving the assistant tool call message (function name, arguments). Default: 2 - `trigger_threshold: Float` Trigger threshold as a percentage of the model's context window (0.0 to 1.0). When input tokens reach this percentage of the model's limit, compaction triggers. Default: 0.75 (75%) - `constraints: AgentVariationSpecConstraints` Execution constraints - `max_sub_objectives: Integer` The maximum number of sub-objectives that can be created. 0 means no limit. - `max_tool_calls: Integer` The maximum number of tool calls that can be made. 0 means no limit. - `description: String` Human-readable description of what this variation does or when it should be used - `enable_episodic_memory: bool` Enable episodic memory for objectives using this variation. When true, the system automatically creates a document namespace for each objective using the objective's episodic_key as the external_id, allowing the agent to store and retrieve documents specific to that episode. - `episodic_memory_ttl: Integer` How long episodic memories should be retained. After this duration, episodic document namespaces can be automatically cleaned up. If not set, episodic memories are retained indefinitely. - `model_config: AgentVariationSpecModelConfig` ModelConfig defines the model configuration for a variation - `model_id: String` The model identifier in family/model format (e.g., "claude/opus-4.6", "claude/sonnet-4.5") - `temperature: Float` Sampling temperature for model inference (0.0 to 1.0) Lower values produce more deterministic outputs, higher values increase randomness - `progressive_discovery: AgentVariationSpecProgressiveDiscovery` ProgressiveDiscovery is used to indicate that the agent should automatically discover tools that are not explicitly assigned to it. Max tools is the maximum number of tools that can be discovered per search. Hints are optional hints for tool search. These are used in conjunction with the context-aware tool search and can help select the best tools for the task. - `hints: Array[String]` - `max_tools: Integer` - `rerank_threshold: Float` Rerank Threshold is an optional value that instructs whether or not to run a search result through a embedding/reranker process which can improve performance and reduce context bloat when tools reach the configured threshold. If a tool match must exceed 0.8, for example, the tool very closely match the query the tool search performed. - `prompt: String` The system prompt for this variation - `weight: Integer` Weight for weighted random selection (>= 0). P(v) = v.weight / sum(all_weights). Only used when the agent's variation_selection_mode is WEIGHTED. A weight of 0 means never auto-selected, but can still be chosen explicitly via variation_id on CreateObjectiveRequest. - `assignments: Array[VariationAssignmentEntry]` Reconciled list — server adjusts the variation's assignments to exactly this set when the variation is bundle-owned. - `sub_agent_id: String` - `tool_id: String` - `tool_set_id: String` - `labels: Hash[Symbol, String]` - `memory_layers: Array[VariationMemoryLayerEntry]` Reconciled list of memory layer assignments. Up to 10 entries. - `memory_layer_id: String` external_id: form. Canonical IDs are rejected. - `position: Integer` - `automatically_publish_agents: bool` When true, every agent created or updated by this Apply has its status forced to AGENT_STATUS_PUBLISHED, regardless of the status declared in the agent's AgentSpec. Useful when the bundle represents a production configuration and you want all of its agents live without setting status: AGENT_STATUS_PUBLISHED on each entry. Default false: each agent's AgentSpec.status controls (which is AGENT_STATUS_DRAFT on create when unspecified). - `memory_layers: Hash[Symbol, MemoryLayerEntry]` Memory layers to upsert, keyed by external_id. - `name: String` - `spec: MemoryLayerSpec` - `type: :MEMORY_LAYER_TYPE_UNSPECIFIED | :MEMORY_LAYER_TYPE_EPISODIC | :MEMORY_LAYER_TYPE_SKILLS` - `:MEMORY_LAYER_TYPE_UNSPECIFIED` - `:MEMORY_LAYER_TYPE_EPISODIC` - `:MEMORY_LAYER_TYPE_SKILLS` - `description: String` Human-readable description of the layer's purpose. Encouraged for user-created layers; system-managed layers may have a generated description. - `expires_at: Time` For layers with a finite lifetime (e.g., episodic), the time at which the layer becomes eligible for cleanup. Set by the system; unset for persistent layers. - `system_managed: bool` Server-set. True for layers managed by the system (e.g., episodic layers created automatically when an objective uses an episodic_key). System-managed layers cannot be assigned to objective stacks via the API and cannot be mutated by clients — their lifecycle is controlled entirely by the runtime. - `entries: Hash[Symbol, MemoryEntryItem]` Memory entries in this layer, keyed by external_id. - `key: String` - `content: String` - `description: String` - `upload_id: String` - `labels: Hash[Symbol, String]` - `source_url: String` Optional URL pointing to the source of this apply (GitHub PR, Jenkins build, GitLab pipeline, etc.). Surfaced in the dashboard so users can jump from an apply back to the change that produced it. Free-form HTTPS URI; not interpreted by the server. - `tool_sets: Hash[Symbol, ToolSetEntry]` Tool sets to upsert, keyed by external_id. - `name: String` - `spec: ToolSetSpec` - `adapter: ToolSetAdapter` - `http: ToolSetAdapterHTTP` - `base_url: String` - `headers: Hash[Symbol, String]` - `mcp: ToolSetAdapterMcp` - `exclude_tools: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `operator: :OPERATOR_UNSPECIFIED | :OPERATOR_AND | :OPERATOR_OR` - `:OPERATOR_UNSPECIFIED` - `:OPERATOR_AND` - `:OPERATOR_OR` - `filters: Array[AttributeFilter]` - `attribute: :ATTRIBUTE_UNSPECIFIED | :ATTRIBUTE_NAME | :ATTRIBUTE_TITLE | :ATTRIBUTE_DESCRIPTION` - `:ATTRIBUTE_UNSPECIFIED` - `:ATTRIBUTE_NAME` - `:ATTRIBUTE_TITLE` - `:ATTRIBUTE_DESCRIPTION` - `matcher: StringMatcher` String matching operations - `case_sensitive: bool` - `contains: String` - `ends_with: String` - `exact: String` - `regex: String` - `starts_with: String` - `headers: Hash[Symbol, String]` - `include_tools: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `tool_approvals: ApprovalRequirementFilter` Approval filters that will automatically set the approval requirement on tools synced from an external source - `always: bool` - `only: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `url: String` - `openapi: ToolSetAdapterOpenAPI` - `base_url: String` Base URL for dispatching tool calls. If set, overrides the server resolved from the spec's servers array. - `exclude_tools: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `headers: Hash[Symbol, String]` Headers sent when fetching the spec from a URL and when dispatching tool calls. - `include_tools: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `server_name: String` Name of the server entry in the spec's servers array (OpenAPI 3.2 server.name field). Used to select which server URL to dispatch to when base_url is not set. If unset, the first server is used. Ignored when base_url is set. - `tool_approvals: ApprovalRequirementFilter` Approval filters that will automatically set the approval requirement on tools synced from an external source - `upload_id: String` ID of a COMPLETE Upload containing the OpenAPI spec document. - `url: String` URL to fetch the OpenAPI spec from. Synced automatically every hour. - `description: String` - `labels: Hash[Symbol, String]` - `tools: Hash[Symbol, ToolEntry]` Tools in this tool set, keyed by external_id. - `name: String` - `spec: ToolSpec` - `config: ToolSpecConfig` Config defines the adapter to use for the tool. This is used to determine how the tool is called. For example, if the tool is an HTTP tool, the adapter will be Http. If the tool is an inline tool, the adapter will be Inline. - `http: ConfigHTTP` - `request_method: :HTTP_METHOD_UNSPECIFIED | :GET | :POST | 3 more` - `:HTTP_METHOD_UNSPECIFIED` - `:GET` - `:POST` - `:PUT` - `:PATCH` - `:DELETE` - `headers: Hash[Symbol, String]` - `path: String` - `query: String` - `request_body_content_type: String` - `request_body_template: String` These are only used when the request method is a POST, PUT, or PATCH - `tool_name: String` The tool name (commonly an "operation id" in OpenAPI specs) to call on the HTTP adapter. This is used to match the tool spec to the correct endpoint on the HTTP adapter. it will be derived from the name of the tool if not provided. - `mcp: ConfigMcp` - `tool_description: String` - `tool_name: String` - `tool_title: String` - `openapi: ConfigOpenAPI` - `method_: String` - `operation_id: String` - `path: String` - `description: String` - `parameters: Hash[Symbol, untyped]` - `status: :TOOL_STATUS_UNSPECIFIED | :TOOL_STATUS_AVAILABLE | :TOOL_STATUS_OMITTED | :TOOL_STATUS_ARCHIVED` - `:TOOL_STATUS_UNSPECIFIED` - `:TOOL_STATUS_AVAILABLE` - `:TOOL_STATUS_OMITTED` - `:TOOL_STATUS_ARCHIVED` - `requires_approval: bool` - `labels: Hash[Symbol, String]` ### Bulk Workspace Apply Info - `class BulkWorkspaceApplyInfo` - `completed_at: Time` - `created_by: Profile` A profile identifies a user or non-human principal (such as an API key) at the account level. Profiles are account-scoped and can be granted access to multiple workspaces. - `metadata: AccountResourceMetadata` AccountResourceMetadata is used to represent a resource that is associated to an account but not to a workspace. - `id: String` Unique identifier for the resource (prefixed ULID, e.g., "apikey_01HXK...") - `account_id: String` Account this resource belongs to for multi-tenant isolation (prefixed ULID) - `name: String` Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool") Required for resources that users interact with directly - `profile_id: String` - `external_id: String` External ID for the resource (e.g., a workflow ID from an external system) - `labels: Hash[Symbol, String]` Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"} - `spec: ProfileSpec` Configuration for a profile. - `type: :PROFILE_TYPE_UNSPECIFIED | :PROFILE_TYPE_USER | :PROFILE_TYPE_API_KEY | :PROFILE_TYPE_SYSTEM` Whether this profile represents a human user, an API key, or a system principal. - `:PROFILE_TYPE_UNSPECIFIED` - `:PROFILE_TYPE_USER` - `:PROFILE_TYPE_API_KEY` - `:PROFILE_TYPE_SYSTEM` - `email: String` Email address of the profile. Required and unique within an account for user profiles. - `name: String` Display name (e.g., "Bobby Tables"). - `created_count: Integer` - `deleted_count: Integer` - `failed_count: Integer` - `started_at: Time` - `total_count: Integer` - `unchanged_count: Integer` - `updated_count: Integer` ### Bulk Workspace Apply Status - `class BulkWorkspaceApplyStatus` - `state: :STATE_UNSPECIFIED | :STATE_PENDING | :STATE_VALIDATING | 5 more` - `:STATE_UNSPECIFIED` - `:STATE_PENDING` - `:STATE_VALIDATING` - `:STATE_RUNNING` - `:STATE_SUCCEEDED` - `:STATE_PARTIALLY_APPLIED` - `:STATE_FAILED` - `:STATE_CANCELLED` - `message: String` - `preflight_error: PreflightError{ code, details, message}` The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code: Integer` The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. - `details: Array[Detail{ type}]` A list of messages that carry the error details. There is a common set of message types for APIs to use. - `type: String` The type of the serialized message. - `message: String` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. ### Memory Entry Item - `class MemoryEntryItem` - `key: String` - `content: String` - `description: String` - `upload_id: String` ### Memory Layer Entry - `class MemoryLayerEntry` - `name: String` - `spec: MemoryLayerSpec` - `type: :MEMORY_LAYER_TYPE_UNSPECIFIED | :MEMORY_LAYER_TYPE_EPISODIC | :MEMORY_LAYER_TYPE_SKILLS` - `:MEMORY_LAYER_TYPE_UNSPECIFIED` - `:MEMORY_LAYER_TYPE_EPISODIC` - `:MEMORY_LAYER_TYPE_SKILLS` - `description: String` Human-readable description of the layer's purpose. Encouraged for user-created layers; system-managed layers may have a generated description. - `expires_at: Time` For layers with a finite lifetime (e.g., episodic), the time at which the layer becomes eligible for cleanup. Set by the system; unset for persistent layers. - `system_managed: bool` Server-set. True for layers managed by the system (e.g., episodic layers created automatically when an objective uses an episodic_key). System-managed layers cannot be assigned to objective stacks via the API and cannot be mutated by clients — their lifecycle is controlled entirely by the runtime. - `entries: Hash[Symbol, MemoryEntryItem]` Memory entries in this layer, keyed by external_id. - `key: String` - `content: String` - `description: String` - `upload_id: String` - `labels: Hash[Symbol, String]` ### Tool Entry - `class ToolEntry` - `name: String` - `spec: ToolSpec` - `config: ToolSpecConfig` Config defines the adapter to use for the tool. This is used to determine how the tool is called. For example, if the tool is an HTTP tool, the adapter will be Http. If the tool is an inline tool, the adapter will be Inline. - `http: ConfigHTTP` - `request_method: :HTTP_METHOD_UNSPECIFIED | :GET | :POST | 3 more` - `:HTTP_METHOD_UNSPECIFIED` - `:GET` - `:POST` - `:PUT` - `:PATCH` - `:DELETE` - `headers: Hash[Symbol, String]` - `path: String` - `query: String` - `request_body_content_type: String` - `request_body_template: String` These are only used when the request method is a POST, PUT, or PATCH - `tool_name: String` The tool name (commonly an "operation id" in OpenAPI specs) to call on the HTTP adapter. This is used to match the tool spec to the correct endpoint on the HTTP adapter. it will be derived from the name of the tool if not provided. - `mcp: ConfigMcp` - `tool_description: String` - `tool_name: String` - `tool_title: String` - `openapi: ConfigOpenAPI` - `method_: String` - `operation_id: String` - `path: String` - `description: String` - `parameters: Hash[Symbol, untyped]` - `status: :TOOL_STATUS_UNSPECIFIED | :TOOL_STATUS_AVAILABLE | :TOOL_STATUS_OMITTED | :TOOL_STATUS_ARCHIVED` - `:TOOL_STATUS_UNSPECIFIED` - `:TOOL_STATUS_AVAILABLE` - `:TOOL_STATUS_OMITTED` - `:TOOL_STATUS_ARCHIVED` - `requires_approval: bool` - `labels: Hash[Symbol, String]` ### Tool Set Entry - `class ToolSetEntry` - `name: String` - `spec: ToolSetSpec` - `adapter: ToolSetAdapter` - `http: ToolSetAdapterHTTP` - `base_url: String` - `headers: Hash[Symbol, String]` - `mcp: ToolSetAdapterMcp` - `exclude_tools: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `operator: :OPERATOR_UNSPECIFIED | :OPERATOR_AND | :OPERATOR_OR` - `:OPERATOR_UNSPECIFIED` - `:OPERATOR_AND` - `:OPERATOR_OR` - `filters: Array[AttributeFilter]` - `attribute: :ATTRIBUTE_UNSPECIFIED | :ATTRIBUTE_NAME | :ATTRIBUTE_TITLE | :ATTRIBUTE_DESCRIPTION` - `:ATTRIBUTE_UNSPECIFIED` - `:ATTRIBUTE_NAME` - `:ATTRIBUTE_TITLE` - `:ATTRIBUTE_DESCRIPTION` - `matcher: StringMatcher` String matching operations - `case_sensitive: bool` - `contains: String` - `ends_with: String` - `exact: String` - `regex: String` - `starts_with: String` - `headers: Hash[Symbol, String]` - `include_tools: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `tool_approvals: ApprovalRequirementFilter` Approval filters that will automatically set the approval requirement on tools synced from an external source - `always: bool` - `only: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `url: String` - `openapi: ToolSetAdapterOpenAPI` - `base_url: String` Base URL for dispatching tool calls. If set, overrides the server resolved from the spec's servers array. - `exclude_tools: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `headers: Hash[Symbol, String]` Headers sent when fetching the spec from a URL and when dispatching tool calls. - `include_tools: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `server_name: String` Name of the server entry in the spec's servers array (OpenAPI 3.2 server.name field). Used to select which server URL to dispatch to when base_url is not set. If unset, the first server is used. Ignored when base_url is set. - `tool_approvals: ApprovalRequirementFilter` Approval filters that will automatically set the approval requirement on tools synced from an external source - `upload_id: String` ID of a COMPLETE Upload containing the OpenAPI spec document. - `url: String` URL to fetch the OpenAPI spec from. Synced automatically every hour. - `description: String` - `labels: Hash[Symbol, String]` - `tools: Hash[Symbol, ToolEntry]` Tools in this tool set, keyed by external_id. - `name: String` - `spec: ToolSpec` - `config: ToolSpecConfig` Config defines the adapter to use for the tool. This is used to determine how the tool is called. For example, if the tool is an HTTP tool, the adapter will be Http. If the tool is an inline tool, the adapter will be Inline. - `http: ConfigHTTP` - `request_method: :HTTP_METHOD_UNSPECIFIED | :GET | :POST | 3 more` - `:HTTP_METHOD_UNSPECIFIED` - `:GET` - `:POST` - `:PUT` - `:PATCH` - `:DELETE` - `headers: Hash[Symbol, String]` - `path: String` - `query: String` - `request_body_content_type: String` - `request_body_template: String` These are only used when the request method is a POST, PUT, or PATCH - `tool_name: String` The tool name (commonly an "operation id" in OpenAPI specs) to call on the HTTP adapter. This is used to match the tool spec to the correct endpoint on the HTTP adapter. it will be derived from the name of the tool if not provided. - `mcp: ConfigMcp` - `tool_description: String` - `tool_name: String` - `tool_title: String` - `openapi: ConfigOpenAPI` - `method_: String` - `operation_id: String` - `path: String` - `description: String` - `parameters: Hash[Symbol, untyped]` - `status: :TOOL_STATUS_UNSPECIFIED | :TOOL_STATUS_AVAILABLE | :TOOL_STATUS_OMITTED | :TOOL_STATUS_ARCHIVED` - `:TOOL_STATUS_UNSPECIFIED` - `:TOOL_STATUS_AVAILABLE` - `:TOOL_STATUS_OMITTED` - `:TOOL_STATUS_ARCHIVED` - `requires_approval: bool` - `labels: Hash[Symbol, String]` ### Variation Assignment Entry - `class VariationAssignmentEntry` - `sub_agent_id: String` - `tool_id: String` - `tool_set_id: String` ### Variation Memory Layer Entry - `class VariationMemoryLayerEntry` - `memory_layer_id: String` external_id: form. Canonical IDs are rejected. - `position: Integer` # Results ## List per-resource results for a bulk workspace apply `bulk_workspace_resources.results.list(bulk_workspace_apply_id, **kwargs) -> CursorPagination` **get** `/v1/workspaces/{workspaceId}/bulk_workspace_applies/{bulkWorkspaceApplyId}/results` Lists each resource action recorded by a bulk workspace apply operation. ### Parameters - `workspace_id: String` - `bulk_workspace_apply_id: String` - `action: :ACTION_UNSPECIFIED | :ACTION_CREATED | :ACTION_UPDATED | 3 more` Filter by action. - `:ACTION_UNSPECIFIED` - `:ACTION_CREATED` - `:ACTION_UPDATED` - `:ACTION_UNCHANGED` - `:ACTION_DELETED` - `:ACTION_FAILED` - `cursor: String` Pagination cursor from previous response - `limit: Integer` Maximum number of results to return - `sort_order: String` Sort order for results (asc or desc by creation time) - `type: String` Filter by data.type discriminator (e.g., "toolSet", "memoryEntry"). ### Returns - `class BulkWorkspaceApplyResult` One row of the per-resource result list for a BulkWorkspaceApply. Each row is itself an operation that can be paginated, sorted by created_at, and addressed individually. - `data: BulkWorkspaceApplyResultData` Outcome for a single resource within a bulk apply. The `type` field is the discriminator string naming the populated `outcome` oneof variant (e.g., "toolSet", "memoryEntry"). Every outcome shell carries an `action` enum and either a resulting resource snapshot (for ACTION_CREATED, ACTION_UPDATED, ACTION_UNCHANGED, ACTION_DELETED) or a google.rpc.Status (for ACTION_FAILED). - `agent: BulkWorkspaceApplyResultDataAgentOutcome` - `action: :ACTION_UNSPECIFIED | :ACTION_CREATED | :ACTION_UPDATED | 3 more` - `:ACTION_UNSPECIFIED` - `:ACTION_CREATED` - `:ACTION_UPDATED` - `:ACTION_UNCHANGED` - `:ACTION_DELETED` - `:ACTION_FAILED` - `error: Error{ code, details, message}` The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code: Integer` The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. - `details: Array[Detail{ type}]` A list of messages that carry the error details. There is a common set of message types for APIs to use. - `type: String` The type of the serialized message. - `message: String` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. - `external_id: String` - `resource: Agent` Agent resource - `metadata: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) - `id: String` Unique identifier for the resource (prefixed ULID, e.g., "agent_01HXK...") - `account_id: String` Account this resource belongs to for multi-tenant isolation (prefixed ULID) - `created_at: Time` Timestamp when this resource was created - `name: String` Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool") Required for resources that users interact with directly - `profile_id: String` ID of the actor (user or service account) that created this resource - `workspace_id: String` Workspace this resource belongs to for organizational grouping (prefixed ULID) - `bundle_key: String` Optional bundle ownership key. When set, indicates the resource is managed by a configuration bundle identified by this key. Used by BulkWorkspaceResources.Apply to track which resources belong to which bundle for reconciliation / soft-delete on re-apply. - `external_id: String` External ID for the resource (e.g., a workflow ID from an external system) - `labels: Hash[Symbol, String]` Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"} - `spec: AgentSpec` Agent specification (user-provided configuration) - `status: :AGENT_STATUS_UNSPECIFIED | :AGENT_STATUS_DRAFT | :AGENT_STATUS_PUBLISHED | :AGENT_STATUS_ARCHIVED` Status of the agent - `:AGENT_STATUS_UNSPECIFIED` - `:AGENT_STATUS_DRAFT` - `:AGENT_STATUS_PUBLISHED` - `:AGENT_STATUS_ARCHIVED` - `variation_selection_mode: :VARIATION_SELECTION_MODE_UNSPECIFIED | :VARIATION_SELECTION_MODE_RANDOM | :VARIATION_SELECTION_MODE_WEIGHTED` Controls how variations are automatically selected when creating objectives Defaults to RANDOM when unspecified - `:VARIATION_SELECTION_MODE_UNSPECIFIED` - `:VARIATION_SELECTION_MODE_RANDOM` - `:VARIATION_SELECTION_MODE_WEIGHTED` - `description: String` Description of the agent's purpose - `input_data_schema: Hash[Symbol, untyped]` InputDataSchema is used for enforcing a data input when objectives are created. This is valuable when using liquid formatting in agent variation prompts. Input data schema is also valuable when using an agent as a sub-agent, as the schema is used as the tool's input parameter schema. If omitted, the sub-agent schema will be loaded with a simple "prompt" free text string as its schema. - `output_definition: Hash[Symbol, untyped]` Optional output definition for objectives created for this agent. When provided, Cadenya will append a tool to that will be called by the LLM in use by the variant to extract information in the format provided here. Use this option when you want structured data to be created by your objectives. - `webhook_events_url: String` The URL that Cadenya will send events for any objective assigned to the agent. - `info: AgentInfo` AgentInfo contains simple information about an agent for display or quick reference - `created_by: Profile` A profile identifies a user or non-human principal (such as an API key) at the account level. Profiles are account-scoped and can be granted access to multiple workspaces. - `metadata: AccountResourceMetadata` AccountResourceMetadata is used to represent a resource that is associated to an account but not to a workspace. - `id: String` Unique identifier for the resource (prefixed ULID, e.g., "apikey_01HXK...") - `account_id: String` Account this resource belongs to for multi-tenant isolation (prefixed ULID) - `name: String` Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool") Required for resources that users interact with directly - `profile_id: String` - `external_id: String` External ID for the resource (e.g., a workflow ID from an external system) - `labels: Hash[Symbol, String]` Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"} - `spec: ProfileSpec` Configuration for a profile. - `type: :PROFILE_TYPE_UNSPECIFIED | :PROFILE_TYPE_USER | :PROFILE_TYPE_API_KEY | :PROFILE_TYPE_SYSTEM` Whether this profile represents a human user, an API key, or a system principal. - `:PROFILE_TYPE_UNSPECIFIED` - `:PROFILE_TYPE_USER` - `:PROFILE_TYPE_API_KEY` - `:PROFILE_TYPE_SYSTEM` - `email: String` Email address of the profile. Required and unique within an account for user profiles. - `name: String` Display name (e.g., "Bobby Tables"). - `variation_count: Integer` - `agent_schedule: BulkWorkspaceApplyResultDataAgentScheduleOutcome` - `action: :ACTION_UNSPECIFIED | :ACTION_CREATED | :ACTION_UPDATED | 3 more` - `:ACTION_UNSPECIFIED` - `:ACTION_CREATED` - `:ACTION_UPDATED` - `:ACTION_UNCHANGED` - `:ACTION_DELETED` - `:ACTION_FAILED` - `error: Error{ code, details, message}` The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code: Integer` The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. - `details: Array[Detail{ type}]` A list of messages that carry the error details. There is a common set of message types for APIs to use. - `type: String` The type of the serialized message. - `message: String` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. - `external_id: String` - `resource: AgentSchedule` AgentSchedule resource — a recurring trigger attached to an agent that creates objectives on its cadence. - `metadata: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) - `spec: AgentScheduleSpec` AgentScheduleSpec is the user-provided configuration for a schedule. - `initial_message: String` The initial message passed to CreateObjective on each fire. Becomes the first user message in the objective's chat history. - `schedule: AgentScheduleSpecSchedule` Schedule defines WHEN the schedule fires. Temporal-style structured form: a list of calendar rules (wall-clock) and/or interval rules (duration), OR'd together. At least one rule is required. - `calendars: Array[ScheduleCalendar]` Wall-clock rules. May be empty if `intervals` is non-empty. - `comment: String` - `day_of_month: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `day_of_week: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `hour: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `minute: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `month: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `second: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `intervals: Array[ScheduleInterval]` Duration-based rules. May be empty if `calendars` is non-empty. - `every: String` - `offset: String` Phase shift within `every`. Must be < `every` (enforced at runtime). - `timezone: String` IANA tz name (e.g. "America/New_York"). Required. Applies to calendars; intervals fire on wall-clock cadence anchored in this zone. - `data: untyped` Optional input data passed to the objective. If the agent has an input_data_schema, this must satisfy it. - `overlap_policy: :OVERLAP_POLICY_UNSPECIFIED | :OVERLAP_POLICY_ALLOW | :OVERLAP_POLICY_SKIP` What to do when the previous run is still in flight. Defaults to SKIP. - `:OVERLAP_POLICY_UNSPECIFIED` - `:OVERLAP_POLICY_ALLOW` - `:OVERLAP_POLICY_SKIP` - `status: :AGENT_SCHEDULE_STATUS_UNSPECIFIED | :AGENT_SCHEDULE_STATUS_ACTIVE | :AGENT_SCHEDULE_STATUS_PAUSED | :AGENT_SCHEDULE_STATUS_ARCHIVED` Lifecycle. Defaults to ACTIVE on create when unspecified. - `:AGENT_SCHEDULE_STATUS_UNSPECIFIED` - `:AGENT_SCHEDULE_STATUS_ACTIVE` - `:AGENT_SCHEDULE_STATUS_PAUSED` - `:AGENT_SCHEDULE_STATUS_ARCHIVED` - `variation_id: String` Optional explicit variation. When unset, the agent's variation_selection_mode chooses per fire. - `info: AgentScheduleInfo` AgentScheduleInfo provides read-only runtime data about a schedule. - `created_by: Profile` A profile identifies a user or non-human principal (such as an API key) at the account level. Profiles are account-scoped and can be granted access to multiple workspaces. - `last_fire_at: Time` When the schedule last fired (regardless of objective outcome). - `last_objective_id: String` ID of the most recent objective the schedule created. - `last_skipped_at: Time` When the schedule most recently skipped a fire (SKIP policy + prior in flight). - `last_skip_reason: String` Reason for the most recent skip (e.g. "previous objective still running"). - `next_fire_at: Time` When the schedule will next fire. Computed from the spec; absent when the schedule is PAUSED/ARCHIVED or has no future fire times. - `total_fires: Integer` Lifetime count of objectives created by this schedule. - `agent_variation: BulkWorkspaceApplyResultDataAgentVariationOutcome` - `action: :ACTION_UNSPECIFIED | :ACTION_CREATED | :ACTION_UPDATED | 3 more` - `:ACTION_UNSPECIFIED` - `:ACTION_CREATED` - `:ACTION_UPDATED` - `:ACTION_UNCHANGED` - `:ACTION_DELETED` - `:ACTION_FAILED` - `error: Error{ code, details, message}` The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code: Integer` The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. - `details: Array[Detail{ type}]` A list of messages that carry the error details. There is a common set of message types for APIs to use. - `type: String` The type of the serialized message. - `message: String` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. - `external_id: String` - `resource: AgentVariation` AgentVariation resource - `metadata: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) - `spec: AgentVariationSpec` AgentVariationSpec defines the operational configuration for a variation - `compaction_config: AgentVariationSpecCompactionConfig` CompactionConfig defines how context window compaction behaves for objectives using this variation. - `summarization: CompactionConfigSummarizationStrategy` SummarizationStrategy configures LLM-powered summarization of older conversation turns. - `instructions: String` Custom instructions that guide what the summarizer preserves. Replaces the default summarization prompt entirely. Example: "Preserve all code snippets, variable names, and technical decisions." - `tool_result_clearing: CompactionConfigToolResultClearingStrategy` ToolResultClearingStrategy configures clearing of older tool result content. - `preserve_recent_results: Integer` Number of most recent tool call results to keep intact. Older tool results have their content replaced with "[result cleared]" while preserving the assistant tool call message (function name, arguments). Default: 2 - `trigger_threshold: Float` Trigger threshold as a percentage of the model's context window (0.0 to 1.0). When input tokens reach this percentage of the model's limit, compaction triggers. Default: 0.75 (75%) - `constraints: AgentVariationSpecConstraints` Execution constraints - `max_sub_objectives: Integer` The maximum number of sub-objectives that can be created. 0 means no limit. - `max_tool_calls: Integer` The maximum number of tool calls that can be made. 0 means no limit. - `description: String` Human-readable description of what this variation does or when it should be used - `enable_episodic_memory: bool` Enable episodic memory for objectives using this variation. When true, the system automatically creates a document namespace for each objective using the objective's episodic_key as the external_id, allowing the agent to store and retrieve documents specific to that episode. - `episodic_memory_ttl: Integer` How long episodic memories should be retained. After this duration, episodic document namespaces can be automatically cleaned up. If not set, episodic memories are retained indefinitely. - `model_config: AgentVariationSpecModelConfig` ModelConfig defines the model configuration for a variation - `model_id: String` The model identifier in family/model format (e.g., "claude/opus-4.6", "claude/sonnet-4.5") - `temperature: Float` Sampling temperature for model inference (0.0 to 1.0) Lower values produce more deterministic outputs, higher values increase randomness - `progressive_discovery: AgentVariationSpecProgressiveDiscovery` ProgressiveDiscovery is used to indicate that the agent should automatically discover tools that are not explicitly assigned to it. Max tools is the maximum number of tools that can be discovered per search. Hints are optional hints for tool search. These are used in conjunction with the context-aware tool search and can help select the best tools for the task. - `hints: Array[String]` - `max_tools: Integer` - `rerank_threshold: Float` Rerank Threshold is an optional value that instructs whether or not to run a search result through a embedding/reranker process which can improve performance and reduce context bloat when tools reach the configured threshold. If a tool match must exceed 0.8, for example, the tool very closely match the query the tool search performed. - `prompt: String` The system prompt for this variation - `weight: Integer` Weight for weighted random selection (>= 0). P(v) = v.weight / sum(all_weights). Only used when the agent's variation_selection_mode is WEIGHTED. A weight of 0 means never auto-selected, but can still be chosen explicitly via variation_id on CreateObjectiveRequest. - `info: AgentVariationInfo` AgentVariationInfo provides read-only summary information about a variation - `assignments: Array[VariationAssignment]` All tools, tool sets, and sub-agents assigned to this variation. Populated on reads so clients can render a variation's full assignment list without calling the add/remove endpoints just to enumerate. - `id: String` - `agent: BareMetadata` BareMetadata contains the minimal metadata for a resource: the ID and an optional human-readable name. These are used for reference fields where the full metadata (account scoping, timestamps, labels, external IDs) is not needed — e.g., the tool references inside an agent variation spec or the tools assigned to an objective. Both fields are server-populated; clients provide IDs through sibling fields rather than by constructing a BareMetadata themselves. - `id: String` - `name: String` Human-readable name of the referenced resource, populated by the server on reads for convenience. Absent on references to resources that do not have a name (e.g., objective tasks). - `tool: BareMetadata` BareMetadata contains the minimal metadata for a resource: the ID and an optional human-readable name. These are used for reference fields where the full metadata (account scoping, timestamps, labels, external IDs) is not needed — e.g., the tool references inside an agent variation spec or the tools assigned to an objective. Both fields are server-populated; clients provide IDs through sibling fields rather than by constructing a BareMetadata themselves. - `tool_set: BareMetadata` BareMetadata contains the minimal metadata for a resource: the ID and an optional human-readable name. These are used for reference fields where the full metadata (account scoping, timestamps, labels, external IDs) is not needed — e.g., the tool references inside an agent variation spec or the tools assigned to an objective. Both fields are server-populated; clients provide IDs through sibling fields rather than by constructing a BareMetadata themselves. - `created_by: Profile` A profile identifies a user or non-human principal (such as an API key) at the account level. Profiles are account-scoped and can be granted access to multiple workspaces. - `feedback_count: Integer` Total number of objective feedbacks received for this variation - `memory_layer_assignments: Array[VariationMemoryLayerAssignment]` Read-only list of memory layer assignments for this variation, returned in ascending `position` (bottom → top). Capped at 10 entries. - `id: String` Assignment row id — handle for removing the assignment. Distinct from the referenced memory layer's id. - `memory_layer: BareMetadata` BareMetadata contains the minimal metadata for a resource: the ID and an optional human-readable name. These are used for reference fields where the full metadata (account scoping, timestamps, labels, external IDs) is not needed — e.g., the tool references inside an agent variation spec or the tools assigned to an objective. Both fields are server-populated; clients provide IDs through sibling fields rather than by constructing a BareMetadata themselves. - `position: Integer` Position in the variation's baseline stack. Lower values sit lower; the highest-position assignment is on top of the variation's baseline. Gaps are fine — only relative position matters. Positions must be unique within a variation; a request that would collide with an existing assignment's position is rejected with InvalidArgument. - `memory_layer_count: Integer` Count of memory layer assignments. - `model: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) - `score: Float` Thompson Sampling score: posterior mean of Beta(ts_alpha, ts_beta). Range [0, 1] where 0.5 = neutral, >0.5 = positive, <0.5 = negative. - `sub_agent_count: Integer` Number of sub-agents assigned to this variation - `tool_count: Integer` Number of individual tools assigned to this variation - `tool_set_count: Integer` Number of tool sets assigned to this variation - `memory_entry: BulkWorkspaceApplyResultDataMemoryEntryOutcome` - `action: :ACTION_UNSPECIFIED | :ACTION_CREATED | :ACTION_UPDATED | 3 more` - `:ACTION_UNSPECIFIED` - `:ACTION_CREATED` - `:ACTION_UPDATED` - `:ACTION_UNCHANGED` - `:ACTION_DELETED` - `:ACTION_FAILED` - `error: Error{ code, details, message}` The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code: Integer` The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. - `details: Array[Detail{ type}]` A list of messages that carry the error details. There is a common set of message types for APIs to use. - `type: String` The type of the serialized message. - `message: String` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. - `external_id: String` - `resource: MemoryEntry` MemoryEntry is a single keyed value within a MemoryLayer. Entries are addressed by their key, which follows the S3 object key safe-character convention (see MemoryEntrySpec.key for the full rule). Keys are unique within a single layer; the same key may appear in multiple layers, in which case the LIFO stack-walk determines which one wins for a given objective. MemoryEntry is the summary shape, returned by ListMemoryEntries. It does not carry the entry body — callers that need the body must fetch the entry individually via GetMemoryEntry, which returns a MemoryEntryDetail. - `metadata: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) - `spec: MemoryEntrySpec` MemoryEntrySpec is the metadata portion of an entry — the fields that identify and describe it, without the body. It appears on both the summary (MemoryEntry) and detail (MemoryEntryDetail) views. - `key: String` The lookup key for this entry within its layer. Must conform to the S3 object key safe-characters spec: ASCII alphanumerics and the special characters !, -, _, ., *, ', (, ), and /. Forward slashes may be used to suggest hierarchy (e.g., "skills/postmortem/write"), but lookups are flat — the key is a single opaque string, not a path. Additional rules enforced by the service: - May not begin or end with / - May not contain consecutive slashes (//) - May not begin with reserved prefixes (cadenya/, system/) - Case-sensitive - Unique within the parent layer For skills entries, this key is also the id the model passes to memory_load_skill when it decides to load the entry's content. - `description: String` One-line "when to use this" hint shown in the frontmatter manifest for skills entries. The model uses this to decide whether to load the body, so it should be written for the model as the audience. Ignored for layer types that do not advertise frontmatter. - `info: MemoryEntryInfo` - `created_by: Profile` A profile identifies a user or non-human principal (such as an API key) at the account level. Profiles are account-scoped and can be granted access to multiple workspaces. - `memory_layer: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) - `memory_layer: BulkWorkspaceApplyResultDataMemoryLayerOutcome` - `action: :ACTION_UNSPECIFIED | :ACTION_CREATED | :ACTION_UPDATED | 3 more` - `:ACTION_UNSPECIFIED` - `:ACTION_CREATED` - `:ACTION_UPDATED` - `:ACTION_UNCHANGED` - `:ACTION_DELETED` - `:ACTION_FAILED` - `error: Error{ code, details, message}` The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code: Integer` The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. - `details: Array[Detail{ type}]` A list of messages that carry the error details. There is a common set of message types for APIs to use. - `type: String` The type of the serialized message. - `message: String` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. - `external_id: String` - `resource: MemoryLayer` MemoryLayer is a named container of memory entries that can be composed into an objective's memory stack. Layers are workspace-scoped resources. The layer type controls how its entries participate in the agent loop — see MemoryLayerType for details. See "Memory stack composition" above for how layers compose at lookup time. - `metadata: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) - `spec: MemoryLayerSpec` - `type: :MEMORY_LAYER_TYPE_UNSPECIFIED | :MEMORY_LAYER_TYPE_EPISODIC | :MEMORY_LAYER_TYPE_SKILLS` - `:MEMORY_LAYER_TYPE_UNSPECIFIED` - `:MEMORY_LAYER_TYPE_EPISODIC` - `:MEMORY_LAYER_TYPE_SKILLS` - `description: String` Human-readable description of the layer's purpose. Encouraged for user-created layers; system-managed layers may have a generated description. - `expires_at: Time` For layers with a finite lifetime (e.g., episodic), the time at which the layer becomes eligible for cleanup. Set by the system; unset for persistent layers. - `system_managed: bool` Server-set. True for layers managed by the system (e.g., episodic layers created automatically when an objective uses an episodic_key). System-managed layers cannot be assigned to objective stacks via the API and cannot be mutated by clients — their lifecycle is controlled entirely by the runtime. - `info: MemoryLayerInfo` - `created_by: Profile` A profile identifies a user or non-human principal (such as an API key) at the account level. Profiles are account-scoped and can be granted access to multiple workspaces. - `entry_count: Integer` Number of entries currently in this layer. - `last_used_at: Time` Timestamp of the most recent objective that resolved against this layer. Useful for surfacing unused layers in the dashboard. - `tool: BulkWorkspaceApplyResultDataToolOutcome` - `action: :ACTION_UNSPECIFIED | :ACTION_CREATED | :ACTION_UPDATED | 3 more` - `:ACTION_UNSPECIFIED` - `:ACTION_CREATED` - `:ACTION_UPDATED` - `:ACTION_UNCHANGED` - `:ACTION_DELETED` - `:ACTION_FAILED` - `error: Error{ code, details, message}` The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code: Integer` The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. - `details: Array[Detail{ type}]` A list of messages that carry the error details. There is a common set of message types for APIs to use. - `type: String` The type of the serialized message. - `message: String` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. - `external_id: String` - `resource: Tool` - `metadata: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) - `spec: ToolSpec` - `config: ToolSpecConfig` Config defines the adapter to use for the tool. This is used to determine how the tool is called. For example, if the tool is an HTTP tool, the adapter will be Http. If the tool is an inline tool, the adapter will be Inline. - `http: ConfigHTTP` - `request_method: :HTTP_METHOD_UNSPECIFIED | :GET | :POST | 3 more` - `:HTTP_METHOD_UNSPECIFIED` - `:GET` - `:POST` - `:PUT` - `:PATCH` - `:DELETE` - `headers: Hash[Symbol, String]` - `path: String` - `query: String` - `request_body_content_type: String` - `request_body_template: String` These are only used when the request method is a POST, PUT, or PATCH - `tool_name: String` The tool name (commonly an "operation id" in OpenAPI specs) to call on the HTTP adapter. This is used to match the tool spec to the correct endpoint on the HTTP adapter. it will be derived from the name of the tool if not provided. - `mcp: ConfigMcp` - `tool_description: String` - `tool_name: String` - `tool_title: String` - `openapi: ConfigOpenAPI` - `method_: String` - `operation_id: String` - `path: String` - `description: String` - `parameters: Hash[Symbol, untyped]` - `status: :TOOL_STATUS_UNSPECIFIED | :TOOL_STATUS_AVAILABLE | :TOOL_STATUS_OMITTED | :TOOL_STATUS_ARCHIVED` - `:TOOL_STATUS_UNSPECIFIED` - `:TOOL_STATUS_AVAILABLE` - `:TOOL_STATUS_OMITTED` - `:TOOL_STATUS_ARCHIVED` - `requires_approval: bool` - `info: ToolInfo` - `created_by: Profile` A profile identifies a user or non-human principal (such as an API key) at the account level. Profiles are account-scoped and can be granted access to multiple workspaces. - `tool_set: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) - `tool_set: BulkWorkspaceApplyResultDataToolSetOutcome` - `action: :ACTION_UNSPECIFIED | :ACTION_CREATED | :ACTION_UPDATED | 3 more` - `:ACTION_UNSPECIFIED` - `:ACTION_CREATED` - `:ACTION_UPDATED` - `:ACTION_UNCHANGED` - `:ACTION_DELETED` - `:ACTION_FAILED` - `error: Error{ code, details, message}` The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code: Integer` The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. - `details: Array[Detail{ type}]` A list of messages that carry the error details. There is a common set of message types for APIs to use. - `type: String` The type of the serialized message. - `message: String` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. - `external_id: String` - `resource: ToolSet` - `metadata: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) - `spec: ToolSetSpec` - `adapter: ToolSetAdapter` - `http: ToolSetAdapterHTTP` - `base_url: String` - `headers: Hash[Symbol, String]` - `mcp: ToolSetAdapterMcp` - `exclude_tools: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `operator: :OPERATOR_UNSPECIFIED | :OPERATOR_AND | :OPERATOR_OR` - `:OPERATOR_UNSPECIFIED` - `:OPERATOR_AND` - `:OPERATOR_OR` - `filters: Array[AttributeFilter]` - `attribute: :ATTRIBUTE_UNSPECIFIED | :ATTRIBUTE_NAME | :ATTRIBUTE_TITLE | :ATTRIBUTE_DESCRIPTION` - `:ATTRIBUTE_UNSPECIFIED` - `:ATTRIBUTE_NAME` - `:ATTRIBUTE_TITLE` - `:ATTRIBUTE_DESCRIPTION` - `matcher: StringMatcher` String matching operations - `case_sensitive: bool` - `contains: String` - `ends_with: String` - `exact: String` - `regex: String` - `starts_with: String` - `headers: Hash[Symbol, String]` - `include_tools: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `tool_approvals: ApprovalRequirementFilter` Approval filters that will automatically set the approval requirement on tools synced from an external source - `always: bool` - `only: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `url: String` - `openapi: ToolSetAdapterOpenAPI` - `base_url: String` Base URL for dispatching tool calls. If set, overrides the server resolved from the spec's servers array. - `exclude_tools: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `headers: Hash[Symbol, String]` Headers sent when fetching the spec from a URL and when dispatching tool calls. - `include_tools: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `server_name: String` Name of the server entry in the spec's servers array (OpenAPI 3.2 server.name field). Used to select which server URL to dispatch to when base_url is not set. If unset, the first server is used. Ignored when base_url is set. - `tool_approvals: ApprovalRequirementFilter` Approval filters that will automatically set the approval requirement on tools synced from an external source - `upload_id: String` ID of a COMPLETE Upload containing the OpenAPI spec document. - `url: String` URL to fetch the OpenAPI spec from. Synced automatically every hour. - `description: String` - `info: ToolSetInfo` Tool set information - `agent_count: Integer` - `created_by: Profile` A profile identifies a user or non-human principal (such as an API key) at the account level. Profiles are account-scoped and can be granted access to multiple workspaces. - `last_sync: Time` - `tool_count: Integer` - `type: String` - `variation_assignment: BulkWorkspaceApplyResultDataVariationAssignmentOutcome` - `action: :ACTION_UNSPECIFIED | :ACTION_CREATED | :ACTION_UPDATED | 3 more` - `:ACTION_UNSPECIFIED` - `:ACTION_CREATED` - `:ACTION_UPDATED` - `:ACTION_UNCHANGED` - `:ACTION_DELETED` - `:ACTION_FAILED` - `error: Error{ code, details, message}` The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code: Integer` The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. - `details: Array[Detail{ type}]` A list of messages that carry the error details. There is a common set of message types for APIs to use. - `type: String` The type of the serialized message. - `message: String` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. - `resource: VariationAssignment` A read-only reference to a single tool, tool set, or sub-agent attached to a variation. Read the full set of assignments via `AgentVariationInfo.assignments`; mutations go through the dedicated add/remove assignment endpoints. The `id` identifies the assignment itself (not the referenced resource) and is the handle used to remove the assignment. It is returned by the add endpoint and present on every entry in `AgentVariationInfo.assignments`. - `id: String` - `agent: BareMetadata` BareMetadata contains the minimal metadata for a resource: the ID and an optional human-readable name. These are used for reference fields where the full metadata (account scoping, timestamps, labels, external IDs) is not needed — e.g., the tool references inside an agent variation spec or the tools assigned to an objective. Both fields are server-populated; clients provide IDs through sibling fields rather than by constructing a BareMetadata themselves. - `tool: BareMetadata` BareMetadata contains the minimal metadata for a resource: the ID and an optional human-readable name. These are used for reference fields where the full metadata (account scoping, timestamps, labels, external IDs) is not needed — e.g., the tool references inside an agent variation spec or the tools assigned to an objective. Both fields are server-populated; clients provide IDs through sibling fields rather than by constructing a BareMetadata themselves. - `tool_set: BareMetadata` BareMetadata contains the minimal metadata for a resource: the ID and an optional human-readable name. These are used for reference fields where the full metadata (account scoping, timestamps, labels, external IDs) is not needed — e.g., the tool references inside an agent variation spec or the tools assigned to an objective. Both fields are server-populated; clients provide IDs through sibling fields rather than by constructing a BareMetadata themselves. - `variation_memory_layer: BulkWorkspaceApplyResultDataVariationMemoryLayerOutcome` - `action: :ACTION_UNSPECIFIED | :ACTION_CREATED | :ACTION_UPDATED | 3 more` - `:ACTION_UNSPECIFIED` - `:ACTION_CREATED` - `:ACTION_UPDATED` - `:ACTION_UNCHANGED` - `:ACTION_DELETED` - `:ACTION_FAILED` - `error: Error{ code, details, message}` The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code: Integer` The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. - `details: Array[Detail{ type}]` A list of messages that carry the error details. There is a common set of message types for APIs to use. - `type: String` The type of the serialized message. - `message: String` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. - `resource: VariationMemoryLayerAssignment` VariationMemoryLayerAssignment attaches a single MemoryLayer to a variation at a given position in the variation's baseline memory stack. A variation has at most one assignment per memory_layer_id. Variations only support whole-layer attachments — entry pinning is an objective-level capability. - `id: String` Assignment row id — handle for removing the assignment. Distinct from the referenced memory layer's id. - `memory_layer: BareMetadata` BareMetadata contains the minimal metadata for a resource: the ID and an optional human-readable name. These are used for reference fields where the full metadata (account scoping, timestamps, labels, external IDs) is not needed — e.g., the tool references inside an agent variation spec or the tools assigned to an objective. Both fields are server-populated; clients provide IDs through sibling fields rather than by constructing a BareMetadata themselves. - `position: Integer` Position in the variation's baseline stack. Lower values sit lower; the highest-position assignment is on top of the variation's baseline. Gaps are fine — only relative position matters. Positions must be unique within a variation; a request that would collide with an existing assignment's position is rejected with InvalidArgument. - `metadata: OperationMetadata` Metadata for ephemeral operations and activities (e.g., objectives, executions, runs) - `id: String` Unique identifier for the operation (prefixed ULID, e.g., "obj_01HXK...") - `account_id: String` Account this operation belongs to for multi-tenant isolation (prefixed ULID) - `created_at: Time` Timestamp when this operation was created ULID includes timestamp information, but this explicit field enables easier querying - `profile_id: String` ID of the actor (user or service account) that created this operation - `workspace_id: String` Workspace this operation belongs to for organizational grouping (prefixed ULID) - `external_id: String` External ID for the operation (e.g., a workflow ID from an external system) - `labels: Hash[Symbol, String]` Arbitrary key-value pairs for categorization and filtering Examples: {"priority": "high", "source": "api", "workflow": "onboarding"} ### Example ```ruby require "cadenya" cadenya = Cadenya::Client.new(api_key: "My API Key") page = cadenya.bulk_workspace_resources.results.list("bulkWorkspaceApplyId", workspace_id: "workspaceId") puts(page) ``` #### Response ```json { "items": [ { "data": { "agent": { "action": "ACTION_UNSPECIFIED", "error": { "code": 0, "details": [ { "@type": "@type" } ], "message": "message" }, "externalId": "externalId", "resource": { "metadata": { "id": "id", "accountId": "accountId", "createdAt": "2019-12-27T18:11:19.117Z", "name": "name", "profileId": "profileId", "workspaceId": "workspaceId", "bundleKey": "bundleKey", "externalId": "externalId", "labels": { "foo": "string" } }, "spec": { "status": "AGENT_STATUS_UNSPECIFIED", "variationSelectionMode": "VARIATION_SELECTION_MODE_UNSPECIFIED", "description": "description", "inputDataSchema": { "foo": "bar" }, "outputDefinition": { "foo": "bar" }, "webhookEventsUrl": "webhookEventsUrl" }, "info": { "createdBy": { "metadata": { "id": "id", "accountId": "accountId", "name": "name", "profileId": "profileId", "externalId": "externalId", "labels": { "foo": "string" } }, "spec": { "type": "PROFILE_TYPE_UNSPECIFIED", "email": "email", "name": "name" } }, "variationCount": 0 } } }, "agentSchedule": { "action": "ACTION_UNSPECIFIED", "error": { "code": 0, "details": [ { "@type": "@type" } ], "message": "message" }, "externalId": "externalId", "resource": { "metadata": { "id": "id", "accountId": "accountId", "createdAt": "2019-12-27T18:11:19.117Z", "name": "name", "profileId": "profileId", "workspaceId": "workspaceId", "bundleKey": "bundleKey", "externalId": "externalId", "labels": { "foo": "string" } }, "spec": { "initialMessage": "initialMessage", "schedule": { "calendars": [ { "comment": "comment", "dayOfMonth": [ { "end": 0, "start": 0, "step": 0 } ], "dayOfWeek": [ { "end": 0, "start": 0, "step": 0 } ], "hour": [ { "end": 0, "start": 0, "step": 0 } ], "minute": [ { "end": 0, "start": 0, "step": 0 } ], "month": [ { "end": 0, "start": 0, "step": 0 } ], "second": [ { "end": 0, "start": 0, "step": 0 } ] } ], "intervals": [ { "every": "-160513s", "offset": "-160513s" } ], "timezone": "timezone" }, "data": {}, "overlapPolicy": "OVERLAP_POLICY_UNSPECIFIED", "status": "AGENT_SCHEDULE_STATUS_UNSPECIFIED", "variationId": "variationId" }, "info": { "createdBy": { "metadata": { "id": "id", "accountId": "accountId", "name": "name", "profileId": "profileId", "externalId": "externalId", "labels": { "foo": "string" } }, "spec": { "type": "PROFILE_TYPE_UNSPECIFIED", "email": "email", "name": "name" } }, "lastFireAt": "2019-12-27T18:11:19.117Z", "lastObjectiveId": "lastObjectiveId", "lastSkippedAt": "2019-12-27T18:11:19.117Z", "lastSkipReason": "lastSkipReason", "nextFireAt": "2019-12-27T18:11:19.117Z", "totalFires": 0 } } }, "agentVariation": { "action": "ACTION_UNSPECIFIED", "error": { "code": 0, "details": [ { "@type": "@type" } ], "message": "message" }, "externalId": "externalId", "resource": { "metadata": { "id": "id", "accountId": "accountId", "createdAt": "2019-12-27T18:11:19.117Z", "name": "name", "profileId": "profileId", "workspaceId": "workspaceId", "bundleKey": "bundleKey", "externalId": "externalId", "labels": { "foo": "string" } }, "spec": { "compactionConfig": { "summarization": { "instructions": "instructions" }, "toolResultClearing": { "preserveRecentResults": 0 }, "triggerThreshold": 0 }, "constraints": { "maxSubObjectives": 0, "maxToolCalls": 0 }, "description": "description", "enableEpisodicMemory": true, "episodicMemoryTtl": 0, "modelConfig": { "modelId": "modelId", "temperature": 0 }, "progressiveDiscovery": { "hints": [ "string" ], "maxTools": 0, "rerankThreshold": 0 }, "prompt": "prompt", "weight": 0 }, "info": { "assignments": [ { "id": "id", "agent": { "id": "id", "name": "name" }, "tool": { "id": "id", "name": "name" }, "toolSet": { "id": "id", "name": "name" } } ], "createdBy": { "metadata": { "id": "id", "accountId": "accountId", "name": "name", "profileId": "profileId", "externalId": "externalId", "labels": { "foo": "string" } }, "spec": { "type": "PROFILE_TYPE_UNSPECIFIED", "email": "email", "name": "name" } }, "feedbackCount": 0, "memoryLayerAssignments": [ { "id": "id", "memoryLayer": { "id": "id", "name": "name" }, "position": 0 } ], "memoryLayerCount": 0, "model": { "id": "id", "accountId": "accountId", "createdAt": "2019-12-27T18:11:19.117Z", "name": "name", "profileId": "profileId", "workspaceId": "workspaceId", "bundleKey": "bundleKey", "externalId": "externalId", "labels": { "foo": "string" } }, "score": 0, "subAgentCount": 0, "toolCount": 0, "toolSetCount": 0 } } }, "memoryEntry": { "action": "ACTION_UNSPECIFIED", "error": { "code": 0, "details": [ { "@type": "@type" } ], "message": "message" }, "externalId": "externalId", "resource": { "metadata": { "id": "id", "accountId": "accountId", "createdAt": "2019-12-27T18:11:19.117Z", "name": "name", "profileId": "profileId", "workspaceId": "workspaceId", "bundleKey": "bundleKey", "externalId": "externalId", "labels": { "foo": "string" } }, "spec": { "key": "key", "description": "description" }, "info": { "createdBy": { "metadata": { "id": "id", "accountId": "accountId", "name": "name", "profileId": "profileId", "externalId": "externalId", "labels": { "foo": "string" } }, "spec": { "type": "PROFILE_TYPE_UNSPECIFIED", "email": "email", "name": "name" } }, "memoryLayer": { "id": "id", "accountId": "accountId", "createdAt": "2019-12-27T18:11:19.117Z", "name": "name", "profileId": "profileId", "workspaceId": "workspaceId", "bundleKey": "bundleKey", "externalId": "externalId", "labels": { "foo": "string" } } } } }, "memoryLayer": { "action": "ACTION_UNSPECIFIED", "error": { "code": 0, "details": [ { "@type": "@type" } ], "message": "message" }, "externalId": "externalId", "resource": { "metadata": { "id": "id", "accountId": "accountId", "createdAt": "2019-12-27T18:11:19.117Z", "name": "name", "profileId": "profileId", "workspaceId": "workspaceId", "bundleKey": "bundleKey", "externalId": "externalId", "labels": { "foo": "string" } }, "spec": { "type": "MEMORY_LAYER_TYPE_UNSPECIFIED", "description": "description", "expiresAt": "2019-12-27T18:11:19.117Z", "systemManaged": true }, "info": { "createdBy": { "metadata": { "id": "id", "accountId": "accountId", "name": "name", "profileId": "profileId", "externalId": "externalId", "labels": { "foo": "string" } }, "spec": { "type": "PROFILE_TYPE_UNSPECIFIED", "email": "email", "name": "name" } }, "entryCount": 0, "lastUsedAt": "2019-12-27T18:11:19.117Z" } } }, "tool": { "action": "ACTION_UNSPECIFIED", "error": { "code": 0, "details": [ { "@type": "@type" } ], "message": "message" }, "externalId": "externalId", "resource": { "metadata": { "id": "id", "accountId": "accountId", "createdAt": "2019-12-27T18:11:19.117Z", "name": "name", "profileId": "profileId", "workspaceId": "workspaceId", "bundleKey": "bundleKey", "externalId": "externalId", "labels": { "foo": "string" } }, "spec": { "config": { "http": { "requestMethod": "HTTP_METHOD_UNSPECIFIED", "headers": { "foo": "string" }, "path": "path", "query": "query", "requestBodyContentType": "requestBodyContentType", "requestBodyTemplate": "requestBodyTemplate", "toolName": "toolName" }, "mcp": { "toolDescription": "toolDescription", "toolName": "toolName", "toolTitle": "toolTitle" }, "openapi": { "method": "method", "operationId": "operationId", "path": "path" } }, "description": "description", "parameters": { "foo": "bar" }, "status": "TOOL_STATUS_UNSPECIFIED", "requiresApproval": true }, "info": { "createdBy": { "metadata": { "id": "id", "accountId": "accountId", "name": "name", "profileId": "profileId", "externalId": "externalId", "labels": { "foo": "string" } }, "spec": { "type": "PROFILE_TYPE_UNSPECIFIED", "email": "email", "name": "name" } }, "toolSet": { "id": "id", "accountId": "accountId", "createdAt": "2019-12-27T18:11:19.117Z", "name": "name", "profileId": "profileId", "workspaceId": "workspaceId", "bundleKey": "bundleKey", "externalId": "externalId", "labels": { "foo": "string" } } } } }, "toolSet": { "action": "ACTION_UNSPECIFIED", "error": { "code": 0, "details": [ { "@type": "@type" } ], "message": "message" }, "externalId": "externalId", "resource": { "metadata": { "id": "id", "accountId": "accountId", "createdAt": "2019-12-27T18:11:19.117Z", "name": "name", "profileId": "profileId", "workspaceId": "workspaceId", "bundleKey": "bundleKey", "externalId": "externalId", "labels": { "foo": "string" } }, "spec": { "adapter": { "http": { "baseUrl": "baseUrl", "headers": { "foo": "string" } }, "mcp": { "excludeTools": { "operator": "OPERATOR_UNSPECIFIED", "filters": [ { "attribute": "ATTRIBUTE_UNSPECIFIED", "matcher": { "caseSensitive": true, "contains": "contains", "endsWith": "endsWith", "exact": "exact", "regex": "regex", "startsWith": "startsWith" } } ] }, "headers": { "foo": "string" }, "includeTools": { "operator": "OPERATOR_UNSPECIFIED", "filters": [ { "attribute": "ATTRIBUTE_UNSPECIFIED", "matcher": { "caseSensitive": true, "contains": "contains", "endsWith": "endsWith", "exact": "exact", "regex": "regex", "startsWith": "startsWith" } } ] }, "toolApprovals": { "always": true, "only": { "operator": "OPERATOR_UNSPECIFIED", "filters": [ { "attribute": "ATTRIBUTE_UNSPECIFIED", "matcher": { "caseSensitive": true, "contains": "contains", "endsWith": "endsWith", "exact": "exact", "regex": "regex", "startsWith": "startsWith" } } ] } }, "url": "url" }, "openapi": { "baseUrl": "baseUrl", "excludeTools": { "operator": "OPERATOR_UNSPECIFIED", "filters": [ { "attribute": "ATTRIBUTE_UNSPECIFIED", "matcher": { "caseSensitive": true, "contains": "contains", "endsWith": "endsWith", "exact": "exact", "regex": "regex", "startsWith": "startsWith" } } ] }, "headers": { "foo": "string" }, "includeTools": { "operator": "OPERATOR_UNSPECIFIED", "filters": [ { "attribute": "ATTRIBUTE_UNSPECIFIED", "matcher": { "caseSensitive": true, "contains": "contains", "endsWith": "endsWith", "exact": "exact", "regex": "regex", "startsWith": "startsWith" } } ] }, "serverName": "serverName", "toolApprovals": { "always": true, "only": { "operator": "OPERATOR_UNSPECIFIED", "filters": [ { "attribute": "ATTRIBUTE_UNSPECIFIED", "matcher": { "caseSensitive": true, "contains": "contains", "endsWith": "endsWith", "exact": "exact", "regex": "regex", "startsWith": "startsWith" } } ] } }, "uploadId": "uploadId", "url": "url" } }, "description": "description" }, "info": { "agentCount": 0, "createdBy": { "metadata": { "id": "id", "accountId": "accountId", "name": "name", "profileId": "profileId", "externalId": "externalId", "labels": { "foo": "string" } }, "spec": { "type": "PROFILE_TYPE_UNSPECIFIED", "email": "email", "name": "name" } }, "lastSync": "2019-12-27T18:11:19.117Z", "toolCount": 0 } } }, "type": "type", "variationAssignment": { "action": "ACTION_UNSPECIFIED", "error": { "code": 0, "details": [ { "@type": "@type" } ], "message": "message" }, "resource": { "id": "id", "agent": { "id": "id", "name": "name" }, "tool": { "id": "id", "name": "name" }, "toolSet": { "id": "id", "name": "name" } } }, "variationMemoryLayer": { "action": "ACTION_UNSPECIFIED", "error": { "code": 0, "details": [ { "@type": "@type" } ], "message": "message" }, "resource": { "id": "id", "memoryLayer": { "id": "id", "name": "name" }, "position": 0 } } }, "metadata": { "id": "id", "accountId": "accountId", "createdAt": "2019-12-27T18:11:19.117Z", "profileId": "profileId", "workspaceId": "workspaceId", "externalId": "externalId", "labels": { "foo": "string" } } } ], "pagination": { "nextCursor": "nextCursor", "total": 0 } } ``` ## Domain Types ### Bulk Workspace Apply Result - `class BulkWorkspaceApplyResult` One row of the per-resource result list for a BulkWorkspaceApply. Each row is itself an operation that can be paginated, sorted by created_at, and addressed individually. - `data: BulkWorkspaceApplyResultData` Outcome for a single resource within a bulk apply. The `type` field is the discriminator string naming the populated `outcome` oneof variant (e.g., "toolSet", "memoryEntry"). Every outcome shell carries an `action` enum and either a resulting resource snapshot (for ACTION_CREATED, ACTION_UPDATED, ACTION_UNCHANGED, ACTION_DELETED) or a google.rpc.Status (for ACTION_FAILED). - `agent: BulkWorkspaceApplyResultDataAgentOutcome` - `action: :ACTION_UNSPECIFIED | :ACTION_CREATED | :ACTION_UPDATED | 3 more` - `:ACTION_UNSPECIFIED` - `:ACTION_CREATED` - `:ACTION_UPDATED` - `:ACTION_UNCHANGED` - `:ACTION_DELETED` - `:ACTION_FAILED` - `error: Error{ code, details, message}` The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code: Integer` The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. - `details: Array[Detail{ type}]` A list of messages that carry the error details. There is a common set of message types for APIs to use. - `type: String` The type of the serialized message. - `message: String` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. - `external_id: String` - `resource: Agent` Agent resource - `metadata: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) - `id: String` Unique identifier for the resource (prefixed ULID, e.g., "agent_01HXK...") - `account_id: String` Account this resource belongs to for multi-tenant isolation (prefixed ULID) - `created_at: Time` Timestamp when this resource was created - `name: String` Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool") Required for resources that users interact with directly - `profile_id: String` ID of the actor (user or service account) that created this resource - `workspace_id: String` Workspace this resource belongs to for organizational grouping (prefixed ULID) - `bundle_key: String` Optional bundle ownership key. When set, indicates the resource is managed by a configuration bundle identified by this key. Used by BulkWorkspaceResources.Apply to track which resources belong to which bundle for reconciliation / soft-delete on re-apply. - `external_id: String` External ID for the resource (e.g., a workflow ID from an external system) - `labels: Hash[Symbol, String]` Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"} - `spec: AgentSpec` Agent specification (user-provided configuration) - `status: :AGENT_STATUS_UNSPECIFIED | :AGENT_STATUS_DRAFT | :AGENT_STATUS_PUBLISHED | :AGENT_STATUS_ARCHIVED` Status of the agent - `:AGENT_STATUS_UNSPECIFIED` - `:AGENT_STATUS_DRAFT` - `:AGENT_STATUS_PUBLISHED` - `:AGENT_STATUS_ARCHIVED` - `variation_selection_mode: :VARIATION_SELECTION_MODE_UNSPECIFIED | :VARIATION_SELECTION_MODE_RANDOM | :VARIATION_SELECTION_MODE_WEIGHTED` Controls how variations are automatically selected when creating objectives Defaults to RANDOM when unspecified - `:VARIATION_SELECTION_MODE_UNSPECIFIED` - `:VARIATION_SELECTION_MODE_RANDOM` - `:VARIATION_SELECTION_MODE_WEIGHTED` - `description: String` Description of the agent's purpose - `input_data_schema: Hash[Symbol, untyped]` InputDataSchema is used for enforcing a data input when objectives are created. This is valuable when using liquid formatting in agent variation prompts. Input data schema is also valuable when using an agent as a sub-agent, as the schema is used as the tool's input parameter schema. If omitted, the sub-agent schema will be loaded with a simple "prompt" free text string as its schema. - `output_definition: Hash[Symbol, untyped]` Optional output definition for objectives created for this agent. When provided, Cadenya will append a tool to that will be called by the LLM in use by the variant to extract information in the format provided here. Use this option when you want structured data to be created by your objectives. - `webhook_events_url: String` The URL that Cadenya will send events for any objective assigned to the agent. - `info: AgentInfo` AgentInfo contains simple information about an agent for display or quick reference - `created_by: Profile` A profile identifies a user or non-human principal (such as an API key) at the account level. Profiles are account-scoped and can be granted access to multiple workspaces. - `metadata: AccountResourceMetadata` AccountResourceMetadata is used to represent a resource that is associated to an account but not to a workspace. - `id: String` Unique identifier for the resource (prefixed ULID, e.g., "apikey_01HXK...") - `account_id: String` Account this resource belongs to for multi-tenant isolation (prefixed ULID) - `name: String` Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool") Required for resources that users interact with directly - `profile_id: String` - `external_id: String` External ID for the resource (e.g., a workflow ID from an external system) - `labels: Hash[Symbol, String]` Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"} - `spec: ProfileSpec` Configuration for a profile. - `type: :PROFILE_TYPE_UNSPECIFIED | :PROFILE_TYPE_USER | :PROFILE_TYPE_API_KEY | :PROFILE_TYPE_SYSTEM` Whether this profile represents a human user, an API key, or a system principal. - `:PROFILE_TYPE_UNSPECIFIED` - `:PROFILE_TYPE_USER` - `:PROFILE_TYPE_API_KEY` - `:PROFILE_TYPE_SYSTEM` - `email: String` Email address of the profile. Required and unique within an account for user profiles. - `name: String` Display name (e.g., "Bobby Tables"). - `variation_count: Integer` - `agent_schedule: BulkWorkspaceApplyResultDataAgentScheduleOutcome` - `action: :ACTION_UNSPECIFIED | :ACTION_CREATED | :ACTION_UPDATED | 3 more` - `:ACTION_UNSPECIFIED` - `:ACTION_CREATED` - `:ACTION_UPDATED` - `:ACTION_UNCHANGED` - `:ACTION_DELETED` - `:ACTION_FAILED` - `error: Error{ code, details, message}` The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code: Integer` The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. - `details: Array[Detail{ type}]` A list of messages that carry the error details. There is a common set of message types for APIs to use. - `type: String` The type of the serialized message. - `message: String` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. - `external_id: String` - `resource: AgentSchedule` AgentSchedule resource — a recurring trigger attached to an agent that creates objectives on its cadence. - `metadata: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) - `spec: AgentScheduleSpec` AgentScheduleSpec is the user-provided configuration for a schedule. - `initial_message: String` The initial message passed to CreateObjective on each fire. Becomes the first user message in the objective's chat history. - `schedule: AgentScheduleSpecSchedule` Schedule defines WHEN the schedule fires. Temporal-style structured form: a list of calendar rules (wall-clock) and/or interval rules (duration), OR'd together. At least one rule is required. - `calendars: Array[ScheduleCalendar]` Wall-clock rules. May be empty if `intervals` is non-empty. - `comment: String` - `day_of_month: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `day_of_week: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `hour: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `minute: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `month: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `second: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `intervals: Array[ScheduleInterval]` Duration-based rules. May be empty if `calendars` is non-empty. - `every: String` - `offset: String` Phase shift within `every`. Must be < `every` (enforced at runtime). - `timezone: String` IANA tz name (e.g. "America/New_York"). Required. Applies to calendars; intervals fire on wall-clock cadence anchored in this zone. - `data: untyped` Optional input data passed to the objective. If the agent has an input_data_schema, this must satisfy it. - `overlap_policy: :OVERLAP_POLICY_UNSPECIFIED | :OVERLAP_POLICY_ALLOW | :OVERLAP_POLICY_SKIP` What to do when the previous run is still in flight. Defaults to SKIP. - `:OVERLAP_POLICY_UNSPECIFIED` - `:OVERLAP_POLICY_ALLOW` - `:OVERLAP_POLICY_SKIP` - `status: :AGENT_SCHEDULE_STATUS_UNSPECIFIED | :AGENT_SCHEDULE_STATUS_ACTIVE | :AGENT_SCHEDULE_STATUS_PAUSED | :AGENT_SCHEDULE_STATUS_ARCHIVED` Lifecycle. Defaults to ACTIVE on create when unspecified. - `:AGENT_SCHEDULE_STATUS_UNSPECIFIED` - `:AGENT_SCHEDULE_STATUS_ACTIVE` - `:AGENT_SCHEDULE_STATUS_PAUSED` - `:AGENT_SCHEDULE_STATUS_ARCHIVED` - `variation_id: String` Optional explicit variation. When unset, the agent's variation_selection_mode chooses per fire. - `info: AgentScheduleInfo` AgentScheduleInfo provides read-only runtime data about a schedule. - `created_by: Profile` A profile identifies a user or non-human principal (such as an API key) at the account level. Profiles are account-scoped and can be granted access to multiple workspaces. - `last_fire_at: Time` When the schedule last fired (regardless of objective outcome). - `last_objective_id: String` ID of the most recent objective the schedule created. - `last_skipped_at: Time` When the schedule most recently skipped a fire (SKIP policy + prior in flight). - `last_skip_reason: String` Reason for the most recent skip (e.g. "previous objective still running"). - `next_fire_at: Time` When the schedule will next fire. Computed from the spec; absent when the schedule is PAUSED/ARCHIVED or has no future fire times. - `total_fires: Integer` Lifetime count of objectives created by this schedule. - `agent_variation: BulkWorkspaceApplyResultDataAgentVariationOutcome` - `action: :ACTION_UNSPECIFIED | :ACTION_CREATED | :ACTION_UPDATED | 3 more` - `:ACTION_UNSPECIFIED` - `:ACTION_CREATED` - `:ACTION_UPDATED` - `:ACTION_UNCHANGED` - `:ACTION_DELETED` - `:ACTION_FAILED` - `error: Error{ code, details, message}` The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code: Integer` The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. - `details: Array[Detail{ type}]` A list of messages that carry the error details. There is a common set of message types for APIs to use. - `type: String` The type of the serialized message. - `message: String` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. - `external_id: String` - `resource: AgentVariation` AgentVariation resource - `metadata: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) - `spec: AgentVariationSpec` AgentVariationSpec defines the operational configuration for a variation - `compaction_config: AgentVariationSpecCompactionConfig` CompactionConfig defines how context window compaction behaves for objectives using this variation. - `summarization: CompactionConfigSummarizationStrategy` SummarizationStrategy configures LLM-powered summarization of older conversation turns. - `instructions: String` Custom instructions that guide what the summarizer preserves. Replaces the default summarization prompt entirely. Example: "Preserve all code snippets, variable names, and technical decisions." - `tool_result_clearing: CompactionConfigToolResultClearingStrategy` ToolResultClearingStrategy configures clearing of older tool result content. - `preserve_recent_results: Integer` Number of most recent tool call results to keep intact. Older tool results have their content replaced with "[result cleared]" while preserving the assistant tool call message (function name, arguments). Default: 2 - `trigger_threshold: Float` Trigger threshold as a percentage of the model's context window (0.0 to 1.0). When input tokens reach this percentage of the model's limit, compaction triggers. Default: 0.75 (75%) - `constraints: AgentVariationSpecConstraints` Execution constraints - `max_sub_objectives: Integer` The maximum number of sub-objectives that can be created. 0 means no limit. - `max_tool_calls: Integer` The maximum number of tool calls that can be made. 0 means no limit. - `description: String` Human-readable description of what this variation does or when it should be used - `enable_episodic_memory: bool` Enable episodic memory for objectives using this variation. When true, the system automatically creates a document namespace for each objective using the objective's episodic_key as the external_id, allowing the agent to store and retrieve documents specific to that episode. - `episodic_memory_ttl: Integer` How long episodic memories should be retained. After this duration, episodic document namespaces can be automatically cleaned up. If not set, episodic memories are retained indefinitely. - `model_config: AgentVariationSpecModelConfig` ModelConfig defines the model configuration for a variation - `model_id: String` The model identifier in family/model format (e.g., "claude/opus-4.6", "claude/sonnet-4.5") - `temperature: Float` Sampling temperature for model inference (0.0 to 1.0) Lower values produce more deterministic outputs, higher values increase randomness - `progressive_discovery: AgentVariationSpecProgressiveDiscovery` ProgressiveDiscovery is used to indicate that the agent should automatically discover tools that are not explicitly assigned to it. Max tools is the maximum number of tools that can be discovered per search. Hints are optional hints for tool search. These are used in conjunction with the context-aware tool search and can help select the best tools for the task. - `hints: Array[String]` - `max_tools: Integer` - `rerank_threshold: Float` Rerank Threshold is an optional value that instructs whether or not to run a search result through a embedding/reranker process which can improve performance and reduce context bloat when tools reach the configured threshold. If a tool match must exceed 0.8, for example, the tool very closely match the query the tool search performed. - `prompt: String` The system prompt for this variation - `weight: Integer` Weight for weighted random selection (>= 0). P(v) = v.weight / sum(all_weights). Only used when the agent's variation_selection_mode is WEIGHTED. A weight of 0 means never auto-selected, but can still be chosen explicitly via variation_id on CreateObjectiveRequest. - `info: AgentVariationInfo` AgentVariationInfo provides read-only summary information about a variation - `assignments: Array[VariationAssignment]` All tools, tool sets, and sub-agents assigned to this variation. Populated on reads so clients can render a variation's full assignment list without calling the add/remove endpoints just to enumerate. - `id: String` - `agent: BareMetadata` BareMetadata contains the minimal metadata for a resource: the ID and an optional human-readable name. These are used for reference fields where the full metadata (account scoping, timestamps, labels, external IDs) is not needed — e.g., the tool references inside an agent variation spec or the tools assigned to an objective. Both fields are server-populated; clients provide IDs through sibling fields rather than by constructing a BareMetadata themselves. - `id: String` - `name: String` Human-readable name of the referenced resource, populated by the server on reads for convenience. Absent on references to resources that do not have a name (e.g., objective tasks). - `tool: BareMetadata` BareMetadata contains the minimal metadata for a resource: the ID and an optional human-readable name. These are used for reference fields where the full metadata (account scoping, timestamps, labels, external IDs) is not needed — e.g., the tool references inside an agent variation spec or the tools assigned to an objective. Both fields are server-populated; clients provide IDs through sibling fields rather than by constructing a BareMetadata themselves. - `tool_set: BareMetadata` BareMetadata contains the minimal metadata for a resource: the ID and an optional human-readable name. These are used for reference fields where the full metadata (account scoping, timestamps, labels, external IDs) is not needed — e.g., the tool references inside an agent variation spec or the tools assigned to an objective. Both fields are server-populated; clients provide IDs through sibling fields rather than by constructing a BareMetadata themselves. - `created_by: Profile` A profile identifies a user or non-human principal (such as an API key) at the account level. Profiles are account-scoped and can be granted access to multiple workspaces. - `feedback_count: Integer` Total number of objective feedbacks received for this variation - `memory_layer_assignments: Array[VariationMemoryLayerAssignment]` Read-only list of memory layer assignments for this variation, returned in ascending `position` (bottom → top). Capped at 10 entries. - `id: String` Assignment row id — handle for removing the assignment. Distinct from the referenced memory layer's id. - `memory_layer: BareMetadata` BareMetadata contains the minimal metadata for a resource: the ID and an optional human-readable name. These are used for reference fields where the full metadata (account scoping, timestamps, labels, external IDs) is not needed — e.g., the tool references inside an agent variation spec or the tools assigned to an objective. Both fields are server-populated; clients provide IDs through sibling fields rather than by constructing a BareMetadata themselves. - `position: Integer` Position in the variation's baseline stack. Lower values sit lower; the highest-position assignment is on top of the variation's baseline. Gaps are fine — only relative position matters. Positions must be unique within a variation; a request that would collide with an existing assignment's position is rejected with InvalidArgument. - `memory_layer_count: Integer` Count of memory layer assignments. - `model: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) - `score: Float` Thompson Sampling score: posterior mean of Beta(ts_alpha, ts_beta). Range [0, 1] where 0.5 = neutral, >0.5 = positive, <0.5 = negative. - `sub_agent_count: Integer` Number of sub-agents assigned to this variation - `tool_count: Integer` Number of individual tools assigned to this variation - `tool_set_count: Integer` Number of tool sets assigned to this variation - `memory_entry: BulkWorkspaceApplyResultDataMemoryEntryOutcome` - `action: :ACTION_UNSPECIFIED | :ACTION_CREATED | :ACTION_UPDATED | 3 more` - `:ACTION_UNSPECIFIED` - `:ACTION_CREATED` - `:ACTION_UPDATED` - `:ACTION_UNCHANGED` - `:ACTION_DELETED` - `:ACTION_FAILED` - `error: Error{ code, details, message}` The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code: Integer` The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. - `details: Array[Detail{ type}]` A list of messages that carry the error details. There is a common set of message types for APIs to use. - `type: String` The type of the serialized message. - `message: String` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. - `external_id: String` - `resource: MemoryEntry` MemoryEntry is a single keyed value within a MemoryLayer. Entries are addressed by their key, which follows the S3 object key safe-character convention (see MemoryEntrySpec.key for the full rule). Keys are unique within a single layer; the same key may appear in multiple layers, in which case the LIFO stack-walk determines which one wins for a given objective. MemoryEntry is the summary shape, returned by ListMemoryEntries. It does not carry the entry body — callers that need the body must fetch the entry individually via GetMemoryEntry, which returns a MemoryEntryDetail. - `metadata: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) - `spec: MemoryEntrySpec` MemoryEntrySpec is the metadata portion of an entry — the fields that identify and describe it, without the body. It appears on both the summary (MemoryEntry) and detail (MemoryEntryDetail) views. - `key: String` The lookup key for this entry within its layer. Must conform to the S3 object key safe-characters spec: ASCII alphanumerics and the special characters !, -, _, ., *, ', (, ), and /. Forward slashes may be used to suggest hierarchy (e.g., "skills/postmortem/write"), but lookups are flat — the key is a single opaque string, not a path. Additional rules enforced by the service: - May not begin or end with / - May not contain consecutive slashes (//) - May not begin with reserved prefixes (cadenya/, system/) - Case-sensitive - Unique within the parent layer For skills entries, this key is also the id the model passes to memory_load_skill when it decides to load the entry's content. - `description: String` One-line "when to use this" hint shown in the frontmatter manifest for skills entries. The model uses this to decide whether to load the body, so it should be written for the model as the audience. Ignored for layer types that do not advertise frontmatter. - `info: MemoryEntryInfo` - `created_by: Profile` A profile identifies a user or non-human principal (such as an API key) at the account level. Profiles are account-scoped and can be granted access to multiple workspaces. - `memory_layer: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) - `memory_layer: BulkWorkspaceApplyResultDataMemoryLayerOutcome` - `action: :ACTION_UNSPECIFIED | :ACTION_CREATED | :ACTION_UPDATED | 3 more` - `:ACTION_UNSPECIFIED` - `:ACTION_CREATED` - `:ACTION_UPDATED` - `:ACTION_UNCHANGED` - `:ACTION_DELETED` - `:ACTION_FAILED` - `error: Error{ code, details, message}` The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code: Integer` The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. - `details: Array[Detail{ type}]` A list of messages that carry the error details. There is a common set of message types for APIs to use. - `type: String` The type of the serialized message. - `message: String` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. - `external_id: String` - `resource: MemoryLayer` MemoryLayer is a named container of memory entries that can be composed into an objective's memory stack. Layers are workspace-scoped resources. The layer type controls how its entries participate in the agent loop — see MemoryLayerType for details. See "Memory stack composition" above for how layers compose at lookup time. - `metadata: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) - `spec: MemoryLayerSpec` - `type: :MEMORY_LAYER_TYPE_UNSPECIFIED | :MEMORY_LAYER_TYPE_EPISODIC | :MEMORY_LAYER_TYPE_SKILLS` - `:MEMORY_LAYER_TYPE_UNSPECIFIED` - `:MEMORY_LAYER_TYPE_EPISODIC` - `:MEMORY_LAYER_TYPE_SKILLS` - `description: String` Human-readable description of the layer's purpose. Encouraged for user-created layers; system-managed layers may have a generated description. - `expires_at: Time` For layers with a finite lifetime (e.g., episodic), the time at which the layer becomes eligible for cleanup. Set by the system; unset for persistent layers. - `system_managed: bool` Server-set. True for layers managed by the system (e.g., episodic layers created automatically when an objective uses an episodic_key). System-managed layers cannot be assigned to objective stacks via the API and cannot be mutated by clients — their lifecycle is controlled entirely by the runtime. - `info: MemoryLayerInfo` - `created_by: Profile` A profile identifies a user or non-human principal (such as an API key) at the account level. Profiles are account-scoped and can be granted access to multiple workspaces. - `entry_count: Integer` Number of entries currently in this layer. - `last_used_at: Time` Timestamp of the most recent objective that resolved against this layer. Useful for surfacing unused layers in the dashboard. - `tool: BulkWorkspaceApplyResultDataToolOutcome` - `action: :ACTION_UNSPECIFIED | :ACTION_CREATED | :ACTION_UPDATED | 3 more` - `:ACTION_UNSPECIFIED` - `:ACTION_CREATED` - `:ACTION_UPDATED` - `:ACTION_UNCHANGED` - `:ACTION_DELETED` - `:ACTION_FAILED` - `error: Error{ code, details, message}` The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code: Integer` The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. - `details: Array[Detail{ type}]` A list of messages that carry the error details. There is a common set of message types for APIs to use. - `type: String` The type of the serialized message. - `message: String` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. - `external_id: String` - `resource: Tool` - `metadata: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) - `spec: ToolSpec` - `config: ToolSpecConfig` Config defines the adapter to use for the tool. This is used to determine how the tool is called. For example, if the tool is an HTTP tool, the adapter will be Http. If the tool is an inline tool, the adapter will be Inline. - `http: ConfigHTTP` - `request_method: :HTTP_METHOD_UNSPECIFIED | :GET | :POST | 3 more` - `:HTTP_METHOD_UNSPECIFIED` - `:GET` - `:POST` - `:PUT` - `:PATCH` - `:DELETE` - `headers: Hash[Symbol, String]` - `path: String` - `query: String` - `request_body_content_type: String` - `request_body_template: String` These are only used when the request method is a POST, PUT, or PATCH - `tool_name: String` The tool name (commonly an "operation id" in OpenAPI specs) to call on the HTTP adapter. This is used to match the tool spec to the correct endpoint on the HTTP adapter. it will be derived from the name of the tool if not provided. - `mcp: ConfigMcp` - `tool_description: String` - `tool_name: String` - `tool_title: String` - `openapi: ConfigOpenAPI` - `method_: String` - `operation_id: String` - `path: String` - `description: String` - `parameters: Hash[Symbol, untyped]` - `status: :TOOL_STATUS_UNSPECIFIED | :TOOL_STATUS_AVAILABLE | :TOOL_STATUS_OMITTED | :TOOL_STATUS_ARCHIVED` - `:TOOL_STATUS_UNSPECIFIED` - `:TOOL_STATUS_AVAILABLE` - `:TOOL_STATUS_OMITTED` - `:TOOL_STATUS_ARCHIVED` - `requires_approval: bool` - `info: ToolInfo` - `created_by: Profile` A profile identifies a user or non-human principal (such as an API key) at the account level. Profiles are account-scoped and can be granted access to multiple workspaces. - `tool_set: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) - `tool_set: BulkWorkspaceApplyResultDataToolSetOutcome` - `action: :ACTION_UNSPECIFIED | :ACTION_CREATED | :ACTION_UPDATED | 3 more` - `:ACTION_UNSPECIFIED` - `:ACTION_CREATED` - `:ACTION_UPDATED` - `:ACTION_UNCHANGED` - `:ACTION_DELETED` - `:ACTION_FAILED` - `error: Error{ code, details, message}` The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code: Integer` The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. - `details: Array[Detail{ type}]` A list of messages that carry the error details. There is a common set of message types for APIs to use. - `type: String` The type of the serialized message. - `message: String` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. - `external_id: String` - `resource: ToolSet` - `metadata: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) - `spec: ToolSetSpec` - `adapter: ToolSetAdapter` - `http: ToolSetAdapterHTTP` - `base_url: String` - `headers: Hash[Symbol, String]` - `mcp: ToolSetAdapterMcp` - `exclude_tools: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `operator: :OPERATOR_UNSPECIFIED | :OPERATOR_AND | :OPERATOR_OR` - `:OPERATOR_UNSPECIFIED` - `:OPERATOR_AND` - `:OPERATOR_OR` - `filters: Array[AttributeFilter]` - `attribute: :ATTRIBUTE_UNSPECIFIED | :ATTRIBUTE_NAME | :ATTRIBUTE_TITLE | :ATTRIBUTE_DESCRIPTION` - `:ATTRIBUTE_UNSPECIFIED` - `:ATTRIBUTE_NAME` - `:ATTRIBUTE_TITLE` - `:ATTRIBUTE_DESCRIPTION` - `matcher: StringMatcher` String matching operations - `case_sensitive: bool` - `contains: String` - `ends_with: String` - `exact: String` - `regex: String` - `starts_with: String` - `headers: Hash[Symbol, String]` - `include_tools: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `tool_approvals: ApprovalRequirementFilter` Approval filters that will automatically set the approval requirement on tools synced from an external source - `always: bool` - `only: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `url: String` - `openapi: ToolSetAdapterOpenAPI` - `base_url: String` Base URL for dispatching tool calls. If set, overrides the server resolved from the spec's servers array. - `exclude_tools: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `headers: Hash[Symbol, String]` Headers sent when fetching the spec from a URL and when dispatching tool calls. - `include_tools: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `server_name: String` Name of the server entry in the spec's servers array (OpenAPI 3.2 server.name field). Used to select which server URL to dispatch to when base_url is not set. If unset, the first server is used. Ignored when base_url is set. - `tool_approvals: ApprovalRequirementFilter` Approval filters that will automatically set the approval requirement on tools synced from an external source - `upload_id: String` ID of a COMPLETE Upload containing the OpenAPI spec document. - `url: String` URL to fetch the OpenAPI spec from. Synced automatically every hour. - `description: String` - `info: ToolSetInfo` Tool set information - `agent_count: Integer` - `created_by: Profile` A profile identifies a user or non-human principal (such as an API key) at the account level. Profiles are account-scoped and can be granted access to multiple workspaces. - `last_sync: Time` - `tool_count: Integer` - `type: String` - `variation_assignment: BulkWorkspaceApplyResultDataVariationAssignmentOutcome` - `action: :ACTION_UNSPECIFIED | :ACTION_CREATED | :ACTION_UPDATED | 3 more` - `:ACTION_UNSPECIFIED` - `:ACTION_CREATED` - `:ACTION_UPDATED` - `:ACTION_UNCHANGED` - `:ACTION_DELETED` - `:ACTION_FAILED` - `error: Error{ code, details, message}` The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code: Integer` The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. - `details: Array[Detail{ type}]` A list of messages that carry the error details. There is a common set of message types for APIs to use. - `type: String` The type of the serialized message. - `message: String` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. - `resource: VariationAssignment` A read-only reference to a single tool, tool set, or sub-agent attached to a variation. Read the full set of assignments via `AgentVariationInfo.assignments`; mutations go through the dedicated add/remove assignment endpoints. The `id` identifies the assignment itself (not the referenced resource) and is the handle used to remove the assignment. It is returned by the add endpoint and present on every entry in `AgentVariationInfo.assignments`. - `id: String` - `agent: BareMetadata` BareMetadata contains the minimal metadata for a resource: the ID and an optional human-readable name. These are used for reference fields where the full metadata (account scoping, timestamps, labels, external IDs) is not needed — e.g., the tool references inside an agent variation spec or the tools assigned to an objective. Both fields are server-populated; clients provide IDs through sibling fields rather than by constructing a BareMetadata themselves. - `tool: BareMetadata` BareMetadata contains the minimal metadata for a resource: the ID and an optional human-readable name. These are used for reference fields where the full metadata (account scoping, timestamps, labels, external IDs) is not needed — e.g., the tool references inside an agent variation spec or the tools assigned to an objective. Both fields are server-populated; clients provide IDs through sibling fields rather than by constructing a BareMetadata themselves. - `tool_set: BareMetadata` BareMetadata contains the minimal metadata for a resource: the ID and an optional human-readable name. These are used for reference fields where the full metadata (account scoping, timestamps, labels, external IDs) is not needed — e.g., the tool references inside an agent variation spec or the tools assigned to an objective. Both fields are server-populated; clients provide IDs through sibling fields rather than by constructing a BareMetadata themselves. - `variation_memory_layer: BulkWorkspaceApplyResultDataVariationMemoryLayerOutcome` - `action: :ACTION_UNSPECIFIED | :ACTION_CREATED | :ACTION_UPDATED | 3 more` - `:ACTION_UNSPECIFIED` - `:ACTION_CREATED` - `:ACTION_UPDATED` - `:ACTION_UNCHANGED` - `:ACTION_DELETED` - `:ACTION_FAILED` - `error: Error{ code, details, message}` The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code: Integer` The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. - `details: Array[Detail{ type}]` A list of messages that carry the error details. There is a common set of message types for APIs to use. - `type: String` The type of the serialized message. - `message: String` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. - `resource: VariationMemoryLayerAssignment` VariationMemoryLayerAssignment attaches a single MemoryLayer to a variation at a given position in the variation's baseline memory stack. A variation has at most one assignment per memory_layer_id. Variations only support whole-layer attachments — entry pinning is an objective-level capability. - `id: String` Assignment row id — handle for removing the assignment. Distinct from the referenced memory layer's id. - `memory_layer: BareMetadata` BareMetadata contains the minimal metadata for a resource: the ID and an optional human-readable name. These are used for reference fields where the full metadata (account scoping, timestamps, labels, external IDs) is not needed — e.g., the tool references inside an agent variation spec or the tools assigned to an objective. Both fields are server-populated; clients provide IDs through sibling fields rather than by constructing a BareMetadata themselves. - `position: Integer` Position in the variation's baseline stack. Lower values sit lower; the highest-position assignment is on top of the variation's baseline. Gaps are fine — only relative position matters. Positions must be unique within a variation; a request that would collide with an existing assignment's position is rejected with InvalidArgument. - `metadata: OperationMetadata` Metadata for ephemeral operations and activities (e.g., objectives, executions, runs) - `id: String` Unique identifier for the operation (prefixed ULID, e.g., "obj_01HXK...") - `account_id: String` Account this operation belongs to for multi-tenant isolation (prefixed ULID) - `created_at: Time` Timestamp when this operation was created ULID includes timestamp information, but this explicit field enables easier querying - `profile_id: String` ID of the actor (user or service account) that created this operation - `workspace_id: String` Workspace this operation belongs to for organizational grouping (prefixed ULID) - `external_id: String` External ID for the operation (e.g., a workflow ID from an external system) - `labels: Hash[Symbol, String]` Arbitrary key-value pairs for categorization and filtering Examples: {"priority": "high", "source": "api", "workflow": "onboarding"} ### Bulk Workspace Apply Result Data - `class BulkWorkspaceApplyResultData` Outcome for a single resource within a bulk apply. The `type` field is the discriminator string naming the populated `outcome` oneof variant (e.g., "toolSet", "memoryEntry"). Every outcome shell carries an `action` enum and either a resulting resource snapshot (for ACTION_CREATED, ACTION_UPDATED, ACTION_UNCHANGED, ACTION_DELETED) or a google.rpc.Status (for ACTION_FAILED). - `agent: BulkWorkspaceApplyResultDataAgentOutcome` - `action: :ACTION_UNSPECIFIED | :ACTION_CREATED | :ACTION_UPDATED | 3 more` - `:ACTION_UNSPECIFIED` - `:ACTION_CREATED` - `:ACTION_UPDATED` - `:ACTION_UNCHANGED` - `:ACTION_DELETED` - `:ACTION_FAILED` - `error: Error{ code, details, message}` The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code: Integer` The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. - `details: Array[Detail{ type}]` A list of messages that carry the error details. There is a common set of message types for APIs to use. - `type: String` The type of the serialized message. - `message: String` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. - `external_id: String` - `resource: Agent` Agent resource - `metadata: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) - `id: String` Unique identifier for the resource (prefixed ULID, e.g., "agent_01HXK...") - `account_id: String` Account this resource belongs to for multi-tenant isolation (prefixed ULID) - `created_at: Time` Timestamp when this resource was created - `name: String` Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool") Required for resources that users interact with directly - `profile_id: String` ID of the actor (user or service account) that created this resource - `workspace_id: String` Workspace this resource belongs to for organizational grouping (prefixed ULID) - `bundle_key: String` Optional bundle ownership key. When set, indicates the resource is managed by a configuration bundle identified by this key. Used by BulkWorkspaceResources.Apply to track which resources belong to which bundle for reconciliation / soft-delete on re-apply. - `external_id: String` External ID for the resource (e.g., a workflow ID from an external system) - `labels: Hash[Symbol, String]` Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"} - `spec: AgentSpec` Agent specification (user-provided configuration) - `status: :AGENT_STATUS_UNSPECIFIED | :AGENT_STATUS_DRAFT | :AGENT_STATUS_PUBLISHED | :AGENT_STATUS_ARCHIVED` Status of the agent - `:AGENT_STATUS_UNSPECIFIED` - `:AGENT_STATUS_DRAFT` - `:AGENT_STATUS_PUBLISHED` - `:AGENT_STATUS_ARCHIVED` - `variation_selection_mode: :VARIATION_SELECTION_MODE_UNSPECIFIED | :VARIATION_SELECTION_MODE_RANDOM | :VARIATION_SELECTION_MODE_WEIGHTED` Controls how variations are automatically selected when creating objectives Defaults to RANDOM when unspecified - `:VARIATION_SELECTION_MODE_UNSPECIFIED` - `:VARIATION_SELECTION_MODE_RANDOM` - `:VARIATION_SELECTION_MODE_WEIGHTED` - `description: String` Description of the agent's purpose - `input_data_schema: Hash[Symbol, untyped]` InputDataSchema is used for enforcing a data input when objectives are created. This is valuable when using liquid formatting in agent variation prompts. Input data schema is also valuable when using an agent as a sub-agent, as the schema is used as the tool's input parameter schema. If omitted, the sub-agent schema will be loaded with a simple "prompt" free text string as its schema. - `output_definition: Hash[Symbol, untyped]` Optional output definition for objectives created for this agent. When provided, Cadenya will append a tool to that will be called by the LLM in use by the variant to extract information in the format provided here. Use this option when you want structured data to be created by your objectives. - `webhook_events_url: String` The URL that Cadenya will send events for any objective assigned to the agent. - `info: AgentInfo` AgentInfo contains simple information about an agent for display or quick reference - `created_by: Profile` A profile identifies a user or non-human principal (such as an API key) at the account level. Profiles are account-scoped and can be granted access to multiple workspaces. - `metadata: AccountResourceMetadata` AccountResourceMetadata is used to represent a resource that is associated to an account but not to a workspace. - `id: String` Unique identifier for the resource (prefixed ULID, e.g., "apikey_01HXK...") - `account_id: String` Account this resource belongs to for multi-tenant isolation (prefixed ULID) - `name: String` Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool") Required for resources that users interact with directly - `profile_id: String` - `external_id: String` External ID for the resource (e.g., a workflow ID from an external system) - `labels: Hash[Symbol, String]` Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"} - `spec: ProfileSpec` Configuration for a profile. - `type: :PROFILE_TYPE_UNSPECIFIED | :PROFILE_TYPE_USER | :PROFILE_TYPE_API_KEY | :PROFILE_TYPE_SYSTEM` Whether this profile represents a human user, an API key, or a system principal. - `:PROFILE_TYPE_UNSPECIFIED` - `:PROFILE_TYPE_USER` - `:PROFILE_TYPE_API_KEY` - `:PROFILE_TYPE_SYSTEM` - `email: String` Email address of the profile. Required and unique within an account for user profiles. - `name: String` Display name (e.g., "Bobby Tables"). - `variation_count: Integer` - `agent_schedule: BulkWorkspaceApplyResultDataAgentScheduleOutcome` - `action: :ACTION_UNSPECIFIED | :ACTION_CREATED | :ACTION_UPDATED | 3 more` - `:ACTION_UNSPECIFIED` - `:ACTION_CREATED` - `:ACTION_UPDATED` - `:ACTION_UNCHANGED` - `:ACTION_DELETED` - `:ACTION_FAILED` - `error: Error{ code, details, message}` The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code: Integer` The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. - `details: Array[Detail{ type}]` A list of messages that carry the error details. There is a common set of message types for APIs to use. - `type: String` The type of the serialized message. - `message: String` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. - `external_id: String` - `resource: AgentSchedule` AgentSchedule resource — a recurring trigger attached to an agent that creates objectives on its cadence. - `metadata: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) - `spec: AgentScheduleSpec` AgentScheduleSpec is the user-provided configuration for a schedule. - `initial_message: String` The initial message passed to CreateObjective on each fire. Becomes the first user message in the objective's chat history. - `schedule: AgentScheduleSpecSchedule` Schedule defines WHEN the schedule fires. Temporal-style structured form: a list of calendar rules (wall-clock) and/or interval rules (duration), OR'd together. At least one rule is required. - `calendars: Array[ScheduleCalendar]` Wall-clock rules. May be empty if `intervals` is non-empty. - `comment: String` - `day_of_month: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `day_of_week: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `hour: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `minute: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `month: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `second: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `intervals: Array[ScheduleInterval]` Duration-based rules. May be empty if `calendars` is non-empty. - `every: String` - `offset: String` Phase shift within `every`. Must be < `every` (enforced at runtime). - `timezone: String` IANA tz name (e.g. "America/New_York"). Required. Applies to calendars; intervals fire on wall-clock cadence anchored in this zone. - `data: untyped` Optional input data passed to the objective. If the agent has an input_data_schema, this must satisfy it. - `overlap_policy: :OVERLAP_POLICY_UNSPECIFIED | :OVERLAP_POLICY_ALLOW | :OVERLAP_POLICY_SKIP` What to do when the previous run is still in flight. Defaults to SKIP. - `:OVERLAP_POLICY_UNSPECIFIED` - `:OVERLAP_POLICY_ALLOW` - `:OVERLAP_POLICY_SKIP` - `status: :AGENT_SCHEDULE_STATUS_UNSPECIFIED | :AGENT_SCHEDULE_STATUS_ACTIVE | :AGENT_SCHEDULE_STATUS_PAUSED | :AGENT_SCHEDULE_STATUS_ARCHIVED` Lifecycle. Defaults to ACTIVE on create when unspecified. - `:AGENT_SCHEDULE_STATUS_UNSPECIFIED` - `:AGENT_SCHEDULE_STATUS_ACTIVE` - `:AGENT_SCHEDULE_STATUS_PAUSED` - `:AGENT_SCHEDULE_STATUS_ARCHIVED` - `variation_id: String` Optional explicit variation. When unset, the agent's variation_selection_mode chooses per fire. - `info: AgentScheduleInfo` AgentScheduleInfo provides read-only runtime data about a schedule. - `created_by: Profile` A profile identifies a user or non-human principal (such as an API key) at the account level. Profiles are account-scoped and can be granted access to multiple workspaces. - `last_fire_at: Time` When the schedule last fired (regardless of objective outcome). - `last_objective_id: String` ID of the most recent objective the schedule created. - `last_skipped_at: Time` When the schedule most recently skipped a fire (SKIP policy + prior in flight). - `last_skip_reason: String` Reason for the most recent skip (e.g. "previous objective still running"). - `next_fire_at: Time` When the schedule will next fire. Computed from the spec; absent when the schedule is PAUSED/ARCHIVED or has no future fire times. - `total_fires: Integer` Lifetime count of objectives created by this schedule. - `agent_variation: BulkWorkspaceApplyResultDataAgentVariationOutcome` - `action: :ACTION_UNSPECIFIED | :ACTION_CREATED | :ACTION_UPDATED | 3 more` - `:ACTION_UNSPECIFIED` - `:ACTION_CREATED` - `:ACTION_UPDATED` - `:ACTION_UNCHANGED` - `:ACTION_DELETED` - `:ACTION_FAILED` - `error: Error{ code, details, message}` The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code: Integer` The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. - `details: Array[Detail{ type}]` A list of messages that carry the error details. There is a common set of message types for APIs to use. - `type: String` The type of the serialized message. - `message: String` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. - `external_id: String` - `resource: AgentVariation` AgentVariation resource - `metadata: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) - `spec: AgentVariationSpec` AgentVariationSpec defines the operational configuration for a variation - `compaction_config: AgentVariationSpecCompactionConfig` CompactionConfig defines how context window compaction behaves for objectives using this variation. - `summarization: CompactionConfigSummarizationStrategy` SummarizationStrategy configures LLM-powered summarization of older conversation turns. - `instructions: String` Custom instructions that guide what the summarizer preserves. Replaces the default summarization prompt entirely. Example: "Preserve all code snippets, variable names, and technical decisions." - `tool_result_clearing: CompactionConfigToolResultClearingStrategy` ToolResultClearingStrategy configures clearing of older tool result content. - `preserve_recent_results: Integer` Number of most recent tool call results to keep intact. Older tool results have their content replaced with "[result cleared]" while preserving the assistant tool call message (function name, arguments). Default: 2 - `trigger_threshold: Float` Trigger threshold as a percentage of the model's context window (0.0 to 1.0). When input tokens reach this percentage of the model's limit, compaction triggers. Default: 0.75 (75%) - `constraints: AgentVariationSpecConstraints` Execution constraints - `max_sub_objectives: Integer` The maximum number of sub-objectives that can be created. 0 means no limit. - `max_tool_calls: Integer` The maximum number of tool calls that can be made. 0 means no limit. - `description: String` Human-readable description of what this variation does or when it should be used - `enable_episodic_memory: bool` Enable episodic memory for objectives using this variation. When true, the system automatically creates a document namespace for each objective using the objective's episodic_key as the external_id, allowing the agent to store and retrieve documents specific to that episode. - `episodic_memory_ttl: Integer` How long episodic memories should be retained. After this duration, episodic document namespaces can be automatically cleaned up. If not set, episodic memories are retained indefinitely. - `model_config: AgentVariationSpecModelConfig` ModelConfig defines the model configuration for a variation - `model_id: String` The model identifier in family/model format (e.g., "claude/opus-4.6", "claude/sonnet-4.5") - `temperature: Float` Sampling temperature for model inference (0.0 to 1.0) Lower values produce more deterministic outputs, higher values increase randomness - `progressive_discovery: AgentVariationSpecProgressiveDiscovery` ProgressiveDiscovery is used to indicate that the agent should automatically discover tools that are not explicitly assigned to it. Max tools is the maximum number of tools that can be discovered per search. Hints are optional hints for tool search. These are used in conjunction with the context-aware tool search and can help select the best tools for the task. - `hints: Array[String]` - `max_tools: Integer` - `rerank_threshold: Float` Rerank Threshold is an optional value that instructs whether or not to run a search result through a embedding/reranker process which can improve performance and reduce context bloat when tools reach the configured threshold. If a tool match must exceed 0.8, for example, the tool very closely match the query the tool search performed. - `prompt: String` The system prompt for this variation - `weight: Integer` Weight for weighted random selection (>= 0). P(v) = v.weight / sum(all_weights). Only used when the agent's variation_selection_mode is WEIGHTED. A weight of 0 means never auto-selected, but can still be chosen explicitly via variation_id on CreateObjectiveRequest. - `info: AgentVariationInfo` AgentVariationInfo provides read-only summary information about a variation - `assignments: Array[VariationAssignment]` All tools, tool sets, and sub-agents assigned to this variation. Populated on reads so clients can render a variation's full assignment list without calling the add/remove endpoints just to enumerate. - `id: String` - `agent: BareMetadata` BareMetadata contains the minimal metadata for a resource: the ID and an optional human-readable name. These are used for reference fields where the full metadata (account scoping, timestamps, labels, external IDs) is not needed — e.g., the tool references inside an agent variation spec or the tools assigned to an objective. Both fields are server-populated; clients provide IDs through sibling fields rather than by constructing a BareMetadata themselves. - `id: String` - `name: String` Human-readable name of the referenced resource, populated by the server on reads for convenience. Absent on references to resources that do not have a name (e.g., objective tasks). - `tool: BareMetadata` BareMetadata contains the minimal metadata for a resource: the ID and an optional human-readable name. These are used for reference fields where the full metadata (account scoping, timestamps, labels, external IDs) is not needed — e.g., the tool references inside an agent variation spec or the tools assigned to an objective. Both fields are server-populated; clients provide IDs through sibling fields rather than by constructing a BareMetadata themselves. - `tool_set: BareMetadata` BareMetadata contains the minimal metadata for a resource: the ID and an optional human-readable name. These are used for reference fields where the full metadata (account scoping, timestamps, labels, external IDs) is not needed — e.g., the tool references inside an agent variation spec or the tools assigned to an objective. Both fields are server-populated; clients provide IDs through sibling fields rather than by constructing a BareMetadata themselves. - `created_by: Profile` A profile identifies a user or non-human principal (such as an API key) at the account level. Profiles are account-scoped and can be granted access to multiple workspaces. - `feedback_count: Integer` Total number of objective feedbacks received for this variation - `memory_layer_assignments: Array[VariationMemoryLayerAssignment]` Read-only list of memory layer assignments for this variation, returned in ascending `position` (bottom → top). Capped at 10 entries. - `id: String` Assignment row id — handle for removing the assignment. Distinct from the referenced memory layer's id. - `memory_layer: BareMetadata` BareMetadata contains the minimal metadata for a resource: the ID and an optional human-readable name. These are used for reference fields where the full metadata (account scoping, timestamps, labels, external IDs) is not needed — e.g., the tool references inside an agent variation spec or the tools assigned to an objective. Both fields are server-populated; clients provide IDs through sibling fields rather than by constructing a BareMetadata themselves. - `position: Integer` Position in the variation's baseline stack. Lower values sit lower; the highest-position assignment is on top of the variation's baseline. Gaps are fine — only relative position matters. Positions must be unique within a variation; a request that would collide with an existing assignment's position is rejected with InvalidArgument. - `memory_layer_count: Integer` Count of memory layer assignments. - `model: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) - `score: Float` Thompson Sampling score: posterior mean of Beta(ts_alpha, ts_beta). Range [0, 1] where 0.5 = neutral, >0.5 = positive, <0.5 = negative. - `sub_agent_count: Integer` Number of sub-agents assigned to this variation - `tool_count: Integer` Number of individual tools assigned to this variation - `tool_set_count: Integer` Number of tool sets assigned to this variation - `memory_entry: BulkWorkspaceApplyResultDataMemoryEntryOutcome` - `action: :ACTION_UNSPECIFIED | :ACTION_CREATED | :ACTION_UPDATED | 3 more` - `:ACTION_UNSPECIFIED` - `:ACTION_CREATED` - `:ACTION_UPDATED` - `:ACTION_UNCHANGED` - `:ACTION_DELETED` - `:ACTION_FAILED` - `error: Error{ code, details, message}` The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code: Integer` The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. - `details: Array[Detail{ type}]` A list of messages that carry the error details. There is a common set of message types for APIs to use. - `type: String` The type of the serialized message. - `message: String` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. - `external_id: String` - `resource: MemoryEntry` MemoryEntry is a single keyed value within a MemoryLayer. Entries are addressed by their key, which follows the S3 object key safe-character convention (see MemoryEntrySpec.key for the full rule). Keys are unique within a single layer; the same key may appear in multiple layers, in which case the LIFO stack-walk determines which one wins for a given objective. MemoryEntry is the summary shape, returned by ListMemoryEntries. It does not carry the entry body — callers that need the body must fetch the entry individually via GetMemoryEntry, which returns a MemoryEntryDetail. - `metadata: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) - `spec: MemoryEntrySpec` MemoryEntrySpec is the metadata portion of an entry — the fields that identify and describe it, without the body. It appears on both the summary (MemoryEntry) and detail (MemoryEntryDetail) views. - `key: String` The lookup key for this entry within its layer. Must conform to the S3 object key safe-characters spec: ASCII alphanumerics and the special characters !, -, _, ., *, ', (, ), and /. Forward slashes may be used to suggest hierarchy (e.g., "skills/postmortem/write"), but lookups are flat — the key is a single opaque string, not a path. Additional rules enforced by the service: - May not begin or end with / - May not contain consecutive slashes (//) - May not begin with reserved prefixes (cadenya/, system/) - Case-sensitive - Unique within the parent layer For skills entries, this key is also the id the model passes to memory_load_skill when it decides to load the entry's content. - `description: String` One-line "when to use this" hint shown in the frontmatter manifest for skills entries. The model uses this to decide whether to load the body, so it should be written for the model as the audience. Ignored for layer types that do not advertise frontmatter. - `info: MemoryEntryInfo` - `created_by: Profile` A profile identifies a user or non-human principal (such as an API key) at the account level. Profiles are account-scoped and can be granted access to multiple workspaces. - `memory_layer: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) - `memory_layer: BulkWorkspaceApplyResultDataMemoryLayerOutcome` - `action: :ACTION_UNSPECIFIED | :ACTION_CREATED | :ACTION_UPDATED | 3 more` - `:ACTION_UNSPECIFIED` - `:ACTION_CREATED` - `:ACTION_UPDATED` - `:ACTION_UNCHANGED` - `:ACTION_DELETED` - `:ACTION_FAILED` - `error: Error{ code, details, message}` The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code: Integer` The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. - `details: Array[Detail{ type}]` A list of messages that carry the error details. There is a common set of message types for APIs to use. - `type: String` The type of the serialized message. - `message: String` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. - `external_id: String` - `resource: MemoryLayer` MemoryLayer is a named container of memory entries that can be composed into an objective's memory stack. Layers are workspace-scoped resources. The layer type controls how its entries participate in the agent loop — see MemoryLayerType for details. See "Memory stack composition" above for how layers compose at lookup time. - `metadata: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) - `spec: MemoryLayerSpec` - `type: :MEMORY_LAYER_TYPE_UNSPECIFIED | :MEMORY_LAYER_TYPE_EPISODIC | :MEMORY_LAYER_TYPE_SKILLS` - `:MEMORY_LAYER_TYPE_UNSPECIFIED` - `:MEMORY_LAYER_TYPE_EPISODIC` - `:MEMORY_LAYER_TYPE_SKILLS` - `description: String` Human-readable description of the layer's purpose. Encouraged for user-created layers; system-managed layers may have a generated description. - `expires_at: Time` For layers with a finite lifetime (e.g., episodic), the time at which the layer becomes eligible for cleanup. Set by the system; unset for persistent layers. - `system_managed: bool` Server-set. True for layers managed by the system (e.g., episodic layers created automatically when an objective uses an episodic_key). System-managed layers cannot be assigned to objective stacks via the API and cannot be mutated by clients — their lifecycle is controlled entirely by the runtime. - `info: MemoryLayerInfo` - `created_by: Profile` A profile identifies a user or non-human principal (such as an API key) at the account level. Profiles are account-scoped and can be granted access to multiple workspaces. - `entry_count: Integer` Number of entries currently in this layer. - `last_used_at: Time` Timestamp of the most recent objective that resolved against this layer. Useful for surfacing unused layers in the dashboard. - `tool: BulkWorkspaceApplyResultDataToolOutcome` - `action: :ACTION_UNSPECIFIED | :ACTION_CREATED | :ACTION_UPDATED | 3 more` - `:ACTION_UNSPECIFIED` - `:ACTION_CREATED` - `:ACTION_UPDATED` - `:ACTION_UNCHANGED` - `:ACTION_DELETED` - `:ACTION_FAILED` - `error: Error{ code, details, message}` The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code: Integer` The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. - `details: Array[Detail{ type}]` A list of messages that carry the error details. There is a common set of message types for APIs to use. - `type: String` The type of the serialized message. - `message: String` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. - `external_id: String` - `resource: Tool` - `metadata: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) - `spec: ToolSpec` - `config: ToolSpecConfig` Config defines the adapter to use for the tool. This is used to determine how the tool is called. For example, if the tool is an HTTP tool, the adapter will be Http. If the tool is an inline tool, the adapter will be Inline. - `http: ConfigHTTP` - `request_method: :HTTP_METHOD_UNSPECIFIED | :GET | :POST | 3 more` - `:HTTP_METHOD_UNSPECIFIED` - `:GET` - `:POST` - `:PUT` - `:PATCH` - `:DELETE` - `headers: Hash[Symbol, String]` - `path: String` - `query: String` - `request_body_content_type: String` - `request_body_template: String` These are only used when the request method is a POST, PUT, or PATCH - `tool_name: String` The tool name (commonly an "operation id" in OpenAPI specs) to call on the HTTP adapter. This is used to match the tool spec to the correct endpoint on the HTTP adapter. it will be derived from the name of the tool if not provided. - `mcp: ConfigMcp` - `tool_description: String` - `tool_name: String` - `tool_title: String` - `openapi: ConfigOpenAPI` - `method_: String` - `operation_id: String` - `path: String` - `description: String` - `parameters: Hash[Symbol, untyped]` - `status: :TOOL_STATUS_UNSPECIFIED | :TOOL_STATUS_AVAILABLE | :TOOL_STATUS_OMITTED | :TOOL_STATUS_ARCHIVED` - `:TOOL_STATUS_UNSPECIFIED` - `:TOOL_STATUS_AVAILABLE` - `:TOOL_STATUS_OMITTED` - `:TOOL_STATUS_ARCHIVED` - `requires_approval: bool` - `info: ToolInfo` - `created_by: Profile` A profile identifies a user or non-human principal (such as an API key) at the account level. Profiles are account-scoped and can be granted access to multiple workspaces. - `tool_set: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) - `tool_set: BulkWorkspaceApplyResultDataToolSetOutcome` - `action: :ACTION_UNSPECIFIED | :ACTION_CREATED | :ACTION_UPDATED | 3 more` - `:ACTION_UNSPECIFIED` - `:ACTION_CREATED` - `:ACTION_UPDATED` - `:ACTION_UNCHANGED` - `:ACTION_DELETED` - `:ACTION_FAILED` - `error: Error{ code, details, message}` The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code: Integer` The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. - `details: Array[Detail{ type}]` A list of messages that carry the error details. There is a common set of message types for APIs to use. - `type: String` The type of the serialized message. - `message: String` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. - `external_id: String` - `resource: ToolSet` - `metadata: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) - `spec: ToolSetSpec` - `adapter: ToolSetAdapter` - `http: ToolSetAdapterHTTP` - `base_url: String` - `headers: Hash[Symbol, String]` - `mcp: ToolSetAdapterMcp` - `exclude_tools: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `operator: :OPERATOR_UNSPECIFIED | :OPERATOR_AND | :OPERATOR_OR` - `:OPERATOR_UNSPECIFIED` - `:OPERATOR_AND` - `:OPERATOR_OR` - `filters: Array[AttributeFilter]` - `attribute: :ATTRIBUTE_UNSPECIFIED | :ATTRIBUTE_NAME | :ATTRIBUTE_TITLE | :ATTRIBUTE_DESCRIPTION` - `:ATTRIBUTE_UNSPECIFIED` - `:ATTRIBUTE_NAME` - `:ATTRIBUTE_TITLE` - `:ATTRIBUTE_DESCRIPTION` - `matcher: StringMatcher` String matching operations - `case_sensitive: bool` - `contains: String` - `ends_with: String` - `exact: String` - `regex: String` - `starts_with: String` - `headers: Hash[Symbol, String]` - `include_tools: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `tool_approvals: ApprovalRequirementFilter` Approval filters that will automatically set the approval requirement on tools synced from an external source - `always: bool` - `only: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `url: String` - `openapi: ToolSetAdapterOpenAPI` - `base_url: String` Base URL for dispatching tool calls. If set, overrides the server resolved from the spec's servers array. - `exclude_tools: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `headers: Hash[Symbol, String]` Headers sent when fetching the spec from a URL and when dispatching tool calls. - `include_tools: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `server_name: String` Name of the server entry in the spec's servers array (OpenAPI 3.2 server.name field). Used to select which server URL to dispatch to when base_url is not set. If unset, the first server is used. Ignored when base_url is set. - `tool_approvals: ApprovalRequirementFilter` Approval filters that will automatically set the approval requirement on tools synced from an external source - `upload_id: String` ID of a COMPLETE Upload containing the OpenAPI spec document. - `url: String` URL to fetch the OpenAPI spec from. Synced automatically every hour. - `description: String` - `info: ToolSetInfo` Tool set information - `agent_count: Integer` - `created_by: Profile` A profile identifies a user or non-human principal (such as an API key) at the account level. Profiles are account-scoped and can be granted access to multiple workspaces. - `last_sync: Time` - `tool_count: Integer` - `type: String` - `variation_assignment: BulkWorkspaceApplyResultDataVariationAssignmentOutcome` - `action: :ACTION_UNSPECIFIED | :ACTION_CREATED | :ACTION_UPDATED | 3 more` - `:ACTION_UNSPECIFIED` - `:ACTION_CREATED` - `:ACTION_UPDATED` - `:ACTION_UNCHANGED` - `:ACTION_DELETED` - `:ACTION_FAILED` - `error: Error{ code, details, message}` The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code: Integer` The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. - `details: Array[Detail{ type}]` A list of messages that carry the error details. There is a common set of message types for APIs to use. - `type: String` The type of the serialized message. - `message: String` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. - `resource: VariationAssignment` A read-only reference to a single tool, tool set, or sub-agent attached to a variation. Read the full set of assignments via `AgentVariationInfo.assignments`; mutations go through the dedicated add/remove assignment endpoints. The `id` identifies the assignment itself (not the referenced resource) and is the handle used to remove the assignment. It is returned by the add endpoint and present on every entry in `AgentVariationInfo.assignments`. - `id: String` - `agent: BareMetadata` BareMetadata contains the minimal metadata for a resource: the ID and an optional human-readable name. These are used for reference fields where the full metadata (account scoping, timestamps, labels, external IDs) is not needed — e.g., the tool references inside an agent variation spec or the tools assigned to an objective. Both fields are server-populated; clients provide IDs through sibling fields rather than by constructing a BareMetadata themselves. - `tool: BareMetadata` BareMetadata contains the minimal metadata for a resource: the ID and an optional human-readable name. These are used for reference fields where the full metadata (account scoping, timestamps, labels, external IDs) is not needed — e.g., the tool references inside an agent variation spec or the tools assigned to an objective. Both fields are server-populated; clients provide IDs through sibling fields rather than by constructing a BareMetadata themselves. - `tool_set: BareMetadata` BareMetadata contains the minimal metadata for a resource: the ID and an optional human-readable name. These are used for reference fields where the full metadata (account scoping, timestamps, labels, external IDs) is not needed — e.g., the tool references inside an agent variation spec or the tools assigned to an objective. Both fields are server-populated; clients provide IDs through sibling fields rather than by constructing a BareMetadata themselves. - `variation_memory_layer: BulkWorkspaceApplyResultDataVariationMemoryLayerOutcome` - `action: :ACTION_UNSPECIFIED | :ACTION_CREATED | :ACTION_UPDATED | 3 more` - `:ACTION_UNSPECIFIED` - `:ACTION_CREATED` - `:ACTION_UPDATED` - `:ACTION_UNCHANGED` - `:ACTION_DELETED` - `:ACTION_FAILED` - `error: Error{ code, details, message}` The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code: Integer` The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. - `details: Array[Detail{ type}]` A list of messages that carry the error details. There is a common set of message types for APIs to use. - `type: String` The type of the serialized message. - `message: String` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. - `resource: VariationMemoryLayerAssignment` VariationMemoryLayerAssignment attaches a single MemoryLayer to a variation at a given position in the variation's baseline memory stack. A variation has at most one assignment per memory_layer_id. Variations only support whole-layer attachments — entry pinning is an objective-level capability. - `id: String` Assignment row id — handle for removing the assignment. Distinct from the referenced memory layer's id. - `memory_layer: BareMetadata` BareMetadata contains the minimal metadata for a resource: the ID and an optional human-readable name. These are used for reference fields where the full metadata (account scoping, timestamps, labels, external IDs) is not needed — e.g., the tool references inside an agent variation spec or the tools assigned to an objective. Both fields are server-populated; clients provide IDs through sibling fields rather than by constructing a BareMetadata themselves. - `position: Integer` Position in the variation's baseline stack. Lower values sit lower; the highest-position assignment is on top of the variation's baseline. Gaps are fine — only relative position matters. Positions must be unique within a variation; a request that would collide with an existing assignment's position is rejected with InvalidArgument. ### Bulk Workspace Apply Result Data Agent Outcome - `class BulkWorkspaceApplyResultDataAgentOutcome` - `action: :ACTION_UNSPECIFIED | :ACTION_CREATED | :ACTION_UPDATED | 3 more` - `:ACTION_UNSPECIFIED` - `:ACTION_CREATED` - `:ACTION_UPDATED` - `:ACTION_UNCHANGED` - `:ACTION_DELETED` - `:ACTION_FAILED` - `error: Error{ code, details, message}` The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code: Integer` The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. - `details: Array[Detail{ type}]` A list of messages that carry the error details. There is a common set of message types for APIs to use. - `type: String` The type of the serialized message. - `message: String` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. - `external_id: String` - `resource: Agent` Agent resource - `metadata: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) - `id: String` Unique identifier for the resource (prefixed ULID, e.g., "agent_01HXK...") - `account_id: String` Account this resource belongs to for multi-tenant isolation (prefixed ULID) - `created_at: Time` Timestamp when this resource was created - `name: String` Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool") Required for resources that users interact with directly - `profile_id: String` ID of the actor (user or service account) that created this resource - `workspace_id: String` Workspace this resource belongs to for organizational grouping (prefixed ULID) - `bundle_key: String` Optional bundle ownership key. When set, indicates the resource is managed by a configuration bundle identified by this key. Used by BulkWorkspaceResources.Apply to track which resources belong to which bundle for reconciliation / soft-delete on re-apply. - `external_id: String` External ID for the resource (e.g., a workflow ID from an external system) - `labels: Hash[Symbol, String]` Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"} - `spec: AgentSpec` Agent specification (user-provided configuration) - `status: :AGENT_STATUS_UNSPECIFIED | :AGENT_STATUS_DRAFT | :AGENT_STATUS_PUBLISHED | :AGENT_STATUS_ARCHIVED` Status of the agent - `:AGENT_STATUS_UNSPECIFIED` - `:AGENT_STATUS_DRAFT` - `:AGENT_STATUS_PUBLISHED` - `:AGENT_STATUS_ARCHIVED` - `variation_selection_mode: :VARIATION_SELECTION_MODE_UNSPECIFIED | :VARIATION_SELECTION_MODE_RANDOM | :VARIATION_SELECTION_MODE_WEIGHTED` Controls how variations are automatically selected when creating objectives Defaults to RANDOM when unspecified - `:VARIATION_SELECTION_MODE_UNSPECIFIED` - `:VARIATION_SELECTION_MODE_RANDOM` - `:VARIATION_SELECTION_MODE_WEIGHTED` - `description: String` Description of the agent's purpose - `input_data_schema: Hash[Symbol, untyped]` InputDataSchema is used for enforcing a data input when objectives are created. This is valuable when using liquid formatting in agent variation prompts. Input data schema is also valuable when using an agent as a sub-agent, as the schema is used as the tool's input parameter schema. If omitted, the sub-agent schema will be loaded with a simple "prompt" free text string as its schema. - `output_definition: Hash[Symbol, untyped]` Optional output definition for objectives created for this agent. When provided, Cadenya will append a tool to that will be called by the LLM in use by the variant to extract information in the format provided here. Use this option when you want structured data to be created by your objectives. - `webhook_events_url: String` The URL that Cadenya will send events for any objective assigned to the agent. - `info: AgentInfo` AgentInfo contains simple information about an agent for display or quick reference - `created_by: Profile` A profile identifies a user or non-human principal (such as an API key) at the account level. Profiles are account-scoped and can be granted access to multiple workspaces. - `metadata: AccountResourceMetadata` AccountResourceMetadata is used to represent a resource that is associated to an account but not to a workspace. - `id: String` Unique identifier for the resource (prefixed ULID, e.g., "apikey_01HXK...") - `account_id: String` Account this resource belongs to for multi-tenant isolation (prefixed ULID) - `name: String` Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool") Required for resources that users interact with directly - `profile_id: String` - `external_id: String` External ID for the resource (e.g., a workflow ID from an external system) - `labels: Hash[Symbol, String]` Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"} - `spec: ProfileSpec` Configuration for a profile. - `type: :PROFILE_TYPE_UNSPECIFIED | :PROFILE_TYPE_USER | :PROFILE_TYPE_API_KEY | :PROFILE_TYPE_SYSTEM` Whether this profile represents a human user, an API key, or a system principal. - `:PROFILE_TYPE_UNSPECIFIED` - `:PROFILE_TYPE_USER` - `:PROFILE_TYPE_API_KEY` - `:PROFILE_TYPE_SYSTEM` - `email: String` Email address of the profile. Required and unique within an account for user profiles. - `name: String` Display name (e.g., "Bobby Tables"). - `variation_count: Integer` ### Bulk Workspace Apply Result Data Agent Schedule Outcome - `class BulkWorkspaceApplyResultDataAgentScheduleOutcome` - `action: :ACTION_UNSPECIFIED | :ACTION_CREATED | :ACTION_UPDATED | 3 more` - `:ACTION_UNSPECIFIED` - `:ACTION_CREATED` - `:ACTION_UPDATED` - `:ACTION_UNCHANGED` - `:ACTION_DELETED` - `:ACTION_FAILED` - `error: Error{ code, details, message}` The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code: Integer` The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. - `details: Array[Detail{ type}]` A list of messages that carry the error details. There is a common set of message types for APIs to use. - `type: String` The type of the serialized message. - `message: String` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. - `external_id: String` - `resource: AgentSchedule` AgentSchedule resource — a recurring trigger attached to an agent that creates objectives on its cadence. - `metadata: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) - `id: String` Unique identifier for the resource (prefixed ULID, e.g., "agent_01HXK...") - `account_id: String` Account this resource belongs to for multi-tenant isolation (prefixed ULID) - `created_at: Time` Timestamp when this resource was created - `name: String` Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool") Required for resources that users interact with directly - `profile_id: String` ID of the actor (user or service account) that created this resource - `workspace_id: String` Workspace this resource belongs to for organizational grouping (prefixed ULID) - `bundle_key: String` Optional bundle ownership key. When set, indicates the resource is managed by a configuration bundle identified by this key. Used by BulkWorkspaceResources.Apply to track which resources belong to which bundle for reconciliation / soft-delete on re-apply. - `external_id: String` External ID for the resource (e.g., a workflow ID from an external system) - `labels: Hash[Symbol, String]` Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"} - `spec: AgentScheduleSpec` AgentScheduleSpec is the user-provided configuration for a schedule. - `initial_message: String` The initial message passed to CreateObjective on each fire. Becomes the first user message in the objective's chat history. - `schedule: AgentScheduleSpecSchedule` Schedule defines WHEN the schedule fires. Temporal-style structured form: a list of calendar rules (wall-clock) and/or interval rules (duration), OR'd together. At least one rule is required. - `calendars: Array[ScheduleCalendar]` Wall-clock rules. May be empty if `intervals` is non-empty. - `comment: String` - `day_of_month: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `day_of_week: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `hour: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `minute: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `month: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `second: Array[ScheduleRange]` - `end_: Integer` - `start: Integer` - `step: Integer` - `intervals: Array[ScheduleInterval]` Duration-based rules. May be empty if `calendars` is non-empty. - `every: String` - `offset: String` Phase shift within `every`. Must be < `every` (enforced at runtime). - `timezone: String` IANA tz name (e.g. "America/New_York"). Required. Applies to calendars; intervals fire on wall-clock cadence anchored in this zone. - `data: untyped` Optional input data passed to the objective. If the agent has an input_data_schema, this must satisfy it. - `overlap_policy: :OVERLAP_POLICY_UNSPECIFIED | :OVERLAP_POLICY_ALLOW | :OVERLAP_POLICY_SKIP` What to do when the previous run is still in flight. Defaults to SKIP. - `:OVERLAP_POLICY_UNSPECIFIED` - `:OVERLAP_POLICY_ALLOW` - `:OVERLAP_POLICY_SKIP` - `status: :AGENT_SCHEDULE_STATUS_UNSPECIFIED | :AGENT_SCHEDULE_STATUS_ACTIVE | :AGENT_SCHEDULE_STATUS_PAUSED | :AGENT_SCHEDULE_STATUS_ARCHIVED` Lifecycle. Defaults to ACTIVE on create when unspecified. - `:AGENT_SCHEDULE_STATUS_UNSPECIFIED` - `:AGENT_SCHEDULE_STATUS_ACTIVE` - `:AGENT_SCHEDULE_STATUS_PAUSED` - `:AGENT_SCHEDULE_STATUS_ARCHIVED` - `variation_id: String` Optional explicit variation. When unset, the agent's variation_selection_mode chooses per fire. - `info: AgentScheduleInfo` AgentScheduleInfo provides read-only runtime data about a schedule. - `created_by: Profile` A profile identifies a user or non-human principal (such as an API key) at the account level. Profiles are account-scoped and can be granted access to multiple workspaces. - `metadata: AccountResourceMetadata` AccountResourceMetadata is used to represent a resource that is associated to an account but not to a workspace. - `id: String` Unique identifier for the resource (prefixed ULID, e.g., "apikey_01HXK...") - `account_id: String` Account this resource belongs to for multi-tenant isolation (prefixed ULID) - `name: String` Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool") Required for resources that users interact with directly - `profile_id: String` - `external_id: String` External ID for the resource (e.g., a workflow ID from an external system) - `labels: Hash[Symbol, String]` Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"} - `spec: ProfileSpec` Configuration for a profile. - `type: :PROFILE_TYPE_UNSPECIFIED | :PROFILE_TYPE_USER | :PROFILE_TYPE_API_KEY | :PROFILE_TYPE_SYSTEM` Whether this profile represents a human user, an API key, or a system principal. - `:PROFILE_TYPE_UNSPECIFIED` - `:PROFILE_TYPE_USER` - `:PROFILE_TYPE_API_KEY` - `:PROFILE_TYPE_SYSTEM` - `email: String` Email address of the profile. Required and unique within an account for user profiles. - `name: String` Display name (e.g., "Bobby Tables"). - `last_fire_at: Time` When the schedule last fired (regardless of objective outcome). - `last_objective_id: String` ID of the most recent objective the schedule created. - `last_skipped_at: Time` When the schedule most recently skipped a fire (SKIP policy + prior in flight). - `last_skip_reason: String` Reason for the most recent skip (e.g. "previous objective still running"). - `next_fire_at: Time` When the schedule will next fire. Computed from the spec; absent when the schedule is PAUSED/ARCHIVED or has no future fire times. - `total_fires: Integer` Lifetime count of objectives created by this schedule. ### Bulk Workspace Apply Result Data Agent Variation Outcome - `class BulkWorkspaceApplyResultDataAgentVariationOutcome` - `action: :ACTION_UNSPECIFIED | :ACTION_CREATED | :ACTION_UPDATED | 3 more` - `:ACTION_UNSPECIFIED` - `:ACTION_CREATED` - `:ACTION_UPDATED` - `:ACTION_UNCHANGED` - `:ACTION_DELETED` - `:ACTION_FAILED` - `error: Error{ code, details, message}` The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code: Integer` The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. - `details: Array[Detail{ type}]` A list of messages that carry the error details. There is a common set of message types for APIs to use. - `type: String` The type of the serialized message. - `message: String` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. - `external_id: String` - `resource: AgentVariation` AgentVariation resource - `metadata: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) - `id: String` Unique identifier for the resource (prefixed ULID, e.g., "agent_01HXK...") - `account_id: String` Account this resource belongs to for multi-tenant isolation (prefixed ULID) - `created_at: Time` Timestamp when this resource was created - `name: String` Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool") Required for resources that users interact with directly - `profile_id: String` ID of the actor (user or service account) that created this resource - `workspace_id: String` Workspace this resource belongs to for organizational grouping (prefixed ULID) - `bundle_key: String` Optional bundle ownership key. When set, indicates the resource is managed by a configuration bundle identified by this key. Used by BulkWorkspaceResources.Apply to track which resources belong to which bundle for reconciliation / soft-delete on re-apply. - `external_id: String` External ID for the resource (e.g., a workflow ID from an external system) - `labels: Hash[Symbol, String]` Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"} - `spec: AgentVariationSpec` AgentVariationSpec defines the operational configuration for a variation - `compaction_config: AgentVariationSpecCompactionConfig` CompactionConfig defines how context window compaction behaves for objectives using this variation. - `summarization: CompactionConfigSummarizationStrategy` SummarizationStrategy configures LLM-powered summarization of older conversation turns. - `instructions: String` Custom instructions that guide what the summarizer preserves. Replaces the default summarization prompt entirely. Example: "Preserve all code snippets, variable names, and technical decisions." - `tool_result_clearing: CompactionConfigToolResultClearingStrategy` ToolResultClearingStrategy configures clearing of older tool result content. - `preserve_recent_results: Integer` Number of most recent tool call results to keep intact. Older tool results have their content replaced with "[result cleared]" while preserving the assistant tool call message (function name, arguments). Default: 2 - `trigger_threshold: Float` Trigger threshold as a percentage of the model's context window (0.0 to 1.0). When input tokens reach this percentage of the model's limit, compaction triggers. Default: 0.75 (75%) - `constraints: AgentVariationSpecConstraints` Execution constraints - `max_sub_objectives: Integer` The maximum number of sub-objectives that can be created. 0 means no limit. - `max_tool_calls: Integer` The maximum number of tool calls that can be made. 0 means no limit. - `description: String` Human-readable description of what this variation does or when it should be used - `enable_episodic_memory: bool` Enable episodic memory for objectives using this variation. When true, the system automatically creates a document namespace for each objective using the objective's episodic_key as the external_id, allowing the agent to store and retrieve documents specific to that episode. - `episodic_memory_ttl: Integer` How long episodic memories should be retained. After this duration, episodic document namespaces can be automatically cleaned up. If not set, episodic memories are retained indefinitely. - `model_config: AgentVariationSpecModelConfig` ModelConfig defines the model configuration for a variation - `model_id: String` The model identifier in family/model format (e.g., "claude/opus-4.6", "claude/sonnet-4.5") - `temperature: Float` Sampling temperature for model inference (0.0 to 1.0) Lower values produce more deterministic outputs, higher values increase randomness - `progressive_discovery: AgentVariationSpecProgressiveDiscovery` ProgressiveDiscovery is used to indicate that the agent should automatically discover tools that are not explicitly assigned to it. Max tools is the maximum number of tools that can be discovered per search. Hints are optional hints for tool search. These are used in conjunction with the context-aware tool search and can help select the best tools for the task. - `hints: Array[String]` - `max_tools: Integer` - `rerank_threshold: Float` Rerank Threshold is an optional value that instructs whether or not to run a search result through a embedding/reranker process which can improve performance and reduce context bloat when tools reach the configured threshold. If a tool match must exceed 0.8, for example, the tool very closely match the query the tool search performed. - `prompt: String` The system prompt for this variation - `weight: Integer` Weight for weighted random selection (>= 0). P(v) = v.weight / sum(all_weights). Only used when the agent's variation_selection_mode is WEIGHTED. A weight of 0 means never auto-selected, but can still be chosen explicitly via variation_id on CreateObjectiveRequest. - `info: AgentVariationInfo` AgentVariationInfo provides read-only summary information about a variation - `assignments: Array[VariationAssignment]` All tools, tool sets, and sub-agents assigned to this variation. Populated on reads so clients can render a variation's full assignment list without calling the add/remove endpoints just to enumerate. - `id: String` - `agent: BareMetadata` BareMetadata contains the minimal metadata for a resource: the ID and an optional human-readable name. These are used for reference fields where the full metadata (account scoping, timestamps, labels, external IDs) is not needed — e.g., the tool references inside an agent variation spec or the tools assigned to an objective. Both fields are server-populated; clients provide IDs through sibling fields rather than by constructing a BareMetadata themselves. - `id: String` - `name: String` Human-readable name of the referenced resource, populated by the server on reads for convenience. Absent on references to resources that do not have a name (e.g., objective tasks). - `tool: BareMetadata` BareMetadata contains the minimal metadata for a resource: the ID and an optional human-readable name. These are used for reference fields where the full metadata (account scoping, timestamps, labels, external IDs) is not needed — e.g., the tool references inside an agent variation spec or the tools assigned to an objective. Both fields are server-populated; clients provide IDs through sibling fields rather than by constructing a BareMetadata themselves. - `tool_set: BareMetadata` BareMetadata contains the minimal metadata for a resource: the ID and an optional human-readable name. These are used for reference fields where the full metadata (account scoping, timestamps, labels, external IDs) is not needed — e.g., the tool references inside an agent variation spec or the tools assigned to an objective. Both fields are server-populated; clients provide IDs through sibling fields rather than by constructing a BareMetadata themselves. - `created_by: Profile` A profile identifies a user or non-human principal (such as an API key) at the account level. Profiles are account-scoped and can be granted access to multiple workspaces. - `metadata: AccountResourceMetadata` AccountResourceMetadata is used to represent a resource that is associated to an account but not to a workspace. - `id: String` Unique identifier for the resource (prefixed ULID, e.g., "apikey_01HXK...") - `account_id: String` Account this resource belongs to for multi-tenant isolation (prefixed ULID) - `name: String` Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool") Required for resources that users interact with directly - `profile_id: String` - `external_id: String` External ID for the resource (e.g., a workflow ID from an external system) - `labels: Hash[Symbol, String]` Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"} - `spec: ProfileSpec` Configuration for a profile. - `type: :PROFILE_TYPE_UNSPECIFIED | :PROFILE_TYPE_USER | :PROFILE_TYPE_API_KEY | :PROFILE_TYPE_SYSTEM` Whether this profile represents a human user, an API key, or a system principal. - `:PROFILE_TYPE_UNSPECIFIED` - `:PROFILE_TYPE_USER` - `:PROFILE_TYPE_API_KEY` - `:PROFILE_TYPE_SYSTEM` - `email: String` Email address of the profile. Required and unique within an account for user profiles. - `name: String` Display name (e.g., "Bobby Tables"). - `feedback_count: Integer` Total number of objective feedbacks received for this variation - `memory_layer_assignments: Array[VariationMemoryLayerAssignment]` Read-only list of memory layer assignments for this variation, returned in ascending `position` (bottom → top). Capped at 10 entries. - `id: String` Assignment row id — handle for removing the assignment. Distinct from the referenced memory layer's id. - `memory_layer: BareMetadata` BareMetadata contains the minimal metadata for a resource: the ID and an optional human-readable name. These are used for reference fields where the full metadata (account scoping, timestamps, labels, external IDs) is not needed — e.g., the tool references inside an agent variation spec or the tools assigned to an objective. Both fields are server-populated; clients provide IDs through sibling fields rather than by constructing a BareMetadata themselves. - `position: Integer` Position in the variation's baseline stack. Lower values sit lower; the highest-position assignment is on top of the variation's baseline. Gaps are fine — only relative position matters. Positions must be unique within a variation; a request that would collide with an existing assignment's position is rejected with InvalidArgument. - `memory_layer_count: Integer` Count of memory layer assignments. - `model: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) - `score: Float` Thompson Sampling score: posterior mean of Beta(ts_alpha, ts_beta). Range [0, 1] where 0.5 = neutral, >0.5 = positive, <0.5 = negative. - `sub_agent_count: Integer` Number of sub-agents assigned to this variation - `tool_count: Integer` Number of individual tools assigned to this variation - `tool_set_count: Integer` Number of tool sets assigned to this variation ### Bulk Workspace Apply Result Data Memory Entry Outcome - `class BulkWorkspaceApplyResultDataMemoryEntryOutcome` - `action: :ACTION_UNSPECIFIED | :ACTION_CREATED | :ACTION_UPDATED | 3 more` - `:ACTION_UNSPECIFIED` - `:ACTION_CREATED` - `:ACTION_UPDATED` - `:ACTION_UNCHANGED` - `:ACTION_DELETED` - `:ACTION_FAILED` - `error: Error{ code, details, message}` The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code: Integer` The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. - `details: Array[Detail{ type}]` A list of messages that carry the error details. There is a common set of message types for APIs to use. - `type: String` The type of the serialized message. - `message: String` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. - `external_id: String` - `resource: MemoryEntry` MemoryEntry is a single keyed value within a MemoryLayer. Entries are addressed by their key, which follows the S3 object key safe-character convention (see MemoryEntrySpec.key for the full rule). Keys are unique within a single layer; the same key may appear in multiple layers, in which case the LIFO stack-walk determines which one wins for a given objective. MemoryEntry is the summary shape, returned by ListMemoryEntries. It does not carry the entry body — callers that need the body must fetch the entry individually via GetMemoryEntry, which returns a MemoryEntryDetail. - `metadata: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) - `id: String` Unique identifier for the resource (prefixed ULID, e.g., "agent_01HXK...") - `account_id: String` Account this resource belongs to for multi-tenant isolation (prefixed ULID) - `created_at: Time` Timestamp when this resource was created - `name: String` Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool") Required for resources that users interact with directly - `profile_id: String` ID of the actor (user or service account) that created this resource - `workspace_id: String` Workspace this resource belongs to for organizational grouping (prefixed ULID) - `bundle_key: String` Optional bundle ownership key. When set, indicates the resource is managed by a configuration bundle identified by this key. Used by BulkWorkspaceResources.Apply to track which resources belong to which bundle for reconciliation / soft-delete on re-apply. - `external_id: String` External ID for the resource (e.g., a workflow ID from an external system) - `labels: Hash[Symbol, String]` Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"} - `spec: MemoryEntrySpec` MemoryEntrySpec is the metadata portion of an entry — the fields that identify and describe it, without the body. It appears on both the summary (MemoryEntry) and detail (MemoryEntryDetail) views. - `key: String` The lookup key for this entry within its layer. Must conform to the S3 object key safe-characters spec: ASCII alphanumerics and the special characters !, -, _, ., *, ', (, ), and /. Forward slashes may be used to suggest hierarchy (e.g., "skills/postmortem/write"), but lookups are flat — the key is a single opaque string, not a path. Additional rules enforced by the service: - May not begin or end with / - May not contain consecutive slashes (//) - May not begin with reserved prefixes (cadenya/, system/) - Case-sensitive - Unique within the parent layer For skills entries, this key is also the id the model passes to memory_load_skill when it decides to load the entry's content. - `description: String` One-line "when to use this" hint shown in the frontmatter manifest for skills entries. The model uses this to decide whether to load the body, so it should be written for the model as the audience. Ignored for layer types that do not advertise frontmatter. - `info: MemoryEntryInfo` - `created_by: Profile` A profile identifies a user or non-human principal (such as an API key) at the account level. Profiles are account-scoped and can be granted access to multiple workspaces. - `metadata: AccountResourceMetadata` AccountResourceMetadata is used to represent a resource that is associated to an account but not to a workspace. - `id: String` Unique identifier for the resource (prefixed ULID, e.g., "apikey_01HXK...") - `account_id: String` Account this resource belongs to for multi-tenant isolation (prefixed ULID) - `name: String` Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool") Required for resources that users interact with directly - `profile_id: String` - `external_id: String` External ID for the resource (e.g., a workflow ID from an external system) - `labels: Hash[Symbol, String]` Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"} - `spec: ProfileSpec` Configuration for a profile. - `type: :PROFILE_TYPE_UNSPECIFIED | :PROFILE_TYPE_USER | :PROFILE_TYPE_API_KEY | :PROFILE_TYPE_SYSTEM` Whether this profile represents a human user, an API key, or a system principal. - `:PROFILE_TYPE_UNSPECIFIED` - `:PROFILE_TYPE_USER` - `:PROFILE_TYPE_API_KEY` - `:PROFILE_TYPE_SYSTEM` - `email: String` Email address of the profile. Required and unique within an account for user profiles. - `name: String` Display name (e.g., "Bobby Tables"). - `memory_layer: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) ### Bulk Workspace Apply Result Data Memory Layer Outcome - `class BulkWorkspaceApplyResultDataMemoryLayerOutcome` - `action: :ACTION_UNSPECIFIED | :ACTION_CREATED | :ACTION_UPDATED | 3 more` - `:ACTION_UNSPECIFIED` - `:ACTION_CREATED` - `:ACTION_UPDATED` - `:ACTION_UNCHANGED` - `:ACTION_DELETED` - `:ACTION_FAILED` - `error: Error{ code, details, message}` The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code: Integer` The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. - `details: Array[Detail{ type}]` A list of messages that carry the error details. There is a common set of message types for APIs to use. - `type: String` The type of the serialized message. - `message: String` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. - `external_id: String` - `resource: MemoryLayer` MemoryLayer is a named container of memory entries that can be composed into an objective's memory stack. Layers are workspace-scoped resources. The layer type controls how its entries participate in the agent loop — see MemoryLayerType for details. See "Memory stack composition" above for how layers compose at lookup time. - `metadata: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) - `id: String` Unique identifier for the resource (prefixed ULID, e.g., "agent_01HXK...") - `account_id: String` Account this resource belongs to for multi-tenant isolation (prefixed ULID) - `created_at: Time` Timestamp when this resource was created - `name: String` Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool") Required for resources that users interact with directly - `profile_id: String` ID of the actor (user or service account) that created this resource - `workspace_id: String` Workspace this resource belongs to for organizational grouping (prefixed ULID) - `bundle_key: String` Optional bundle ownership key. When set, indicates the resource is managed by a configuration bundle identified by this key. Used by BulkWorkspaceResources.Apply to track which resources belong to which bundle for reconciliation / soft-delete on re-apply. - `external_id: String` External ID for the resource (e.g., a workflow ID from an external system) - `labels: Hash[Symbol, String]` Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"} - `spec: MemoryLayerSpec` - `type: :MEMORY_LAYER_TYPE_UNSPECIFIED | :MEMORY_LAYER_TYPE_EPISODIC | :MEMORY_LAYER_TYPE_SKILLS` - `:MEMORY_LAYER_TYPE_UNSPECIFIED` - `:MEMORY_LAYER_TYPE_EPISODIC` - `:MEMORY_LAYER_TYPE_SKILLS` - `description: String` Human-readable description of the layer's purpose. Encouraged for user-created layers; system-managed layers may have a generated description. - `expires_at: Time` For layers with a finite lifetime (e.g., episodic), the time at which the layer becomes eligible for cleanup. Set by the system; unset for persistent layers. - `system_managed: bool` Server-set. True for layers managed by the system (e.g., episodic layers created automatically when an objective uses an episodic_key). System-managed layers cannot be assigned to objective stacks via the API and cannot be mutated by clients — their lifecycle is controlled entirely by the runtime. - `info: MemoryLayerInfo` - `created_by: Profile` A profile identifies a user or non-human principal (such as an API key) at the account level. Profiles are account-scoped and can be granted access to multiple workspaces. - `metadata: AccountResourceMetadata` AccountResourceMetadata is used to represent a resource that is associated to an account but not to a workspace. - `id: String` Unique identifier for the resource (prefixed ULID, e.g., "apikey_01HXK...") - `account_id: String` Account this resource belongs to for multi-tenant isolation (prefixed ULID) - `name: String` Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool") Required for resources that users interact with directly - `profile_id: String` - `external_id: String` External ID for the resource (e.g., a workflow ID from an external system) - `labels: Hash[Symbol, String]` Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"} - `spec: ProfileSpec` Configuration for a profile. - `type: :PROFILE_TYPE_UNSPECIFIED | :PROFILE_TYPE_USER | :PROFILE_TYPE_API_KEY | :PROFILE_TYPE_SYSTEM` Whether this profile represents a human user, an API key, or a system principal. - `:PROFILE_TYPE_UNSPECIFIED` - `:PROFILE_TYPE_USER` - `:PROFILE_TYPE_API_KEY` - `:PROFILE_TYPE_SYSTEM` - `email: String` Email address of the profile. Required and unique within an account for user profiles. - `name: String` Display name (e.g., "Bobby Tables"). - `entry_count: Integer` Number of entries currently in this layer. - `last_used_at: Time` Timestamp of the most recent objective that resolved against this layer. Useful for surfacing unused layers in the dashboard. ### Bulk Workspace Apply Result Data Tool Outcome - `class BulkWorkspaceApplyResultDataToolOutcome` - `action: :ACTION_UNSPECIFIED | :ACTION_CREATED | :ACTION_UPDATED | 3 more` - `:ACTION_UNSPECIFIED` - `:ACTION_CREATED` - `:ACTION_UPDATED` - `:ACTION_UNCHANGED` - `:ACTION_DELETED` - `:ACTION_FAILED` - `error: Error{ code, details, message}` The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code: Integer` The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. - `details: Array[Detail{ type}]` A list of messages that carry the error details. There is a common set of message types for APIs to use. - `type: String` The type of the serialized message. - `message: String` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. - `external_id: String` - `resource: Tool` - `metadata: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) - `id: String` Unique identifier for the resource (prefixed ULID, e.g., "agent_01HXK...") - `account_id: String` Account this resource belongs to for multi-tenant isolation (prefixed ULID) - `created_at: Time` Timestamp when this resource was created - `name: String` Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool") Required for resources that users interact with directly - `profile_id: String` ID of the actor (user or service account) that created this resource - `workspace_id: String` Workspace this resource belongs to for organizational grouping (prefixed ULID) - `bundle_key: String` Optional bundle ownership key. When set, indicates the resource is managed by a configuration bundle identified by this key. Used by BulkWorkspaceResources.Apply to track which resources belong to which bundle for reconciliation / soft-delete on re-apply. - `external_id: String` External ID for the resource (e.g., a workflow ID from an external system) - `labels: Hash[Symbol, String]` Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"} - `spec: ToolSpec` - `config: ToolSpecConfig` Config defines the adapter to use for the tool. This is used to determine how the tool is called. For example, if the tool is an HTTP tool, the adapter will be Http. If the tool is an inline tool, the adapter will be Inline. - `http: ConfigHTTP` - `request_method: :HTTP_METHOD_UNSPECIFIED | :GET | :POST | 3 more` - `:HTTP_METHOD_UNSPECIFIED` - `:GET` - `:POST` - `:PUT` - `:PATCH` - `:DELETE` - `headers: Hash[Symbol, String]` - `path: String` - `query: String` - `request_body_content_type: String` - `request_body_template: String` These are only used when the request method is a POST, PUT, or PATCH - `tool_name: String` The tool name (commonly an "operation id" in OpenAPI specs) to call on the HTTP adapter. This is used to match the tool spec to the correct endpoint on the HTTP adapter. it will be derived from the name of the tool if not provided. - `mcp: ConfigMcp` - `tool_description: String` - `tool_name: String` - `tool_title: String` - `openapi: ConfigOpenAPI` - `method_: String` - `operation_id: String` - `path: String` - `description: String` - `parameters: Hash[Symbol, untyped]` - `status: :TOOL_STATUS_UNSPECIFIED | :TOOL_STATUS_AVAILABLE | :TOOL_STATUS_OMITTED | :TOOL_STATUS_ARCHIVED` - `:TOOL_STATUS_UNSPECIFIED` - `:TOOL_STATUS_AVAILABLE` - `:TOOL_STATUS_OMITTED` - `:TOOL_STATUS_ARCHIVED` - `requires_approval: bool` - `info: ToolInfo` - `created_by: Profile` A profile identifies a user or non-human principal (such as an API key) at the account level. Profiles are account-scoped and can be granted access to multiple workspaces. - `metadata: AccountResourceMetadata` AccountResourceMetadata is used to represent a resource that is associated to an account but not to a workspace. - `id: String` Unique identifier for the resource (prefixed ULID, e.g., "apikey_01HXK...") - `account_id: String` Account this resource belongs to for multi-tenant isolation (prefixed ULID) - `name: String` Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool") Required for resources that users interact with directly - `profile_id: String` - `external_id: String` External ID for the resource (e.g., a workflow ID from an external system) - `labels: Hash[Symbol, String]` Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"} - `spec: ProfileSpec` Configuration for a profile. - `type: :PROFILE_TYPE_UNSPECIFIED | :PROFILE_TYPE_USER | :PROFILE_TYPE_API_KEY | :PROFILE_TYPE_SYSTEM` Whether this profile represents a human user, an API key, or a system principal. - `:PROFILE_TYPE_UNSPECIFIED` - `:PROFILE_TYPE_USER` - `:PROFILE_TYPE_API_KEY` - `:PROFILE_TYPE_SYSTEM` - `email: String` Email address of the profile. Required and unique within an account for user profiles. - `name: String` Display name (e.g., "Bobby Tables"). - `tool_set: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) ### Bulk Workspace Apply Result Data Tool Set Outcome - `class BulkWorkspaceApplyResultDataToolSetOutcome` - `action: :ACTION_UNSPECIFIED | :ACTION_CREATED | :ACTION_UPDATED | 3 more` - `:ACTION_UNSPECIFIED` - `:ACTION_CREATED` - `:ACTION_UPDATED` - `:ACTION_UNCHANGED` - `:ACTION_DELETED` - `:ACTION_FAILED` - `error: Error{ code, details, message}` The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code: Integer` The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. - `details: Array[Detail{ type}]` A list of messages that carry the error details. There is a common set of message types for APIs to use. - `type: String` The type of the serialized message. - `message: String` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. - `external_id: String` - `resource: ToolSet` - `metadata: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) - `id: String` Unique identifier for the resource (prefixed ULID, e.g., "agent_01HXK...") - `account_id: String` Account this resource belongs to for multi-tenant isolation (prefixed ULID) - `created_at: Time` Timestamp when this resource was created - `name: String` Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool") Required for resources that users interact with directly - `profile_id: String` ID of the actor (user or service account) that created this resource - `workspace_id: String` Workspace this resource belongs to for organizational grouping (prefixed ULID) - `bundle_key: String` Optional bundle ownership key. When set, indicates the resource is managed by a configuration bundle identified by this key. Used by BulkWorkspaceResources.Apply to track which resources belong to which bundle for reconciliation / soft-delete on re-apply. - `external_id: String` External ID for the resource (e.g., a workflow ID from an external system) - `labels: Hash[Symbol, String]` Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"} - `spec: ToolSetSpec` - `adapter: ToolSetAdapter` - `http: ToolSetAdapterHTTP` - `base_url: String` - `headers: Hash[Symbol, String]` - `mcp: ToolSetAdapterMcp` - `exclude_tools: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `operator: :OPERATOR_UNSPECIFIED | :OPERATOR_AND | :OPERATOR_OR` - `:OPERATOR_UNSPECIFIED` - `:OPERATOR_AND` - `:OPERATOR_OR` - `filters: Array[AttributeFilter]` - `attribute: :ATTRIBUTE_UNSPECIFIED | :ATTRIBUTE_NAME | :ATTRIBUTE_TITLE | :ATTRIBUTE_DESCRIPTION` - `:ATTRIBUTE_UNSPECIFIED` - `:ATTRIBUTE_NAME` - `:ATTRIBUTE_TITLE` - `:ATTRIBUTE_DESCRIPTION` - `matcher: StringMatcher` String matching operations - `case_sensitive: bool` - `contains: String` - `ends_with: String` - `exact: String` - `regex: String` - `starts_with: String` - `headers: Hash[Symbol, String]` - `include_tools: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `tool_approvals: ApprovalRequirementFilter` Approval filters that will automatically set the approval requirement on tools synced from an external source - `always: bool` - `only: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `url: String` - `openapi: ToolSetAdapterOpenAPI` - `base_url: String` Base URL for dispatching tool calls. If set, overrides the server resolved from the spec's servers array. - `exclude_tools: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `headers: Hash[Symbol, String]` Headers sent when fetching the spec from a URL and when dispatching tool calls. - `include_tools: ToolFilter` Top-level filter with simple boolean logic (no nesting) - `server_name: String` Name of the server entry in the spec's servers array (OpenAPI 3.2 server.name field). Used to select which server URL to dispatch to when base_url is not set. If unset, the first server is used. Ignored when base_url is set. - `tool_approvals: ApprovalRequirementFilter` Approval filters that will automatically set the approval requirement on tools synced from an external source - `upload_id: String` ID of a COMPLETE Upload containing the OpenAPI spec document. - `url: String` URL to fetch the OpenAPI spec from. Synced automatically every hour. - `description: String` - `info: ToolSetInfo` Tool set information - `agent_count: Integer` - `created_by: Profile` A profile identifies a user or non-human principal (such as an API key) at the account level. Profiles are account-scoped and can be granted access to multiple workspaces. - `metadata: AccountResourceMetadata` AccountResourceMetadata is used to represent a resource that is associated to an account but not to a workspace. - `id: String` Unique identifier for the resource (prefixed ULID, e.g., "apikey_01HXK...") - `account_id: String` Account this resource belongs to for multi-tenant isolation (prefixed ULID) - `name: String` Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool") Required for resources that users interact with directly - `profile_id: String` - `external_id: String` External ID for the resource (e.g., a workflow ID from an external system) - `labels: Hash[Symbol, String]` Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"} - `spec: ProfileSpec` Configuration for a profile. - `type: :PROFILE_TYPE_UNSPECIFIED | :PROFILE_TYPE_USER | :PROFILE_TYPE_API_KEY | :PROFILE_TYPE_SYSTEM` Whether this profile represents a human user, an API key, or a system principal. - `:PROFILE_TYPE_UNSPECIFIED` - `:PROFILE_TYPE_USER` - `:PROFILE_TYPE_API_KEY` - `:PROFILE_TYPE_SYSTEM` - `email: String` Email address of the profile. Required and unique within an account for user profiles. - `name: String` Display name (e.g., "Bobby Tables"). - `last_sync: Time` - `tool_count: Integer` ### Bulk Workspace Apply Result Data Variation Assignment Outcome - `class BulkWorkspaceApplyResultDataVariationAssignmentOutcome` - `action: :ACTION_UNSPECIFIED | :ACTION_CREATED | :ACTION_UPDATED | 3 more` - `:ACTION_UNSPECIFIED` - `:ACTION_CREATED` - `:ACTION_UPDATED` - `:ACTION_UNCHANGED` - `:ACTION_DELETED` - `:ACTION_FAILED` - `error: Error{ code, details, message}` The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code: Integer` The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. - `details: Array[Detail{ type}]` A list of messages that carry the error details. There is a common set of message types for APIs to use. - `type: String` The type of the serialized message. - `message: String` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. - `resource: VariationAssignment` A read-only reference to a single tool, tool set, or sub-agent attached to a variation. Read the full set of assignments via `AgentVariationInfo.assignments`; mutations go through the dedicated add/remove assignment endpoints. The `id` identifies the assignment itself (not the referenced resource) and is the handle used to remove the assignment. It is returned by the add endpoint and present on every entry in `AgentVariationInfo.assignments`. - `id: String` - `agent: BareMetadata` BareMetadata contains the minimal metadata for a resource: the ID and an optional human-readable name. These are used for reference fields where the full metadata (account scoping, timestamps, labels, external IDs) is not needed — e.g., the tool references inside an agent variation spec or the tools assigned to an objective. Both fields are server-populated; clients provide IDs through sibling fields rather than by constructing a BareMetadata themselves. - `id: String` - `name: String` Human-readable name of the referenced resource, populated by the server on reads for convenience. Absent on references to resources that do not have a name (e.g., objective tasks). - `tool: BareMetadata` BareMetadata contains the minimal metadata for a resource: the ID and an optional human-readable name. These are used for reference fields where the full metadata (account scoping, timestamps, labels, external IDs) is not needed — e.g., the tool references inside an agent variation spec or the tools assigned to an objective. Both fields are server-populated; clients provide IDs through sibling fields rather than by constructing a BareMetadata themselves. - `tool_set: BareMetadata` BareMetadata contains the minimal metadata for a resource: the ID and an optional human-readable name. These are used for reference fields where the full metadata (account scoping, timestamps, labels, external IDs) is not needed — e.g., the tool references inside an agent variation spec or the tools assigned to an objective. Both fields are server-populated; clients provide IDs through sibling fields rather than by constructing a BareMetadata themselves. ### Bulk Workspace Apply Result Data Variation Memory Layer Outcome - `class BulkWorkspaceApplyResultDataVariationMemoryLayerOutcome` - `action: :ACTION_UNSPECIFIED | :ACTION_CREATED | :ACTION_UPDATED | 3 more` - `:ACTION_UNSPECIFIED` - `:ACTION_CREATED` - `:ACTION_UPDATED` - `:ACTION_UNCHANGED` - `:ACTION_DELETED` - `:ACTION_FAILED` - `error: Error{ code, details, message}` The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code: Integer` The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. - `details: Array[Detail{ type}]` A list of messages that carry the error details. There is a common set of message types for APIs to use. - `type: String` The type of the serialized message. - `message: String` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. - `resource: VariationMemoryLayerAssignment` VariationMemoryLayerAssignment attaches a single MemoryLayer to a variation at a given position in the variation's baseline memory stack. A variation has at most one assignment per memory_layer_id. Variations only support whole-layer attachments — entry pinning is an objective-level capability. - `id: String` Assignment row id — handle for removing the assignment. Distinct from the referenced memory layer's id. - `memory_layer: BareMetadata` BareMetadata contains the minimal metadata for a resource: the ID and an optional human-readable name. These are used for reference fields where the full metadata (account scoping, timestamps, labels, external IDs) is not needed — e.g., the tool references inside an agent variation spec or the tools assigned to an objective. Both fields are server-populated; clients provide IDs through sibling fields rather than by constructing a BareMetadata themselves. - `id: String` - `name: String` Human-readable name of the referenced resource, populated by the server on reads for convenience. Absent on references to resources that do not have a name (e.g., objective tasks). - `position: Integer` Position in the variation's baseline stack. Lower values sit lower; the highest-position assignment is on top of the variation's baseline. Gaps are fine — only relative position matters. Positions must be unique within a variation; a request that would collide with an existing assignment's position is rejected with InvalidArgument.