## Update an agent

`client.agents.update(stringid, AgentUpdateParamsbody, RequestOptionsoptions?): Agent`

**patch** `/v1/agents/{id}`

Updates an agent in the workspace

### Parameters

- `id: string`

- `body: AgentUpdateParams`

  - `metadata?: UpdateResourceMetadata`

    UpdateResourceMetadata contains the user-provided fields for updating
    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.

  - `updateMask?: string`

    Fields to update

### 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.update('id');

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