Salesforce Docs Portal

Agentforce Metadata Types (v67 and Earlier)

Manage actions and customize the planner service using the Metadata API.

important: Agent metadata changed in v68. To learn more, see Move an Agent to a New Org.

Agent metadata hierarchy

Metadata Types

  • AiAuthoringBundle: Represents an AI authoring bundle, which contains the blueprint of an agent. For example, an AI authoring bundle for an Agentforce agent contains:

    • an Agent Script file stored in <bundle-api-name>.agent
    • the Metadata API XML, stored in <bundle-api-name>.bundle-meta.xml

    To commit an agent version, the target field must specify the developerName for the Bot and BotVersion components, separated by a period: {Bot}.{BotVersion}. For example, Agentforce_Service_Agent.v2. These two components tie the AI authoring bundle to a specific agent and a specific agent version.

  • Bot: The top-level representation of an Einstein Bot or an Agentforce Agent.

    • localMlDomain.name: Agent name.
    • type: Agent type.
    • description: Agent description.
    • ConversationContextVariable: A context variable local to the current bot or agent version.

  • BotVersion: A BotVersion represents the configuration for a specific bot or agent version. A single Einstein Bot or Agentforce Agent can have many versions, but only one version can be active.

    • ConversationVariable: A container that stores a specific piece of data collected from the customer. You can use variables within actions as both inputs and outputs.

  • GenAiFunction: Represents an action that can be added to agents. Action input and output variables are located in schema.json for each action's input and output folders, or in schema.json in the localActions folder of genAIPlannerBundle.

  • GenAiPlannerBundle represents a planner for an agent or agent template. It’s a container for all the subagents and actions used to interact with a large language model (LLM). An agent has a single GenAiPlannerBundle component. A GenAIPlannerBundle file contains the Agentforce Builder Subagent Map for a specific agent.

    • GenAiPluginInstructionDef: Subagent instructions.

  • GenAiPlugin: Represents a subagent, which is a category of actions related to a particular job to be done by the agent. An agent can have multiple GenAiPlugin components.

    • developerName: Subagent API name.

See Also