POST
/
v1
/
scoring_config
curl --request POST \
  --url https://api.getscorecard.ai/v1/scoring_config \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "name": "Scoring Config Name",
  "description": "Description of the scoring config",
  "metrics": [
    1,
    2,
    3
  ],
  "project_id": 1
}'
{
  "org_id": "<string>",
  "user_id": "<string>",
  "id": 123,
  "name": "<string>",
  "description": "<string>",
  "config": {},
  "is_archived": true,
  "metrics": [
    123
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "project_id": 1
}

Authorizations

​
X-API-Key
string
header
required

Body

application/json

The parameters to create a new scoring config.

​
name
string | null
Example:

"Scoring Config Name"

​
description
string | null
Example:

"This scoring config contains a set of metrics measuring the correctness of the model"

​
metrics
integer[] | null
Example:
[1, 2, 3]
​
project_id
integer
Example:

1

Response

200
application/json
Successful Response
​
org_id
string | null

The organization this resource belongs to.

​
user_id
string | null

The user this record belongs to.

​
id
integer | null
​
name
string | null
​
description
string | null
​
config
object | null
​
is_archived
boolean | null
default:false
​
metrics
integer[] | null
​
created_at
string | null
​
project_id
integer | null

The ID of the project the scoring config belongs to.

Example:

1

Was this page helpful?