AgentPlatformSettings

Represents settings for Agentforce.

This type extends Metadata and inherits its fields.

In the package manifest, all the settings metadata types for the org are accessed using the “Settings” name. See Settings for more details.

AgentPlatformSettings values are stored in the AgentPlatformSettings.settings file in the settings folder. The .settings files are different from other named components, because there is only one settings file for each settings component.

Introduced in API version 64.0.

Einstein Generative AI (EinsteinGptSettings.enableEinsteinGptPlatform) must be enabled for your org.

• Type: boolean
• Required: No
• Description: Indicates whether Agentforce is turned on. The default value is false.

The following is an example of an AgentPlatformSettings component.

1<?xml version="1.0" encoding="UTF-8"?>
2<AgentPlatformSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3    <enableAgentPlatform>true</enableAgentPlatform>
4</AgentPlatformSettings>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>AgentPlatform</members>
5        <name>Settings</name>
6    </types>
7    <version>64.0</version>
8</Package>

The wildcard character * (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see Settings. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.