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": {}
}
'import requests
url = "https://api.metal.ai/v1/scores"
payload = {
"frameworkName": "<string>",
"elementScores": [
{
"elementId": "<string>",
"elementName": "<string>",
"score": 123,
"reasoning": "<string>",
"confidence": 123
}
],
"finalScore": 50,
"frameworkId": "<string>",
"company": "<string>",
"screeningId": "<string>",
"metadata": {}
}
headers = {
"x-metal-client-id": "<api-key>",
"x-metal-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-metal-client-id': '<api-key>',
'x-metal-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
frameworkName: '<string>',
elementScores: [
{
elementId: '<string>',
elementName: '<string>',
score: 123,
reasoning: '<string>',
confidence: 123
}
],
finalScore: 50,
frameworkId: '<string>',
company: '<string>',
screeningId: '<string>',
metadata: {}
})
};
fetch('https://api.metal.ai/v1/scores', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.metal.ai/v1/scores"
payload := strings.NewReader("{\n \"frameworkName\": \"<string>\",\n \"elementScores\": [\n {\n \"elementId\": \"<string>\",\n \"elementName\": \"<string>\",\n \"score\": 123,\n \"reasoning\": \"<string>\",\n \"confidence\": 123\n }\n ],\n \"finalScore\": 50,\n \"frameworkId\": \"<string>\",\n \"company\": \"<string>\",\n \"screeningId\": \"<string>\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-metal-client-id", "<api-key>")
req.Header.Add("x-metal-api-key", "<api-key>")
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))
}{
"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"
}
}{
"error": "Invalid request body"
}{
"error": "invalid api key or clientId"
}Create a score
Records a score against a scoring framework.
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": {}
}
'import requests
url = "https://api.metal.ai/v1/scores"
payload = {
"frameworkName": "<string>",
"elementScores": [
{
"elementId": "<string>",
"elementName": "<string>",
"score": 123,
"reasoning": "<string>",
"confidence": 123
}
],
"finalScore": 50,
"frameworkId": "<string>",
"company": "<string>",
"screeningId": "<string>",
"metadata": {}
}
headers = {
"x-metal-client-id": "<api-key>",
"x-metal-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-metal-client-id': '<api-key>',
'x-metal-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
frameworkName: '<string>',
elementScores: [
{
elementId: '<string>',
elementName: '<string>',
score: 123,
reasoning: '<string>',
confidence: 123
}
],
finalScore: 50,
frameworkId: '<string>',
company: '<string>',
screeningId: '<string>',
metadata: {}
})
};
fetch('https://api.metal.ai/v1/scores', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.metal.ai/v1/scores"
payload := strings.NewReader("{\n \"frameworkName\": \"<string>\",\n \"elementScores\": [\n {\n \"elementId\": \"<string>\",\n \"elementName\": \"<string>\",\n \"score\": 123,\n \"reasoning\": \"<string>\",\n \"confidence\": 123\n }\n ],\n \"finalScore\": 50,\n \"frameworkId\": \"<string>\",\n \"company\": \"<string>\",\n \"screeningId\": \"<string>\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-metal-client-id", "<api-key>")
req.Header.Add("x-metal-api-key", "<api-key>")
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))
}{
"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"
}
}{
"error": "Invalid request body"
}{
"error": "invalid api key or clientId"
}Authorizations
The Client ID of your API key.
The secret value of your API key.
Body
application/json
Response
Records a score against a scoring framework.
Show child attributes
Show child attributes
⌘I

