Moltaro
Overview
Moltaro Public Integration API moltaro-public-v1
Section titled “Moltaro Public Integration API moltaro-public-v1”Public runtime and integration API for Moltaro.
Server and URL
- This document may be viewed as a public reference copy on
moltaro.com/docs, butmoltaro.comis not a customer workspace API host. - Resolve every
/api/workspace/...path against the API base URL of the target Moltaro installation. - For actual integration work, prefer the OpenAPI document served by that installation at
/openapi/moltaro-public-v1.json; it matches the installed release. - The workspace Web Application URL and workspace API URL may differ. Use the API base URL supplied by the workspace administrator; do not derive it from the Web Application or portal hostname.
Workspace endpoints
- Moltaro OnPrem resolves the single workspace database from runtime configuration.
- Use
Authorization: Bearer <token>for authenticated routes. - Service API keys use the same bearer header (
Authorization: Bearer <api-key>). - API keys are created and governed through the Configuration API or the Moltaro admin UI, with the same authorization requirements.
- If headers are not possible, pass the token as
access_tokenquery parameter (use only when needed).
Scope
-
Together with the Configuration API, this reference publishes every workspace HTTP operation. HTTP supports external clients; the C# SDK separately supports in-project logic.
-
It includes runtime entity, record matching and merge, transfer, collaboration, lookup, resumable FileSystem uploads, Boards, Tasks, Workflow, Work Schedule, notifications, File Protection, and other registered module runtime endpoints.
-
It includes business-logic invocation: published function commands, API function enqueue with job tracking, and entity UI actions.
-
Administration, entity-builder, module configuration, and business-logic authoring and diagnostics are published in the Configuration API. Module enablement and resource permissions remain runtime requirements.
-
File Protection Agent operations use TLS and the enrolled device credential in
X-Moltaro-File-Protection-Agent; enrollment redeems a one-time code. These operations do not use a workspace bearer token. Published inbound function endpoints follow their configured authentication policy.
Responses
- Most endpoints return
ApiResponse<T>withSuccess,Data,Errors, andWarnings. GET /api/workspace/error-catalogreturns this installation’s machine-readable error catalog: code meanings, HTTP status, Field and safe client reactions for the covered surfaces. It is partial; an unlisted code is still a valid answer.
Information
- OpenAPI version:
3.0.4
Operations
Section titled “Operations”POST
/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/collaboration/files/preparations/statusDELETE
/api/workspace/boards/{boardIdOrKey}/items/{boardItemId}/process-attachments/{fileReferenceId}GET
/api/workspace/community-memberships/communities/{communityId}/membership-types/{membershipTypeId}PUT
/api/workspace/community-memberships/communities/{communityId}/membership-types/{membershipTypeId}DELETE
/api/workspace/community-memberships/communities/{communityId}/membership-types/{membershipTypeId}GET
/api/workspace/entity/{entityIdOrKey}/instances/{instanceId}/responsibilities/{responsibilityKey}PUT
/api/workspace/entity/{entityIdOrKey}/instances/{instanceId}/responsibilities/{responsibilityKey}POST
/api/workspace/entity/{entityIdOrKey}/ui/form/{formSurfaceId}/items/{formItemId}/lookup-table/moveAuthentication
Section titled “Authentication”FileProtectionAgent
Section titled “FileProtectionAgent”Enrolled File Protection device credential. Requires TLS; enrollment uses a one-time code.
Security scheme type: apiKey
Header parameter name: X-Moltaro-File-Protection-Agent
WorkspaceBearer
Section titled “WorkspaceBearer”Workspace bearer token or service API key. Example: Bearer {token}
Security scheme type: http
Bearer format: Bearer