OpenVibe.Community API

Generated at from openvibe-contracts v0.114.0 and openvibe-sdk v0.35.1.

Server https://openvibe.community. 24 routes performing 7 capabilities. OpenAPI 3.1 document.

POST /api/pastes

Create a paste (text or screenshot).

Capabilities
community.paste.create
Visibility
public
Request body
application/json community.paste-create-request@1
Response
application/json community.paste-create-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>community.paste.create</strong> (public): Create a paste (text or screenshot). A service token creates it for the acting subject named in X-OV-Subject, or as origin &quot;ai&quot; for derived pastes (roadmap 33).</p> <p>Route note: Community</p>

PUT /api/pastes/{slug}

Edit, delete, fork, like, copy and comment on pastes as the acting subject (X-OV-Subject).

Capabilities
community.paste.write
Visibility
first-party
Parameters
  • slug (path, required)
Request body
application/json community.paste-write-request@1
Response
application/json community.paste-write-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>community.paste.write</strong> (first-party): Edit, delete, fork, like, copy and comment on pastes as the acting subject (X-OV-Subject). Ownership is checked by Community, never by the caller.</p>

DELETE /api/pastes/{slug}

Edit, delete, fork, like, copy and comment on pastes as the acting subject (X-OV-Subject).

Capabilities
community.paste.write
Visibility
first-party
Parameters
  • slug (path, required)
Input
community.paste-write-request@1
Response
application/json community.paste-write-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>community.paste.write</strong> (first-party): Edit, delete, fork, like, copy and comment on pastes as the acting subject (X-OV-Subject). Ownership is checked by Community, never by the caller.</p>

POST /api/pastes/{slug}/{fork,like,copy,comments}

Edit, delete, fork, like, copy and comment on pastes as the acting subject (X-OV-Subject).

Capabilities
community.paste.write
Visibility
first-party
Parameters
  • slug (path, required)
  • fork,like,copy,comments (path, required)
Request body
application/json community.paste-write-request@1
Response
application/json community.paste-write-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>community.paste.write</strong> (first-party): Edit, delete, fork, like, copy and comment on pastes as the acting subject (X-OV-Subject). Ownership is checked by Community, never by the caller.</p>

POST /api/pastes/{slug}/censor

Staff moderation of any paste or comment (censor, delete, bulk).

Capabilities
community.paste.moderate
Visibility
internal
Parameters
  • slug (path, required)
Request body
application/json community.paste-moderate-request@1
Response
application/json community.paste-moderate-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>community.paste.moderate</strong> (internal): Staff moderation of any paste or comment (censor, delete, bulk). The caller vouches that the acting subject is staff.</p>

DELETE /api/pastes/{slug}/comments/{id}

Staff moderation of any paste or comment (censor, delete, bulk).

Capabilities
community.paste.moderate
Visibility
internal
Parameters
  • slug (path, required)
  • id (path, required)
Input
community.paste-moderate-request@1
Response
application/json community.paste-moderate-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>community.paste.moderate</strong> (internal): Staff moderation of any paste or comment (censor, delete, bulk). The caller vouches that the acting subject is staff.</p>

POST /api/pastes/bulk

Staff moderation of any paste or comment (censor, delete, bulk).

Capabilities
community.paste.moderate
Visibility
internal
Request body
application/json community.paste-moderate-request@1
Response
application/json community.paste-moderate-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>community.paste.moderate</strong> (internal): Staff moderation of any paste or comment (censor, delete, bulk). The caller vouches that the acting subject is staff.</p>

DELETE /api/v1/comments/{commentId}

Moderation of discussions: set a comment thread's visibility (public, hidden, locked — e.g.

Capabilities
community.comment.moderate, community.comment.write
Visibility
internal, first-party
Parameters
  • commentId (path, required)
Input
one of community.moderation-request@1, community.comment-write-request@1
Response
application/json one of community.moderation-result@1, community.comment-write-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>community.comment.moderate</strong> (internal): Moderation of discussions: set a comment thread&#39;s visibility (public, hidden, locked — e.g. when the owner service hides the entity), delete any comment or forum post, pin and lock forum threads, read hidden threads, administer the Discord relay. Acting as itself (no X-OV-Subject) the service is the moderator; acting for a person it must vouch with X-OV-Staff: 1 that the person is staff.</p> <p><strong>community.comment.write</strong> (first-party): Typed comment threads as a service: resolve the thread of any EntityRef (browsers are limited to an allowlist of types), and comment, vote and delete one&#39;s own comments as the acting subject (X-OV-Subject), or comment as origin &quot;ai&quot; (never attributed to a person, roadmap 33). Ownership and limits are checked by Community.</p>

POST /api/v1/comments/{commentId}/votes

Typed comment threads as a service: resolve the thread of any EntityRef (browsers are limited to an allowlist of types), and comment, vote and delete one's own comments as the acting subject (X-OV-Sub

Capabilities
community.comment.write
Visibility
first-party
Parameters
  • commentId (path, required)
Request body
application/json community.comment-write-request@1
Response
application/json community.comment-write-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>community.comment.write</strong> (first-party): Typed comment threads as a service: resolve the thread of any EntityRef (browsers are limited to an allowlist of types), and comment, vote and delete one&#39;s own comments as the acting subject (X-OV-Subject), or comment as origin &quot;ai&quot; (never attributed to a person, roadmap 33). Ownership and limits are checked by Community.</p>

GET /api/v1/comments/threads/{id}

Typed comment threads as a service: resolve the thread of any EntityRef (browsers are limited to an allowlist of types), and comment, vote and delete one's own comments as the acting subject (X-OV-Sub

Capabilities
community.comment.write
Visibility
first-party
Parameters
  • id (path, required)
Input
community.comment-write-request@1
Response
application/json community.comment-write-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>community.comment.write</strong> (first-party): Typed comment threads as a service: resolve the thread of any EntityRef (browsers are limited to an allowlist of types), and comment, vote and delete one&#39;s own comments as the acting subject (X-OV-Subject), or comment as origin &quot;ai&quot; (never attributed to a person, roadmap 33). Ownership and limits are checked by Community.</p>

POST /api/v1/comments/threads/{id}/comments

Typed comment threads as a service: resolve the thread of any EntityRef (browsers are limited to an allowlist of types), and comment, vote and delete one's own comments as the acting subject (X-OV-Sub

Capabilities
community.comment.write
Visibility
first-party
Parameters
  • id (path, required)
Request body
application/json community.comment-write-request@1
Response
application/json community.comment-write-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>community.comment.write</strong> (first-party): Typed comment threads as a service: resolve the thread of any EntityRef (browsers are limited to an allowlist of types), and comment, vote and delete one&#39;s own comments as the acting subject (X-OV-Subject), or comment as origin &quot;ai&quot; (never attributed to a person, roadmap 33). Ownership and limits are checked by Community.</p>

PUT /api/v1/comments/threads/{id}/visibility

Moderation of discussions: set a comment thread's visibility (public, hidden, locked — e.g.

Capabilities
community.comment.moderate
Visibility
internal
Parameters
  • id (path, required)
Request body
application/json community.moderation-request@1
Response
application/json community.moderation-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>community.comment.moderate</strong> (internal): Moderation of discussions: set a comment thread&#39;s visibility (public, hidden, locked — e.g. when the owner service hides the entity), delete any comment or forum post, pin and lock forum threads, read hidden threads, administer the Discord relay. Acting as itself (no X-OV-Subject) the service is the moderator; acting for a person it must vouch with X-OV-Staff: 1 that the person is staff.</p>

POST /api/v1/comments/threads/resolve

Typed comment threads as a service: resolve the thread of any EntityRef (browsers are limited to an allowlist of types), and comment, vote and delete one's own comments as the acting subject (X-OV-Sub

Capabilities
community.comment.write
Visibility
first-party
Request body
application/json community.comment-write-request@1
Response
application/json community.comment-write-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>community.comment.write</strong> (first-party): Typed comment threads as a service: resolve the thread of any EntityRef (browsers are limited to an allowlist of types), and comment, vote and delete one&#39;s own comments as the acting subject (X-OV-Subject), or comment as origin &quot;ai&quot; (never attributed to a person, roadmap 33). Ownership and limits are checked by Community.</p>

PUT /api/v1/posts/{id}

Moderation of discussions: set a comment thread's visibility (public, hidden, locked — e.g.

Capabilities
community.comment.moderate
Visibility
internal
Parameters
  • id (path, required)
Request body
application/json community.moderation-request@1
Response
application/json community.moderation-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>community.comment.moderate</strong> (internal): Moderation of discussions: set a comment thread&#39;s visibility (public, hidden, locked — e.g. when the owner service hides the entity), delete any comment or forum post, pin and lock forum threads, read hidden threads, administer the Discord relay. Acting as itself (no X-OV-Subject) the service is the moderator; acting for a person it must vouch with X-OV-Staff: 1 that the person is staff.</p>

DELETE /api/v1/posts/{id}

Moderation of discussions: set a comment thread's visibility (public, hidden, locked — e.g.

Capabilities
community.comment.moderate
Visibility
internal
Parameters
  • id (path, required)
Input
community.moderation-request@1
Response
application/json community.moderation-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>community.comment.moderate</strong> (internal): Moderation of discussions: set a comment thread&#39;s visibility (public, hidden, locked — e.g. when the owner service hides the entity), delete any comment or forum post, pin and lock forum threads, read hidden threads, administer the Discord relay. Acting as itself (no X-OV-Subject) the service is the moderator; acting for a person it must vouch with X-OV-Staff: 1 that the person is staff.</p>

GET /api/v1/pulse

Read the network's public activity feed (Pulse): entity reference, title, URL and origin (user, ai or system), newest first with a cursor.

Capabilities
community.pulse.read
Visibility
public
Response
application/json community.pulse-read-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>community.pulse.read</strong> (public): Read the network&#39;s public activity feed (Pulse): entity reference, title, URL and origin (user, ai or system), newest first with a cursor. Only public items are ever stored. Served to anyone (CORS allow-list for browsers). Live&#39;s /api/home/pulse is a different, Live-only feed.</p>

POST /api/v1/pulse/items

Publish public activity of the calling service's own entities to Pulse (EntityRef + title + url + origin user|ai|system + occurred_at), or retract it.

Capabilities
community.pulse.write
Visibility
first-party
Request body
application/json community.pulse-write-request@1
Response
application/json community.pulse-write-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>community.pulse.write</strong> (first-party): Publish public activity of the calling service&#39;s own entities to Pulse (EntityRef + title + url + origin user|ai|system + occurred_at), or retract it. Only visibility public is accepted; the ref&#39;s service must be the caller&#39;s. Provenance is kept: the first record&#39;s origin, actor (X-OV-Subject, never for ai/system) and time stand.</p>

DELETE /api/v1/pulse/items/{service}/{type}/{id}

Publish public activity of the calling service's own entities to Pulse (EntityRef + title + url + origin user|ai|system + occurred_at), or retract it.

Capabilities
community.pulse.write
Visibility
first-party
Parameters
  • service (path, required)
  • type (path, required)
  • id (path, required)
Input
community.pulse-write-request@1
Response
application/json community.pulse-write-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>community.pulse.write</strong> (first-party): Publish public activity of the calling service&#39;s own entities to Pulse (EntityRef + title + url + origin user|ai|system + occurred_at), or retract it. Only visibility public is accepted; the ref&#39;s service must be the caller&#39;s. Provenance is kept: the first record&#39;s origin, actor (X-OV-Subject, never for ai/system) and time stand.</p>

GET /api/v1/relay/*

Moderation of discussions: set a comment thread's visibility (public, hidden, locked — e.g.

Capabilities
community.comment.moderate
Visibility
internal
Input
community.moderation-request@1
Response
application/json community.moderation-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>community.comment.moderate</strong> (internal): Moderation of discussions: set a comment thread&#39;s visibility (public, hidden, locked — e.g. when the owner service hides the entity), delete any comment or forum post, pin and lock forum threads, read hidden threads, administer the Discord relay. Acting as itself (no X-OV-Subject) the service is the moderator; acting for a person it must vouch with X-OV-Staff: 1 that the person is staff.</p>

POST /api/v1/relay/*

Moderation of discussions: set a comment thread's visibility (public, hidden, locked — e.g.

Capabilities
community.comment.moderate
Visibility
internal
Request body
application/json community.moderation-request@1
Response
application/json community.moderation-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>community.comment.moderate</strong> (internal): Moderation of discussions: set a comment thread&#39;s visibility (public, hidden, locked — e.g. when the owner service hides the entity), delete any comment or forum post, pin and lock forum threads, read hidden threads, administer the Discord relay. Acting as itself (no X-OV-Subject) the service is the moderator; acting for a person it must vouch with X-OV-Staff: 1 that the person is staff.</p>

PUT /api/v1/relay/*

Moderation of discussions: set a comment thread's visibility (public, hidden, locked — e.g.

Capabilities
community.comment.moderate
Visibility
internal
Request body
application/json community.moderation-request@1
Response
application/json community.moderation-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>community.comment.moderate</strong> (internal): Moderation of discussions: set a comment thread&#39;s visibility (public, hidden, locked — e.g. when the owner service hides the entity), delete any comment or forum post, pin and lock forum threads, read hidden threads, administer the Discord relay. Acting as itself (no X-OV-Subject) the service is the moderator; acting for a person it must vouch with X-OV-Staff: 1 that the person is staff.</p>

DELETE /api/v1/spaces/{space}/threads/{slug}

Moderation of discussions: set a comment thread's visibility (public, hidden, locked — e.g.

Capabilities
community.comment.moderate
Visibility
internal
Parameters
  • space (path, required)
  • slug (path, required)
Input
community.moderation-request@1
Response
application/json community.moderation-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>community.comment.moderate</strong> (internal): Moderation of discussions: set a comment thread&#39;s visibility (public, hidden, locked — e.g. when the owner service hides the entity), delete any comment or forum post, pin and lock forum threads, read hidden threads, administer the Discord relay. Acting as itself (no X-OV-Subject) the service is the moderator; acting for a person it must vouch with X-OV-Staff: 1 that the person is staff.</p>

PUT /api/v1/spaces/{space}/threads/{slug}/state

Moderation of discussions: set a comment thread's visibility (public, hidden, locked — e.g.

Capabilities
community.comment.moderate
Visibility
internal
Parameters
  • space (path, required)
  • slug (path, required)
Request body
application/json community.moderation-request@1
Response
application/json community.moderation-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>community.comment.moderate</strong> (internal): Moderation of discussions: set a comment thread&#39;s visibility (public, hidden, locked — e.g. when the owner service hides the entity), delete any comment or forum post, pin and lock forum threads, read hidden threads, administer the Discord relay. Acting as itself (no X-OV-Subject) the service is the moderator; acting for a person it must vouch with X-OV-Staff: 1 that the person is staff.</p>

GET /pulse

Read the network's public activity feed (Pulse): entity reference, title, URL and origin (user, ai or system), newest first with a cursor.

Capabilities
community.pulse.read
Visibility
public
Response
application/json community.pulse-read-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>community.pulse.read</strong> (public): Read the network&#39;s public activity feed (Pulse): entity reference, title, URL and origin (user, ai or system), newest first with a cursor. Only public items are ever stored. Served to anyone (CORS allow-list for browsers). Live&#39;s /api/home/pulse is a different, Live-only feed.</p>