Spedy Docs

The Wiki provides a structured knowledge base for your organization. Content is organized into spaces, which contain pages and folders. Spaces can be linked to boards for project-specific documentation.

Spaces

List Spaces

GET /api/v1/wiki/spaces

Query Parameters

Parameter	Type	Required	Description
boardId	string	No	Filter spaces linked to a specific board

Example Response

[
  {
    "id": "ws_abc123",
    "name": "Engineering Handbook",
    "slug": "engineering-handbook",
    "description": "Internal engineering documentation",
    "icon": "book",
    "boardId": null,
    "createdAt": "2025-01-15T10:00:00Z"
  }
]

Create Space

POST /api/v1/wiki/spaces

Permission required: wiki:create

Rate limit: 10 per hour.

Request Body

Field	Type	Required	Description
name	string	Yes	Space name (max 100 characters)
slug	string	No	URL-friendly slug (auto-generated if omitted)
description	string	No	Space description (max 500 characters)
icon	string	No	Icon identifier
boardId	string	No	Board ID to link the space to
memberMode	string	No	`INHERIT_BOARD` or `MANAGE_SEPARATE`

Example Request

{
  "name": "Engineering Handbook",
  "description": "Internal engineering documentation"
}

Get Space

GET /api/v1/wiki/spaces/{spaceId}

Get Space Tree

GET /api/v1/wiki/spaces/{spaceId}/tree

Returns the full folder and page hierarchy of a space as a tree structure.

Update Space

PATCH /api/v1/wiki/spaces/{spaceId}

Wiki role required: manage

Delete Space

DELETE /api/v1/wiki/spaces/{spaceId}

Wiki role required: manage

Returns 204 No Content.

Get Linked Space for Board

GET /api/v1/wiki/spaces/board/{boardId}

Returns the wiki space linked to a specific board.

Pages

List Pages

GET /api/v1/wiki/spaces/{spaceId}/pages

Query Parameters

Parameter	Type	Required	Description
folderId	string	No	Filter by folder

Create Page

POST /api/v1/wiki/spaces/{spaceId}/pages

Wiki role required: edit or manage

Rate limit: 60 per hour.

Request Body

Field	Type	Required	Description
title	string	Yes	Page title (max 255 characters)
content	string	No	Page content (max 500,000 characters)
folderId	string	No	Parent folder ID
isPublished	boolean	No	Whether the page is published

Example Request

{
  "title": "Getting Started Guide",
  "content": "<h1>Welcome</h1><p>This guide covers...</p>",
  "isPublished": true
}

Get Page

GET /api/v1/wiki/spaces/{spaceId}/pages/{pageId}

Update Page

PATCH /api/v1/wiki/spaces/{spaceId}/pages/{pageId}

Wiki role required: edit or manage

Delete Page

DELETE /api/v1/wiki/spaces/{spaceId}/pages/{pageId}

Wiki role required: edit or manage

Returns 204 No Content.

Get Page Versions

GET /api/v1/wiki/spaces/{spaceId}/pages/{pageId}/versions

Returns the version history of a page.

Restore Page Version

POST /api/v1/wiki/spaces/{spaceId}/pages/{pageId}/versions/{versionId}/restore

Wiki role required: edit or manage

Restores a previous version of the page, creating a new version in the process.

Folders

List Folders

GET /api/v1/wiki/spaces/{spaceId}/folders

Query Parameters

Parameter	Type	Required	Description
parentId	string	No	Filter by parent folder

Create Folder

POST /api/v1/wiki/spaces/{spaceId}/folders

Wiki role required: edit or manage

Request Body

Field	Type	Required	Description
name	string	Yes	Folder name
parentId	string	No	Parent folder ID (for nesting)

Get Folder

GET /api/v1/wiki/spaces/{spaceId}/folders/{folderId}

Update Folder

PATCH /api/v1/wiki/spaces/{spaceId}/folders/{folderId}

Wiki role required: edit or manage

Delete Folder

DELETE /api/v1/wiki/spaces/{spaceId}/folders/{folderId}

Wiki role required: edit or manage

Query Parameters

Parameter	Type	Required	Description
deleteContents	boolean	No	Also delete all pages and subfolders (default: false)

Returns 204 No Content. If deleteContents is false and the folder is not empty, the request will fail.

Wiki

On this page