Read a bot profile, including archived history

GET

/api/v1/org-agents/{agentId}

Authorization

bearerAuth
HTTP Bearer (API key)
required
Authorization: Bearer <token>

Path parameters

agentId
string
required

Returns

200

Versioned bot profile

JSON

ok
optional
boolean
agent
optional
object
- id
  string
  required
- orgId
  string
  required
- slug
  string
  required
- version
  integer
  required
  minimum: 1
- config
  object
  required
  name
  string
  required
  maxLength: 120 · minLength: 1
  instructions
  string
  required
  maxLength: 32000 · minLength: 1
  harness
  string
  required
  maxLength: 64 · minLength: 1
  emoji
  optional
  string
  maxLength: 16 · minLength: 1
  mascotPreset
  optional
  hero
  or
  climbing
  or
  riding
  or
  sleeping
  or
  sunglasses
  codingModel
  optional
  string
  maxLength: 200 · minLength: 1
  connectionId
  optional
  string
  maxLength: 120 · minLength: 1
  sandboxProvider
  optional
  cloudflare
  or
  docker-local
  or
  computesdk
  or
  e2b
  defaultRepoUrl
  optional
  string
  maxLength: 500 · minLength: 1
  expectedDeliverables
  optional
  array of
  string
  Optional approval-frozen workspace output paths, in delivery order. Paths are unique ignoring case; relative, non-hidden ASCII segments only (letters/digits, dot, underscore, hyphen, internal spaces), no empty/dot/parent/absolute segments or leading/trailing spaces. Only md/txt/json/csv. Requested complete UTF-8 nonempty files are capped at 16384 bytes each and 65536 bytes total; JSON must parse. Collection checks do not assess semantic quality.
  
  maxLength: 240 · minLength: 1 · pattern: ^(?!.* (?:/|$))(?:[A-Za-z0-9][A-Za-z0-9._ -]*/)*[A-Za-z0-9][A-Za-z0-9._ -]*\.(?:[mM][dD]|[tT][xX][tT]|[jJ][sS][oO][nN]|[cC][sS][vV])$
  approvalPolicy
  optional
  standard
  or
  auto_approve
  Legacy auto_approve configuration does not bypass human run approval.
  
  toolScopes
  optional
  array of
  string
  Legacy values are readable; create/update reject nonempty scopes until execution enforces them.
  
  maxLength: 64
- createdAt
  number
  required
- updatedAt
  number
  required
- archivedAt
  optional
  number
}

404

Bot not found