---
title: "Update agent profile (role, description, capabilities, etc.)"
method: PUT
path: "/api/agents/{id}/profile"
tags: ["Agents"]
---

# Update agent profile (role, description, capabilities, etc.)

`PUT /api/agents/{id}/profile`

## Path parameters

- `id` string, required

## Request body

- object
  - `role` string
  - `description` string
  - `capabilities` string[]
  - `claudeMd` string
  - `soulMd` string
  - `identityMd` string
  - `setupScript` string
  - `toolsMd` string
  - `heartbeatMd` string
  - `avatar` object, nullable
    - `type` 'lucide', required
    - `icon` string, required
    - `color` string
  - `changeSource` string
  - `changedByAgentId` string
  - `changeReason` string

## Response `200`

Profile updated

- object
  - `id` string, required
  - `name` string, required
  - `isLead` boolean
  - `status` 'idle' | 'busy' | 'offline' | 'waiting_for_credentials', required
  - `description` string
  - `role` string
  - `capabilities` string[]
  - `claudeMd` string
  - `soulMd` string
  - `identityMd` string
  - `setupScript` string
  - `toolsMd` string
  - `heartbeatMd` string
  - `maxTasks` integer
  - `emptyPollCount` integer
  - `lastActivityAt` string, date-time
  - `provider` 'claude' | 'codex' | 'pi' | 'devin' | 'claude-managed' | 'opencode'
  - `harnessProvider` 'claude' | 'codex' | 'pi' | 'devin' | 'claude-managed' | 'opencode' | 'null', nullable
  - `credentialMissing` string[], nullable
  - `credStatus` AgentCredStatus
    - `ready` boolean, required
    - `missing` string[]
    - `satisfiedBy` 'env' | 'file' | 'side-effect-pending' | 'sdk-delegated' | 'null', nullable
    - `hint` string, nullable
    - `liveTest` AgentCredStatusLiveTest, nullable
      - `ok` boolean, required
      - `error` string, nullable
      - `latency_ms` number, required
      - `testedAt` number, required
    - `latestModel` AgentLatestModel, nullable
      - `model` string, required
      - `source` 'task' | 'agent_config' | 'adapter_default' | 'custom', required
      - `taskId` string, nullable
      - `harnessProvider` 'claude' | 'codex' | 'pi' | 'devin' | 'claude-managed' | 'opencode' | 'null', nullable
      - `reportedAt` number, required
      - `reasoningEffort` 'off' | 'low' | 'medium' | 'high' | 'xhigh' | 'max'
    - `reportedAt` number, required
    - `reportKind` 'boot' | 'post_task'
    - `bedrock` AgentBedrockStatus, nullable
      - `region` string, required
      - `probedAt` number, required
      - `ready` boolean, required
      - `models` object[]
        - `id` string, required
        - `name` string, required
      - `error` string
  - `avatar` object
    - `type` 'lucide', required
    - `icon` string, required
    - `color` string
  - `createdAt` string, date-time, required
  - `lastUpdatedAt` string, date-time, required
  - `capacity` object, required
    - `current` integer, required
    - `max` integer, required
    - `available` integer, required

## Other responses

- `400` — Validation error
- `404` — Agent not found

---

[API](https://skmtc.net/desplega-ai/apis/agent-swarm-api.md) · [All operations](https://skmtc.net/desplega-ai/apis/agent-swarm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/desplega-ai/agent-swarm-api/versions/0375890be8c4/schema)