## Create a new agent

`client.agents.create(AgentCreateParamsbody, RequestOptionsoptions?): Agent`

**post** `/v1/agents`

Creates a new agent in the workspace

### Parameters

- `body: AgentCreateParams`

  - `metadata: 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.

    - `name: string`

      Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool")

    - `externalId?: string`

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

    - `labels?: Record<string, 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"`

    - `variationSelectionMode: "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

    - `webhookEventsUrl?: string`

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

  - `defaultVariation?: DefaultVariation`

    Create agent variation request

    - `metadata: 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: 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?: number`

            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?: number`

          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?: number`

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

        - `maxToolCalls?: number`

          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?: boolean`

        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?: number`

        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?: number`

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

      - `prompt?: string`

        The system prompt for this variation

      - `toolSelection?: AgentVariationSpecToolSelection`

        Tool selection strategy

        - `assignedTools?: ToolSelectionAssignedTools`

          AssignedTools is used to indicate that the agent should only use the tools/tool sets that are explicitly assigned to it.
          Allow discovery is used when the agent thinks it needs to discover more tools.

          - `allowDiscovery?: boolean`

        - `autoDiscovery?: ToolSelectionAutoDiscovery`

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

          - `maxTools?: number`

      - `weight?: number`

        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.

    - `agentId?: string`

      Agent ID (from path)

### Returns

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

    - `accountId: string`

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

    - `createdAt: string`

      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)

    - `externalId?: string`

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

    - `labels?: Record<string, 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"`

    - `variationSelectionMode: "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

    - `webhookEventsUrl?: 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

    - `createdBy?: Profile`

      Profile represents a human user at the account level.
      Profiles are account-scoped resources that can be associated with multiple workspaces
      through the Actor model. Authentication for profiles is handled via SSO/OAuth (WorkOS).

      - `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?: Record<string, string>`

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

      - `spec: ProfileSpec`

        ProfileSpec contains the profile-specific fields

        - `type: "PROFILE_TYPE_USER" | "PROFILE_TYPE_API_KEY" | "PROFILE_TYPE_SYSTEM"`

          Type is the type of profile. User's are humans, API keys are computers. You know the deal.

          - `"PROFILE_TYPE_USER"`

          - `"PROFILE_TYPE_API_KEY"`

          - `"PROFILE_TYPE_SYSTEM"`

        - `email?: string`

          Email address of the user (required, unique per account)

        - `name?: string`

          Display name for the user (e.g., "Bobby Tables")

    - `variationCount?: number`

### Example

```typescript
import Cadenya from '@cadenya/cadenya';

const client = new Cadenya({
  apiKey: process.env['CADENYA_API_KEY'], // This is the default and can be omitted
});

const agent = await client.agents.create({
  metadata: { name: 'name' },
  spec: {
    status: 'AGENT_STATUS_UNSPECIFIED',
    variationSelectionMode: 'VARIATION_SELECTION_MODE_UNSPECIFIED',
  },
});

console.log(agent.metadata);
```

#### Response

```json
{
  "metadata": {
    "id": "id",
    "accountId": "accountId",
    "createdAt": "2019-12-27T18:11:19.117Z",
    "name": "name",
    "profileId": "profileId",
    "workspaceId": "workspaceId",
    "externalId": "externalId",
    "labels": {
      "foo": "string"
    }
  },
  "spec": {
    "status": "AGENT_STATUS_UNSPECIFIED",
    "variationSelectionMode": "VARIATION_SELECTION_MODE_UNSPECIFIED",
    "description": "description",
    "webhookEventsUrl": "webhookEventsUrl"
  },
  "info": {
    "createdBy": {
      "metadata": {
        "id": "id",
        "accountId": "accountId",
        "name": "name",
        "profileId": "profileId",
        "externalId": "externalId",
        "labels": {
          "foo": "string"
        }
      },
      "spec": {
        "type": "PROFILE_TYPE_USER",
        "email": "email",
        "name": "name"
      }
    },
    "variationCount": 0
  }
}
```