Sign in
Agents

Configure the agent for one purpose

put/workspaces/{workspaceSlug}/agents/{purpose}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /workspaces/{workspaceSlug}/agents/{purpose}
  • Auth: HTTP bearer

Path parameters

workspaceSlugstring required

Workspace slug

purpose'PRACTICE_REVIEW' | 'MENTOR' required

Query parameters

dataHandlingTier'IN_HOUSE' | 'CLOUD' | 'UNDECLARED'

Request body

allowInternetboolean

Whether the sandbox may reach the public internet

enabledboolean

Whether this purpose is active (paused when false)

instanceModelIdinteger

Shared (instance-catalog) model id to run this purpose on

maxConcurrentJobsinteger

Maximum concurrent runs for this purpose

timeoutSecondsinteger

Per-run timeout in seconds (30–10800; three hours is the longest a single run may take)

workspaceModelIdinteger

Workspace-owned model id to run this purpose on

Response

Binding saved

allowInternetboolean
dataHandlingTier'IN_HOUSE' | 'CLOUD' | 'UNDECLARED' required
enabledboolean required
instanceModelIdinteger
maxConcurrentJobsinteger
purpose'PRACTICE_REVIEW' | 'MENTOR' required
readyboolean required

True when the bound model is available to run right now

timeoutSecondsinteger
workspaceModelIdinteger

Changes

No recorded changes to this operation across all 1 revision of this API.