Introduction
Every app in your workspace gets its own endpoints under one address, with the same keys, errors, paging and retries.
https://api.olamma.sh/v1/w/your-workspaceWith your key, GET /openapi.json under that address gives this reference for your workspace alone: only the apps it uses, and its own data shapes. The general file is /v1/openapi.json.
Apps
Workspace
Who a key acts as, the workspace it opens (its apps, members and projects), and the changes it proposed that wait for a person.
GETGet current key/meGETGet workspace/GETList members/membersGETList projects/projectsGETList approvals/approvalsGETGet approval/approvals/{approvalId}Tasks
Bugs, feature requests and project tasks, with sub-tasks and sprints.
GETList tasks/tasksPOSTCreate task/tasksGETGet task/tasks/{id}PATCHUpdate task/tasks/{id}POSTAdd sub-tasks/tasks/{id}/subtasksGETList sprints/sprintsGETGet sprint/sprints/{id}Pages
Documents your team writes: pages in projects and folders, with versions, comments and publishing.
GETList pages/pagesPOSTCreate page/pagesGETGet page/pages/{id}PATCHUpdate page/pages/{id}POSTAppend to page/pages/{id}/appendPOSTMove to Trash/pages/{id}/trashPOSTRestore page/pages/{id}/restorePOSTCreate folder/foldersGETList versions/pages/{id}/versionsGETGet version/pages/{id}/versions/{versionId}POSTRestore version/pages/{id}/versions/{versionId}/restoreGETList comments/pages/{id}/commentsPOSTAdd comment/pages/{id}/commentsPOSTResolve comment/comments/{threadId}/resolvePOSTPublish page/pages/{id}/publishSupport chat
Conversations with customers across chat, in-app, email and WhatsApp, and the team’s saved replies. Read-only for now.
GETList conversations/conversationsGETGet conversation/conversations/{id}GETList saved replies/saved-repliesHelp sites
Your public help sites: topics and articles, search the way readers do, publishing and reading insights.
GETList sites/help-sitesGETSearch articles/help-articlesPOSTAdd article/help-articlesGETGet article/help-articles/{id}POSTPublish article/help-articles/{articleId}/publishGETGet insights/help-sites/{siteId}/insightsChangelogs
Each product’s changelog: record changes from pull requests, ship releases on deploy, and propose publishing them to customers.
GETList changelogs/changelogsGETList changes/changesPOSTRecord change/changesPATCHUpdate change/changes/{changeId}DELETEDelete change/changes/{changeId}POSTRestore change/changes/{changeId}/restoreGETGet release/releasesGETCheck release/releases/checkPOSTSkip pull request/releases/{releaseId}/skipPOSTShip release/releases/shipPATCHUpdate release/releases/{releaseId}POSTPublish release/releases/{releaseId}/publishPOSTTell reporters/releases/{releaseId}/tellTables
Bases of tables with typed fields, saved views and records: a database your servers can read and fill.
GETList bases/basesPOSTCreate base/basesPOSTCreate table/bases/{baseId}/tablesGETGet table/tables/{tableId}GETList records/tables/{tableId}/recordsPOSTAdd records/tables/{tableId}/recordsPATCHUpdate records/tables/{tableId}/recordsDELETEDelete records/tables/{tableId}/recordsPOSTRestore records/tables/{tableId}/records/restorePOSTCreate field/tables/{tableId}/fieldsPATCHUpdate field/fields/{fieldId}DELETEDelete field/fields/{fieldId}POSTRestore field/fields/{fieldId}/restorePOSTCreate view/tables/{tableId}/viewsPATCHUpdate view/views/{viewId}DELETEDelete view/views/{viewId}GETRecord history/records/{recordId}/historyGETList comments/records/{recordId}/commentsPOSTAdd comment/records/{recordId}/commentsComing to the API
These apps aren’t in the API yet. Each gets its own section here when it is. Agents can already work with them through MCP: see Settings → How to connect in Olamma.