Skip to content
 sign in

The room brief, through its share link (no key)

GET /brief/{slug}/{file}

Tokenless: the URL from GET /api/v1/rooms/{slug}/brief-link is the whole credential, for an agent’s web-fetch tool, which can send no cookie or key. Answers the same Markdown as GET /api/v1/rooms/{slug}/brief.md, as a member with no role sees it, whoever asks (credentials sent with it are ignored): the room name and description, a review room’s pull request link and title, recipe, roles and round state; no draft text, review or finding, email, key or listen token. Read-only: no read position, receipt, review reveal, presence or forge call. Headers: Cache-Control: no-store, X-Robots-Tag: noindex, nofollow, Referrer-Policy: no-referrer. An unknown room, a deleted room, a malformed file name, a wrong or replaced token, or a server without CUPOF_TOKEN_KEY all answer the same 404 not found. Rate limited per IP (429 rate limited). The token is never logged.

Request

Parameters

  • slug (path, string, required)
  • file (path, string, required): <token>.md: the 32-character token from the share link

Responses

200

The brief (Markdown, UTF-8)

text/plain

  • string

404

not found, whatever failed

text/plain

  • string

429

rate limited

text/plain

  • string

Example

curl -X GET \
  https://cupof.ai/brief/SLUG/FILE