Skip to content
Get started

Get a bulk workspace apply operation

client.BulkWorkspaceResources.Get(ctx, workspaceID, id) (*BulkWorkspaceApply, error)
GET/v1/workspaces/{workspaceId}/bulk_workspace_applies/{id}

Retrieves a bulk workspace apply operation by ID.

ParametersExpand Collapse
workspaceID string
id string
ReturnsExpand Collapse
type BulkWorkspaceApply struct{…}

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.

BundleKey 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 map[string, AgentEntry]Optional

Agents to upsert, keyed by external_id.

Name string

Agent specification (user-provided configuration)

Status AgentSpecStatus

Status of the agent

formatenum
One of the following:
const AgentSpecStatusAgentStatusUnspecified AgentSpecStatus = "AGENT_STATUS_UNSPECIFIED"
const AgentSpecStatusAgentStatusDraft AgentSpecStatus = "AGENT_STATUS_DRAFT"
const AgentSpecStatusAgentStatusPublished AgentSpecStatus = "AGENT_STATUS_PUBLISHED"
const AgentSpecStatusAgentStatusArchived AgentSpecStatus = "AGENT_STATUS_ARCHIVED"
VariationSelectionMode AgentSpecVariationSelectionMode

Controls how variations are automatically selected when creating objectives Defaults to RANDOM when unspecified

formatenum
One of the following:
const AgentSpecVariationSelectionModeVariationSelectionModeUnspecified AgentSpecVariationSelectionMode = "VARIATION_SELECTION_MODE_UNSPECIFIED"
const AgentSpecVariationSelectionModeVariationSelectionModeRandom AgentSpecVariationSelectionMode = "VARIATION_SELECTION_MODE_RANDOM"
const AgentSpecVariationSelectionModeVariationSelectionModeWeighted AgentSpecVariationSelectionMode = "VARIATION_SELECTION_MODE_WEIGHTED"
Description stringOptional

Description of the agent’s purpose

InputDataSchema map[string, unknown]Optional

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.

OutputDefinition map[string, unknown]Optional

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.

WebhookEventsURL stringOptional

The URL that Cadenya will send events for any objective assigned to the agent.

Labels map[string, string]Optional
Schedules map[string, AgentScheduleEntry]Optional

Schedules under this agent, keyed by external_id.

Name string

AgentScheduleSpec is the user-provided configuration for a schedule.

InitialMessage string

The initial message passed to CreateObjective on each fire. Becomes the first user message in the objective’s chat history.

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 []ScheduleCalendarOptional

Wall-clock rules. May be empty if intervals is non-empty.

Comment stringOptional
DayOfMonth []ScheduleRangeOptional
End int64Optional
Start int64Optional
Step int64Optional
DayOfWeek []ScheduleRangeOptional
End int64Optional
Start int64Optional
Step int64Optional
Hour []ScheduleRangeOptional
End int64Optional
Start int64Optional
Step int64Optional
Minute []ScheduleRangeOptional
End int64Optional
Start int64Optional
Step int64Optional
Month []ScheduleRangeOptional
End int64Optional
Start int64Optional
Step int64Optional
Second []ScheduleRangeOptional
End int64Optional
Start int64Optional
Step int64Optional
Intervals []ScheduleIntervalOptional

Duration-based rules. May be empty if calendars is non-empty.

Every stringOptional
Offset stringOptional

Phase shift within every. Must be < every (enforced at runtime).

Timezone stringOptional

IANA tz name (e.g. “America/New_York”). Required. Applies to calendars; intervals fire on wall-clock cadence anchored in this zone.

Data unknownOptional

Optional input data passed to the objective. If the agent has an input_data_schema, this must satisfy it.

OverlapPolicy AgentScheduleSpecOverlapPolicyOptional

What to do when the previous run is still in flight. Defaults to SKIP.

formatenum
One of the following:
const AgentScheduleSpecOverlapPolicyOverlapPolicyUnspecified AgentScheduleSpecOverlapPolicy = "OVERLAP_POLICY_UNSPECIFIED"
const AgentScheduleSpecOverlapPolicyOverlapPolicyAllow AgentScheduleSpecOverlapPolicy = "OVERLAP_POLICY_ALLOW"
const AgentScheduleSpecOverlapPolicyOverlapPolicySkip AgentScheduleSpecOverlapPolicy = "OVERLAP_POLICY_SKIP"
Status AgentScheduleSpecStatusOptional

Lifecycle. Defaults to ACTIVE on create when unspecified.

formatenum
One of the following:
const AgentScheduleSpecStatusAgentScheduleStatusUnspecified AgentScheduleSpecStatus = "AGENT_SCHEDULE_STATUS_UNSPECIFIED"
const AgentScheduleSpecStatusAgentScheduleStatusActive AgentScheduleSpecStatus = "AGENT_SCHEDULE_STATUS_ACTIVE"
const AgentScheduleSpecStatusAgentScheduleStatusPaused AgentScheduleSpecStatus = "AGENT_SCHEDULE_STATUS_PAUSED"
const AgentScheduleSpecStatusAgentScheduleStatusArchived AgentScheduleSpecStatus = "AGENT_SCHEDULE_STATUS_ARCHIVED"
VariationID stringOptional

Optional explicit variation. When unset, the agent’s variation_selection_mode chooses per fire.

Labels map[string, string]Optional
Variations map[string, AgentVariationEntry]Optional

Variations under this agent, keyed by external_id.

Name string

AgentVariationSpec defines the operational configuration for a variation

CompactionConfig AgentVariationSpecCompactionConfigOptional

CompactionConfig defines how context window compaction behaves for objectives using this variation.

SummarizationStrategy configures LLM-powered summarization of older conversation turns.

Instructions stringOptional

Custom instructions that guide what the summarizer preserves. Replaces the default summarization prompt entirely. Example: “Preserve all code snippets, variable names, and technical decisions.”

ToolResultClearingStrategy configures clearing of older tool result content.

PreserveRecentResults int64Optional

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

formatint32
TriggerThreshold float64Optional

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%)

formatfloat
Constraints AgentVariationSpecConstraintsOptional

Execution constraints

MaxSubObjectives int64Optional

The maximum number of sub-objectives that can be created. 0 means no limit.

formatint32
MaxToolCalls int64Optional

The maximum number of tool calls that can be made. 0 means no limit.

formatint32
Description stringOptional

Human-readable description of what this variation does or when it should be used

EnableEpisodicMemory boolOptional

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.

EpisodicMemoryTtl int64Optional

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.

ModelConfig AgentVariationSpecModelConfigOptional

ModelConfig defines the model configuration for a variation

ModelID stringOptional

The model identifier in family/model format (e.g., “claude/opus-4.6”, “claude/sonnet-4.5”)

Temperature float64Optional

Sampling temperature for model inference (0.0 to 1.0) Lower values produce more deterministic outputs, higher values increase randomness

formatfloat
ProgressiveDiscovery AgentVariationSpecProgressiveDiscoveryOptional

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 []stringOptional
MaxTools int64Optional
RerankThreshold float64Optional

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.

formatfloat
Prompt stringOptional

The system prompt for this variation

Weight int64Optional

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.

formatint32
Assignments []VariationAssignmentEntryOptional

Reconciled list — server adjusts the variation’s assignments to exactly this set when the variation is bundle-owned.

SubAgentID stringOptional
ToolID stringOptional
ToolSetID stringOptional
Labels map[string, string]Optional
MemoryLayers []VariationMemoryLayerEntryOptional

Reconciled list of memory layer assignments. Up to 10 entries.

MemoryLayerID stringOptional

external_id: form. Canonical IDs are rejected.

Position int64Optional
AutomaticallyPublishAgents boolOptional

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).

MemoryLayers map[string, MemoryLayerEntry]Optional

Memory layers to upsert, keyed by external_id.

Name string
Type MemoryLayerSpecType
formatenum
One of the following:
const MemoryLayerSpecTypeMemoryLayerTypeUnspecified MemoryLayerSpecType = "MEMORY_LAYER_TYPE_UNSPECIFIED"
const MemoryLayerSpecTypeMemoryLayerTypeEpisodic MemoryLayerSpecType = "MEMORY_LAYER_TYPE_EPISODIC"
const MemoryLayerSpecTypeMemoryLayerTypeSkills MemoryLayerSpecType = "MEMORY_LAYER_TYPE_SKILLS"
Description stringOptional

Human-readable description of the layer’s purpose. Encouraged for user-created layers; system-managed layers may have a generated description.

ExpiresAt TimeOptional

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.

formatdate-time
SystemManaged boolOptional

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 map[string, MemoryEntryItem]Optional

Memory entries in this layer, keyed by external_id.

Key string
Content stringOptional
Description stringOptional
UploadID stringOptional
Labels map[string, string]Optional
SourceURL stringOptional

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.

ToolSets map[string, ToolSetEntry]Optional

Tool sets to upsert, keyed by external_id.

Name string
Adapter ToolSetAdapterOptional
HTTP ToolSetAdapterHTTPOptional
BaseURL stringOptional
Headers map[string, string]Optional
Mcp ToolSetAdapterMcpOptional
ExcludeTools ToolFilterOptional

Top-level filter with simple boolean logic (no nesting)

Operator ToolFilterOperator
formatenum
One of the following:
const ToolFilterOperatorOperatorUnspecified ToolFilterOperator = "OPERATOR_UNSPECIFIED"
const ToolFilterOperatorOperatorAnd ToolFilterOperator = "OPERATOR_AND"
const ToolFilterOperatorOperatorOr ToolFilterOperator = "OPERATOR_OR"
Filters []AttributeFilterOptional
Attribute AttributeFilterAttribute
formatenum
One of the following:
const AttributeFilterAttributeAttributeUnspecified AttributeFilterAttribute = "ATTRIBUTE_UNSPECIFIED"
const AttributeFilterAttributeAttributeName AttributeFilterAttribute = "ATTRIBUTE_NAME"
const AttributeFilterAttributeAttributeTitle AttributeFilterAttribute = "ATTRIBUTE_TITLE"
const AttributeFilterAttributeAttributeDescription AttributeFilterAttribute = "ATTRIBUTE_DESCRIPTION"
Matcher StringMatcherOptional

String matching operations

CaseSensitive boolOptional
Contains stringOptional
EndsWith stringOptional
Exact stringOptional
Regex stringOptional
StartsWith stringOptional
Headers map[string, string]Optional
IncludeTools ToolFilterOptional

Top-level filter with simple boolean logic (no nesting)

Operator ToolFilterOperator
formatenum
One of the following:
const ToolFilterOperatorOperatorUnspecified ToolFilterOperator = "OPERATOR_UNSPECIFIED"
const ToolFilterOperatorOperatorAnd ToolFilterOperator = "OPERATOR_AND"
const ToolFilterOperatorOperatorOr ToolFilterOperator = "OPERATOR_OR"
Filters []AttributeFilterOptional
Attribute AttributeFilterAttribute
formatenum
One of the following:
const AttributeFilterAttributeAttributeUnspecified AttributeFilterAttribute = "ATTRIBUTE_UNSPECIFIED"
const AttributeFilterAttributeAttributeName AttributeFilterAttribute = "ATTRIBUTE_NAME"
const AttributeFilterAttributeAttributeTitle AttributeFilterAttribute = "ATTRIBUTE_TITLE"
const AttributeFilterAttributeAttributeDescription AttributeFilterAttribute = "ATTRIBUTE_DESCRIPTION"
Matcher StringMatcherOptional

String matching operations

CaseSensitive boolOptional
Contains stringOptional
EndsWith stringOptional
Exact stringOptional
Regex stringOptional
StartsWith stringOptional
ToolApprovals ApprovalRequirementFilterOptional

Approval filters that will automatically set the approval requirement on tools synced from an external source

Always boolOptional
Only ToolFilterOptional

Top-level filter with simple boolean logic (no nesting)

Operator ToolFilterOperator
formatenum
One of the following:
const ToolFilterOperatorOperatorUnspecified ToolFilterOperator = "OPERATOR_UNSPECIFIED"
const ToolFilterOperatorOperatorAnd ToolFilterOperator = "OPERATOR_AND"
const ToolFilterOperatorOperatorOr ToolFilterOperator = "OPERATOR_OR"
Filters []AttributeFilterOptional
Attribute AttributeFilterAttribute
formatenum
One of the following:
const AttributeFilterAttributeAttributeUnspecified AttributeFilterAttribute = "ATTRIBUTE_UNSPECIFIED"
const AttributeFilterAttributeAttributeName AttributeFilterAttribute = "ATTRIBUTE_NAME"
const AttributeFilterAttributeAttributeTitle AttributeFilterAttribute = "ATTRIBUTE_TITLE"
const AttributeFilterAttributeAttributeDescription AttributeFilterAttribute = "ATTRIBUTE_DESCRIPTION"
Matcher StringMatcherOptional

String matching operations

CaseSensitive boolOptional
Contains stringOptional
EndsWith stringOptional
Exact stringOptional
Regex stringOptional
StartsWith stringOptional
URL stringOptional
OpenAPI ToolSetAdapterOpenAPIOptional
BaseURL stringOptional

Base URL for dispatching tool calls. If set, overrides the server resolved from the spec’s servers array.

ExcludeTools ToolFilterOptional

Top-level filter with simple boolean logic (no nesting)

Operator ToolFilterOperator
formatenum
One of the following:
const ToolFilterOperatorOperatorUnspecified ToolFilterOperator = "OPERATOR_UNSPECIFIED"
const ToolFilterOperatorOperatorAnd ToolFilterOperator = "OPERATOR_AND"
const ToolFilterOperatorOperatorOr ToolFilterOperator = "OPERATOR_OR"
Filters []AttributeFilterOptional
Attribute AttributeFilterAttribute
formatenum
One of the following:
const AttributeFilterAttributeAttributeUnspecified AttributeFilterAttribute = "ATTRIBUTE_UNSPECIFIED"
const AttributeFilterAttributeAttributeName AttributeFilterAttribute = "ATTRIBUTE_NAME"
const AttributeFilterAttributeAttributeTitle AttributeFilterAttribute = "ATTRIBUTE_TITLE"
const AttributeFilterAttributeAttributeDescription AttributeFilterAttribute = "ATTRIBUTE_DESCRIPTION"
Matcher StringMatcherOptional

String matching operations

CaseSensitive boolOptional
Contains stringOptional
EndsWith stringOptional
Exact stringOptional
Regex stringOptional
StartsWith stringOptional
Headers map[string, string]Optional

Headers sent when fetching the spec from a URL and when dispatching tool calls.

IncludeTools ToolFilterOptional

Top-level filter with simple boolean logic (no nesting)

Operator ToolFilterOperator
formatenum
One of the following:
const ToolFilterOperatorOperatorUnspecified ToolFilterOperator = "OPERATOR_UNSPECIFIED"
const ToolFilterOperatorOperatorAnd ToolFilterOperator = "OPERATOR_AND"
const ToolFilterOperatorOperatorOr ToolFilterOperator = "OPERATOR_OR"
Filters []AttributeFilterOptional
Attribute AttributeFilterAttribute
formatenum
One of the following:
const AttributeFilterAttributeAttributeUnspecified AttributeFilterAttribute = "ATTRIBUTE_UNSPECIFIED"
const AttributeFilterAttributeAttributeName AttributeFilterAttribute = "ATTRIBUTE_NAME"
const AttributeFilterAttributeAttributeTitle AttributeFilterAttribute = "ATTRIBUTE_TITLE"
const AttributeFilterAttributeAttributeDescription AttributeFilterAttribute = "ATTRIBUTE_DESCRIPTION"
Matcher StringMatcherOptional

String matching operations

CaseSensitive boolOptional
Contains stringOptional
EndsWith stringOptional
Exact stringOptional
Regex stringOptional
StartsWith stringOptional
ServerName stringOptional

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.

ToolApprovals ApprovalRequirementFilterOptional

Approval filters that will automatically set the approval requirement on tools synced from an external source

Always boolOptional
Only ToolFilterOptional

Top-level filter with simple boolean logic (no nesting)

Operator ToolFilterOperator
formatenum
One of the following:
const ToolFilterOperatorOperatorUnspecified ToolFilterOperator = "OPERATOR_UNSPECIFIED"
const ToolFilterOperatorOperatorAnd ToolFilterOperator = "OPERATOR_AND"
const ToolFilterOperatorOperatorOr ToolFilterOperator = "OPERATOR_OR"
Filters []AttributeFilterOptional
Attribute AttributeFilterAttribute
formatenum
One of the following:
const AttributeFilterAttributeAttributeUnspecified AttributeFilterAttribute = "ATTRIBUTE_UNSPECIFIED"
const AttributeFilterAttributeAttributeName AttributeFilterAttribute = "ATTRIBUTE_NAME"
const AttributeFilterAttributeAttributeTitle AttributeFilterAttribute = "ATTRIBUTE_TITLE"
const AttributeFilterAttributeAttributeDescription AttributeFilterAttribute = "ATTRIBUTE_DESCRIPTION"
Matcher StringMatcherOptional

String matching operations

CaseSensitive boolOptional
Contains stringOptional
EndsWith stringOptional
Exact stringOptional
Regex stringOptional
StartsWith stringOptional
UploadID stringOptional

ID of a COMPLETE Upload containing the OpenAPI spec document.

URL stringOptional

URL to fetch the OpenAPI spec from. Synced automatically every hour.

Description stringOptional
Labels map[string, string]Optional
Tools map[string, ToolEntry]Optional

Tools in this tool set, keyed by external_id.

Name string

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 ConfigHTTPOptional
RequestMethod ConfigHTTPRequestMethod
formatenum
One of the following:
const ConfigHTTPRequestMethodHTTPMethodUnspecified ConfigHTTPRequestMethod = "HTTP_METHOD_UNSPECIFIED"
const ConfigHTTPRequestMethodGet ConfigHTTPRequestMethod = "GET"
const ConfigHTTPRequestMethodPost ConfigHTTPRequestMethod = "POST"
const ConfigHTTPRequestMethodPut ConfigHTTPRequestMethod = "PUT"
const ConfigHTTPRequestMethodPatch ConfigHTTPRequestMethod = "PATCH"
const ConfigHTTPRequestMethodDelete ConfigHTTPRequestMethod = "DELETE"
Headers map[string, string]Optional
Path stringOptional
Query stringOptional
RequestBodyContentType stringOptional
RequestBodyTemplate stringOptional

These are only used when the request method is a POST, PUT, or PATCH

ToolName stringOptional

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 ConfigMcpOptional
ToolDescription stringOptional
ToolName stringOptional
ToolTitle stringOptional
OpenAPI ConfigOpenAPIOptional
Method stringOptional
OperationID stringOptional
Path stringOptional
Description string
Parameters map[string, unknown]
Status ToolSpecStatus
formatenum
One of the following:
const ToolSpecStatusToolStatusUnspecified ToolSpecStatus = "TOOL_STATUS_UNSPECIFIED"
const ToolSpecStatusToolStatusAvailable ToolSpecStatus = "TOOL_STATUS_AVAILABLE"
const ToolSpecStatusToolStatusOmitted ToolSpecStatus = "TOOL_STATUS_OMITTED"
const ToolSpecStatusToolStatusArchived ToolSpecStatus = "TOOL_STATUS_ARCHIVED"
RequiresApproval boolOptional
Labels map[string, string]Optional

Metadata for ephemeral operations and activities (e.g., objectives, executions, runs)

ID string

Unique identifier for the operation (prefixed ULID, e.g., “obj_01HXK…”)

AccountID string

Account this operation belongs to for multi-tenant isolation (prefixed ULID)

CreatedAt Time

Timestamp when this operation was created ULID includes timestamp information, but this explicit field enables easier querying

formatdate-time
ProfileID string

ID of the actor (user or service account) that created this operation

WorkspaceID string

Workspace this operation belongs to for organizational grouping (prefixed ULID)

ExternalID stringOptional

External ID for the operation (e.g., a workflow ID from an external system)

Labels map[string, string]Optional

Arbitrary key-value pairs for categorization and filtering Examples: {“priority”: “high”, “source”: “api”, “workflow”: “onboarding”}

State BulkWorkspaceApplyStatusState
formatenum
One of the following:
const BulkWorkspaceApplyStatusStateStateUnspecified BulkWorkspaceApplyStatusState = "STATE_UNSPECIFIED"
const BulkWorkspaceApplyStatusStateStatePending BulkWorkspaceApplyStatusState = "STATE_PENDING"
const BulkWorkspaceApplyStatusStateStateValidating BulkWorkspaceApplyStatusState = "STATE_VALIDATING"
const BulkWorkspaceApplyStatusStateStateRunning BulkWorkspaceApplyStatusState = "STATE_RUNNING"
const BulkWorkspaceApplyStatusStateStateSucceeded BulkWorkspaceApplyStatusState = "STATE_SUCCEEDED"
const BulkWorkspaceApplyStatusStateStatePartiallyApplied BulkWorkspaceApplyStatusState = "STATE_PARTIALLY_APPLIED"
const BulkWorkspaceApplyStatusStateStateFailed BulkWorkspaceApplyStatusState = "STATE_FAILED"
const BulkWorkspaceApplyStatusStateStateCancelled BulkWorkspaceApplyStatusState = "STATE_CANCELLED"
Message stringOptional
PreflightError BulkWorkspaceApplyStatusPreflightErrorOptional

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. 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.

Code int64Optional

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

formatint32
Details []BulkWorkspaceApplyStatusPreflightErrorDetailOptional

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Type stringOptional

The type of the serialized message.

Message stringOptional

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.

CompletedAt TimeOptional
CreatedBy ProfileOptional

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.

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…”)

AccountID 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

ProfileID string
ExternalID stringOptional

External ID for the resource (e.g., a workflow ID from an external system)

Labels map[string, string]Optional

Arbitrary key-value pairs for categorization and filtering Examples: {“environment”: “production”, “team”: “platform”, “version”: “v2”}

Configuration for a profile.

Type ProfileSpecType

Whether this profile represents a human user, an API key, or a system principal.

formatenum
One of the following:
const ProfileSpecTypeProfileTypeUnspecified ProfileSpecType = "PROFILE_TYPE_UNSPECIFIED"
const ProfileSpecTypeProfileTypeUser ProfileSpecType = "PROFILE_TYPE_USER"
const ProfileSpecTypeProfileTypeAPIKey ProfileSpecType = "PROFILE_TYPE_API_KEY"
const ProfileSpecTypeProfileTypeSystem ProfileSpecType = "PROFILE_TYPE_SYSTEM"
Email stringOptional

Email address of the profile. Required and unique within an account for user profiles.

Name stringOptional

Display name (e.g., “Bobby Tables”).

CreatedCount int64Optional
DeletedCount int64Optional
FailedCount int64Optional
StartedAt TimeOptional
TotalCount int64Optional
UnchangedCount int64Optional
UpdatedCount int64Optional

Get a bulk workspace apply operation

package main

import (
  "context"
  "fmt"

  "github.com/cadenya/cadenya-go"
  "github.com/cadenya/cadenya-go/option"
)

func main() {
  client := cadenya.NewClient(
    option.WithAPIKey("My API Key"),
  )
  bulkWorkspaceApply, err := client.BulkWorkspaceResources.Get(
    context.TODO(),
    "workspaceId",
    "id",
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", bulkWorkspaceApply.Data)
}
{
  "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
  }
}
Returns Examples
{
  "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
  }
}