OpenVibe.Space API

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

Server https://openvibe.space. 30 routes performing 4 capabilities. OpenAPI 3.1 document.

PUT /api/v1/posts/{id}

Forum writes as a service (renamed from community.post.create, plan T10 D3): create threads and replies in a space, vote on threads, and edit or delete one's own posts, as the acting subject (X-OV-Sub

Capabilities
space.post.write
Visibility
public
Parameters
  • id (path, required)
Request body
application/json space.post-write-request@1
Response
application/json space.post-write-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>space.post.write</strong> (public): Forum writes as a service (renamed from community.post.create, plan T10 D3): create threads and replies in a space, vote on threads, and edit or delete one&#39;s own posts, as the acting subject (X-OV-Subject) or as origin &quot;ai&quot; (no author, labelled as AI). Space visibility (public, members, staff), locks and limits are checked by OpenVibe.Space.</p>

DELETE /api/v1/posts/{id}

Forum writes as a service (renamed from community.post.create, plan T10 D3): create threads and replies in a space, vote on threads, and edit or delete one's own posts, as the acting subject (X-OV-Sub

Capabilities
space.post.write
Visibility
public
Parameters
  • id (path, required)
Input
space.post-write-request@1
Response
application/json space.post-write-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>space.post.write</strong> (public): Forum writes as a service (renamed from community.post.create, plan T10 D3): create threads and replies in a space, vote on threads, and edit or delete one&#39;s own posts, as the acting subject (X-OV-Subject) or as origin &quot;ai&quot; (no author, labelled as AI). Space visibility (public, members, staff), locks and limits are checked by OpenVibe.Space.</p>

POST /api/v1/posts/{id}/reactions

Forum writes as a service (renamed from community.post.create, plan T10 D3): create threads and replies in a space, vote on threads, and edit or delete one's own posts, as the acting subject (X-OV-Sub

Capabilities
space.post.write
Visibility
public
Parameters
  • id (path, required)
Request body
application/json space.post-write-request@1
Response
application/json space.post-write-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>space.post.write</strong> (public): Forum writes as a service (renamed from community.post.create, plan T10 D3): create threads and replies in a space, vote on threads, and edit or delete one&#39;s own posts, as the acting subject (X-OV-Subject) or as origin &quot;ai&quot; (no author, labelled as AI). Space visibility (public, members, staff), locks and limits are checked by OpenVibe.Space.</p>

GET /api/v1/space-groups

List the spaces the caller can open and read one space's metadata (renamed from community.space.read, plan T10 D3: OpenVibe.Space owns the forum).

Capabilities
space.forum.read
Visibility
public
Response
application/json space.forum-read-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>space.forum.read</strong> (public): List the spaces the caller can open and read one space&#39;s metadata (renamed from community.space.read, plan T10 D3: OpenVibe.Space owns the forum). Anonymous callers see public spaces, signed-in people also members spaces, moderators also staff spaces; members-only (VIP) spaces are flagged. Served to anyone; Space checks space visibility itself.</p>

PUT /api/v1/space-groups/{group}

Manage forum spaces and moderation in OpenVibe.Space: create spaces, update settings and categories, manage moderators, and gate spaces to creator VIP members.

Capabilities
space.forum.manage
Visibility
internal
Parameters
  • group (path, required)
Response
—
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>space.forum.manage</strong> (internal): Manage forum spaces and moderation in OpenVibe.Space: create spaces, update settings and categories, manage moderators, and gate spaces to creator VIP members. Service callers need space.forum.manage; people need discussion staff or a space moderator where supported. PUT /api/v1/spaces/:space/moderators/:subject refuses a block in either direction with 403 space.blocked (errors.problem@1). Other Space problem codes are documented in docs/space-problem-codes.md.</p>

GET /api/v1/spaces

List the spaces the caller can open and read one space's metadata (renamed from community.space.read, plan T10 D3: OpenVibe.Space owns the forum).

Capabilities
space.forum.read
Visibility
public
Response
application/json space.forum-read-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>space.forum.read</strong> (public): List the spaces the caller can open and read one space&#39;s metadata (renamed from community.space.read, plan T10 D3: OpenVibe.Space owns the forum). Anonymous callers see public spaces, signed-in people also members spaces, moderators also staff spaces; members-only (VIP) spaces are flagged. Served to anyone; Space checks space visibility itself.</p>

POST /api/v1/spaces

Manage forum spaces and moderation in OpenVibe.Space: create spaces, update settings and categories, manage moderators, and gate spaces to creator VIP members.

Capabilities
space.forum.manage
Visibility
internal
Response
—
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>space.forum.manage</strong> (internal): Manage forum spaces and moderation in OpenVibe.Space: create spaces, update settings and categories, manage moderators, and gate spaces to creator VIP members. Service callers need space.forum.manage; people need discussion staff or a space moderator where supported. PUT /api/v1/spaces/:space/moderators/:subject refuses a block in either direction with 403 space.blocked (errors.problem@1). Other Space problem codes are documented in docs/space-problem-codes.md.</p>

GET /api/v1/spaces/{space}

List the spaces the caller can open and read one space's metadata (renamed from community.space.read, plan T10 D3: OpenVibe.Space owns the forum).

Capabilities
space.forum.read
Visibility
public
Parameters
  • space (path, required)
Response
application/json space.forum-read-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>space.forum.read</strong> (public): List the spaces the caller can open and read one space&#39;s metadata (renamed from community.space.read, plan T10 D3: OpenVibe.Space owns the forum). Anonymous callers see public spaces, signed-in people also members spaces, moderators also staff spaces; members-only (VIP) spaces are flagged. Served to anyone; Space checks space visibility itself.</p>

POST /api/v1/spaces/{space}/attachments

Forum writes as a service (renamed from community.post.create, plan T10 D3): create threads and replies in a space, vote on threads, and edit or delete one's own posts, as the acting subject (X-OV-Sub

Capabilities
space.post.write
Visibility
public
Parameters
  • space (path, required)
Request body
application/json space.post-write-request@1
Response
application/json space.post-write-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>space.post.write</strong> (public): Forum writes as a service (renamed from community.post.create, plan T10 D3): create threads and replies in a space, vote on threads, and edit or delete one&#39;s own posts, as the acting subject (X-OV-Subject) or as origin &quot;ai&quot; (no author, labelled as AI). Space visibility (public, members, staff), locks and limits are checked by OpenVibe.Space.</p>

GET /api/v1/spaces/{space}/categories

List the spaces the caller can open and read one space's metadata (renamed from community.space.read, plan T10 D3: OpenVibe.Space owns the forum).

Capabilities
space.forum.read
Visibility
public
Parameters
  • space (path, required)
Response
application/json space.forum-read-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>space.forum.read</strong> (public): List the spaces the caller can open and read one space&#39;s metadata (renamed from community.space.read, plan T10 D3: OpenVibe.Space owns the forum). Anonymous callers see public spaces, signed-in people also members spaces, moderators also staff spaces; members-only (VIP) spaces are flagged. Served to anyone; Space checks space visibility itself.</p>

PUT /api/v1/spaces/{space}/categories/{category}

Manage forum spaces and moderation in OpenVibe.Space: create spaces, update settings and categories, manage moderators, and gate spaces to creator VIP members.

Capabilities
space.forum.manage
Visibility
internal
Parameters
  • space (path, required)
  • category (path, required)
Response
—
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>space.forum.manage</strong> (internal): Manage forum spaces and moderation in OpenVibe.Space: create spaces, update settings and categories, manage moderators, and gate spaces to creator VIP members. Service callers need space.forum.manage; people need discussion staff or a space moderator where supported. PUT /api/v1/spaces/:space/moderators/:subject refuses a block in either direction with 403 space.blocked (errors.problem@1). Other Space problem codes are documented in docs/space-problem-codes.md.</p>

DELETE /api/v1/spaces/{space}/categories/{category}

Manage forum spaces and moderation in OpenVibe.Space: create spaces, update settings and categories, manage moderators, and gate spaces to creator VIP members.

Capabilities
space.forum.manage
Visibility
internal
Parameters
  • space (path, required)
  • category (path, required)
Response
—
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>space.forum.manage</strong> (internal): Manage forum spaces and moderation in OpenVibe.Space: create spaces, update settings and categories, manage moderators, and gate spaces to creator VIP members. Service callers need space.forum.manage; people need discussion staff or a space moderator where supported. PUT /api/v1/spaces/:space/moderators/:subject refuses a block in either direction with 403 space.blocked (errors.problem@1). Other Space problem codes are documented in docs/space-problem-codes.md.</p>

PUT /api/v1/spaces/{space}/members-only

Manage forum spaces and moderation in OpenVibe.Space: create spaces, update settings and categories, manage moderators, and gate spaces to creator VIP members.

Capabilities
space.forum.manage
Visibility
internal
Parameters
  • space (path, required)
Response
—
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>space.forum.manage</strong> (internal): Manage forum spaces and moderation in OpenVibe.Space: create spaces, update settings and categories, manage moderators, and gate spaces to creator VIP members. Service callers need space.forum.manage; people need discussion staff or a space moderator where supported. PUT /api/v1/spaces/:space/moderators/:subject refuses a block in either direction with 403 space.blocked (errors.problem@1). Other Space problem codes are documented in docs/space-problem-codes.md.</p>

GET /api/v1/spaces/{space}/moderators

List the spaces the caller can open and read one space's metadata (renamed from community.space.read, plan T10 D3: OpenVibe.Space owns the forum).

Capabilities
space.forum.read
Visibility
public
Parameters
  • space (path, required)
Response
application/json space.forum-read-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>space.forum.read</strong> (public): List the spaces the caller can open and read one space&#39;s metadata (renamed from community.space.read, plan T10 D3: OpenVibe.Space owns the forum). Anonymous callers see public spaces, signed-in people also members spaces, moderators also staff spaces; members-only (VIP) spaces are flagged. Served to anyone; Space checks space visibility itself.</p>

PUT /api/v1/spaces/{space}/moderators/{subject}

Manage forum spaces and moderation in OpenVibe.Space: create spaces, update settings and categories, manage moderators, and gate spaces to creator VIP members.

Capabilities
space.forum.manage
Visibility
internal
Parameters
  • space (path, required)
  • subject (path, required)
Response
—
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>space.forum.manage</strong> (internal): Manage forum spaces and moderation in OpenVibe.Space: create spaces, update settings and categories, manage moderators, and gate spaces to creator VIP members. Service callers need space.forum.manage; people need discussion staff or a space moderator where supported. PUT /api/v1/spaces/:space/moderators/:subject refuses a block in either direction with 403 space.blocked (errors.problem@1). Other Space problem codes are documented in docs/space-problem-codes.md.</p>

DELETE /api/v1/spaces/{space}/moderators/{subject}

Manage forum spaces and moderation in OpenVibe.Space: create spaces, update settings and categories, manage moderators, and gate spaces to creator VIP members.

Capabilities
space.forum.manage
Visibility
internal
Parameters
  • space (path, required)
  • subject (path, required)
Response
—
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>space.forum.manage</strong> (internal): Manage forum spaces and moderation in OpenVibe.Space: create spaces, update settings and categories, manage moderators, and gate spaces to creator VIP members. Service callers need space.forum.manage; people need discussion staff or a space moderator where supported. PUT /api/v1/spaces/:space/moderators/:subject refuses a block in either direction with 403 space.blocked (errors.problem@1). Other Space problem codes are documented in docs/space-problem-codes.md.</p>

PUT /api/v1/spaces/{space}/settings

Manage forum spaces and moderation in OpenVibe.Space: create spaces, update settings and categories, manage moderators, and gate spaces to creator VIP members.

Capabilities
space.forum.manage
Visibility
internal
Parameters
  • space (path, required)
Response
—
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>space.forum.manage</strong> (internal): Manage forum spaces and moderation in OpenVibe.Space: create spaces, update settings and categories, manage moderators, and gate spaces to creator VIP members. Service callers need space.forum.manage; people need discussion staff or a space moderator where supported. PUT /api/v1/spaces/:space/moderators/:subject refuses a block in either direction with 403 space.blocked (errors.problem@1). Other Space problem codes are documented in docs/space-problem-codes.md.</p>

GET /api/v1/spaces/{space}/threads

Read a space's threads (hot, new or top, paged) and one thread with its posts, plus the RSS feeds (renamed from community.thread.read, plan T10 D3).

Capabilities
space.thread.read
Visibility
public
Parameters
  • space (path, required)
Response
application/json space.thread-read-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>space.thread.read</strong> (public): Read a space&#39;s threads (hot, new or top, paged) and one thread with its posts, plus the RSS feeds (renamed from community.thread.read, plan T10 D3). Space checks space visibility and the VIP gate (403 vip.members_only); writing threads and replies is space.post.write.</p>

POST /api/v1/spaces/{space}/threads

Forum writes as a service (renamed from community.post.create, plan T10 D3): create threads and replies in a space, vote on threads, and edit or delete one's own posts, as the acting subject (X-OV-Sub

Capabilities
space.post.write
Visibility
public
Parameters
  • space (path, required)
Request body
application/json space.post-write-request@1
Response
application/json space.post-write-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>space.post.write</strong> (public): Forum writes as a service (renamed from community.post.create, plan T10 D3): create threads and replies in a space, vote on threads, and edit or delete one&#39;s own posts, as the acting subject (X-OV-Subject) or as origin &quot;ai&quot; (no author, labelled as AI). Space visibility (public, members, staff), locks and limits are checked by OpenVibe.Space.</p>

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

Read a space's threads (hot, new or top, paged) and one thread with its posts, plus the RSS feeds (renamed from community.thread.read, plan T10 D3).

Capabilities
space.thread.read
Visibility
public
Parameters
  • space (path, required)
  • slug (path, required)
Response
application/json space.thread-read-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>space.thread.read</strong> (public): Read a space&#39;s threads (hot, new or top, paged) and one thread with its posts, plus the RSS feeds (renamed from community.thread.read, plan T10 D3). Space checks space visibility and the VIP gate (403 vip.members_only); writing threads and replies is space.post.write.</p>

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

Forum writes as a service (renamed from community.post.create, plan T10 D3): create threads and replies in a space, vote on threads, and edit or delete one's own posts, as the acting subject (X-OV-Sub

Capabilities
space.post.write
Visibility
public
Parameters
  • space (path, required)
  • slug (path, required)
Input
space.post-write-request@1
Response
application/json space.post-write-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>space.post.write</strong> (public): Forum writes as a service (renamed from community.post.create, plan T10 D3): create threads and replies in a space, vote on threads, and edit or delete one&#39;s own posts, as the acting subject (X-OV-Subject) or as origin &quot;ai&quot; (no author, labelled as AI). Space visibility (public, members, staff), locks and limits are checked by OpenVibe.Space.</p>

POST /api/v1/spaces/{space}/threads/{slug}/crosspost

Forum writes as a service (renamed from community.post.create, plan T10 D3): create threads and replies in a space, vote on threads, and edit or delete one's own posts, as the acting subject (X-OV-Sub

Capabilities
space.post.write
Visibility
public
Parameters
  • space (path, required)
  • slug (path, required)
Request body
application/json space.post-write-request@1
Response
application/json space.post-write-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>space.post.write</strong> (public): Forum writes as a service (renamed from community.post.create, plan T10 D3): create threads and replies in a space, vote on threads, and edit or delete one&#39;s own posts, as the acting subject (X-OV-Subject) or as origin &quot;ai&quot; (no author, labelled as AI). Space visibility (public, members, staff), locks and limits are checked by OpenVibe.Space.</p>

POST /api/v1/spaces/{space}/threads/{slug}/posts

Forum writes as a service (renamed from community.post.create, plan T10 D3): create threads and replies in a space, vote on threads, and edit or delete one's own posts, as the acting subject (X-OV-Sub

Capabilities
space.post.write
Visibility
public
Parameters
  • space (path, required)
  • slug (path, required)
Request body
application/json space.post-write-request@1
Response
application/json space.post-write-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>space.post.write</strong> (public): Forum writes as a service (renamed from community.post.create, plan T10 D3): create threads and replies in a space, vote on threads, and edit or delete one&#39;s own posts, as the acting subject (X-OV-Subject) or as origin &quot;ai&quot; (no author, labelled as AI). Space visibility (public, members, staff), locks and limits are checked by OpenVibe.Space.</p>

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

Manage forum spaces and moderation in OpenVibe.Space: create spaces, update settings and categories, manage moderators, and gate spaces to creator VIP members.

Capabilities
space.forum.manage
Visibility
internal
Parameters
  • space (path, required)
  • slug (path, required)
Response
—
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>space.forum.manage</strong> (internal): Manage forum spaces and moderation in OpenVibe.Space: create spaces, update settings and categories, manage moderators, and gate spaces to creator VIP members. Service callers need space.forum.manage; people need discussion staff or a space moderator where supported. PUT /api/v1/spaces/:space/moderators/:subject refuses a block in either direction with 403 space.blocked (errors.problem@1). Other Space problem codes are documented in docs/space-problem-codes.md.</p>

POST /api/v1/spaces/{space}/threads/{slug}/votes

Forum writes as a service (renamed from community.post.create, plan T10 D3): create threads and replies in a space, vote on threads, and edit or delete one's own posts, as the acting subject (X-OV-Sub

Capabilities
space.post.write
Visibility
public
Parameters
  • space (path, required)
  • slug (path, required)
Request body
application/json space.post-write-request@1
Response
application/json space.post-write-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>space.post.write</strong> (public): Forum writes as a service (renamed from community.post.create, plan T10 D3): create threads and replies in a space, vote on threads, and edit or delete one&#39;s own posts, as the acting subject (X-OV-Subject) or as origin &quot;ai&quot; (no author, labelled as AI). Space visibility (public, members, staff), locks and limits are checked by OpenVibe.Space.</p>

GET /s

List the spaces the caller can open and read one space's metadata (renamed from community.space.read, plan T10 D3: OpenVibe.Space owns the forum).

Capabilities
space.forum.read
Visibility
public
Response
application/json space.forum-read-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>space.forum.read</strong> (public): List the spaces the caller can open and read one space&#39;s metadata (renamed from community.space.read, plan T10 D3: OpenVibe.Space owns the forum). Anonymous callers see public spaces, signed-in people also members spaces, moderators also staff spaces; members-only (VIP) spaces are flagged. Served to anyone; Space checks space visibility itself.</p>

GET /s/{space}

Read a space's threads (hot, new or top, paged) and one thread with its posts, plus the RSS feeds (renamed from community.thread.read, plan T10 D3).

Capabilities
space.thread.read
Visibility
public
Parameters
  • space (path, required)
Response
application/json space.thread-read-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>space.thread.read</strong> (public): Read a space&#39;s threads (hot, new or top, paged) and one thread with its posts, plus the RSS feeds (renamed from community.thread.read, plan T10 D3). Space checks space visibility and the VIP gate (403 vip.members_only); writing threads and replies is space.post.write.</p>

GET /s/{space}/feed.xml

Read a space's threads (hot, new or top, paged) and one thread with its posts, plus the RSS feeds (renamed from community.thread.read, plan T10 D3).

Capabilities
space.thread.read
Visibility
public
Parameters
  • space (path, required)
Response
application/json space.thread-read-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>space.thread.read</strong> (public): Read a space&#39;s threads (hot, new or top, paged) and one thread with its posts, plus the RSS feeds (renamed from community.thread.read, plan T10 D3). Space checks space visibility and the VIP gate (403 vip.members_only); writing threads and replies is space.post.write.</p>

GET /s/{space}/t/{slug}

Read a space's threads (hot, new or top, paged) and one thread with its posts, plus the RSS feeds (renamed from community.thread.read, plan T10 D3).

Capabilities
space.thread.read
Visibility
public
Parameters
  • space (path, required)
  • slug (path, required)
Response
application/json space.thread-read-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>space.thread.read</strong> (public): Read a space&#39;s threads (hot, new or top, paged) and one thread with its posts, plus the RSS feeds (renamed from community.thread.read, plan T10 D3). Space checks space visibility and the VIP gate (403 vip.members_only); writing threads and replies is space.post.write.</p>

GET /s/feed.xml

Read a space's threads (hot, new or top, paged) and one thread with its posts, plus the RSS feeds (renamed from community.thread.read, plan T10 D3).

Capabilities
space.thread.read
Visibility
public
Response
application/json space.thread-read-result@1
Errors
errors.problem@1 (application/problem+json)
Description<p><strong>space.thread.read</strong> (public): Read a space&#39;s threads (hot, new or top, paged) and one thread with its posts, plus the RSS feeds (renamed from community.thread.read, plan T10 D3). Space checks space visibility and the VIP gate (403 vip.members_only); writing threads and replies is space.post.write.</p>