Agents

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

Changed on
put/api/agents/{id}/profile

Request

  • Base URL
    http://localhost:3013
  • URL
    http://localhost:3013/api/agents/{id}/profile
  • Auth
    HTTP bearer

Path parameters

idstring required

Request body

rolestring
descriptionstring
capabilitiesstring[]
claudeMdstring
soulMdstring
identityMdstring
setupScriptstring
toolsMdstring
heartbeatMdstring
changeSourcestring
changedByAgentIdstring
changeReasonstring

Response

Profile updated

idstring required
namestring required
isLeadboolean
status'idle' | 'busy' | 'offline' | 'waiting_for_credentials' required
runtimePoolIdstring nullable
runtimeProvisionAttemptsinteger
runtimeProvisionRetryAtstring nullable
descriptionstring
rolestring
capabilitiesstring[]
claudeMdstring
soulMdstring
identityMdstring
setupScriptstring
toolsMdstring
heartbeatMdstring
maxTasksinteger
emptyPollCountinteger
lastActivityAtstring date-time
provider'claude' | 'codex' | 'pi' | 'devin' | 'claude-managed' | 'opencode' | 'acp' | 'dsh' | 'amp' | 'cursor' | 'grok' | 'fx'
harnessProvider'claude' | 'codex' | 'pi' | 'devin' | 'claude-managed' | 'opencode' | 'acp' | 'dsh' | 'amp' | 'cursor' | 'grok' | 'fx' | 'null' nullable
credentialMissingstring[] nullable
createdAtstring date-time required
lastUpdatedAtstring date-time required

Changes

    • warning

      added the new fx enum value to the ////////// response property for the response status

    • warning

      added the new fx enum value to the //// response property for the response status

    • warning

      added the new fx enum value to the //// response property for the response status

    • info

      added the new optional request property

    • info

      added the optional property //// to the response with the status