Introduction
ai-plugin.json was the manifest of a ChatGPT plugin. A developer served it at /.well-known/ai-plugin.json on the plugin’s domain, together with an OpenAPI description of the API the plugin
offered; the user told ChatGPT the domain and it “found the manifest file”. This format is legacy. The README of OpenAI’s own plugins-quickstart repository says so in one sentence: “Plugins have
been superseded by GPTs, learn more about creating a GPT with actions.” The files are still seen in the wild because sites and sample repositories kept them.
The plugin documentation page that defined each member could not be read for this site (it is rendered by script and the archived copy was empty). What follows is therefore read from two manifests that OpenAI itself
published (the quickstart’s TODO list sample, and the sample of the chatgpt-retrieval-plugin repository); the meaning of a member is taken from its name and is hedged accordingly.
Structure
{
"schema_version": "v1",
"name_for_human": "TODO List (no auth)",
"name_for_model": "todo",
"description_for_human": "Manage your TODO list. You can add, remove and view your TODOs.",
"description_for_model": "Plugin for managing a TODO list, you can add, remove and view your TODOs.",
"auth": { "type": "none" },
"api": { "type": "openapi", "url": "http://localhost:5003/openapi.yaml" },
"logo_url": "http://localhost:5003/logo.png",
"contact_email": "legal@example.com",
"legal_info_url": "http://example.com/legal"
}
| Member | What the samples show |
|---|---|
schema_version | "v1" in both samples. |
name_for_human, name_for_model | One name for people and one for the model. |
description_for_human, description_for_model | One description for people and one written for the model. |
auth | An object. {"type": "none"} in the quickstart; {"type": "user_http", "authorization_type": "bearer"} in the retrieval-plugin sample. |
api | An object: "type": "openapi", the url of the OpenAPI document, and (retrieval-plugin sample) has_user_authentication. |
logo_url, contact_email, legal_info_url | The logo, a contact address and a page of legal information. |
In the explorer
A file named ai-plugin.json opens here when it is a JSON object with a schema_version string, an api object and a name. Any other file with that name opens as JSON, as before. The tree labels each member as above;
the Overview says the format is legacy and quotes the source. The problems are notes: members the two samples have that this file lacks, an api without a url, members of the wrong type, a logo or legal address that is
not http or https. They are worded as notes and not as errors, because the page that says which members are required was not readable. Public manifests found: only three still answer (Instacart, Slack and WolframAlpha); the
others were gone, which fits the legacy status.
Not described
Known, not yet covered
- Reference: the other authentication types (OAuth and service-level), the length limits on names and descriptions, and the manifest’s other members that the original documentation lists are not described: the documentation could not be read.
- Viewer: the OpenAPI document and the logo are not fetched or read.
Unknown
- Reference: which members are required, and the exact semantics of each: the specification text was not obtained. The date plugins were switched off is also not given by a primary source read here.
Links
Reference
- openai/plugins-quickstart – OpenAI’s quickstart: its README says plugins have been superseded by GPTs, and it holds a sample manifest
- openai/chatgpt-retrieval-plugin – the repository whose
.well-known/ai-plugin.jsonis the second sample - GPT actions – the replacement the README names