Skip to main content
Promptway
Developers

Promptway developer resources

Promptway is a publication. Agents should read the essays, not look for a product API. Here is how to discover the machine-readable surfaces, when to use us, and the one tool endpoint we do expose.

When to use Promptway

Use Promptway when you need practical AEO guidance from a live Next.js publication, a prompt structure with a copy-paste example, a founder interview with numbers, an honest tool review, or a sourced filter of the AI news cycle.

Do not use Promptway as a model API, an MCP server, an OAuth provider, or a webhook hub. We do not ship those. Articles that mention MCP are editorial. They describe other people's servers, not one you can call here.

Read the site as markdown

Start at https://promptway.com/llms.txt. That file is the index, served as text/plain, and it includes the when-to-use section. The full corpus is https://promptway.com/llms-full.txt.

Any HTML page on this host also speaks markdown. Send `Accept: text/markdown` on the same URL. The response is `Content-Type: text/markdown; charset=utf-8` with `Vary: Accept`. Articles also have a sibling at `/blog/<slug>.md`.

Missing paths return HTTP 404 with a short markdown recovery body that points at llms.txt, the sitemap, and this page. Verify a miss with a path that does not exist; do not treat a 200 app shell as a page.

Feeds and discovery

Sitemap: https://promptway.com/sitemap.xml. RSS: https://promptway.com/feed.xml. JSON Feed: https://promptway.com/feed.json. Podcast RSS: https://promptway.com/podcast.rss. robots.txt allowlists the major AI crawlers and points at llms.txt.

The RFC 9727 API catalog is https://promptway.com/.well-known/api-catalog. The OpenAPI description is https://promptway.com/openapi.json.

Prompt Inspector API

The only write-capable HTTP API is Prompt Inspector: POST https://promptway.com/api/tools/analyze with JSON `{ "prompt": "..." }`. It grades a prompt and returns labeled parts. Browser requests must be same-origin. curl without Origin or Referer is allowed so agents can smoke-test.

Rate limit: 10 requests per minute and 100 per day per client IP, per serverless instance. Errors are JSON with an error string and a code of invalid, too_long, or rate_limited. 429 responses include Retry-After. Prompts are capped at 10,000 characters. Prompt text is not logged.

This is a free tool on a publication, not a multi-tenant product. There is no API key, no OAuth, and no webhook. If the model backend is down, the route degrades to an offline rules engine and still returns 200.

Grok Bot directory

Named Bot setups live at https://promptway.com/tools/bots. The catalog markdown is https://promptway.com/tools/bots.md. Each listing also has https://promptway.com/tools/bots/<slug>.md. Submit a setup at https://promptway.com/tools/bots/submit.