Skip to main content
POST
/
v1
/
recommendations
Create Recommendation
curl --request POST \
  --url https://api.example.com/v1/recommendations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "description": "",
  "effort": "medium",
  "expected_loops_prevented": 0,
  "rank": 2,
  "patterns": []
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
title
string
required
Required string length: 1 - 300
​
type
enum<string>
required
Available options:
code_fix,
config_change,
process,
monitoring
​
impact
enum<string>
required
Available options:
high,
medium,
quick_win
​
description
string
default:""
Maximum string length: 5000
​
effort
string
default:medium
Maximum string length: 50
​
expected_loops_prevented
integer
default:0
Required range: x >= 0
​
rank
integer | null
Required range: x >= 1
​
patterns
Patterns · object[]

Response

Successful Response