Extensions

What extensions are

Extensions add optional features on top of the specification. Each one solves a problem that some companies and personal agents have and others don't, so it stays out of the core protocol that everyone implements.

Supporting an extension is always optional. A personal agent or company that doesn't support one ignores it, and the two sides still work together under the specification alone.

How they work

The rules are in the specification's Extensions section. In short:

• A company lists the extensions it supports in extensions in its poppy.json, with an entry for each version it supports and that version's settings, such as an endpoint.
• A personal agent declares the extensions it uses with a company, one version of each, in the Poppy-Extensions header of its requests, so it can use different versions with different companies.
• Each entry has a version, the extension's major version. It changes only when an update would break existing implementations.
• Plain names are reserved for extensions defined on this site. Anyone can define their own, named with a domain they control, such as example.com/gift-wrap.
• An extension can add content to conversation messages, in their extensions, keyed by the extension's name. It publishes a JSON Schema for that content, and each side sends it only to a side that uses the same version.
• A company that won't do something without an extension refuses that request with extension_required.

Extensions