ai-plugin.json Generator

Expose your API as a discoverable tool that AI agents can call. Built from the OpenAI plugin spec.

{
  "schema_version": "v1",
  "name_for_human": "Acme Search",
  "name_for_model": "acme_search",
  "description_for_human": "Search Acme's documentation and product catalog.",
  "description_for_model": "Use this plugin to answer user questions about Acme products, pricing, and docs. Always cite the returned URL.",
  "auth": {
    "type": "none"
  },
  "api": {
    "type": "openapi",
    "url": "https://acme.com/openapi.yaml"
  },
  "logo_url": "https://acme.com/logo.png",
  "contact_email": "support@acme.com",
  "legal_info_url": "https://acme.com/legal"
}

Why publish an ai-plugin.json?

As AI agents start booking, searching, and transacting on behalf of users, your API needs a manifest they can discover. ai-plugin.json at /.well-known/ is the standard entry point.

Two key descriptions

  • description_for_human — what a user sees in a plugin store
  • description_for_model — instructions the LLM reads to decide when to call you

The model description matters most. Be explicit about when to use the plugin and how to present results — including any required citation behavior.

Want the full picture?

This tool generates one piece. OptimAIze scans your whole site, audits structured data, content, crawler access, and answer-readiness — then gives you everything you need to be cited by AI.

Run a full GEO + AEO scan on your site

Frequently asked questions

What is ai-plugin.json?
ai-plugin.json is the manifest file that exposes your site or API as a tool that AI agents can call. It lives at /.well-known/ai-plugin.json and points to your OpenAPI spec, logo, and contact info.
Do I need an API to publish one?
Yes — ai-plugin.json describes a callable API. If you only have a marketing site, you want llms.txt instead. If you have any HTTP endpoints worth exposing (search, lookups, actions), an ai-plugin.json is worth publishing.
Where do I host the file?
Always at https://yourdomain.com/.well-known/ai-plugin.json. The path is part of the spec — agents look there directly.
What auth types are supported?
'none' for fully public APIs, 'service_http' for a bearer token you provide, 'user_http' for per-user tokens, and 'oauth' for the full OAuth flow.