Skip to main content
POST
/
v1
/
scores
Create a score
curl --request POST \
  --url https://api.metal.ai/v1/scores \
  --header 'Content-Type: application/json' \
  --header 'x-metal-api-key: <api-key>' \
  --header 'x-metal-client-id: <api-key>' \
  --data '
{
  "frameworkName": "<string>",
  "elementScores": [
    {
      "elementId": "<string>",
      "elementName": "<string>",
      "score": 123,
      "reasoning": "<string>",
      "confidence": 123
    }
  ],
  "finalScore": 50,
  "frameworkId": "<string>",
  "company": "<string>",
  "screeningId": "<string>",
  "metadata": {}
}
'
{
  "data": {
    "id": "<string>",
    "frameworkId": "<string>",
    "frameworkName": "<string>",
    "company": "<string>",
    "screeningId": "<string>",
    "finalScore": 78.5,
    "elementScores": [
      {
        "elementId": "<string>",
        "elementName": "<string>",
        "score": 123,
        "reasoning": "<string>",
        "confidence": 123
      }
    ],
    "metadata": {},
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

x-metal-client-id
string
header
required

The Client ID of your API key.

x-metal-api-key
string
header
required

The secret value of your API key.

Body

application/json
frameworkName
string
required
elementScores
object[]
required
finalScore
number
required
Required range: 0 <= x <= 100
frameworkId
string
company
string
screeningId
string
metadata
object

Response

Records a score against a scoring framework.

data
object