Helmdesk Documentation

One support layer for every app you run — helpdesk, email, knowledge base, customers, feedback, and error logs. Drive it three ways.

Agents & MCP

Run your support desk by asking. 73 tools for Claude Code, Claude Desktop, Codex, Cursor, or any MCP client.

Connect an agent

Node.js SDK

Call Helmdesk from your own app. Typed client for tickets, email, articles, customers, feedback, and logs.

Install the SDK

REST API

Every endpoint, the scope it needs, and the conventions that apply to all of them. OpenAPI 3.1 spec included.

Read the reference

Start with an agent

Connecting takes one command. After that you stop reading documentation and start asking for things.

Prompt cookbook42 things to say, what each one calls, and what comes back.Scaffold an appProject, scoped key, templates, and widget from a single prompt.Tool referenceAll 73 tools, grouped, with the scope each one needs.Safety & approvalsWhat can reach a customer, and how to keep a key away from it.

Every part of the platform

Each page covers the resource from all three angles — an agent prompt, an SDK call, and the REST endpoint.

Quickstart

Install the SDK and send your first API call in under 2 minutes.

Sandbox

A second data plane where mail renders but is never delivered.

Tickets

Create, list, update, and manage support tickets programmatically.

Emails

Send transactional emails with templates, layouts, and partials.

Customers

The directory that builds itself — link customers to your app by externalId.

Articles

Write and search the knowledge base behind your public help centre.

Logs

Ship application logs, get error grouping and Log Watch alerts.

Feedback

Ask customers how they feel — ratings, requests, conversations.

Automations

The six agents Helmdesk runs on your project, and their review queue.

Webhooks

Receive real-time notifications when events occur in your project.

What needs which plan

Everything else — tickets, email, articles, customers, logs, the sandbox — is on every plan, metered by the quotas on the pricing page. A call that needs a higher plan returns 403 auth.forbidden.

Feature	Plan
AI answers and the six agents	Starter and up
Webhooks	Starter and up
Feedback conversations	Starter and up
Batch email sends	Starter and up
Shared @account/ templates	Growth and up
Analytics	Growth and up

Looking for the OpenAPI spec?

The full OpenAPI 3.1 specification is at https://helmdesk.dev/openapi.json. Use it to generate clients in any language, import into Postman, or point another tool at the API.