Storyden
Misc

Get Info

Get the basic forum installation info such as title, description, etc. This is a fully public endpoint as it drives the ability to render stuff like OpenGraph metadata, favicon, titles, descriptions, for crawlers.

GET
/info

Get the basic forum installation info such as title, description, etc.

This is a fully public endpoint as it drives the ability to render stuff like OpenGraph metadata, favicon, titles, descriptions, for crawlers.

Response Body

OK

application/json
  1. response

Basic public information about the Storyden installation.

title*string
description*string
content*PostContent

Rich HTML content.

Storyden owns the HTML id attribute in this content. Client-supplied id attributes are ignored and removed during sanitisation.

For block-aware resources such as threads, replies, library nodes, and node versions, successful create and update operations assign stable server-owned block IDs to addressable block elements using the sdb_ prefix, for example <p id="sdb_d46b4s1fs0s8b8j6k2g0">. On updates, Storyden preserves existing sdb_ block IDs where the corresponding block can be matched across edits, so links and references to specific blocks can remain stable as content moves.

Read operations do not assign missing block IDs. Content created before block IDs were assigned, or content where a particular block has no server-owned ID yet, may be returned without block IDs until that resource is next written.

accent_colour*string
onboarding_status*OnboardingStatus

Derived from data state, indicates what stage in the onboarding process the Storyden installation is in for directing first-time setup steps.

Value in"requires_first_account""requires_category""requires_more_accounts""requires_first_post""complete"
authentication_mode*AuthMode
Value in"handle""email""phone"
registration_mode*RegistrationMode

The mode of registration for the instance, which determines how new accounts can be created. This is a global setting that affects the whole instance and is used to control whether new users can register on their own, need an invitation, or if registration is completely disabled.

When set to "public", anyone can register for a new account without any special prerequisites. When set to "invitation", new accounts can only be created if they have a valid invitation code, which can be generated by existing users with the required permission. When set to "disabled", new account registration is completely disabled and accounts can only be provisioned using the API.

Value in"public""invitation""disabled"
discovery?

Public discovery and crawler preferences, configurable by administrators at runtime.

capabilities*array<>
web_address*string

The public web frontend address for this Storyden instance.

Formaturi
api_address*string

The public API address for this Storyden instance.

Formaturi
metadata?

Arbitrary metadata for the resource.

motd?
web_push_public_key?string

Present when Web Push is enabled on the instance. Unpadded base64url-encoded VAPID public key for PushManager.subscribe().

Example Request
curl -X GET 'https://example.com/api/info'
Example Response
{  "title": "string",  "description": "string",  "content": "string",  "accent_colour": "string",  "onboarding_status": "requires_first_account",  "authentication_mode": "handle",  "registration_mode": "public",  "discovery": {    "search_indexing": true,    "training_crawling": true,    "llms_txt": true,    "auth_md": true,    "ai_catalog": true,    "api_catalog": true,    "mcp_server_card": true,    "robots_txt": "string"  },  "capabilities": [    "plugins"  ],  "web_address": "http://example.com",  "api_address": "http://example.com",  "metadata": {},  "motd": {    "content": "string",    "start_at": "2019-08-24T14:15:22Z",    "end_at": "2019-08-24T14:15:22Z",    "metadata": {}  },  "web_push_public_key": "string"}