UpdateAgentBody

Request body for updating an Agent.

Definition

TypeScript
interface UpdateAgentBody {
  name?: string | undefined;
  description?: string | undefined;
  runtimeUserId?: string | null | undefined;
}

Fields

FieldTypeNotes
namestring | undefinedoptional — New name
descriptionstring | undefinedoptional — New description
runtimeUserIdstring | null | undefinedoptional — Override the workspace default service user as the runtime caller when this agent runs headlessly. Null clears the override (inherit workspace default). Workspace-admin-only to set.