Overview
Developer
The programmatic surfaces: what you can call, what you can implement, and what comes back.
| Page | Covers |
|---|---|
| Apex API | Entity, EntityRequest, EntityFindRequest — calling the engine |
| Provider SPI | EntityEnrichmentProvider, EnrichmentItem — extending it |
| Invocable actions | The three shipped actions and every input |
| JSON payload schema | Key-by-key, for parsing |
| Query filters | Filter syntax, operators, date literals |
Namespace
The package namespace is ctxl. Reference package classes from your own code as ctxl.ClassName:
String context = ctxl.Entity.load(recordId);Examples in this section include the prefix. Inside the package itself it is omitted.
API stability
The classes and methods documented here are global — a permanent, deprecation-only surface once the first released package version is installed anywhere. Two caveats while the package is pre-1.0:
- The JSON payload schema is versioned
0.1-betaand becomes additive-only once stable. ReadschemaVersionif you parse it in production. - The global surface is provisional until the freeze review before the first released version. Beta versions may still change it.
Anything not documented here is internal and may change without notice.
What’s callable from where
| From | Use |
|---|---|
| Apex | Entity directly |
| Flow, Prompt Builder | The invocable actions, or your own invocable over Entity |
| Agentforce | Agent actions over the invocables |
| MCP | Tools over the invocables |
| Another package | ctxl.Entity — the global surface is the contract |