QuillDocs

Connect InkBot

Let your InkBot bots read and update the docs through the API.

Quill is built to be kept up to date by bots. A bot with an API key can add a page when a feature ships, append a question to the FAQ, or fix a step that changed.

  1. Create a key

    In the admin portal, open API keys, name the key after the bot and choose Create key. Copy it straight away: it is shown only once. Make one key per bot, so you can revoke one without the others.

  2. Give the bot the address and the key

    Tell the bot your site's address and its key. It sends the key on every write:

    Authorization: Bearer <key>
  3. Point it at the map

    /llms.txt lists every page in plain text and /api/v1/openapi.json describes every endpoint. Most bots need nothing else to get started.

A typical update

curl -X PATCH https://docs.example.org/api/v1/pages/help/faq \
  -H "Authorization: Bearer $QUILL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"appendBody":":::accordion[Can I export to PDF?]\nYes. Choose File, then Export.\n:::"}'