Sign in
Agents

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

put/api/agents/{id}/profile

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
descriptionstring
rolestring
capabilitiesstring[]
claudeMdstring
soulMdstring
identityMdstring
setupScriptstring
toolsMdstring
heartbeatMdstring
maxTasksinteger
emptyPollCountinteger
lastActivityAtstring date-time
provider'claude' | 'codex' | 'pi' | 'devin' | 'claude-managed' | 'opencode' | 'acp'
harnessProvider'claude' | 'codex' | 'pi' | 'devin' | 'claude-managed' | 'opencode' | 'acp' | 'null' nullable
credentialMissingstring[] nullable
createdAtstring date-time required
lastUpdatedAtstring date-time required

Changes

Changed in 5 of the 104 revisions of this API.311

  • 0f5503f5cd283See the full diff
    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

  • 5c23246626741See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 06cac6a7c5bc3See the full diff
    • ○

      added the media type application/json for the response with the status

      response-media-type-added

    • ○

      added the media type application/json for the response with the status

      response-media-type-added

    • ○

      added the media type application/json for the response with the status

      response-media-type-added

  • 0a6cfa00296a6See the full diff
    • ○

      the request property's maxLength was increased from 65536 to 262144

      request-property-max-length-increased

    • ○

      the request property's maxLength was increased from 65536 to 262144

      request-property-max-length-increased

    • ○

      the request property's maxLength was increased from 65536 to 262144

      request-property-max-length-increased

    • ○

      the request property's maxLength was increased from 65536 to 262144

      request-property-max-length-increased

    • ○

      the request property's maxLength was increased from 65536 to 262144

      request-property-max-length-increased

    • ○

      the request property's maxLength was increased from 65536 to 262144

      request-property-max-length-increased

  • 27581e60c0cf1See the full diff
    • ○

      added the new optional request property

      new-optional-request-property