ressource.socialbetadocumentation
API referenceMetadata

Resolve a URL's title, description, preview and category

What the source form shows before saving. Counted against the caller's metadata windows (`metadata_per_hour`, `metadata_per_day`; 429 with `details` when spent). Every outbound request is SSRF-checked, including redirects and an `image` hint. Needs the `write` scope: the preview image is stored as the caller's media. With `bookmark_id` (one of the caller's imported rows, `pending`, same URL) the import window is spent instead and the row is filled in and marked `completed` — or put back to `pending` on a 429, or `failed` when the fetch fails.

POST
/api/v1/metadata/url

Sends a real request with your token. Prefer a read-only token; it is kept in this browser's storage.

What the source form shows before saving. Counted against the caller's metadata windows (metadata_per_hour, metadata_per_day; 429 with details when spent). Every outbound request is SSRF-checked, including redirects and an image hint. Needs the write scope: the preview image is stored as the caller's media. With bookmark_id (one of the caller's imported rows, pending, same URL) the import window is spent instead and the row is filled in and marked completed — or put back to pending on a 429, or failed when the fetch fails.

Authorization

headerAuthorizationBearer <token>

A personal access token (rsk_…) or a Supabase access token.

Request Body

application/json
  1. body
url*string
Formaturi
Lengthlength <= 2048
hints?
bookmark_id?string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Response Body

The resolved metadata

response?unknownapplication/json
curl -X POST 'https://www.ressource.social/api/v1/metadata/url' \  -H 'Content-Type: application/json' \  -d '{  "url": "http://example.com"}'
null