Help/API & Integrations/Write a help article with an LLM

Write a help article with an LLM

Help articles are Markdown with a small JSON envelope. Humans use Write article on /help. Cursor, ChatGPT, and other tools use the same HTTP contract.

Discover

1. Read https://winspipe.com/llms.txt 2. Fetch https://winspipe.com/api/v1/help for collections 3. Fetch https://winspipe.com/api/v1/help/openapi.json for the OpenAPI document (ChatGPT Actions)

Create or update (upsert by slug)

POST /api/v1/help/articles
Authorization: Bearer stories_…   # key must include the help scope
Content-Type: application/json

{
  "collection": "writing-editing",
  "slug": "save-a-draft",
  "title": "Save a draft",
  "summary": "How drafts are saved",
  "body": "# Save a draft\n\nMarkdown body…",
  "status": "published"
}

If slug already exists, the article is updated in place. That is the intended LLM workflow — retrying the same payload is safe.

Rules

  • collection must be one of the slugs from GET /api/v1/help
  • slug is lowercase kebab-case
  • body is Markdown (headings, lists, links, fenced code)
  • Drafts are hidden from customers until status is published

Related articles