Skip to main content
POST
/
api
/
v0
/
repositories
/
{repo_id}
/
ai
/
evaluate-draft-quality
Evaluate the quality of a finding before submitting it.
curl --request POST \
  --url https://api.example.com/api/v0/repositories/{repo_id}/ai/evaluate-draft-quality \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "category": "<string>",
  "assetGroup": {
    "assetGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "assets": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ]
  },
  "safeHarborAssetIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "relatedFiles": [
    {
      "path": "<string>",
      "lines": {
        "start": 123,
        "end": 123
      }
    }
  ],
  "commentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "qualityScore": 1,
  "templateCompliance": true,
  "hasPoc": true,
  "hasLikelihoodField": true,
  "hasImpactField": true,
  "hasRemediation": true,
  "isCodeLinked": true,
  "suggestionsWriting": "<string>",
  "isIssueClearlyDescribed": true,
  "isIssueReasonDescribed": true,
  "isLikelihoodImpactMatrixCorrect": true
}

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

Body

application/json
title
string
required
description
string
required
severity
enum<string>
required

Severity of a [Finding].

Available options:
critical,
high,
medium,
low,
informational,
gas_optimization
likelihood
null | enum<string>

Likelihood of a [Finding].

Available options:
high,
medium,
low
impact
null | enum<string>

Impact of a [Finding].

Available options:
high,
medium,
low
category
string | null
assetGroup
object
safeHarborAssetIds
string<uuid>[]
commentId
string<uuid> | null

Populate it if the new finding originates from a file comment

Response

AI response

The response of evaluating a finding draft via AI

qualityScore
integer<int32>
required
Required range: x >= 0
templateCompliance
boolean
required
hasPoc
boolean
required
hasLikelihoodField
boolean
required
hasImpactField
boolean
required
hasRemediation
boolean
required
isCodeLinked
boolean
required
suggestionsWriting
string
required
isIssueClearlyDescribed
boolean
required
isIssueReasonDescribed
boolean
required
isLikelihoodImpactMatrixCorrect
boolean
required