Reports

Create a report

Upload an HTML report on behalf of the token's owner. Defaults to visibility: public with public_permission: comment (anyone with the link can read; commenting needs a free sign-in) so the returned share URL works out of the box; pass visibility: private to keep it unlisted (link permission is then forced to none). Optional inline assets are uploaded and relative references in the HTML (src/href/srcset/url(...)) are rewritten to stored URLs. Scope: reports:write. Rate limit: per-token sliding window (plan-aware — Free 60 req/min, Pro 600, Team/Enterprise 6000 by default); 429 responses carry a Retry-After header.

post/reports

Request

  • Base URL: https://commareports.com/api/v1
  • URL: https://commareports.com/api/v1/reports
  • Auth: HTTP bearer

Request body

htmlstring required

Required. Max 5 MB (413 above that).

titlestring

Defaults to 'Untitled report'.

descriptionstring
visibility'private' | 'registered' | 'public'

'team' and 'domain' cannot be set at create time — use PUT /reports/{id}/share.

public_permission'none' | 'view' | 'comment' | 'edit'

Link permission for /p/:id. Forced to 'none' when visibility is 'private'.

producer_namestring

Attribution chip on the public view.

producer_urlstring uri

http(s) only; anything else is dropped.

producer_icon_urlstring uri

http(s) only; anything else is dropped.

source_recipeobject

Arbitrary JSON object powering the 'Continue this run' modal (.prompt, .tools).

Response

Report created.

idstring uuid required
titlestring required
created_atstring date-time required
edit_urlstring uri required

Absolute editor URL (/r/:id).

share_urlstring uri required

Absolute public share URL (/p/:id).

urlstring uri required

Same as share_url.

Changes

No recorded changes to this operation across all 1 revision of this API.