Inkies Docs

Quickstart

Connect a website and prepare credentials for pulling Inkies articles.

1. Connect a website

Open the Inkies dashboard and connect the website that Inkies should learn and publish for. Inkies crawls the connected site and keeps its product truth available to the article workflow.

2. Create an API key

Open the website detail page and use the Publishing card to create an API key. The complete key is shown once. Store it as a server-side secret and revoke it from the same card if it is no longer needed.

The API key uses the ink_live_... format. Requests send it as a bearer token:

Authorization: Bearer ink_live_...

3. Pick a framework guide

Set these environment variables in the application that renders your blog:

INKIES_API_KEY=ink_live_...
INKIES_API_URL=https://<deployment>.convex.site

For a production website, use the Convex site URL shown in the dashboard Publishing card. Keep both values on the server. The API key must not be exposed to browser JavaScript.

On this page