Bring Apex REST and AuraEnabled APIs into API Catalog to take advantage of the automatic agent action activation and make your APIs more discoverable.
Required Editions
| Available in: Lightning Experience |
| Available in: Developer, Enterprise, Performance, and Unlimited Editions |
| User Permissions Needed | |
|---|---|
| To access API Catalog: |
Available to Salesforce admins by default. For other users, View Setup |
| To bring Apex APIs into API Catalog: | Customize Application |
API information brought into API Catalog must meet schema and governance requirements.
- Schema definitions
- Schema update requirements
- API governance ruleset definitions (applied to APIs annotated for agent actions)
APIs brought into API Catalog must meet the system limits.
- External Services system limits
- Other system limits for Apex APIs
If you reach system limits during the Apex deployment, remove APIs that you no longer need.
Bring Apex REST APIs into API Catalog
If you have Apex REST code with custom agent actions and an LLM to create the OAS document for the REST code, you can bring the API into your API catalog.
Bring Apex AuraEnabled APIs into API Catalog
If you have Apex classes with methods annotated with @AuraEnabled, you can bring the API into your API catalog.
System Limits for Apex Documents in API Catalog
When you deploy Apex classes, there are maximum limits for registrations, schema size, operations, objects, and properties. These limits affect what is displayed in API Catalog.
| Limit | VALUE |
|---|---|
| Max Apex API registrations | 150 per org |
| Max schema size (JSON) | 10,000,000 characters (10.0 MB) |
| Max schema size (YAML) | 3,000,000 characters (3.0 MB) |
| Max active operations | 1250 per org |
| Max active and inactive operations | 10,000 total per org |
| Max active objects | 1250 per org |
| Max active and inactive objects | 10,000 total per org |
| Max object properties | 400,000 total per org |