Pin a version - Veri Documentation

POST

/

v1

/

models

/

{name}

/

versions

/

{version}

/

pin

Pin a version

curl --request POST \
  --url https://api.veri.studio/v1/models/{name}/versions/{version}/pin \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "pinned": true
}'

import requests

url = "https://api.veri.studio/v1/models/{name}/versions/{version}/pin"

payload = { "pinned": True }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({pinned: true})
};

fetch('https://api.veri.studio/v1/models/{name}/versions/{version}/pin', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "object": "<string>",
  "id": "<string>",
  "model_id": "<string>",
  "model": "<string>",
  "version": 123,
  "name": "<string>",
  "artifact_type": "<string>",
  "tags": [
    "<string>"
  ],
  "pinned": true,
  "status": "<string>",
  "aliases": [
    "<string>"
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "custom_model_id": "<string>",
  "dataset_snapshot_id": "<string>",
  "training_job_id": "<string>",
  "parent_version_id": "<string>",
  "pinned_at": "2023-11-07T05:31:56Z",
  "purged_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>"
}

Authorizations

Authorization

string

header

required

API key with the vk_ prefix. Create one from the dashboard.

Path Parameters

name

string

required

Lineage name

version

string

required

Version: "v3" or "3"

Body

application/json

Optional; defaults to pinned=true

pinned

boolean

true (default) pins; false unpins.

Response

The version with its new pinned state

One version of a lineage ({name}@v{version}).

object

string

required

Always "model_version".

id

string

required

Version id (mv...).

model_id

string

required

Lineage id.

model

string

required

Lineage name.

version

integer<int32>

required

Dense, monotonic version number within the lineage.

name

string

required

Human handle: "{model}@v{version}".

artifact_type

string

required

'full' | 'adapter'.

tags

string[]

required

pinned

boolean

required

Pinned versions are protected from retention.

status

string

required

'ready' | 'purged' (Task 6, VS-84). A purged version still lists — number, tags, audit and scorecards stay — but its weights are deleted and it can no longer be deployed, attached or promoted.

aliases

string[]

required

Aliases currently pointing at this version.

created_at

string<date-time>

required

custom_model_id

string | null

The library model (custom_models row) whose weights this version is; deploy or attach by this id.

dataset_snapshot_id

string | null

Dataset snapshot (Task 2) or plain dataset id the version was trained on.

training_job_id

string | null

parent_version_id

string | null

The version production pointed at when this one was registered.

pinned_at

string<date-time> | null

purged_at

string<date-time> | null

created_by

string | null

Pin a version

curl --request POST \
  --url https://api.veri.studio/v1/models/{name}/versions/{version}/pin \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "pinned": true
}'

import requests

url = "https://api.veri.studio/v1/models/{name}/versions/{version}/pin"

payload = { "pinned": True }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({pinned: true})
};

fetch('https://api.veri.studio/v1/models/{name}/versions/{version}/pin', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "object": "<string>",
  "id": "<string>",
  "model_id": "<string>",
  "model": "<string>",
  "version": 123,
  "name": "<string>",
  "artifact_type": "<string>",
  "tags": [
    "<string>"
  ],
  "pinned": true,
  "status": "<string>",
  "aliases": [
    "<string>"
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "custom_model_id": "<string>",
  "dataset_snapshot_id": "<string>",
  "training_job_id": "<string>",
  "parent_version_id": "<string>",
  "pinned_at": "2023-11-07T05:31:56Z",
  "purged_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>"
}