ressource.socialbetadocumentation

Quickstart

Read and write a ressource.social Library from a script, an app or an assistant, over the REST API or the MCP server.

ressource.social is where people save the web pages that matter to them, called sources, organise them in folders and tags, and share them with communities. Everything on this site is about reaching that from your own code.

The REST API (/api/v1) lets a script, a native app or a CLI read and write a person's Library: sources, folders, tags, the read-later queue and search, plus the conversation around them: reactions, comments, notifications, push devices, RSS feeds and uploads.

The MCP server gives an assistant such as Claude, Cursor or ChatGPT the same Library as a set of tools: search, list, read and save sources, manage folders and tags, move sources in bulk. A person connects it once and signs in; no code needed. See MCP.

Base URL

https://www.ressource.social/api/v1

Always use the www host. The bare domain redirects to it, and most HTTP clients drop the Authorization header when they follow a redirect, so a request to the apex arrives unauthenticated.

The machine-readable contract is public, OpenAPI 3.1: /api/v1/openapi.json. The API reference on this site is generated from it; generate a client from it in any language.

In three steps

Create a token

Sign in at ressource.social, open Settings → Integrations → API & assistants and choose Create a token. Copy it right away: it is shown once.

export BASE=https://www.ressource.social/api/v1
export TOKEN=rsk_…                      # Settings → Integrations → API & assistants

Make your first call

GET /me is the cheapest proof that a credential works.

curl -s -H "Authorization: Bearer $TOKEN" "$BASE/me"

Then list your newest sources:

curl -s -H "Authorization: Bearer $TOKEN" "$BASE/sources?limit=5" | jq '.items[] | {short_id, name, url}'

Go further

Read how responses and errors are shaped and how to page through lists, then browse every route in the API reference. Building in TypeScript? Start from the typed client.

What v1 covers

Sources, folders, tags, read later, search, URL metadata, reactions, comments, notifications, push devices, RSS and uploads. Managing communities and events is not in v1 yet; it is planned for v1.1, and the app remains the way to manage them until then. Sources shared into your communities are already readable.

On this page