The whole HTTP surface: 76 operations over 68 paths, in 18 groups. Everything is under /api/v1/, speaks JSON-LD, and is authenticated with a bearer token unless noted.
This page is generated from the OpenAPI document the application itself publishes, so a route that is not here does not exist. For request and response schemas, the interactive explorer at /api/v1/docs is the same document rendered.
curl -H "Authorization: Bearer $TOKEN" http://localhost/api/v1/content/pages
27 of the 76 operations carry a description written for a reader; the other 49 fall back to the framework's generated sentence and are shown here as the operation they perform.
.well-known#
| Method |
Path |
|
GET |
/.well-known/coolms-workspace |
What this server is and how to sign in to it. |
analytics#
| Method |
Path |
|
GET |
/api/v1/analytics/me/segments |
The audience segments the current visitor belongs to. |
POST |
/api/v1/analytics/pageview |
create PageView |
api#
| Method |
Path |
|
POST |
/api/mcp/rpc |
Model Context Protocol endpoint over Streamable HTTP. |
GET |
/api/mcp/tools |
List the MCP tools this installation exposes. |
auth#
| Method |
Path |
|
POST |
/api/v1/auth/deletion/cancel |
create AccountDeletion |
DELETE |
/api/v1/auth/elevation |
delete Elevation |
GET |
/api/v1/auth/elevation |
list Elevation |
POST |
/api/v1/auth/elevation |
create Elevation |
POST |
/api/v1/auth/invitation/accept |
create Invitation |
POST |
/api/v1/auth/login |
create Token |
POST |
/api/v1/auth/logout |
create Token |
GET |
/api/v1/auth/me |
list User |
PATCH |
/api/v1/auth/me |
update User |
DELETE |
/api/v1/auth/me/avatar |
delete User |
POST |
/api/v1/auth/me/avatar |
create User |
PATCH |
/api/v1/auth/me/color |
update User |
POST |
/api/v1/auth/me/deletion |
create AccountDeletion |
PATCH |
/api/v1/auth/me/preferences |
update User |
GET |
/api/v1/auth/me/settings |
list User |
GET |
/api/v1/auth/me/settings/sections |
list User |
GET |
/api/v1/auth/me/settings/{section} |
read User |
PATCH |
/api/v1/auth/me/settings/{section} |
update User |
PATCH |
/api/v1/auth/me/status |
update User |
POST |
/api/v1/auth/password-reset/confirm |
create Verification |
POST |
/api/v1/auth/password-reset/request |
create Verification |
POST |
/api/v1/auth/refresh |
create Token |
POST |
/api/v1/auth/register |
create User |
POST |
/api/v1/auth/resend |
create Verification |
POST |
/api/v1/auth/verify |
create Verification |
POST |
/auth/invitation/accept |
Accept an invitation with the token from the mail and set the first password. |
POST |
/auth/login |
Exchange credentials for an access and refresh token pair. |
GET |
/auth/logout |
End the session and revoke the refresh token. |
POST |
/auth/logout |
End the session and revoke the refresh token. |
POST |
/auth/password-reset/confirm |
Set a new password using the emailed token. |
POST |
/auth/password-reset/request |
Request a password-reset email. |
POST |
/auth/refresh |
Exchange a refresh token for a new pair. |
POST |
/auth/register |
Create an account and send the confirmation email. |
GET |
/auth/sso/providers |
List the single sign-on providers this installation offers. |
GET |
/auth/sso/{provider} |
Begin single sign-on with one provider. |
POST |
/auth/verify-email |
Confirm an address with the code that was emailed to it. |
POST |
/auth/verify-email/resend |
Send another confirmation code. |
capabilities#
| Method |
Path |
|
GET |
/api/v1/capabilities |
list Capabilities |
| Method |
Path |
|
GET |
/api/v1/comments |
list Comment |
POST |
/api/v1/comments |
create Comment |
consent#
| Method |
Path |
|
POST |
/api/v1/consent |
Record a consent decision for the current visitor. |
GET |
/api/v1/consent/me |
What consent is in force for the current visitor. |
desk#
| Method |
Path |
|
GET |
/api/v1/desk/manifest |
list WorkspaceManifest |
discovery#
| Method |
Path |
|
GET |
/api/v1/discovery |
Everything the anonymous discovery document states, plus what a signed-in client uses. |
experiments#
| Method |
Path |
|
POST |
/api/v1/experiments/conversion |
create Experiment |
POST |
/api/v1/experiments/exposure |
create Experiment |
| Method |
Path |
|
GET |
/media/assets/{uuid} |
Stream a resized rendition of a media asset. |
navi#
| Method |
Path |
|
GET |
/api/v1/navi/trees/navi.workspace/graph |
list NaviTree |
newsletter#
| Method |
Path |
|
POST |
/api/v1/newsletter/subscribe |
create Subscriber |
GET |
/newsletter/confirm |
Confirm a newsletter subscription from the emailed link. |
GET |
/newsletter/unsubscribe |
Unsubscribe from the newsletter. |
POST |
/newsletter/unsubscribe |
Unsubscribe from the newsletter. |
public-options#
| Method |
Path |
|
GET |
/api/v1/public-options/{source} |
read Option |
rtc#
| Method |
Path |
|
POST |
/api/v1/rtc/calls |
create RtcCall |
GET |
/api/v1/rtc/calls/{id} |
read RtcCall |
POST |
/api/v1/rtc/calls/{id}/answer |
create RtcCall |
POST |
/api/v1/rtc/calls/{id}/decline |
create RtcCall |
POST |
/api/v1/rtc/calls/{id}/hangup |
create RtcCall |
GET |
/api/v1/rtc/calls/{id}/ice-servers |
list RtcIceServers |
GET |
/api/v1/rtc/calls/{id}/media-token |
list RtcMediaToken |
GET |
/api/v1/rtc/calls/{id}/recording |
Download the recording of a media-room call |
POST |
/api/v1/rtc/calls/{id}/recording/start |
create RtcCall |
POST |
/api/v1/rtc/calls/{id}/recording/stop |
create RtcCall |
POST |
/api/v1/rtc/calls/{id}/signal |
create RtcCall |
GET |
/api/v1/rtc/ice-servers |
list RtcIceServers |
GET |
/api/v1/rtc/ringing |
list RtcCall |
search#
| Method |
Path |
|
GET |
/api/v1/search |
list Search |
GET |
/search |
Search the public site. |
workspace#
| Method |
Path |
|
GET |
/api/v1/workspace/manifest |
list WorkspaceManifest |
{collection}#
| Method |
Path |
|
GET |
/{collection}/atom.xml |
Atom 1.0 feed for a content collection. |
GET |
/{collection}/feed.xml |
RSS 2.0 feed for a content collection. |