Pūnaha Docs
Version 1.0.0
How can we help?
Find help for installing, using, managing, and connecting to the Pūnaha API on your own servers.
Previous version
Still using RC1?
The complete RC1 documentation remains available for installations that have not upgraded. Choose RC1 in the version selector to keep its instructions and search results together.
Browse all RC1 documentation · Download the original RC1 guides
Browse by task
Choose what you need to do
Install and run
Install Pūnaha, check its health, and keep it working.
02Manage Pūnaha
Manage tenants, people, access, settings, Connections and models.
03Build solutions
Build workflows, decisions, cases and knowledge tools.
04Use the API
Open Swagger, download OpenAPI, sign in, and call approved routes.
Available now
Current documentation
- ReferenceDownload Pūnaha 1.0.0Select the released package for your operating system and follow its matching installation guide.
- Get startedStart with PūnahaFind the installation, registration and first-workflow guides for the first release.
- ReferenceVerify Pūnaha 1.0.0 downloadsCheck the package hash and the publisher signature before installation.
- ReferenceGPU compatibility and testingReview GPU development testing across Windows and Linux, then check the runtime included in your exact package.
- Get startedChoose your starting pointFollow a short documentation path for the work you need to do.
- Get startedComplete a common Punaha journeyChoose a complete guide for one of the most common Punaha goals.
- Get startedExplore the Pūnaha 1.0.0 interfaceSee the main screens in the installed Pūnaha 1.0.0 frontend before following a task guide.
- Get startedUnderstand the product and registrationRead the current issued term and renewal policy.
- ReferencePūnaha 1.0.0 package checksumsCompare your installer with the exact SHA-256 published for its platform.
- ReferencePūnaha 1.0.0 release notesReview the published installer scope, installation path and known limits.
- Get startedPlan a Pūnaha 1.0.0 installationPrepare the host, verify the released package and complete setup and registration.
- Get startedInstall Pūnaha 1.0.0 on WindowsVerify and install the signed MSI on Windows 11 or Server 2022/2025.
- Get startedInstall Pūnaha 1.0.0 on LinuxChoose the exact Ubuntu, Debian, RHEL, SLES or generic archive procedure.
- Get startedInstall Pūnaha 1.0.0 on Ubuntu 24.04 LTSInstall the signed punaha-1.0.0-ubuntu24.04-amd64.deb package on a new Ubuntu 24.04 LTS host.
- Get startedInstall Pūnaha 1.0.0 on Debian 13Install the signed punaha-1.0.0-debian13-amd64.deb package on a new Debian 13 host.
- Get startedInstall Pūnaha 1.0.0 on RHEL 9Install the signed punaha-1.0.0-1.el9.x86_64.rpm package on a new RHEL 9 host.
- Get startedInstall Pūnaha 1.0.0 on SLES 15 SP7Install the signed punaha-1.0.0-1.sles15sp7.x86_64.rpm package on a new SLES 15 SP7 host.
- Get startedInstall Pūnaha 1.0.0 on Generic Linux archiveInstall the signed punaha-1.0.0-linux-amd64.tar.gz package on a new Generic Linux archive host.
- Get startedChoose and prepare the databasesSelect one database provider for Control, Workflow, and AI during the first browser setup.
- Get startedFinish first setupInitialise a new installation, protect the System Owner account and plan registration.
- Get startedCreate your first Gemma chat in Pūnaha 1.0.0Verify and upload a Gemma 4 E4B GGUF file, enable the model, build and test a chat workflow, then try a real conversation. Includes a 1.0.0 video and screenshots.
- Get startedBuild a Gemma knowledge chat in Pūnaha 1.0.0Download EmbeddingGemma GGUF, index a practice document, build a knowledge-grounded Gemma workflow, and test answers and refusals in Pūnaha 1.0.0.
- Get startedSign in and accept an invitationSign in, use MFA, and join a tenant from an invitation.
- Get startedBrowsers and accessibilitySee which browsers and accessibility settings Punaha supports.
- Use PunahaFind your way around PunahaLearn how to move between the platform and a tenant.
- Use PunahaChange your personal settingsChoose the colours and display settings that work best for you.
- Use PunahaCreate and search knowledgeCreate a knowledge database, add files, and search their content.
- Use PunahaUse ChatStart a chat that uses an approved workflow and approved resources.
- Use PunahaFind and run workflowsOpen a workflow, start it, and follow its progress.
- Use PunahaWork with casesFind your case work and complete the steps that are assigned to you.
- AdministerRegister and renew an installationUnderstand the issued term, online registration and the 720 powered-on-hour cutoff.
- AdministerRegister or renew an offline installationTransfer the correct request and activation through Support while retaining the original installation identity.
- AdministerConfigure public addresses and organisation sign inMap frontend and API origins, register OIDC callbacks, and allow intended browser integrations.
- AdministerManage tenantsCreate a tenant, open it, and manage its main settings.
- AdministerManage people and groupsInvite people, manage groups, and keep membership details up to date.
- AdministerInvite a person and give accessInvite one person, give the required access, and check the final result.
- AdministerManage accessGive people and services the exact access they need.
- AdministerFix an access problemFind out why a person cannot see or use an item.
- AdministerPrepare a model and knowledge databasePrepare a model, create a knowledge database, and test a simple search.
- AdministerManage ConnectionsAdd and test the connections used by workflows and cases.
- AdministerManage settingsChange platform or tenant settings and check the final value.
- AdministerUnderstand administration responsibilitiesSeparate platform, tenant, access, solution, and operating responsibilities.
- AdministerReview accessReview direct access and record whether each item should stay, change, or be removed.
- OperateChoose how to run the servicesRun all services together or place Control, Workflow, and AI on separate servers.
- OperateRun Punaha on several serversSet up private databases, service groups, and a secure web address.
- OperateAdd and manage cluster nodesPrepare an installation for additional nodes, approve their identities, and check service readiness.
- OperatePrepare shared storageSeparate private node state from shared documents, indexes, logs, and model files.
- OperateCheck service healthUse the health checks to decide when a server can receive work.
- OperateCheck operations, logs, and audit recordsFollow one failed or waiting item from Operations into logs and audit records.
- OperateUse the Operations pagesCheck active, waiting, and failed work for the platform or a tenant.
- OperatePrepare diagnostic information for SupportKeep incident references, review a reduced diagnostic bundle and share it through your Support case.
- OperateControl document processingRead processing stages, stop work safely, assign an eligible node, and resume a document.
- OperateManage model capacity and GPU policyChoose processing policy and distinguish document slots, model requests, and section concurrency.
- OperateCheck model execution and worker recoverySeparate model memory state, processor availability and recovery after a failed worker.
- OperateUse logs and audit recordsSearch logs for a problem and use audit records to see important changes.
- OperateRun local AI modelsInstall the local AI runtime, add GGUF models, and manage their memory use.
- OperatePlan storage and backupsChoose storage, back up the full installation, and test a restore.
- OperateMake a safe production changePrepare, apply, check, and if needed reverse an approved production change.
- OperatePrepare an upgrade or removalProtect data and installation identity while waiting for a qualified 1.0.0 upgrade path.
- OperateRecover solution configurationUse retained versions and encrypted configuration backups without confusing them with business data recovery.
- OperateVerify a backup and restoreCheck that a complete Punaha backup can restore consistent services and data.
- Build solutionsBuild, publish, and run a workflowCreate a workflow, test its draft, publish a version, and check a run.
- Build solutionsBuild a workflowCreate a workflow with clear inputs, steps, and outputs.
- Build solutionsChoose workflow stepsChoose the right step for input, AI, rules, connections, approval, and output.
- Build solutionsCheck, publish, and run a workflowMove a workflow from a draft to a published version and test its runs.
- Build solutionsImport or export BPMN and DMNImport a BPMN or DMN file, check it, and test it before you publish.
- Build solutionsAdd safety checks and approvalsCheck unsafe content and ask a person before an important action.
- Build solutionsCreate a case type and complete a case in Pūnaha 1.0.0Create and publish a case type, then open, work and complete a case. Includes a real Pūnaha 1.0.0 example with screenshots and narrated video.
- Build solutionsBuild a case typeCreate the stages, tasks, requirements, and files for a type of case.
- Build solutionsInstall and activate a solution packageImport a protected solution, check its requirements, obtain approval, and activate the intended version.
- APIStart a supported API integrationChoose the customer contract, confirm access, and make a safe first request.
- APIUse tenant and access contextSelect the tenant and confirm the exact resource action before API work.
- APICreate and monitor a workflow runFind a workflow, check access, start it, and monitor the resulting run.
- APIPūnaha 1.0.0 API overviewUse the versioned customer API overview and contract generated from the released Product source.
- APIUpload and search a knowledge documentFind a knowledge database, upload a safe document, monitor ingestion, and search it.
- APISign in to the APIUnderstand API sessions, access checks, and safe error handling.
- APIWork with a case through the APIChoose a case type, create a case, perform authorised work, and read the result.
- APIHandle API errors and background workUse status, error code, request ID, retries, polling, and streams safely.
- APIProtect the private Workflow to AI APIConnect Workflow servers to AI servers without making the private API public.
- APIAPI referenceChoose a Product API category, then open the operation needed for your task.
- APIAccess and identity APIBrowse the Access and identity operations in the current Punaha customer contract.
- APIWorkflows and runs APIBrowse the Workflows and runs operations in the current Punaha customer contract.
- APICases and case types APIBrowse the Cases and case types operations in the current Punaha customer contract.
- APIModels and inference APIBrowse the Models and inference operations in the current Punaha customer contract.
- APIKnowledge and documents APIBrowse the Knowledge and documents operations in the current Punaha customer contract.
- APIConnections and storage APIBrowse the Connections and storage operations in the current Punaha customer contract.
- APIHealth and observability APIBrowse the Health and observability operations in the current Punaha customer contract.
- ReferencePunaha glossaryFind simple meanings for the main words used in Punaha and its guides.
- ReferenceTenants, people, groups, roles, and permissionsUnderstand how Punaha groups people and decides what each person can do.
- ReferenceWorkflows, versions, and runsUnderstand the workflow draft, published versions, and individual runs.
- ReferenceCases and case typesUnderstand the case type definition, published version, and each case created from it.
- ReferenceConnectionsUnderstand how a Connection lets approved work reach another system safely.
- ReferenceModels, knowledge, and vector databasesUnderstand models, embeddings, documents, and searchable knowledge in Punaha.
- ReferenceOperational logs and audit recordsUnderstand the different questions answered by logs and audit records.
- ReferenceCommand listFind the commands for starting, updating, repairing, and checking Punaha.
- ReferenceServices and portsFind the normal ports and see which service owns each group of requests.
- ReferenceStart troubleshootingChoose a safe guide for a sign in, access, work, service, storage, log, or backup problem.
- ReferenceResolve a registration or renewal problemDistinguish a pending request, an expired allowance and unverifiable powered time.
- ReferenceFix sign in, invitation, and access problemsUnderstand a failed sign in, unavailable invitation, missing area, or forbidden action.
- ReferenceFix model, upload, and knowledge search problemsCheck an unavailable model, rejected document, failed processing job, or weak knowledge result.
- ReferenceFix workflow and Connection problemsCheck a workflow that is not ready, a failed run, or a Connection test that does not pass.
- ReferenceGet help through Pūnaha SupportFind the configured Support destination and share case information privately.
- ReferenceFix service readiness and storage problemsUnderstand a running service that is not ready or data that is unavailable after a storage change.
- ReferenceFix log, backup, and restore problemsFind missing investigation records and check an incomplete backup or restore.
- ReferenceServer setting namesFind the main environment setting names and what each group controls.
- ReferenceDocument types and upload limitsCheck which document types Punaha can read and how many files you can upload.
- ReferenceUnderstand security and data handlingFind the current guides for sign in, access, tenant separation, data movement, audit, and secrets.
- ReferenceAuthentication and access overviewUnderstand sessions, membership, exact actions, groups, Deny rules, and service access.
- ReferenceTenant separationUnderstand how the current build keeps tenant requests and records in the selected tenant scope.
- ReferenceData locations and movementSee the main places where product data is stored and when configured work can send data elsewhere.
- ReferenceAudit and sensitive informationUse audit and operational records without exposing personal information or secrets.
- ReferenceHow access worksUnderstand who gets access, which item it covers, and which actions it allows.
- ReferenceSecrets and safe configurationEnter, store, test, change, and report configuration without exposing passwords, keys, or tokens.
- ReferenceImportant defaults and limitsFind the main default values that affect server size and performance.
- ReferenceVersions and release notesOpen the release notes and documentation edition that matches your installed Product version.
- ReferenceDocumentation scope for Pūnaha 1.0.0Match these guides and historical media to the released Product version.
- ReferenceKeep documentation currentFind pages and screenshots that need review when the Punaha product changes.
- APICases and case work data modelsRead the shared cases and case work fields used by the customer API.
- LearnPractise with PunahaChoose a safe exercise and practise one Punaha task in a local test tenant.
- APICommon HTTP models data modelsRead the shared common http models fields used by the customer API.
- APIIdentity and access data modelsRead the shared identity and access fields used by the customer API.
- APIKnowledge and documents data modelsRead the shared knowledge and documents fields used by the customer API.
- APIModels, inference and Connections data modelsRead the shared models, inference and connections fields used by the customer API.
- APIOther shared models data modelsRead the shared other shared models fields used by the customer API.
- APIWorkflows and runs data modelsRead the shared workflows and runs fields used by the customer API.
- LearnExercise: Check why an action is allowedUse Check access to read one allowed result and one restricted result without changing access.
- LearnExercise: Upload and find practice knowledgeUpload a small made up text file and confirm that a knowledge search finds the right passage.
- LearnExercise: Build and test a workflow draftCreate a small workflow draft, check it, and use a safe draft test without publishing it.
- LearnExercise: Design a case type draftCreate a small case type draft and check its information, stage, and work without publishing it.
- LearnExercise: Check services and recent recordsRead service health, server details, logs, and audit records without changing the local installation.
- APIAPI changesSee the lifecycle and baseline history of every operation in the current customer contract.
- Quick guidesPrintable quick guidesChoose a short checklist to print and use beside a local Punaha installation.
- Quick guidesStart a new installationA short checklist for preparing the first release.
- Quick guidesQuick guide: Check an access resultUse a short checklist to confirm why one person or group can or cannot complete an action.
- ReferencePlatform and GPU testing scopeReview the published platform packages and the scope of GPU testing.
- Quick guidesQuick guide: Start an operational investigationUse a short checklist to follow a problem from the visible symptom to operations, logs, and audit records.
- Quick guidesQuick guide: Verify a backup and restoreUse a short checklist to confirm that a complete Punaha backup restores consistent services and data.
- APICheck Access authorizationCheck Access authorization. This applies the validated business action to the selected tenant or platform resource.
- APIEffective Access authorizationEffective Access authorization. This applies the validated business action to the selected tenant or platform resource.
- APIList workflowsList workflows. This reads the current tenant or platform state without changing the resource.
- APICreate workflowsCreate workflows. This applies the validated business action to the selected tenant or platform resource.
- APIList workflows conformance (GET /api/workflows/bpmn/conformance)List workflows conformance. This reads the current tenant or platform state without changing the resource.
- APIList workflows report (GET /api/workflows/bpmn/conformance/report)List workflows report. This reads the current tenant or platform state without changing the resource.
- APIList workflows common executableList workflows common executable. This reads the current tenant or platform state without changing the resource.
- APIList workflows conformance (GET /api/workflows/dmn/conformance)List workflows conformance. This reads the current tenant or platform state without changing the resource.
- APIList workflows report (GET /api/workflows/dmn/conformance/report)List workflows report. This reads the current tenant or platform state without changing the resource.
- APIList workflows catalogList workflows catalog. This reads the current tenant or platform state without changing the resource.
- APIPreview workflowsPreview workflows. This applies the validated business action to the selected tenant or platform resource.
- APIDelete workflows (DELETE /api/workflows/{workflowId})Delete workflows. This removes or retires the selected resource according to its lifecycle rules.
- APIGet workflowsGet workflows. This reads the current tenant or platform state without changing the resource.
- APIUpdate workflowsUpdate workflows. This applies only the supplied changes.
- APIGet workflows dmnGet workflows dmn. This reads the current tenant or platform state without changing the resource.
- APIDmn workflowsDmn workflows. This replaces or sets the selected state using the full supplied value.
- APIDraft workflowsDraft workflows. This replaces or sets the selected state using the full supplied value.
- APIGet workflows export (GET /api/workflows/{workflowId}/export/bpel)Get workflows export. This reads the current tenant or platform state without changing the resource.
- APIGet workflows export (GET /api/workflows/{workflowId}/export/bpmn)Get workflows export. This reads the current tenant or platform state without changing the resource.
- APIGet workflows export (GET /api/workflows/{workflowId}/export/dmn)Get workflows export. This reads the current tenant or platform state without changing the resource.
- APIGet workflows import sourceGet workflows import source. This reads the current tenant or platform state without changing the resource.
- APIPublish workflowsPublish workflows. This applies the validated business action to the selected tenant or platform resource.
- APIGet workflows runs (GET /api/workflows/{workflowId}/runs)Get workflows runs. This reads the current tenant or platform state without changing the resource.
- APIRuns workflowsRuns workflows. This applies the validated business action to the selected tenant or platform resource.
- APIDelete workflows (DELETE /api/workflows/{workflowId}/runs/{runId})Delete workflows. This removes or retires the selected resource according to its lifecycle rules.
- APIGet workflows runs (GET /api/workflows/{workflowId}/runs/{runId})Get workflows runs. This reads the current tenant or platform state without changing the resource.
- APIDecision workflowsDecision workflows. This applies the validated business action to the selected tenant or platform resource.
- APIGet workflows events (GET /api/workflows/{workflowId}/runs/{runId}/events)Get workflows events. This reads the current tenant or platform state without changing the resource.
- APIGet workflows events (GET /api/workflows/{workflowId}/runs/{runId}/events/stream)Get workflows events. This reads the current tenant or platform state without changing the resource.
- APIComplete workflowsComplete workflows. This applies the validated business action to the selected tenant or platform resource.
- APIDelete workflows (DELETE /api/workflows/{workflowId}/star)Delete workflows. This removes or retires the selected resource according to its lifecycle rules.
- APIStar workflowsStar workflows. This replaces or sets the selected state using the full supplied value.
- APIValidate workflowsValidate workflows. This applies the validated business action to the selected tenant or platform resource.
- APIGet workflows versionsGet workflows versions. This reads the current tenant or platform state without changing the resource.
- APICreate case eventsCreate case events. This applies the validated business action to the selected tenant or platform resource.
- APIList case typesList case types. This reads the current tenant or platform state without changing the resource.
- APICreate case typesCreate case types. This applies the validated business action to the selected tenant or platform resource.
- APICmmn case typesCmmn case types. This applies the validated business action to the selected tenant or platform resource.
- APIPreview case typesPreview case types. This applies the validated business action to the selected tenant or platform resource.
- APIDelete case typesDelete case types. This removes or retires the selected resource according to its lifecycle rules.
- APIGet case typesGet case types. This reads the current tenant or platform state without changing the resource.
- APIUpdate case typesUpdate case types. This applies only the supplied changes.
- APIDraft case typesDraft case types. This replaces or sets the selected state using the full supplied value.
- APIGet case types exportGet case types export. This reads the current tenant or platform state without changing the resource.
- APIPublish case typesPublish case types. This applies the validated business action to the selected tenant or platform resource.
- APIValidate case typesValidate case types. This applies the validated business action to the selected tenant or platform resource.
- APIGet case types versionsGet case types versions. This reads the current tenant or platform state without changing the resource.
- APICreate chatCreate chat. This applies the validated business action to the selected tenant or platform resource.
- APICreate embeddingsCreate embeddings. This applies the validated business action to the selected tenant or platform resource.
- APIList model providers connectionsList model providers connections. This reads the current tenant or platform state without changing the resource.
- APIConnections model providersConnections model providers. This applies the validated business action to the selected tenant or platform resource.
- APIDelete model providers (DELETE /api/model providers/connections/{connectionId})Delete model providers. This removes or retires the selected resource according to its lifecycle rules.
- APIGet model providers (GET /api/model providers/connections/{connectionId})Get model providers. This reads the current tenant or platform state without changing the resource.
- APIUpdate model providers (PATCH /api/model providers/connections/{connectionId})Update model providers. This applies only the supplied changes.
- APIDeployments model providersDeployments model providers. This applies the validated business action to the selected tenant or platform resource.
- APIGet model providers modelsGet model providers models. This reads the current tenant or platform state without changing the resource.
- APIModels model providers (POST /api/model providers/connections/{connectionId}/models/discover)Models model providers. This applies the validated business action to the selected tenant or platform resource.
- APIModels model providers (POST /api/model providers/connections/{connectionId}/models/import)Models model providers. This applies the validated business action to the selected tenant or platform resource.
- APITest model providersTest model providers. This applies the validated business action to the selected tenant or platform resource.
- APIList model providers deploymentsList model providers deployments. This reads the current tenant or platform state without changing the resource.
- APISync Local model providersSync Local model providers. This applies the validated business action to the selected tenant or platform resource.
- APIDelete model providers (DELETE /api/model providers/deployments/{deploymentId})Delete model providers. This removes or retires the selected resource according to its lifecycle rules.
- APIGet model providers (GET /api/model providers/deployments/{deploymentId})Get model providers. This reads the current tenant or platform state without changing the resource.
- APIUpdate model providers (PATCH /api/model providers/deployments/{deploymentId})Update model providers. This applies only the supplied changes.
- APIMemory model providersMemory model providers. This replaces or sets the selected state using the full supplied value.
- APIPreload model providersPreload model providers. This replaces or sets the selected state using the full supplied value.
- APIRefresh Revision model providersRefresh Revision model providers. This applies the validated business action to the selected tenant or platform resource.
- APIList model providers typesList model providers types. This reads the current tenant or platform state without changing the resource.
- APIList modelsList models. This reads the current tenant or platform state without changing the resource.
- APIList vector databasesList vector databases. This reads the current tenant or platform state without changing the resource.
- APICreate vector databasesCreate vector databases. This applies the validated business action to the selected tenant or platform resource.
- APIList vector databases address availabilityList vector databases address availability. This reads the current tenant or platform state without changing the resource.
- APIList vector databases embedding modelsList vector databases embedding models. This reads the current tenant or platform state without changing the resource.
- APIList vector databases ingestion jobsList vector databases ingestion jobs. This reads the current tenant or platform state without changing the resource.
- APIDelete vector databases (DELETE /api/vector databases/ingestion jobs/{jobId})Delete vector databases. This removes or retires the selected resource according to its lifecycle rules.
- APIGet vector databasesGet vector databases. This reads the current tenant or platform state without changing the resource.
- APIGet vector databases serversGet vector databases servers. This reads the current tenant or platform state without changing the resource.
- APIList vector databases methodologiesList vector databases methodologies. This reads the current tenant or platform state without changing the resource.
- APIList vector databases upload policyList vector databases upload policy. This reads the current tenant or platform state without changing the resource.
- APIDelete vector databases (DELETE /api/vector databases/{name})Delete vector databases. This removes or retires the selected resource according to its lifecycle rules.
- APIUpdate vector databasesUpdate vector databases. This applies only the supplied changes.
- APIGet vector databases filesGet vector databases files. This reads the current tenant or platform state without changing the resource.
- APIFiles vector databases (POST /api/vector databases/{name}/files)Files vector databases. This applies the validated business action to the selected tenant or platform resource.
- APIDelete vector databases (DELETE /api/vector databases/{name}/files/{fileId})Delete vector databases. This removes or retires the selected resource according to its lifecycle rules.
- APIFiles vector databases (PATCH /api/vector databases/{name}/files/{fileId})Files vector databases. This applies only the supplied changes.
- APIQuery vector databasesQuery vector databases. This applies the validated business action to the selected tenant or platform resource.
- APIList connectionsList connections. This reads the current tenant or platform state without changing the resource.
- APICreate connectionsCreate connections. This applies the validated business action to the selected tenant or platform resource.
- APIList connections optionsList connections options. This reads the current tenant or platform state without changing the resource.
- APIDelete connectionsDelete connections. This removes or retires the selected resource according to its lifecycle rules.
- APIGet connectionsGet connections. This reads the current tenant or platform state without changing the resource.
- APIUpdate connectionsUpdate connections. This applies only the supplied changes.
- APITest connectionsTest connections. This applies the validated business action to the selected tenant or platform resource.
- APIList healthReports the installation health state used by operators and automated probes.
- APIList health liveReports the installation health state used by operators and automated probes.
- APIList health readyReports the installation health state used by operators and automated probes.