Comma Reports API

Create, read, search, and update HTML reports.

GitHub OpenAPI

Operations 4

POST /reports Create a report #
GET /reports/search Full-text search reports #
GET /reports/{id} Fetch a report #
PATCH /reports/{id} Update a report in place #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/commareports-com:commareports-com-reports-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

commareports-com-reports-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Commareports Com Reports API
  version: 1.0.0
  contact:
    url: https://commareports.com/contact
  description: 'Operations tagged Reports across 2 of this provider''s published API definitions: commareports-com-openapi.json, commareports-com-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://commareports.com/api/v1
security:
- commaApiToken: []
tags:
- name: Reports
  description: Create, read, search, and update HTML reports.
paths:
  /reports:
    post:
      tags:
      - Reports
      operationId: createReport
      summary: Create a report
      description: '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.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReportCreateRequest'
      responses:
        '201':
          description: Report created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportCreated'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '413':
          $ref: '#/components/responses/PayloadTooLarge'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
    servers:
    - url: https://commareports.com/api/v1
  /reports/search:
    get:
      tags:
      - Reports
      operationId: searchReports
      summary: Full-text search reports
      description: 'Trigram search across reports the token''s owner owns, was invited to, or shares with their team (other people''s public share links are not searchable). Scope: `reports:read`.'
      parameters:
      - name: q
        in: query
        required: true
        schema:
          type: string
        description: Free-text query.
      - name: limit
        in: query
        schema:
          type: integer
          minimum: 1
          maximum: 20
          default: 5
      - name: include_html
        in: query
        schema:
          type: string
          enum:
          - 'true'
          - '1'
        description: If set, hydrates `html` for the top 3 results.
      responses:
        '200':
          description: Ranked matches.
          content:
            application/json:
              schema:
                type: object
                properties:
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/SearchResult'
                required:
                - results
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
    servers:
    - url: https://commareports.com/api/v1
  /reports/{id}:
    parameters:
    - $ref: '#/components/parameters/ReportId'
    get:
      tags:
      - Reports
      operationId: getReport
      summary: Fetch a report
      description: 'Report metadata plus the stored HTML. Access is gated by the same rule as the app (`can_view_report`); reports you can''t view return 404, not 403. Encrypted (`user_passphrase`) reports return 409 — API tokens cannot decrypt them. Scope: `reports:read`.'
      responses:
        '200':
          description: The report.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Report'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          description: Report is end-to-end encrypted; plaintext read is unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
    patch:
      tags:
      - Reports
      operationId: updateReport
      summary: Update a report in place
      description: 'Update `title`, `description`, and/or `html` (plus producer attribution fields). New HTML appends a revision — the share URL is stable. Requires edit access (`can_edit_report`: owner, admin, or editor) — 403 otherwise. Encrypted reports return 409. Scope: `reports:write`.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReportPatchRequest'
      responses:
        '200':
          description: Updated report summary.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportPatched'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          description: Report is encrypted; use the ciphertext endpoints instead.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '413':
          $ref: '#/components/responses/PayloadTooLarge'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
    servers:
    - url: https://commareports.com/api/v1
components:
  schemas:
    ReportCreated:
      type: object
      properties:
        id:
          type: string
          format: uuid
        title:
          type: string
        created_at:
          type: string
          format: date-time
        edit_url:
          type: string
          format: uri
          description: Absolute editor URL (/r/:id).
        share_url:
          type: string
          format: uri
          description: Absolute public share URL (/p/:id).
        url:
          type: string
          format: uri
          description: Same as share_url.
        assets:
          type: array
          items:
            $ref: '#/components/schemas/UploadedAsset'
      required:
      - id
      - title
      - created_at
      - edit_url
      - share_url
      - url
      - assets
    ReportPatched:
      type: object
      properties:
        id:
          type: string
          format: uuid
        title:
          type: string
        description:
          type:
          - string
          - 'null'
        updated_at:
          type: string
          format: date-time
        head_revision_id:
          type:
          - string
          - 'null'
          format: uuid
        edit_url:
          type: string
        share_url:
          type: string
      required:
      - id
      - title
      - updated_at
      - edit_url
      - share_url
    ReportCreateRequest:
      type: object
      properties:
        html:
          type: string
          description: Required. Max 5 MB (413 above that).
        title:
          type: string
          description: Defaults to 'Untitled report'.
        description:
          type: string
        visibility:
          type: string
          enum:
          - private
          - registered
          - public
          default: public
          description: '''team'' and ''domain'' cannot be set at create time — use PUT /reports/{id}/share.'
        public_permission:
          type: string
          enum:
          - none
          - view
          - comment
          - edit
          default: comment
          description: Link permission for /p/:id. Forced to 'none' when visibility is 'private'.
        producer_name:
          type: string
          maxLength: 80
          description: Attribution chip on the public view.
        producer_url:
          type: string
          format: uri
          description: http(s) only; anything else is dropped.
        producer_icon_url:
          type: string
          format: uri
          description: http(s) only; anything else is dropped.
        source_recipe:
          type: object
          description: Arbitrary JSON object powering the 'Continue this run' modal (.prompt, .tools).
        assets:
          type: array
          items:
            $ref: '#/components/schemas/InlineAssetInput'
          description: Inline assets; relative references in the HTML are rewritten to stored URLs.
      required:
      - html
    InlineAssetInput:
      type: object
      properties:
        relative_path:
          type: string
          description: POSIX-style path the HTML references, e.g. 'images/hero.png'. No leading slash, no '.'/'..' segments, no '%', '?' or '#'.
        content_base64:
          type: string
          description: Base64 file contents ('data:' URL prefix tolerated).
        content_type:
          type: string
          description: MIME type; defaults to application/octet-stream.
      required:
      - relative_path
      - content_base64
    SearchResult:
      type: object
      properties:
        id:
          type: string
          format: uuid
        title:
          type:
          - string
          - 'null'
        description:
          type:
          - string
          - 'null'
        snippet:
          type:
          - string
          - 'null'
        similarity:
          type: number
        url:
          type: string
          format: uri
          description: Absolute public URL.
        share_url:
          type: string
          format: uri
          description: Absolute /p/:id URL.
        html:
          type: string
          description: Present on the top 3 results when include_html was set.
      required:
      - id
      - similarity
      - url
      - share_url
    UploadedAsset:
      type: object
      properties:
        relative_path:
          type: string
        url:
          type: string
          format: uri
        mime:
          type: string
        size_bytes:
          type: integer
      required:
      - relative_path
      - url
      - mime
      - size_bytes
    ReportPatchRequest:
      type: object
      description: At least one property must be present.
      minProperties: 1
      properties:
        title:
          type: string
          description: Non-empty.
        description:
          type:
          - string
          - 'null'
          description: null clears it.
        html:
          type: string
          description: Non-empty, max 5 MB. Appends a revision (deduped when the content hash is unchanged).
        producer_name:
          type:
          - string
          - 'null'
          maxLength: 80
        producer_url:
          type:
          - string
          - 'null'
          description: http(s) only.
        producer_icon_url:
          type:
          - string
          - 'null'
          description: http(s) only.
        source_recipe:
          type:
          - object
          - 'null'
    Report:
      type: object
      properties:
        id:
          type: string
          format: uuid
        owner_id:
          type: string
          format: uuid
        title:
          type: string
        description:
          type:
          - string
          - 'null'
        html:
          type: string
          description: Rendered HTML (falls back to the original upload).
        visibility:
          type: string
          enum:
          - private
          - team
          - registered
          - public
          - domain
        public_permission:
          type: string
          enum:
          - none
          - view
          - comment
          - edit
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        producer_name:
          type:
          - string
          - 'null'
        producer_url:
          type:
          - string
          - 'null'
        producer_icon_url:
          type:
          - string
          - 'null'
        source_recipe:
          type:
          - object
          - 'null'
        edit_url:
          type: string
        share_url:
          type: string
      required:
      - id
      - owner_id
      - title
      - html
      - visibility
      - public_permission
      - created_at
      - updated_at
      - edit_url
      - share_url
    Error:
      type: object
      properties:
        error:
          type: string
      required:
      - error
  responses:
    ServerError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Missing, invalid, revoked, or expired token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Token missing the required scope, or no access to the resource.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimited:
      description: 'Rate limit exceeded. 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.'
      headers:
        Retry-After:
          schema:
            type: integer
          description: Seconds to wait before retrying.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Resource not found (also returned instead of 403 where existence must not leak).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    PayloadTooLarge:
      description: Payload exceeds a size limit (HTML > 5 MB; asset > 25 MB per file or > 250 MB per report).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Malformed body or invalid field.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  parameters:
    ReportId:
      name: id
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: Report id.
  securitySchemes:
    commaApiToken:
      type: http
      scheme: bearer
      bearerFormat: comma_sk_…
      description: Comma personal API token (Settings → API tokens). Scoped, revocable, optionally expiring. The same token also authenticates the MCP server at /api/mcp.
    supabaseSessionJwt:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Supabase user-session access token — the signed-in browser path. Only accepted where an operation explicitly lists it.
x-refined-from:
- commareports-com-openapi.json
- commareports-com-openapi.yml