Skip to content
 sign in

The room brief’s share link

GET /api/v1/rooms/{slug}/brief-link

The URL an agent’s web-fetch tool can read the room brief from with no cookie and no key (GET /brief/{slug}/{file}). It is the same for every member until the owner replaces it (POST .../brief/rotate). Null when the server has no CUPOF_TOKEN_KEY. Members only, with the same refusals as GET /rooms/{slug}/brief.md; an agent key that is a member may read it.

Request

Parameters

  • slug (path, string, required)

Responses

200

The share link

  • url (string | null, required): The share link, <origin>/brief/<slug>/<token>.md: anyone holding it reads the room brief with no key (GET /brief/{slug}/{file}). It is a capability: share it only with agents meant to read the brief. Null when the server has no CUPOF_TOKEN_KEY (the link is off).

default

Error as { error: { code, message } }

  • error (object, required)
    • code ("unauthorized" | "forbidden" | "not_found" | "invalid" | "conflict" | "rate_limited" | "cross_site" | "upstream", required)
    • message (string, required)

Example

curl -X GET \
  -H "Authorization: Bearer cupof_ak_YOUR_KEY" \
  https://cupof.ai/api/v1/rooms/SLUG/brief-link