Zingasolve API

These are the Zingasolve endpoints of the Zingasuite API. They let your own
systems write documentation and run the helpdesk without opening the console:

  • Docs authoring — create spaces, build the chapter tree, create articles,
    save drafts and publish immutable versions per locale. This is the surface for
    a docs-as-code pipeline, a translation vendor, or a one-off migration from
    another docs tool.
  • Helpdesk — open, update, assign, escalate, annotate and reply to tickets;
    manage support areas and the FAQ knowledge base. Use it to raise tickets from
    your product, sync them with an internal system, or report on them.

Everything you write here goes through the same services the console uses, so a
published article is indexed for search and the AI assistant, gets its canonical
URL, and appears on your micro-site immediately; a ticket opened through the API
is numbered, gets its SLA clock, is auto-assigned, and emails the requester
exactly like one opened from the public form.

The base URL is:

https://api-v1.zingasuite.com/papi/v1

Access

Every request needs a zk_ API key sent as a bearer token. Reads need
data:read; writes need data:write:*. See Authentication
for the whole model.

Sections

  • Docs authoring — spaces, chapters, articles and the
    draft → publish content flow.
  • Tickets — support areas, tickets and the actions on them
    (assign, escalate, note, reply).
  • FAQs — the curated Q&A knowledge base.

Shared rules

The conventions that apply to every Zingasuite endpoint:

You can try these endpoints live, with your own key, in the interactive explorer
at /_solve/api.

What is not on the API

A few things are console-only for now, by design:

  • Annexures and file uploads — they are multipart uploads tied to the file
    store; attach them in the editor.
  • The AI assistant's chat sessions — those are visitor-facing and live on the
    docs micro-site.
  • Access grants and custom docs domains — account-level configuration.
Was this helpful?