---
schema_version: "1"
id: 594f0a6555a6239556d6971b4a72554afa0525622cea05acc1ba6e724b996a99
title: AgentPlatformSettings
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_agentplatformsettings.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_agentplatformsettings.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: feb53398fe9b1e45e24f5aefb95266c43a4ba57bebdbca4458844988024725d7
description: Represents settings for Agentforce.
---
# AgentPlatformSettings

Represents settings for Agentforce.

## Parent Type and Manifest Access

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

In the package manifest, all the settings metadata types for the org are accessed using the “Settings” name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for more details.

## File Suffix and Directory Location

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.

## Version

AgentPlatformSettings components are available in API version 64.0 and later.

## Special Access Rules

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

## Fields

| Field Name | Description |
| --- | --- |
| enableAgentPlatform | 
Field Type

boolean

Description

Indicates whether Agentforce is turned on. The default value is false.



 |

## Declarative Metadata Sample Definition

The following is an example of an AgentPlatformSettings component.

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

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

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>AgentPlatform</members\>
        <name\>Settings</name\>
    </types\>
    <version\>64.0</version\>
</Package\>

## Wildcard Support in the Manifest File

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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type."). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").