Skip to main content
POST
/
api
/
v0
/
repositories
/
{repo_id}
/
comments
/
files
/
{path}
Comment on a file.
curl --request POST \
  --url https://api.example.com/api/v0/repositories/{repo_id}/comments/files/{path} \
  --header 'Content-Type: application/json' \
  --data '
{
  "content": "<string>",
  "lines": {
    "start": 123,
    "end": 123
  },
  "parent": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Documentation Index

Fetch the complete documentation index at: https://docs.cantina.xyz/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

​
repo_id
string<uuid>
required
​
path
string
required

Body

application/json

Create a new comment on a file.

​
content
string
required

The content is expected to be valid markdown, but this is not validated at this time.

Users can "ping" other users by using:

  • @project to ping all company users associated with the company, or
  • @username to ping auditors (reviewers, judges and triagers) that are part of the repository.

A ping will cause the pinged user(s) to receive a notification.

​
lines
object

The line(s) refered to in the comment.

Notes

This must be not be used if parent is set.

​
parent
string<uuid> | null

Comment is in a reply to a thread.

Response

Comment made

​
id
string<uuid>
required