The Comments API from Sweep — 7 operation(s) for comments.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/sweep:sweep-comments-api"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.
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: 3.2.0
info:
title: Sweep Comments API
description: This is a publicly available Sweep API.
version: '0.1'
contact: {}
servers:
- url: https://api.sweep.io
description: Sweep production API — the host this document was harvested from (GET /api-json); /health responds here
tags:
- name: Comments
paths:
/comments/{funnelMapId}:
get:
operationId: CommentsController_fetchCommentThreadsByFunnelMapId
parameters:
- name: funnelMapId
required: true
in: path
schema:
type: string
- name: excludeResolved
required: true
in: query
schema:
type: boolean
responses:
'200':
description: ''
security:
- bearer: []
tags:
- Comments
summary: Comments controller fetch comment threads by funnel map id
x-summary-source: derived
post:
operationId: CommentsController_createCommentThread
parameters:
- name: funnelMapId
required: true
in: path
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateCommentThreadDto'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CommentThreadDto'
security:
- bearer: []
tags:
- Comments
summary: Comments controller create comment thread
x-summary-source: derived
/comments/{funnelMapId}/{commentThreadId}/resolved:
patch:
operationId: CommentsController_updateCommentThreadResolved
parameters:
- name: funnelMapId
required: true
in: path
schema:
type: string
- name: commentThreadId
required: true
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CommentThreadDto'
security:
- bearer: []
tags:
- Comments
summary: Comments controller update comment thread resolved
x-summary-source: derived
/comments/{funnelMapId}/{commentThreadId}/position:
patch:
operationId: CommentsController_updateCommentThreadPosition
parameters:
- name: funnelMapId
required: true
in: path
schema:
type: string
- name: commentThreadId
required: true
in: path
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateCommentThreadPositionDto'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CommentThreadDto'
security:
- bearer: []
tags:
- Comments
summary: Comments controller update comment thread position
x-summary-source: derived
/comments/{funnelMapId}/{commentThreadId}/read:
patch:
operationId: CommentsController_updateCommentThreadReadBy
parameters:
- name: funnelMapId
required: true
in: path
schema:
type: string
- name: commentThreadId
required: true
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CommentThreadDto'
security:
- bearer: []
tags:
- Comments
summary: Comments controller update comment thread read by
x-summary-source: derived
/comments/{funnelMapId}/{commentThreadId}/commentReplies:
post:
operationId: CommentsController_createCommentReply
parameters:
- name: funnelMapId
required: true
in: path
schema:
type: string
- name: commentThreadId
required: true
in: path
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateCommentReplyDto'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CommentReplyDto'
security:
- bearer: []
tags:
- Comments
summary: Comments controller create comment reply
x-summary-source: derived
/comments/{funnelMapId}/{commentThreadId}:
delete:
operationId: CommentsController_deleteCommentThread
parameters:
- name: funnelMapId
required: true
in: path
schema:
type: string
- name: commentThreadId
required: true
in: path
schema:
type: string
responses:
'200':
description: ''
security:
- bearer: []
tags:
- Comments
summary: Comments controller delete comment thread
x-summary-source: derived
/comments/{funnelMapId}/{commentThreadId}/commentReplies/{commentReplyId}:
delete:
operationId: CommentsController_deleteCommentReply
parameters:
- name: funnelMapId
required: true
in: path
schema:
type: string
- name: commentThreadId
required: true
in: path
schema:
type: string
- name: commentReplyId
required: true
in: path
schema:
type: string
responses:
'200':
description: ''
security:
- bearer: []
tags:
- Comments
summary: Comments controller delete comment reply
x-summary-source: derived
patch:
operationId: CommentsController_updateCommentReply
parameters:
- name: funnelMapId
required: true
in: path
schema:
type: string
- name: commentThreadId
required: true
in: path
schema:
type: string
- name: commentReplyId
required: true
in: path
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateCommentReplyDto'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CommentReplyDto'
security:
- bearer: []
tags:
- Comments
summary: Comments controller update comment reply
x-summary-source: derived
components:
schemas:
CommentThreadDto:
type: object
properties:
id:
type: string
positionX:
type: number
positionY:
type: number
isResolved:
type: boolean
isRead:
type: boolean
commentReplies:
type: array
items:
$ref: '#/components/schemas/CommentReplyDto'
createdById:
type: string
createdAt:
format: date-time
type: string
funnelMapId:
type: string
required:
- id
- positionX
- positionY
- isResolved
- commentReplies
- createdById
- createdAt
- funnelMapId
CreateCommentReplyDto:
type: object
properties:
commentBody:
type: string
mentionedUserIds:
type: array
items:
type: string
transientId:
type: string
required:
- commentBody
- mentionedUserIds
CreateCommentThreadDto:
type: object
properties:
positionX:
type: number
positionY:
type: number
commentBody:
type: string
mentionedUserIds:
type: array
items:
type: string
required:
- positionX
- positionY
- commentBody
- mentionedUserIds
UpdateCommentThreadPositionDto:
type: object
properties:
positionX:
type: number
positionY:
type: number
required:
- positionX
- positionY
UpdateCommentReplyDto:
type: object
properties:
commentBody:
type: string
mentionedUserIds:
type: array
items:
type: string
required:
- commentBody
- mentionedUserIds
CommentReplyDto:
type: object
properties:
id:
type: string
commentBody:
type: string
createdById:
type: string
createdAt:
format: date-time
type: string
updatedAt:
format: date-time
type: string
mentionedUserIds:
type: array
items:
type: string
required:
- id
- commentBody
- createdById
- createdAt
- updatedAt
- mentionedUserIds
securitySchemes:
bearer:
scheme: bearer
bearerFormat: JWT
type: http