Sign in
Agents

Get a single agent

get/api/agents/{id}

Path parameters

idstring required

Query parameters

include'tasks'

Response

Agent with capacity info

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 4 of the 104 revisions of this API.64

  • 0f5503f5cd285See 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

    • ●

      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

  • 09d5eb0300932See the full diff
    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

  • 6f2d2fbe25991See the full diff
    • ●

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

      response-property-enum-value-added

  • 06cac6a7c5bc2See 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