Generate documentation from a script or an agent
A REST API, a CLI and an agent skill for Claude Code, Cursor and other agents call the same actions the app does. Generate documentation from a video, edit an article and publish, on the Solo / Small Team plan and above.
One documentation API, eight endpoint groups
Articles, folders, templates, videos, generation, project settings, publishing and export are documented in a single OpenAPI spec, the same reference a browser or a code generator can read. Translation, version restore and regeneration sit inside those groups.
Articles, folders and templates
Generate, then check on the job
Project settings and publishing
Get a signed callback instead of polling
Four scopes, enforced per endpoint
Every v2 request checks the key's scopes before it runs. Generate starts a job, write creates, edits or moves content, publish publishes or republishes, and read covers everything else. A key acts only on the project it was issued for. Every key carries all four scopes today, since issuing a restricted key isn't built yet.
| Scope | What it allows | For example |
|---|---|---|
read | Reading articles, folders, templates, videos, exports and job status | GET /articlesGET /generate/{jobId} |
write | Creating, moving, duplicating and restoring content, and uploading videos | POST /articles/emptyPATCH /folders/{id}/move |
generate | Starting generation, regeneration and translation, and importing a video from a link | POST /generatePOST /videos/import |
publish | Publishing and republishing the project | POST /publishPOST /publish/republish |
Run it from a terminal, or hand it to an agent
The CLI wraps the same API, and the agent skill wraps the CLI, so a person, a script and an agent such as Claude Code or Cursor all reach the same commands. Add --json for output a script can read, and --wait to block until a job is done.
$npm install -g @hintoai/cli
Install the CLI$hinto articles list
List every article in the project$npx skills add hintoai/hinto-cli
Install the agent skillWebhooks: four events, one URL, your own headers
A project fires a webhook on publish, republish, unpublish and archive, carrying any headers you add for authentication. Each call sends an event name, the project and publication id, a timestamp, and the project's name and URL slug, a notice that something happened and where to find it, not the content itself.
project.publishWhen the project is published for the first timeproject.republishWhen the project is republished with changesproject.unpublishWhen the project is unpublishedproject.archiveWhen the project is archived
{
"event": "project.republish",
"projectId": "<project id>",
"publicationId": "<publication id>",
"timestamp": "2026-09-15T10:24:00.000Z",
"data": {
"projectName": "Acme Help Center",
"urlSlug": "acme"
}
}Sent as a POST with your custom headers added. Hinto tries up to 3 times, waits up to 30 seconds for each attempt, and does not retry a 4xx response.How this worksConnects to the tools you already run
A webhook, a support inbox and a website builder can all read from the same project.
A webhook for your own systems
Point a webhook at your own endpoint and react to a publish, republish, unpublish or archive as it happens.
Intercom Fin answers from it
Sync a project's content into Intercom so Fin, Intercom's support agent, answers from what Hinto generated.
Framer imports it into your site
A Framer plugin imports articles and folders into the Framer CMS, for a site built and hosted in Framer.
What teams automate
Help centre articles
Answer the questions customers keep asking, in articles they can search.
SOPs and process guides
Turn a recorded walkthrough into a step-by-step SOP, with screenshots at the steps that need one.
Context for your AI tools
Give an assistant your own written processes as one plain-text file.
Other features
Questions about the Hinto API, CLI and agent skill
No. Each request carries an X-API-Key header, for a key created in one project's settings.
Ready to Build a Better
Knowledge Base, Faster?
Get Started Free & Create Your First Article in Minutes