Skip to main content
GET
/
v1
/
scores
/
{id}
Get a score
curl --request GET \
  --url https://api.metal.ai/v1/scores/{id} \
  --header 'x-metal-api-key: <api-key>' \
  --header 'x-metal-client-id: <api-key>'
{
  "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.

Path Parameters

​
id
string
required

The score id.

Response

Retrieves a single score by id.

​
data
object