## Create a new variation

`client.Agents.Variations.New(ctx, workspaceID, agentID, body) (*AgentVariation, error)`

**post** `/v1/workspaces/{workspaceId}/agents/{agentId}/variations`

Creates a new variation for an agent

### Parameters

- `workspaceID string`

- `agentID string`

- `body AgentVariationNewParams`

  - `Metadata param.Field[CreateResourceMetadata]`

    CreateResourceMetadata contains the user-provided fields for creating
    a workspace-scoped resource. Read-only fields (id, account_id, workspace_id, profile_id,
    created_at) are excluded since they are set by the server.

  - `Spec param.Field[AgentVariationSpec]`

    AgentVariationSpec defines the operational configuration for a variation

### Returns

- `type AgentVariation struct{…}`

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

    - `AccountID string`

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

    - `CreatedAt 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

    - `ProfileID string`

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

    - `WorkspaceID string`

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

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

    - `ExternalID string`

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

    - `Labels map[string, 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

    - `CompactionConfig 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."

      - `ToolResultClearing CompactionConfigToolResultClearingStrategy`

        ToolResultClearingStrategy configures clearing of older tool result content.

        - `PreserveRecentResults int64`

          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

      - `TriggerThreshold float64`

        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

      - `MaxSubObjectives int64`

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

      - `MaxToolCalls int64`

        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

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

    - `EpisodicMemoryTtl int64`

      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 AgentVariationSpecModelConfig`

      ModelConfig defines the model configuration for a variation

      - `ModelID string`

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

      - `Temperature float64`

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

    - `ProgressiveDiscovery 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 []string`

      - `MaxTools int64`

      - `RerankThreshold float64`

        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 int64`

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

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

    - `CreatedBy 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...")

        - `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 string`

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

        - `Labels map[string, string]`

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

      - `Spec ProfileSpec`

        Configuration for a profile.

        - `Type ProfileSpecType`

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

          - `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 string`

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

        - `Name string`

          Display name (e.g., "Bobby Tables").

    - `FeedbackCount int64`

      Total number of objective feedbacks received for this variation

    - `MemoryLayerAssignments []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.

      - `MemoryLayer 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 int64`

        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.

    - `MemoryLayerCount int64`

      Count of memory layer assignments.

    - `Model ResourceMetadata`

      Standard metadata for persistent, named resources (e.g., agents, tools, prompts)

    - `Score float64`

      Thompson Sampling score: posterior mean of Beta(ts_alpha, ts_beta).
      Range [0, 1] where 0.5 = neutral, >0.5 = positive, <0.5 = negative.

    - `SubAgentCount int64`

      Number of sub-agents assigned to this variation

    - `ToolCount int64`

      Number of individual tools assigned to this variation

    - `ToolSetCount int64`

      Number of tool sets assigned to this variation

### Example

```go
package main

import (
  "context"
  "fmt"

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

func main() {
  client := cadenya.NewClient(
    option.WithAPIKey("My API Key"),
  )
  agentVariation, err := client.Agents.Variations.New(
    context.TODO(),
    "workspaceId",
    "agentId",
    cadenya.AgentVariationNewParams{
      Metadata: cadenya.F(shared.CreateResourceMetadataParam{
        Name: cadenya.F("name"),
      }),
      Spec: cadenya.F(cadenya.AgentVariationSpecParam{

      }),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", agentVariation.Metadata)
}
```

#### Response

```json
{
  "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
  }
}
```