ressource.socialbetadocumentation
API referenceAi

Rewrite a source's description with Claude

A short description written from the page's own text (same order as suggest-tags). With no readable text there is no call and nothing is spent. Refusals carry `details.assist`: `disabled` / `forbidden` (403 — the assists are off, or the user holds no grant), `quota_exceeded` (429), `no_page_text` (404 — nothing readable to rewrite from), `upstream` / `invalid_output` (500). Session callers only: a personal access token or an OAuth client gets 403.

POST
/api/v1/ai/rewrite-description

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

A short description written from the page's own text (same order as suggest-tags). With no readable text there is no call and nothing is spent. Refusals carry details.assist: disabled / forbidden (403 — the assists are off, or the user holds no grant), quota_exceeded (429), no_page_text (404 — nothing readable to rewrite from), upstream / invalid_output (500). Session callers only: a personal access token or an OAuth client gets 403.

Authorization

headerAuthorizationBearer <token>

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

Request Body

application/json
  1. body
url*string
Formaturi
Lengthlength <= 2048
title?|null
description?|null
page_text?string|null
locale?string
Value in"en""fr"

Response Body

The rewritten description

application/json
  1. response
description*string
curl -X POST 'https://www.ressource.social/api/v1/ai/rewrite-description' \  -H 'Content-Type: application/json' \  -d '{  "url": "http://example.com"}'
{  "description": "string"}