Data & schema semantics

x-ai-description

`x-ai-description` appears on operations. Its value is a structured object. Used by a single provider across 19 OpenAPI documents. Consistent with data & schema semantics — this is inferred from where the key appears and what it carries, not from any published definition.

Data & schema semantics derived description
How this description was produced. It is assembled from what was measured in the corpus — where this key appears in a document, what shape its value takes, the values observed, and how many providers use it. It is not taken from a published definition, because for most extensions none exists. Read it as evidence, not as a specification. If you own this extension and want it described properly, tell us.
720 occurrences
19 documents
1 providers
purpose-named

Where it appears

Location in the documentOccurrences
info 7
operation 634
securityScheme 38
schema 41

What its value looks like

Value shapeOccurrences
object613
string107

Observed values

Sampled from the specifications, most frequent first.

Detailed structure and summary metrics for a specific flow.Aggregated performance metrics for every node in the automation.Entry point analysis for the automation.Engagement metrics for an email node.Web push notification performance.SMS delivery and status tracking.Chatbot and messenger interaction stats.Segmentation logic performance.

Providers publishing it

All 1.

sendpulse

Why this is not in OpenAPI

Extensions exist because a provider needed something the specification would not carry. Most of what they hold is not the API contract at all — it is operational metadata about the contract: documentation, lifecycle, policy, provenance, and now agents. That metadata is usually better placed alongside the contract, in an Overlay or an APIs.json index, than crammed inside it. See everything else doing the data & schema semantics job.