API

API reference.

Floom API endpoints cover publishing, fetching, saving, and organizing knowledge, instructions, workflows, and skills under shareable links and libraries.

MethodPathAuthUse
POST/api/skillsSessionPublish a skill
GET/api/v1/skills/:slugOptionalFetch generic metadata and markdown
GET/s/:slugOptionalOpen the human-readable skill page
GET/s/:slug.mdOptionalFetch raw Markdown
GET/s/:slug.jsonOptionalFetch machine-readable metadata and Markdown
GET/api/meSessionFetch the signed-in user
POST/api/v1/skills/:slug/saveSessionSave a skill to your library
DELETE/api/v1/skills/:slug/saveSessionRemove a saved skill
GET/api/v1/me/librarySessionList saved skills
GET/api/v1/librariesOptionalList public starter libraries
POST/api/v1/librariesSessionCreate a library
GET/api/v1/libraries/:slugOptionalRead a visible library
POST/api/v1/libraries/:slug/skillsSessionAdd a skill to your library
POST/api/v1/me/subscriptionsSessionSubscribe to a library
PUT/api/v1/me/skills/:slug/overrideSessionSet folder and tag overrides
POST/api/skills

Publish a skill

Auth: Session
GET/api/v1/skills/:slug

Fetch generic metadata and markdown

Auth: Optional
GET/s/:slug

Open the human-readable skill page

Auth: Optional
GET/s/:slug.md

Fetch raw Markdown

Auth: Optional
GET/s/:slug.json

Fetch machine-readable metadata and Markdown

Auth: Optional
GET/api/me

Fetch the signed-in user

Auth: Session
POST/api/v1/skills/:slug/save

Save a skill to your library

Auth: Session
DELETE/api/v1/skills/:slug/save

Remove a saved skill

Auth: Session
GET/api/v1/me/library

List saved skills

Auth: Session
GET/api/v1/libraries

List public starter libraries

Auth: Optional
POST/api/v1/libraries

Create a library

Auth: Session
GET/api/v1/libraries/:slug

Read a visible library

Auth: Optional
POST/api/v1/libraries/:slug/skills

Add a skill to your library

Auth: Session
POST/api/v1/me/subscriptions

Subscribe to a library

Auth: Session
PUT/api/v1/me/skills/:slug/override

Set folder and tag overrides

Auth: Session

Publish

curl -X POST /api/skills \
  -H "Content-Type: application/json" \
  -d '{"title":"Example","body_md":"# Example"}'

Add from CLI

npx -y @floomhq/floom add https://floom.dev/s/ffas93ud --setup