api-catalog (RFC 9727)

api-catalog is a standard discovery location, defined by RFC 9727, where a site can link to the APIs it offers.

The location is /.well-known/api-catalog. It provides a predictable starting point for a client looking for API descriptions and related resources, instead of requiring it to search a developer portal.

A JSON Linkset can be served as application/linkset+json. Its links identify API descriptions or related resources using declared relation types. The catalog points to the documentation rather than replacing it.

The catalog is relevant to sites that offer APIs. Check the response format and the destinations of its links. Publishing one does not imply that an AI platform will use it or that it will increase mentions.

Frequently asked questions

What format does api-catalog use?

RFC 9727 uses the Linkset format. A JSON Linkset is served as application/linkset+json and contains links with declared relation types.

Does every website need an API catalog?

No. It is useful when a site offers APIs that clients need to discover. A site without an API has nothing to list.

Related

More terms