Skip to main content
POST
/
v1
/
model-cards
Create Model Card
curl --request POST \
  --url https://api.example.com/v1/model-cards \
  --header 'Content-Type: application/json' \
  --data '
{
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "report_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "training_metadata": {}
}
'
import requests

url = "https://api.example.com/v1/model-cards"

payload = {
"project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"report_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"training_metadata": {}
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
project_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
name: '<string>',
report_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
training_metadata: {}
})
};

fetch('https://api.example.com/v1/model-cards', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "<string>",
  "name": "<string>",
  "card_json": {},
  "report_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "version": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "training_metadata": {}
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}

Headers

authorization
string | null

Body

application/json
project_id
string<uuid>
required
name
string
required
report_ids
string<uuid>[]
required
training_metadata
Training Metadata · object | null

Response

Successful Response

id
string<uuid>
required
project_id
string<uuid>
required
organization_id
string
required
name
string
required
card_json
Card Json · object
required
report_ids
string<uuid>[]
required
version
integer
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
training_metadata
Training Metadata · object | null