GenAiFunction

Represents an agent action that can be added to an AI agent.

This type extends Metadata and inherits its fields.

GenAiFunction components have the suffix .genAiFunction and are stored in the genAiFunctions folder.

GenAiFunction components can contain folders for the input and output schemas. Here’s an example component, showing the schema folders.

GenAiFunction folder structure

See the Input Folder and Output Folder sections for more information.

Introduced in API version 60.0.

GenAiFunction is available only if Agents is enabled in your org.

• Type: string
• Required: No
• Description: A description explaining the general purpose and domain of the action.

• Type: string
• Required: No
• Description: The unique developer name of this component. Used as an API reference and must follow Salesforce identifier rules.

• Type: string
• Required: No
• Description: Required. Target invocation used by invocation operations.

• Type: PlannerFunctionInvocableTargetType (enumeration of type string)

• Required: Yes

• Description: Required. Invocable action type used by invocation operations.

  Values are:

• Possible values:

  • api
  • apex
  • auraEnabled
  • createCatalogItemRequest
  • executeIntegrationProcedure
  • externalService
  • flow
  • generatePromptResponse
  • mcpTool
  • namedQuery
  • quickAction
  • retriever
  • runExpressionSet
  • slack
  • standardInvocableAction
  • stub

• Type: boolean
• Required: No
• Description: Indicates whether confirmation is required for this action.

• Type: boolean
• Required: No
• Description: Indicates whether to display the progress indicator for this action.

• Type: string
• Required: No

• Type: string
• Required: No

• Type: GenAiPlannerAttr[]
• Required: No
• Description: List of attributes for the planner.

• Type: string
• Required: Yes
• Description: Required. The master label for the generative AI action.

• Type: string
• Required: No
• Description: Represents the action’s parent topic.

• Type: string
• Required: No
• Description: The progress message.

• Type: string
• Required: No

• Type: string
• Required: No
• Description: Description of the planner attribute.

• Type: string
• Required: Yes
• Description: Required. Label for the planner attribute.

• Type: string
• Required: Yes
• Description: Required. Name of the planner attribute.

• Type: string
• Required: Yes
• Description: Required. The parameter name.

• Type: PlannerAttrMappingType (enumeration of type string)
• Required: Yes
• Description: Required. The parameter type. Values are:
• Possible values:
  • input
  • output

The following is an example of a GenAiFunction component.

1<?xml version="1.0" encoding="UTF-8"?>
2<GenAiFunction xmlns="http://soap.sforce.com/2006/04/metadata">
3    <description>get tracking information</description>
4    <invocationTarget>TrackShipment</invocationTarget>
5    <invocationTargetType>apex</invocationTargetType>
6    <isConfirmationRequired>false</isConfirmationRequired>
7    <masterLabel>get_tracking_info</masterLabel>
8</GenAiFunction>

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>*</members>
5      <name>GenAiFunction</name>
6   </types>
7   <version>60.0</version>
8</Package>

The input folder contains a schema.json file with the action inputs. Here’s a sample input schema file.

1{
2 "required" : ["OwnerId", "Status"],
3 "properties" : {
4 "OwnerId" : {
5 "title" : "Owner Id",
6 "description" : "ID of the Salesforce record that owns the request.",
7 "lightning:type" : "lightning__textType",
8 "lightning:isPII" : false,
9 "copilotAction:isUserInput" : true
10 },
11 "Status" : {
12 "title" : "Request Status",
13 "description" : "The status of the contact request.",
14 "lightning:type" : "lightning__textType",
15 "lightning:isPII" : false,
16 "copilotAction:isUserInput" : true
17 }
18 },
19 "lightning:type" : "lightning__objectType"
20}

This table describes the properties that you can specify in this JSON file.

The output folder contains a schema.json file with the action output. Here’s a sample output schema file.

1{
2 "properties" : {
3 "Id" : {
4 "title" : "Contact Request Id",
5 "description" : "ID of the Salesforce contact request record.",
6 "lightning:type" : "lightning__recordIdType",
7 "lightning:isPII" : false,
8 "copilotAction:isDisplayable" : true,
9 "copilotAction:isUsedByPlanner" : true
10 }
11 },
12 "lightning:type" : "lightning__objectType"
13 }

This table describes the properties that you can specify in this JSON file.

In Winter ‘26 orgs and later, use GenAiPlannerBundle to retrieve actions that are created within a particular agent. To retrieve actions in the asset library, use GenAiFunction.

When deploying topic or action metadata to a Summer ‘25 (version 64.0) org, retrieve the metadata using Metadata API version 64.0, even if your source org is Winter ‘26 or later (version 65.0). For Winter `26 and later, use Metadata API version 65.0 and later.

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.