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"
}
'
import requests

url = "https://api.example.com/api/v0/repositories/{repo_id}/ai/evaluate-draft-quality"

payload = {
    "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"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    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'
  })
};

fetch('https://api.example.com/api/v0/repositories/{repo_id}/ai/evaluate-draft-quality', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v0/repositories/{repo_id}/ai/evaluate-draft-quality",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v0/repositories/{repo_id}/ai/evaluate-draft-quality"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"category\": \"<string>\",\n  \"assetGroup\": {\n    \"assetGroupId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"assets\": [\n      \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    ]\n  },\n  \"safeHarborAssetIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"relatedFiles\": [\n    {\n      \"path\": \"<string>\",\n      \"lines\": {\n        \"start\": 123,\n        \"end\": 123\n      }\n    }\n  ],\n  \"commentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/api/v0/repositories/{repo_id}/ai/evaluate-draft-quality")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"category\": \"<string>\",\n  \"assetGroup\": {\n    \"assetGroupId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"assets\": [\n      \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    ]\n  },\n  \"safeHarborAssetIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"relatedFiles\": [\n    {\n      \"path\": \"<string>\",\n      \"lines\": {\n        \"start\": 123,\n        \"end\": 123\n      }\n    }\n  ],\n  \"commentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v0/repositories/{repo_id}/ai/evaluate-draft-quality")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"category\": \"<string>\",\n  \"assetGroup\": {\n    \"assetGroupId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"assets\": [\n      \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    ]\n  },\n  \"safeHarborAssetIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"relatedFiles\": [\n    {\n      \"path\": \"<string>\",\n      \"lines\": {\n        \"start\": 123,\n        \"end\": 123\n      }\n    }\n  ],\n  \"commentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body
{
  "qualityScore": 1,
  "templateCompliance": true,
  "hasPoc": true,
  "hasLikelihoodField": true,
  "hasImpactField": true,
  "hasRemediation": true,
  "isCodeLinked": true,
  "suggestionsWriting": "<string>",
  "isIssueClearlyDescribed": true,
  "isIssueReasonDescribed": true,
  "isLikelihoodImpactMatrixCorrect": true
}
{
  "msg": "<string>"
}
{
  "msg": "<string>"
}
{
  "msg": "<string>"
}
{
  "msg": "<string>"
}
{
  "msg": "<string>"
}

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
null | 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