A family: its dataset and where it started, its switch and the model it serves, its
models with their own switches, keep warm, its fine-tunes with how each ended, what each
cost and why it made no model, and what continuing it would do now (continue): train
on the dataset’s newest version, or why it can’t yet, with the rows it would take and
the fee it would hold.
Its idle clock: the latest of its last production call by an API key that named it, its last evaluation that named it, and when it was switched on.
switches_off_at
number | null
required
When idling switches it off unless it's used. Null while it is off or kept warm on its own switch, and when idling never switches anything off. A family's is also null while it serves no model.
off_reason
enum<string> | null
required
Why it is off: owner when it was switched off by hand, idle when nothing used it for too long. Null otherwise.
Available options:
owner,
idle
off_at
number | null
required
When it went off, with off_reason. Null otherwise.
dataset_id
string
required
The dataset it grows on.
origin
string
required
Where it started: a base model, or one of your models.
created_at
number
required
When it was named, as its first fine-tune was queued.
served
ModelVersion · object | null
required
The model calls to its name get while it is switched on, or null for none yet.
Every model of its line, oldest first. A deleted one shows only where it stood.
ModelVersion
DeletedModelVersion
Show child attributes
keep_warm
boolean
required
keep_warm_window
KeepWarmWindow · object | null
required
The hour of keep warm being billed for the model the family serves, while the family is kept warm. Null otherwise: a model kept warm on its own shows its own hour.
Show child attributes
keep_warm_stopped_at
number | null
required
When keep warm switched off because the next hour couldn't be reserved, while it stays off. Otherwise null.
move
FamilyMove · object | null
required
The move to its latest model it waits to make, and what it waits for. Null while it serves its latest model, or is switched off.
Show child attributes
moved
FamilyMoved · object | null
required
When it last moved by itself to the model it serves, and from which. Null when it never did, or serves another model or was rolled back since.
Show child attributes
continue
Continuation · object | null
What continuing it would do now, from the family's dataset and jobs. It doesn't check credit, storage allowance or queue room, which the start refuses with insufficient_credit, storage_allowance, queue_full or tenant_queue_full. A list of families reads no dataset: there new_data and retry only say a version no finished job used is waiting, and the counts and fee are null. The answers of a switch, keep warm or rollback leave it out.
Show child attributes
jobs
FamilyJob · object[]
Its fine-tunes, newest first, with how each ended. Lists of families, and the answers of a switch, keep warm or rollback, leave it out.
{"docsConfig":{"theme":"sequoia","$schema":"https://mintlify.com/docs.json","name":"OneHot","description":"Decisions your application can act on. Build, evaluate and improve with OneHot.","colors":{"primary":"#555555","light":"#B0B0B0","dark":"#555555"},"logo":"https://mintcdn.com/sqwishai/DckT8DnfX584QrKL/images/sqwish.png?fit=max\u0026auto=format\u0026n=DckT8DnfX584QrKL\u0026q=85\u0026s=bc446299f18ab06437c9fc4cd723c188","favicon":"https://mintcdn.com/sqwishai/kKumWj08JcS35zZs/images/favicon.png?fit=max\u0026auto=format\u0026n=kKumWj08JcS35zZs\u0026q=85\u0026s=6276444493fc860ed9af71a1ec903f60","api":{"playground":{"display":"interactive","proxy":true},"examples":{"languages":["bash","python","javascript"]}},"appearance":{"default":"dark"},"background":{"color":{"light":"#FCFAF8","dark":"#1E1E1E"}},"navbar":{"links":[{"href":"mailto:help@sqwish.ai","label":"Support"}],"primary":{"type":"button","label":"Open console","href":"https://console.sqwish.ai"}},"integrations":{"telemetry":{"enabled":false}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"llms.txt","icon":"file-lines","href":"https://api.sqwish.ai/llms.txt"},{"anchor":"openapi.json","icon":"file-code","href":"https://api.sqwish.ai/openapi.json"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"sqwishai","hasAudioNarration":false,"actualSubdomain":"sqwishai","customDomains":["docs.sqwish.ai"],"gitSource":{"type":"github","owner":"sqwishai","repo":"decisionone-workbench","deployBranch":"main","contentDirectory":"docs/public","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6afa56188ab3673930464953","clientVersion":"0.0.4271","searchFilterCounts":[{"language":"default","tag":"API Reference","count":80},{"language":"default","tag":"Documentation","count":34},{"language":"default","tag":"Examples","count":12},{"language":"default","tag":"Labelling","count":12},{"language":"default","tag":"Datasets","count":11},{"language":"default","tag":"Families","count":10},{"language":"default","tag":"Improve accuracy","count":8},{"language":"default","tag":"Make decisions","count":7},{"language":"default","tag":"Decisions","count":7},{"language":"default","tag":"Models","count":7}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"styles.css","content":"@font-face{font-family:\"Chesna Grotesk\";src:url(\"/fonts/chesna-grotesk-400.woff2\") format(\"woff2\");font-weight:400;font-style:normal;font-display:swap;size-adjust:105.5%}@font-face{font-family:\"Chesna Grotesk\";src:url(\"/fonts/chesna-grotesk-500.woff2\") format(\"woff2\");font-weight:500;font-style:normal;font-display:swap;size-adjust:105.5%}@font-face{font-family:\"Chesna Grotesk\";src:url(\"/fonts/chesna-grotesk-600.woff2\") format(\"woff2\");font-weight:600;font-style:normal;font-display:swap;size-adjust:105.5%}html{--font-family-body-custom: \"Chesna Grotesk\", sans-serif;--font-family-headings-custom: \"Chesna Grotesk\", sans-serif;--sqwish-accent-light: 168 54 127;--sqwish-accent-dark: 240 138 204;--sqwish-chase-docs: 168 54 127;--sqwish-chase-api: 41 118 81;--sqwish-chase-examples: 138 90 0;--sqwish-accent: var(--sqwish-accent-light);--sqwish-pink-ink: 168 54 127;--sqwish-page: 252 250 248;--sqwish-sunk: 247 246 242;--sqwish-sunk-2: 243 241 237;--sqwish-surface: var(--sqwish-page);--sqwish-border: 223 223 223;--sqwish-text: 30 30 30;--sqwish-muted: 99 99 99;--sqwish-sidebar-label-opacity: 0.7;--sqwish-topbar-height: 3.5rem;--mintlify-slot-header-height: calc(var(--sqwish-topbar-height) + 3.5rem)}html.dark{--sqwish-accent: var(--sqwish-accent-dark);--sqwish-chase-docs: 240 138 204;--sqwish-chase-api: 0 210 126;--sqwish-chase-examples: 245 167 50;--sqwish-pink-ink: 240 138 204;--sqwish-page: 30 30 30;--sqwish-sunk: 38 38 38;--sqwish-sunk-2: 47 47 47;--sqwish-surface: var(--sqwish-page);background-color:#1e1e1e;--sqwish-border: 56 56 56;--sqwish-text: 240 240 240;--sqwish-muted: 174 174 174;--sqwish-sidebar-label-opacity: 0.58}html[data-current-path^=\"/api-reference/\"]{--sqwish-accent-light: 41 118 81;--sqwish-accent-dark: 0 210 126}html[data-current-path^=\"/examples/\"]{--sqwish-accent-light: 138 90 0;--sqwish-accent-dark: 245 167 50}#navbar>div>div:has(.nav-logo){height:var(--sqwish-topbar-height)}#navbar>div>div:has(.nav-tabs,>button){background-color:rgb(var(--sqwish-surface))}.nav-tabs{background-color:transparent}.nav-tabs-item[data-active=\"true\"]{color:rgb(var(--sqwish-text))}:is(.nav-tabs-item,.mobile-nav-tabs-item):is([href=\"/introduction\"],[href^=\"/api-reference/\"],[href^=\"/examples/\"]){align-self:stretch;margin:0;padding-inline:0.85rem;border:0;border-radius:0;background-color:transparent;color:rgb(var(--sqwish-muted))}:is(.nav-tabs-item,.mobile-nav-tabs-item):is([href=\"/introduction\"],[href^=\"/api-reference/\"],[href^=\"/examples/\"])>div{height:2px;border-radius:0;background-color:transparent}:is(.nav-tabs-item,.mobile-nav-tabs-item)[href=\"/introduction\"]{--tab-tint: var(--sqwish-chase-docs)}:is(.nav-tabs-item,.mobile-nav-tabs-item)[href^=\"/api-reference/\"]{--tab-tint: var(--sqwish-chase-api)}:is(.nav-tabs-item,.mobile-nav-tabs-item)[href^=\"/examples/\"]{--tab-tint: var(--sqwish-chase-examples)}:is(.nav-tabs-item,.mobile-nav-tabs-item):is([href=\"/introduction\"],[href^=\"/api-reference/\"],[href^=\"/examples/\"]):is(:hover,[data-active=\"true\"]){background-color:transparent}:is(.nav-tabs-item,.mobile-nav-tabs-item):is([href=\"/introduction\"],[href^=\"/api-reference/\"],[href^=\"/examples/\"])[data-active=\"true\"]{color:rgb(var(--tab-tint))}:is(.nav-tabs-item,.mobile-nav-tabs-item):is([href=\"/introduction\"],[href^=\"/api-reference/\"],[href^=\"/examples/\"])[data-active=\"true\"]>div{height:2px;background-color:rgb(var(--tab-tint))}#table-of-contents-content a[aria-current=\"location\"]{color:rgb(var(--sqwish-accent))}@supports (animation-timeline: scroll()){#table-of-contents-content{--sqwish-toc-rest: 84 84 84}html.dark #table-of-contents-content{--sqwish-toc-rest: 161 161 161}#table-of-contents-content li:last-child>a{animation:sqwish-toc-arrive linear forwards;animation-timeline:scroll(root);animation-range:calc(100% - 1px) 100%}#table-of-contents-content li:not(:last-child)>a[aria-current=\"location\"]{animation:sqwish-toc-yield linear forwards;animation-timeline:scroll(root);animation-range:calc(100% - 1px) 100%}}@keyframes sqwish-toc-arrive{to{color:rgb(var(--sqwish-accent));text-shadow:-0.15px 0 0 currentColor, 0.15px 0 0 currentColor}}@keyframes sqwish-toc-yield{to{color:rgb(var(--sqwish-toc-rest));text-shadow:none}}@media (hover: hover){#pagination a:hover :is([data-component-part=\"pagination-chevron\"],[data-component-part=\"pagination-label\"]){color:rgb(var(--sqwish-accent))}}#sidebar-content a[aria-current=\"page\"],#mobile-nav a[aria-current=\"page\"]{border-radius:8px;background-color:rgb(var(--sqwish-sunk-2));color:rgb(var(--sqwish-accent))}html[data-current-path^=\"/api-reference/\"] :is(#sidebar-content,#mobile-nav) a[aria-current=\"page\"]:has(.bg-\\[\\#2AB673\\])>div:last-child{color:#007141}html[data-current-path^=\"/api-reference/\"] :is(#sidebar-content,#mobile-nav) a[aria-current=\"page\"]:has(.bg-\\[\\#3064E3\\])>div:last-child{color:#3a5aa1}html[data-current-path^=\"/api-reference/\"] :is(#sidebar-content,#mobile-nav) a[aria-current=\"page\"]:has(.bg-\\[\\#CB3A32\\])>div:last-child{color:#963e36}html[data-current-path^=\"/api-reference/\"] :is(#sidebar-content,#mobile-nav) a[aria-current=\"page\"]:has(.bg-\\[\\#DA622B\\])>div:last-child{color:#914511}html[data-current-path^=\"/api-reference/\"] :is(#sidebar-content,#mobile-nav) a[aria-current=\"page\"]:has(.bg-\\[\\#C28C30\\])>div:last-child{color:#7c5600}html.dark[data-current-path^=\"/api-reference/\"] :is(#sidebar-content,#mobile-nav) a[aria-current=\"page\"]:has(.bg-\\[\\#2AB673\\])>div:last-child{color:#a6eac1}html.dark[data-current-path^=\"/api-reference/\"] :is(#sidebar-content,#mobile-nav) a[aria-current=\"page\"]:has(.bg-\\[\\#3064E3\\])>div:last-child{color:#b9d8ff}html.dark[data-current-path^=\"/api-reference/\"] :is(#sidebar-content,#mobile-nav) a[aria-current=\"page\"]:has(.bg-\\[\\#CB3A32\\])>div:last-child{color:#ffc1b8}html.dark[data-current-path^=\"/api-reference/\"] :is(#sidebar-content,#mobile-nav) a[aria-current=\"page\"]:has(.bg-\\[\\#DA622B\\])>div:last-child{color:#ffc7a4}html.dark[data-current-path^=\"/api-reference/\"] :is(#sidebar-content,#mobile-nav) a[aria-current=\"page\"]:has(.bg-\\[\\#C28C30\\])>div:last-child{color:#f3d394}html.dark[data-current-path^=\"/api-reference/\"] :is(#sidebar-content,#mobile-nav) .method-nav-pill>.text-green-700{background-color:rgb(103 208 150 / 0.2);color:#7ddea8}html.dark[data-current-path^=\"/api-reference/\"] :is(#sidebar-content,#mobile-nav) .method-nav-pill>.text-blue-700{background-color:rgb(141 182 255 / 0.2);color:#8db6ff}html.dark[data-current-path^=\"/api-reference/\"] :is(#sidebar-content,#mobile-nav) .method-nav-pill>.text-red-700{background-color:rgb(255 150 137 / 0.2);color:#ff9689}html.dark[data-current-path^=\"/api-reference/\"] :is(#sidebar-content,#mobile-nav) .method-nav-pill>.text-orange-700{background-color:rgb(250 157 106 / 0.2);color:#fa9d6a}html.dark[data-current-path^=\"/api-reference/\"] :is(#sidebar-content,#mobile-nav) .method-nav-pill>.text-yellow-700{background-color:rgb(221 176 76 / 0.2);color:#ddb04c}html.dark[data-current-path^=\"/api-reference/\"] :is(#sidebar-content,#mobile-nav) a[aria-current=\"page\"] .method-nav-pill>.bg-\\[\\#2AB673\\]{background-color:#62c896;color:#f4fbf7}:is(#sidebar-content,#mobile-nav) .sidebar-title,#header .eyebrow{font-size:0.6875rem;font-weight:700;letter-spacing:0.09em;text-transform:uppercase}.onehot-endpoint{display:flex;flex-wrap:wrap;align-items:baseline;gap:0.55rem 0.85rem;margin:0.25rem 0 1.75rem;padding:0.8rem 1rem;border:1px solid rgb(var(--sqwish-border));border-radius:0.85rem;background:rgb(var(--sqwish-text) / 0.045)}.onehot-endpoint-label{font-size:0.68rem;font-weight:650;letter-spacing:0.08em;text-transform:uppercase;color:rgb(var(--sqwish-text) / 0.5)}.onehot-endpoint a,.onehot-endpoint a:hover{color:inherit;text-decoration:none;background-image:none;box-shadow:none;border-bottom:0}.onehot-endpoint code{font-weight:650;background:transparent;border:0;box-shadow:none;text-decoration:none;color:rgb(var(--sqwish-text))}.onehot-endpoint-meta{color:rgb(var(--sqwish-text) / 0.62)}#sidebar-content,#mobile-nav{border-right-width:0;background-color:rgb(var(--sqwish-page))}#sidebar-content #navigation-items>[data-component-part=\"scroll-area-viewport\"]{padding:1.25rem 0.375rem 1.5rem}:is(#sidebar-content,#mobile-nav) [data-component-part=\"scroll-area-content\"]>.text-sm{display:flex;flex-direction:column;min-height:100%}:is(#sidebar-content,#mobile-nav) [data-component-part=\"scroll-area-content\"]>.text-sm>div:has(.sidebar-group):first-of-type{margin-top:0}:is(#sidebar-content,#mobile-nav) [data-component-part=\"scroll-area-content\"]>.text-sm>ul:has(>li>a.nav-anchor){order:1;margin-top:2.75rem;padding-bottom:4.5rem}:is(#sidebar-content,#mobile-nav) [data-component-part=\"scroll-area-content\"]>.text-sm>ul:has(>li>a.nav-anchor)::before{content:\"Not for Human\";display:block;margin-bottom:0.85rem;padding-left:1rem;font-size:0.6875rem;font-weight:700;letter-spacing:0.09em;text-transform:uppercase;color:rgb(var(--sqwish-text))}html.dark :is(#sidebar-content,#mobile-nav) [data-component-part=\"scroll-area-content\"]>.text-sm>ul:has(>li>a.nav-anchor)::before{color:#fff}:is(#sidebar-content,#mobile-nav) .sidebar-group-header{margin-bottom:1.25rem}:is(#sidebar-content,#mobile-nav) [data-component-part=\"scroll-area-content\"]>.text-sm>div:has(.sidebar-group)+div:has(.sidebar-group){margin-top:2.75rem}:is(#sidebar-content,#mobile-nav) .sidebar-title{color:rgb(var(--sqwish-text));font-weight:700}html.dark :is(#sidebar-content,#mobile-nav) .sidebar-title{color:#fff}:is(#sidebar-content,#mobile-nav) .sidebar-group a:not([aria-current=\"page\"]){color:rgb(var(--sqwish-muted))}:is(#sidebar-content,#mobile-nav) .sidebar-group a:not([aria-current=\"page\"]):hover{color:rgb(var(--sqwish-text));background-color:rgb(var(--sqwish-sunk));border-radius:8px}#header .eyebrow{margin-bottom:0.5rem;color:rgb(var(--sqwish-text) / 0.7);font-weight:600}#navbar [data-component-name=\"primary-header-button\"]{position:relative;z-index:0;border:1px solid #dfdfdf;border-radius:9999px;padding-inline:1rem;background-color:#ffffff;color:#1e1e1e;font-weight:600;box-shadow:0 1px 2px rgb(0 0 0 / 0.08)}#navbar [data-component-name=\"primary-header-button\"]::before{content:\"\";position:absolute;z-index:-1;inset:-1.5px;border-radius:inherit;padding:1.5px;background:conic-gradient(\n from var(--sqwish-chase-angle),\n rgb(var(--sqwish-chase-docs)),\n rgb(var(--sqwish-chase-api)),\n rgb(var(--sqwish-chase-examples)),\n rgb(var(--sqwish-chase-docs))\n );mask:linear-gradient(#fff 0 0) content-box, linear-gradient(#fff 0 0);mask-composite:exclude;opacity:0;transition:opacity 0.2s ease}#navbar [data-component-name=\"primary-header-button\"]:hover{opacity:1}#navbar [data-component-name=\"primary-header-button\"]:hover::before{opacity:1;animation:sqwish-chase-ring 2.8s linear infinite}@property --sqwish-chase-angle{syntax:\"\u003cangle>\";inherits:false;initial-value:0deg}@keyframes sqwish-chase-ring{to{--sqwish-chase-angle: 360deg}}@media (prefers-reduced-motion: reduce){#navbar [data-component-name=\"primary-header-button\"]:hover::before{animation:none}}#search-bar-entry,#search-bar-entry-mobile{border-radius:9999px;background-color:transparent}#search-bar-entry{flex-shrink:1;width:min(22rem, 100%);min-width:0;height:2.5rem;padding-inline:0.9rem;border-color:rgb(var(--sqwish-text) / 0.12);color:rgb(var(--sqwish-text) / 0.7);box-shadow:none}#search-bar-entry>span:first-of-type{font-size:0.9375rem}#search-bar-entry>svg{width:1.05rem;height:1.05rem}#search-bar-entry:hover,#search-bar-entry-mobile:hover{background-color:rgb(var(--sqwish-text) / 0.035)}#search-bar-entry>span{color:inherit;background-color:transparent}#search-bar-entry>svg{background-color:currentColor}#navbar [data-component-name=\"primary-header-button\"]:focus-visible,#search-bar-entry:focus-visible,#search-bar-entry-mobile:focus-visible{outline:2px solid rgb(var(--sqwish-text) / 0.75);outline-offset:3px}.tryit-button{border-radius:9999px;border:1px solid rgb(var(--sqwish-border));background-color:rgb(var(--sqwish-surface));color:rgb(var(--sqwish-text));box-shadow:none}.tryit-button [data-component-part=\"icon-svg\"]{background-color:currentColor}:is(.code-block-copy-button,button[aria-label=\"Copy\"]):is(:hover,:focus-within,:has(>[role=\"status\"]:not(:empty))) svg{color:rgb(var(--sqwish-accent))}.code-block-copy-button[data-base-ui-tooltip-trigger]{position:relative}.code-block-copy-button[data-base-ui-tooltip-trigger]:not([data-popup-open])>[role=\"status\"]:not(:empty){position:absolute;inset:auto auto calc(100% + 0.25rem) 50%;transform:translateX(-50%);z-index:50;width:max-content;height:auto;margin:0;padding:0.125rem 0.375rem;overflow:visible;clip:auto;clip-path:none;border-radius:0.25rem;background-color:rgb(var(--primary-dark));color:rgb(var(--tooltip-foreground));font-size:0.75rem;font-weight:400;line-height:1rem;white-space:nowrap;pointer-events:none}.code-block-copy-button[data-base-ui-tooltip-trigger]>[role=\"status\"]:not(:empty)::after{content:\"!\"}#api-playground-2-operation-page :has(>div>.tryit-button),#api-playground-2-operation-page :has(>.method-pill),#api-playground-2-operation-page .method-pill{border-radius:9999px}.callout{border-radius:0.75rem}.callout[data-callout-type=\"note\"]{border-color:rgb(var(--sqwish-border));background-color:rgb(var(--sqwish-surface));color:rgb(var(--sqwish-text))}.callout[data-callout-type=\"note\"] [data-component-part=\"callout-content\"]{color:inherit}.callout [data-component-part=\"callout-icon\"] svg{color:rgb(var(--sqwish-accent))}img.nav-logo{height:1.75rem!important;width:auto!important}#navbar img.nav-logo{height:2rem!important}#page-title{font-size:clamp(2rem, 2.8vw, 3rem);font-weight:500;line-height:1.15;letter-spacing:-0.04em}html[data-current-path=\"/introduction\"] #page-title::after{content:\"\";display:inline-block;width:1.5em;height:1.5em;margin:-1em 0 -0.12em 0.6em;vertical-align:baseline;background:url(\"/images/inky-reading.svg\") center / contain no-repeat;animation:sqwish-inky-arrive 360ms cubic-bezier(0.16, 1, 0.3, 1)}@keyframes sqwish-inky-arrive{from{opacity:0;transform:translateY(4px)}}@media (prefers-reduced-motion: reduce){html[data-current-path=\"/introduction\"] #page-title::after{animation:none}}#header>.prose{margin-top:0.75rem;font-size:1.125rem;line-height:1.6}html[data-current-path^=\"/api-reference/\"] #page-title{text-wrap:balance;overflow-wrap:normal}html[data-current-path^=\"/api-reference/\"] #header>.prose{font-size:1rem;font-weight:400;line-height:1.75}:is(#sidebar-content,#mobile-nav) a[href^=\"/api-reference/\"] span{hyphens:none;word-break:normal;overflow-wrap:normal}html.dark :is([data-component-part=\"code-block-root\"],[data-fade-overlay]){--shiki-dark-bg: rgb(var(--sqwish-sunk)) !important;--fade-color-dark: rgb(var(--sqwish-sunk)) !important}[data-component-part=\"code-block-root\"] pre{font-size:min(1em, 0.8125rem);line-height:1.6}#content-area .prose code:not(pre code){font-size:max(0.75rem, 0.8125em);font-weight:400;padding:0.125em 0.375em}#content-area .prose table code{word-break:normal}#content-area .prose :is(a:not(.card),u){text-decoration-color:rgb(var(--sqwish-accent));text-underline-offset:0.22em}#content-area [role=\"tabpanel\"]{overflow-x:clip}#content-area [role=\"tabpanel\"] pre{overflow-x:auto}#content-area .prose a.link{border-bottom-color:rgb(var(--sqwish-accent))}#footer{display:none}@media (min-width: 1024px){html{--mintlify-slot-header-height: calc(var(--sqwish-topbar-height) + 3rem)}#content-area{max-width:72rem;padding-inline:clamp(2.5rem, 3.75vw, 4.5rem);padding-top:3rem}#content-container #content-area{margin-inline:0!important}}#content-side-layout{border-left-width:0}#content-side-layout nav{border-left:1px solid rgb(var(--sqwish-border));margin-left:0.15rem;padding-left:0.7rem}#content-side-layout h2>button{display:inline-flex;align-items:center;gap:0.45rem}#content-side-layout h2>button::before{content:\"\";width:0.8rem;height:0.55rem;flex:none;background:linear-gradient(currentColor, currentColor) 0 0 / 100% 1.5px no-repeat,\n linear-gradient(currentColor, currentColor) 0 50% / 100% 1.5px no-repeat,\n linear-gradient(currentColor, currentColor) 0 100% / 100% 1.5px no-repeat}@media (min-width: 1280px){#content-side-layout{top:calc(var(--mintlify-slot-header-height) + var(--banner-height, 0px));height:calc(100vh - var(--mintlify-slot-header-height) - var(--banner-height, 0px));padding-top:3rem}html:not([data-current-path^=\"/api-reference/\"]) #content-side-layout{width:15rem;flex-shrink:0;padding-inline:1.5rem}}@media (max-width: 1279px){#content-container:has(#table-of-contents-content a){flex-wrap:wrap;align-content:flex-start}#content-container:has(#table-of-contents-content a)>:not(#content-side-layout){flex:1 0 100%;min-width:100%}body:has(#table-of-contents-content a) #content-area{padding-top:0.75rem}#content-side-layout:has(#table-of-contents-content a){display:flex;position:sticky;z-index:20;top:calc(var(--mintlify-slot-header-height) + var(--banner-height, 0px) + 0.75rem);order:-1;flex:1 0 100%;min-width:100%;justify-content:flex-end;width:auto;height:auto;margin:0;padding:0.85rem clamp(2.5rem, 3.75vw, 4.5rem) 0;border:0;background:transparent;pointer-events:none}#content-side-layout:has(#table-of-contents-content a) :is(#table-of-contents-layout,#table-of-contents,[data-component-part=\"scroll-area\"],[data-component-part=\"scroll-area-viewport\"],[data-component-part=\"scroll-area-content\"]){display:contents}#content-side-layout nav{position:relative;display:flex;flex-direction:column;align-items:flex-end;gap:0;margin:0;padding:0;border:0;pointer-events:none}#content-side-layout nav>div:has(#table-of-contents-content){display:contents}#content-side-layout h2{margin:0;pointer-events:auto}#content-side-layout h2>button{border:1px solid rgb(var(--sqwish-border));border-radius:999px;background:rgb(var(--sqwish-surface));color:rgb(var(--sqwish-text));padding:0.55rem 0.95rem;font-size:0.8125rem;line-height:1.2;white-space:nowrap;box-shadow:0 10px 28px rgb(0 0 0 / 0.22)}#content-side-layout:focus-within h2>button{border-color:rgb(var(--sqwish-accent));color:rgb(var(--sqwish-accent))}#content-side-layout #table-of-contents-content{position:absolute;top:calc(100% + 0.45rem);right:0;display:none;width:min(22rem, calc(100vw - 2.5rem));max-height:min(24rem, calc(100vh - 8rem));margin:0;padding:0.7rem 0.85rem 0.8rem;overflow:auto;border:1px solid rgb(var(--sqwish-border));border-radius:0.85rem;background:rgb(var(--sqwish-surface));box-shadow:0 16px 40px rgb(0 0 0 / 0.32);pointer-events:auto}#content-side-layout:focus-within #table-of-contents-content{display:block}}@media (max-width: 1023px){#body-content>div:has(>#content-container){padding-top:calc(var(--mintlify-slot-header-height) + var(--banner-height, 0px))}#content-area{padding-inline:1.5rem;padding-top:1.75rem}#content-side-layout:has(#table-of-contents-content a){padding-inline:1.5rem;padding-top:0.35rem}}"}]}
{"page":{"pagePath":"api-reference/families/get-family","slug":"/api-reference/families/get-family","pageMetadata":{"title":"Get family","description":"A family: its dataset and where it started, its switch and the model it serves, its\nmodels with their own switches, keep warm, its fine-tunes with how each ended, what each\ncost and why it made no model, and what continuing it would do now (`continue`): train\non the dataset's newest version, or why it can't yet, with the rows it would take and\nthe fee it would hold.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/families/{family}","href":"/api-reference/families/get-family","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"A family: its dataset and where it started, its switch and the model it serves, its\\nmodels with their own switches, keep warm, its fine-tunes with how each ended, what each\\ncost and why it made no model, and what continuing it would do now (\", _jsx(_components.code, {\n children: \"continue\"\n }), \"): train\\non the dataset’s newest version, or why it can’t yet, with the rows it would take and\\nthe fee it would hold.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get family","description":"A family: its dataset and where it started, its switch and the model it serves, its\nmodels with their own switches, keep warm, its fine-tunes with how each ended, what each\ncost and why it made no model, and what continuing it would do now (`continue`): train\non the dataset's newest version, or why it can't yet, with the rows it would take and\nthe fee it would hold.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/families/{family}","href":"/api-reference/families/get-family","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/sqwishai/d139d3da925631df/tab-title.js","/_mintlify/custom/sqwishai/7ab8422084ffa751/tab-icon.js"],"openApiReferenceData":{"operation":{"summary":"Get family","description":"A family: its dataset and where it started, its switch and the model it serves, its\nmodels with their own switches, keep warm, its fine-tunes with how each ended, what each\ncost and why it made no model, and what continuing it would do now (`continue`): train\non the dataset's newest version, or why it can't yet, with the rows it would take and\nthe fee it would hold.","operationId":"getFamily","parameters":["420a127f-705f-4c1f-8a2d-c8bc04e74358"],"responses":{"200":"12c7b394-7ff8-4740-98c7-073a2bb76ba9","4XX":"dc9bd3a4-310d-4ef8-859f-18a26f1c4ef5","5XX":"577b321b-65eb-4dd1-938e-bbc9ce625235"},"tags":["Families"],"x-internal":false,"security":["8283907c-5f0e-4d80-97d9-c7972e703429"],"method":"get","type":"path","servers":["b46254f4-e116-4546-b0af-1d5e8cbad909"],"path":"/v1/families/{family}","baseUrlOptions":["https://api.sqwish.ai"],"title":"Get family","codeSamples":[],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"420a127f-705f-4c1f-8a2d-c8bc04e74358":{"name":"family","in":"path","required":true,"schema":{"type":"string","title":"Family","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"12c7b394-7ff8-4740-98c7-073a2bb76ba9":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","title":"Id","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"object":{"type":"string","const":"family","title":"Object","isRequired":true,"uniqueKey":"object","typeLabel":"string"},"switched_on":{"type":"boolean","title":"Switched On","description":"Whether calls to its name are answered.","isRequired":true,"uniqueKey":"switched_on","typeLabel":"boolean"},"used_at":{"type":"number","title":"Used At","description":"Its idle clock: the latest of its last production call by an API key that named it, its last evaluation that named it, and when it was switched on.","isRequired":true,"uniqueKey":"used_at","typeLabel":"number"},"switches_off_at":{"oneOf":[{"type":"number","title":"Switches Off At","description":"When idling switches it off unless it's used. Null while it is off or kept warm on its own switch, and when idling never switches anything off. A family's is also null while it serves no model.","isRequired":true,"uniqueKey":"switches_off_at.oneOf.0","typeLabel":"number"},{"type":"null","title":"Switches Off At","description":"When idling switches it off unless it's used. Null while it is off or kept warm on its own switch, and when idling never switches anything off. A family's is also null while it serves no model.","isRequired":true,"uniqueKey":"switches_off_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"switches_off_at","typeLabel":"number | null"},"off_reason":{"oneOf":[{"type":"string","title":"Off Reason","description":"Why it is off: owner when it was switched off by hand, idle when nothing used it for too long. Null otherwise.","enum":["owner","idle"],"isRequired":true,"uniqueKey":"off_reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Off Reason","description":"Why it is off: owner when it was switched off by hand, idle when nothing used it for too long. Null otherwise.","isRequired":true,"uniqueKey":"off_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"off_reason","typeLabel":"enum\u003cstring> | null"},"off_at":{"oneOf":[{"type":"number","title":"Off At","description":"When it went off, with off_reason. Null otherwise.","isRequired":true,"uniqueKey":"off_at.oneOf.0","typeLabel":"number"},{"type":"null","title":"Off At","description":"When it went off, with off_reason. Null otherwise.","isRequired":true,"uniqueKey":"off_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"off_at","typeLabel":"number | null"},"dataset_id":{"type":"string","title":"Dataset Id","description":"The dataset it grows on.","isRequired":true,"uniqueKey":"dataset_id","typeLabel":"string"},"origin":{"type":"string","title":"Origin","description":"Where it started: a base model, or one of your models.","isRequired":true,"uniqueKey":"origin","typeLabel":"string"},"created_at":{"type":"number","title":"Created At","description":"When it was named, as its first fine-tune was queued.","isRequired":true,"uniqueKey":"created_at","typeLabel":"number"},"served":{"oneOf":[{"type":"object","title":"ModelVersion","description":"The model calls to its name get while it is switched on, or null for none yet.","required":["version","ref","adapter","status","on_at","keep_warm","keep_warm_stopped_at","used_at","switches_off_at","off_reason","off_at","parent","created_at","gate","heldout"],"properties":{"version":{"type":"integer","title":"Version","isRequired":true,"uniqueKey":"served.oneOf.0.version","typeLabel":"integer"},"ref":{"type":"string","title":"Ref","isRequired":true,"uniqueKey":"served.oneOf.0.ref","typeLabel":"string"},"adapter":{"type":"string","title":"Adapter","isRequired":true,"uniqueKey":"served.oneOf.0.adapter","typeLabel":"string"},"status":{"type":"string","title":"Status","isRequired":true,"uniqueKey":"served.oneOf.0.status","typeLabel":"string"},"on_at":{"oneOf":[{"type":"number","title":"On At","description":"When its own switch went on, so it answers calls to its number. Null while off.","isRequired":true,"uniqueKey":"served.oneOf.0.on_at.oneOf.0","typeLabel":"number"},{"type":"null","title":"On At","description":"When its own switch went on, so it answers calls to its number. Null while off.","isRequired":true,"uniqueKey":"served.oneOf.0.on_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"served.oneOf.0.on_at","typeLabel":"number | null"},"keep_warm":{"type":"boolean","title":"Keep Warm","description":"Whether it is kept warm on its own switch.","isRequired":true,"uniqueKey":"served.oneOf.0.keep_warm","typeLabel":"boolean"},"keep_warm_stopped_at":{"oneOf":[{"type":"number","title":"Keep Warm Stopped At","description":"When its own keep warm switched off because the next hour couldn't be reserved, while it stays off. Otherwise null.","isRequired":true,"uniqueKey":"served.oneOf.0.keep_warm_stopped_at.oneOf.0","typeLabel":"number"},{"type":"null","title":"Keep Warm Stopped At","description":"When its own keep warm switched off because the next hour couldn't be reserved, while it stays off. Otherwise null.","isRequired":true,"uniqueKey":"served.oneOf.0.keep_warm_stopped_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"served.oneOf.0.keep_warm_stopped_at","typeLabel":"number | null"},"used_at":{"oneOf":[{"type":"number","title":"Used At","description":"Its idle clock: the latest of its last production call by an API key that named it, its last evaluation that named it, and when it was switched on.","isRequired":true,"uniqueKey":"served.oneOf.0.used_at.oneOf.0","typeLabel":"number"},{"type":"null","title":"Used At","description":"Its idle clock: the latest of its last production call by an API key that named it, its last evaluation that named it, and when it was switched on.","isRequired":true,"uniqueKey":"served.oneOf.0.used_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"served.oneOf.0.used_at","typeLabel":"number | null"},"switches_off_at":{"oneOf":[{"type":"number","title":"Switches Off At","description":"When idling switches it off unless it's used. Null while it is off or kept warm on its own switch, and when idling never switches anything off. A family's is also null while it serves no model.","isRequired":true,"uniqueKey":"served.oneOf.0.switches_off_at.oneOf.0","typeLabel":"number"},{"type":"null","title":"Switches Off At","description":"When idling switches it off unless it's used. Null while it is off or kept warm on its own switch, and when idling never switches anything off. A family's is also null while it serves no model.","isRequired":true,"uniqueKey":"served.oneOf.0.switches_off_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"served.oneOf.0.switches_off_at","typeLabel":"number | null"},"off_reason":{"oneOf":[{"type":"string","title":"Off Reason","description":"Why it is off: owner when it was switched off by hand, idle when nothing used it for too long. Null otherwise.","enum":["owner","idle"],"isRequired":true,"uniqueKey":"served.oneOf.0.off_reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Off Reason","description":"Why it is off: owner when it was switched off by hand, idle when nothing used it for too long. Null otherwise.","isRequired":true,"uniqueKey":"served.oneOf.0.off_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"served.oneOf.0.off_reason","typeLabel":"enum\u003cstring> | null"},"off_at":{"oneOf":[{"type":"number","title":"Off At","description":"When it went off, with off_reason. Null otherwise.","isRequired":true,"uniqueKey":"served.oneOf.0.off_at.oneOf.0","typeLabel":"number"},{"type":"null","title":"Off At","description":"When it went off, with off_reason. Null otherwise.","isRequired":true,"uniqueKey":"served.oneOf.0.off_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"served.oneOf.0.off_at","typeLabel":"number | null"},"parent":{"oneOf":[{"type":"string","title":"Parent","isRequired":true,"uniqueKey":"served.oneOf.0.parent.oneOf.0","typeLabel":"string"},{"type":"null","title":"Parent","isRequired":true,"uniqueKey":"served.oneOf.0.parent.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"served.oneOf.0.parent","typeLabel":"string | null"},"created_at":{"oneOf":[{"type":"number","title":"Created At","isRequired":true,"uniqueKey":"served.oneOf.0.created_at.oneOf.0","typeLabel":"number"},{"type":"null","title":"Created At","isRequired":true,"uniqueKey":"served.oneOf.0.created_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"served.oneOf.0.created_at","typeLabel":"number | null"},"gate":{"oneOf":[{"type":"object","title":"Gate","required":["passed","against","reasons"],"properties":{"passed":{"type":"boolean","title":"Passed","isRequired":true,"uniqueKey":"served.oneOf.0.gate.oneOf.0.passed","typeLabel":"boolean"},"against":{"type":"string","enum":["parent","base"],"title":"Against","isRequired":true,"uniqueKey":"served.oneOf.0.gate.oneOf.0.against","typeLabel":"enum\u003cstring>"},"reasons":{"items":{"type":"string","uniqueKey":"served.oneOf.0.gate.oneOf.0.reasons.items.[INDEX]","typeLabel":"string"},"type":"array","title":"Reasons","isRequired":true,"uniqueKey":"served.oneOf.0.gate.oneOf.0.reasons","typeLabel":"string[]"},"groups":{"additionalProperties":{"additionalProperties":true,"type":"object","uniqueKey":"served.oneOf.0.gate.oneOf.0.groups.additionalProperties","typeLabel":"object"},"type":"object","title":"Groups","uniqueKey":"served.oneOf.0.gate.oneOf.0.groups","typeLabel":"Groups · object"},"ece":{"additionalProperties":{"oneOf":[{"type":"number","uniqueKey":"served.oneOf.0.gate.oneOf.0.ece.additionalProperties.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"served.oneOf.0.gate.oneOf.0.ece.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"served.oneOf.0.gate.oneOf.0.ece.additionalProperties","typeLabel":"number | null"},"type":"object","title":"Ece","uniqueKey":"served.oneOf.0.gate.oneOf.0.ece","typeLabel":"Ece · object"}},"isRequired":true,"uniqueKey":"served.oneOf.0.gate.oneOf.0","typeLabel":"Gate · object"},{"type":"null","isRequired":true,"uniqueKey":"served.oneOf.0.gate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"served.oneOf.0.gate","typeLabel":"Gate · object | null"},"heldout":{"additionalProperties":{"type":"number","uniqueKey":"served.oneOf.0.heldout.additionalProperties","typeLabel":"number"},"type":"object","title":"Heldout","isRequired":true,"uniqueKey":"served.oneOf.0.heldout","typeLabel":"Heldout · object"},"discarded_at":{"type":"number","title":"Discarded At","uniqueKey":"served.oneOf.0.discarded_at","typeLabel":"number"},"keep_warm_trial":{"oneOf":[{"type":"object","title":"KeepWarmTrial","required":["slot","started_at","ends_at","state"],"properties":{"slot":{"type":"integer","title":"Slot","isRequired":true,"uniqueKey":"served.oneOf.0.keep_warm_trial.oneOf.0.slot","typeLabel":"integer"},"started_at":{"type":"number","title":"Started At","description":"The successful test that started seven free days.","isRequired":true,"uniqueKey":"served.oneOf.0.keep_warm_trial.oneOf.0.started_at","typeLabel":"number"},"ends_at":{"type":"number","title":"Ends At","description":"The fixed expiry; more tests never extend it.","isRequired":true,"uniqueKey":"served.oneOf.0.keep_warm_trial.oneOf.0.ends_at","typeLabel":"number"},"state":{"type":"string","enum":["pending","reserved","inactive","expired"],"title":"State","description":"Pending waits for pool capacity; reserved has capacity for the normal placement follow. Neither guarantees GPU residency. Inactive is switched off, blocked or otherwise unusable. Expired has ended. This never changes paid keep warm or starts billing.","isRequired":true,"uniqueKey":"served.oneOf.0.keep_warm_trial.oneOf.0.state","typeLabel":"enum\u003cstring>"}},"uniqueKey":"served.oneOf.0.keep_warm_trial.oneOf.0","typeLabel":"KeepWarmTrial · object"},{"type":"null","uniqueKey":"served.oneOf.0.keep_warm_trial.oneOf.1","typeLabel":"null"}],"uniqueKey":"served.oneOf.0.keep_warm_trial","typeLabel":"KeepWarmTrial · object | null"}},"isRequired":true,"uniqueKey":"served.oneOf.0","typeLabel":"ModelVersion · object"},{"type":"null","description":"The model calls to its name get while it is switched on, or null for none yet.","isRequired":true,"uniqueKey":"served.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"served","typeLabel":"ModelVersion · object | null"},"latest":{"oneOf":[{"type":"object","title":"ModelVersion","description":"Its newest model, neither deleted nor discarded.","required":["version","ref","adapter","status","on_at","keep_warm","keep_warm_stopped_at","used_at","switches_off_at","off_reason","off_at","parent","created_at","gate","heldout"],"properties":{"version":{"type":"integer","title":"Version","isRequired":true,"uniqueKey":"latest.oneOf.0.version","typeLabel":"integer"},"ref":{"type":"string","title":"Ref","isRequired":true,"uniqueKey":"latest.oneOf.0.ref","typeLabel":"string"},"adapter":{"type":"string","title":"Adapter","isRequired":true,"uniqueKey":"latest.oneOf.0.adapter","typeLabel":"string"},"status":{"type":"string","title":"Status","isRequired":true,"uniqueKey":"latest.oneOf.0.status","typeLabel":"string"},"on_at":{"oneOf":[{"type":"number","title":"On At","description":"When its own switch went on, so it answers calls to its number. Null while off.","isRequired":true,"uniqueKey":"latest.oneOf.0.on_at.oneOf.0","typeLabel":"number"},{"type":"null","title":"On At","description":"When its own switch went on, so it answers calls to its number. Null while off.","isRequired":true,"uniqueKey":"latest.oneOf.0.on_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"latest.oneOf.0.on_at","typeLabel":"number | null"},"keep_warm":{"type":"boolean","title":"Keep Warm","description":"Whether it is kept warm on its own switch.","isRequired":true,"uniqueKey":"latest.oneOf.0.keep_warm","typeLabel":"boolean"},"keep_warm_stopped_at":{"oneOf":[{"type":"number","title":"Keep Warm Stopped At","description":"When its own keep warm switched off because the next hour couldn't be reserved, while it stays off. Otherwise null.","isRequired":true,"uniqueKey":"latest.oneOf.0.keep_warm_stopped_at.oneOf.0","typeLabel":"number"},{"type":"null","title":"Keep Warm Stopped At","description":"When its own keep warm switched off because the next hour couldn't be reserved, while it stays off. Otherwise null.","isRequired":true,"uniqueKey":"latest.oneOf.0.keep_warm_stopped_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"latest.oneOf.0.keep_warm_stopped_at","typeLabel":"number | null"},"used_at":{"oneOf":[{"type":"number","title":"Used At","description":"Its idle clock: the latest of its last production call by an API key that named it, its last evaluation that named it, and when it was switched on.","isRequired":true,"uniqueKey":"latest.oneOf.0.used_at.oneOf.0","typeLabel":"number"},{"type":"null","title":"Used At","description":"Its idle clock: the latest of its last production call by an API key that named it, its last evaluation that named it, and when it was switched on.","isRequired":true,"uniqueKey":"latest.oneOf.0.used_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"latest.oneOf.0.used_at","typeLabel":"number | null"},"switches_off_at":{"oneOf":[{"type":"number","title":"Switches Off At","description":"When idling switches it off unless it's used. Null while it is off or kept warm on its own switch, and when idling never switches anything off. A family's is also null while it serves no model.","isRequired":true,"uniqueKey":"latest.oneOf.0.switches_off_at.oneOf.0","typeLabel":"number"},{"type":"null","title":"Switches Off At","description":"When idling switches it off unless it's used. Null while it is off or kept warm on its own switch, and when idling never switches anything off. A family's is also null while it serves no model.","isRequired":true,"uniqueKey":"latest.oneOf.0.switches_off_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"latest.oneOf.0.switches_off_at","typeLabel":"number | null"},"off_reason":{"oneOf":[{"type":"string","title":"Off Reason","description":"Why it is off: owner when it was switched off by hand, idle when nothing used it for too long. Null otherwise.","enum":["owner","idle"],"isRequired":true,"uniqueKey":"latest.oneOf.0.off_reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Off Reason","description":"Why it is off: owner when it was switched off by hand, idle when nothing used it for too long. Null otherwise.","isRequired":true,"uniqueKey":"latest.oneOf.0.off_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"latest.oneOf.0.off_reason","typeLabel":"enum\u003cstring> | null"},"off_at":{"oneOf":[{"type":"number","title":"Off At","description":"When it went off, with off_reason. Null otherwise.","isRequired":true,"uniqueKey":"latest.oneOf.0.off_at.oneOf.0","typeLabel":"number"},{"type":"null","title":"Off At","description":"When it went off, with off_reason. Null otherwise.","isRequired":true,"uniqueKey":"latest.oneOf.0.off_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"latest.oneOf.0.off_at","typeLabel":"number | null"},"parent":{"oneOf":[{"type":"string","title":"Parent","isRequired":true,"uniqueKey":"latest.oneOf.0.parent.oneOf.0","typeLabel":"string"},{"type":"null","title":"Parent","isRequired":true,"uniqueKey":"latest.oneOf.0.parent.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"latest.oneOf.0.parent","typeLabel":"string | null"},"created_at":{"oneOf":[{"type":"number","title":"Created At","isRequired":true,"uniqueKey":"latest.oneOf.0.created_at.oneOf.0","typeLabel":"number"},{"type":"null","title":"Created At","isRequired":true,"uniqueKey":"latest.oneOf.0.created_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"latest.oneOf.0.created_at","typeLabel":"number | null"},"gate":{"oneOf":[{"type":"object","title":"Gate","required":["passed","against","reasons"],"properties":{"passed":{"type":"boolean","title":"Passed","isRequired":true,"uniqueKey":"latest.oneOf.0.gate.oneOf.0.passed","typeLabel":"boolean"},"against":{"type":"string","enum":["parent","base"],"title":"Against","isRequired":true,"uniqueKey":"latest.oneOf.0.gate.oneOf.0.against","typeLabel":"enum\u003cstring>"},"reasons":{"items":{"type":"string","uniqueKey":"latest.oneOf.0.gate.oneOf.0.reasons.items.[INDEX]","typeLabel":"string"},"type":"array","title":"Reasons","isRequired":true,"uniqueKey":"latest.oneOf.0.gate.oneOf.0.reasons","typeLabel":"string[]"},"groups":{"additionalProperties":{"additionalProperties":true,"type":"object","uniqueKey":"latest.oneOf.0.gate.oneOf.0.groups.additionalProperties","typeLabel":"object"},"type":"object","title":"Groups","uniqueKey":"latest.oneOf.0.gate.oneOf.0.groups","typeLabel":"Groups · object"},"ece":{"additionalProperties":{"oneOf":[{"type":"number","uniqueKey":"latest.oneOf.0.gate.oneOf.0.ece.additionalProperties.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"latest.oneOf.0.gate.oneOf.0.ece.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"latest.oneOf.0.gate.oneOf.0.ece.additionalProperties","typeLabel":"number | null"},"type":"object","title":"Ece","uniqueKey":"latest.oneOf.0.gate.oneOf.0.ece","typeLabel":"Ece · object"}},"isRequired":true,"uniqueKey":"latest.oneOf.0.gate.oneOf.0","typeLabel":"Gate · object"},{"type":"null","isRequired":true,"uniqueKey":"latest.oneOf.0.gate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"latest.oneOf.0.gate","typeLabel":"Gate · object | null"},"heldout":{"additionalProperties":{"type":"number","uniqueKey":"latest.oneOf.0.heldout.additionalProperties","typeLabel":"number"},"type":"object","title":"Heldout","isRequired":true,"uniqueKey":"latest.oneOf.0.heldout","typeLabel":"Heldout · object"},"discarded_at":{"type":"number","title":"Discarded At","uniqueKey":"latest.oneOf.0.discarded_at","typeLabel":"number"},"keep_warm_trial":{"oneOf":[{"type":"object","title":"KeepWarmTrial","required":["slot","started_at","ends_at","state"],"properties":{"slot":{"type":"integer","title":"Slot","isRequired":true,"uniqueKey":"latest.oneOf.0.keep_warm_trial.oneOf.0.slot","typeLabel":"integer"},"started_at":{"type":"number","title":"Started At","description":"The successful test that started seven free days.","isRequired":true,"uniqueKey":"latest.oneOf.0.keep_warm_trial.oneOf.0.started_at","typeLabel":"number"},"ends_at":{"type":"number","title":"Ends At","description":"The fixed expiry; more tests never extend it.","isRequired":true,"uniqueKey":"latest.oneOf.0.keep_warm_trial.oneOf.0.ends_at","typeLabel":"number"},"state":{"type":"string","enum":["pending","reserved","inactive","expired"],"title":"State","description":"Pending waits for pool capacity; reserved has capacity for the normal placement follow. Neither guarantees GPU residency. Inactive is switched off, blocked or otherwise unusable. Expired has ended. This never changes paid keep warm or starts billing.","isRequired":true,"uniqueKey":"latest.oneOf.0.keep_warm_trial.oneOf.0.state","typeLabel":"enum\u003cstring>"}},"uniqueKey":"latest.oneOf.0.keep_warm_trial.oneOf.0","typeLabel":"KeepWarmTrial · object"},{"type":"null","uniqueKey":"latest.oneOf.0.keep_warm_trial.oneOf.1","typeLabel":"null"}],"uniqueKey":"latest.oneOf.0.keep_warm_trial","typeLabel":"KeepWarmTrial · object | null"}},"isRequired":true,"uniqueKey":"latest.oneOf.0","typeLabel":"ModelVersion · object"},{"type":"null","description":"Its newest model, neither deleted nor discarded.","isRequired":true,"uniqueKey":"latest.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"latest","typeLabel":"ModelVersion · object | null"},"models":{"items":{"oneOf":[{"type":"object","title":"ModelVersion","required":["version","ref","adapter","status","on_at","keep_warm","keep_warm_stopped_at","used_at","switches_off_at","off_reason","off_at","parent","created_at","gate","heldout"],"properties":{"version":{"type":"integer","title":"Version","isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.0.version","typeLabel":"integer"},"ref":{"type":"string","title":"Ref","isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.0.ref","typeLabel":"string"},"adapter":{"type":"string","title":"Adapter","isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.0.adapter","typeLabel":"string"},"status":{"type":"string","title":"Status","isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.0.status","typeLabel":"string"},"on_at":{"oneOf":[{"type":"number","title":"On At","description":"When its own switch went on, so it answers calls to its number. Null while off.","isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.0.on_at.oneOf.0","typeLabel":"number"},{"type":"null","title":"On At","description":"When its own switch went on, so it answers calls to its number. Null while off.","isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.0.on_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.0.on_at","typeLabel":"number | null"},"keep_warm":{"type":"boolean","title":"Keep Warm","description":"Whether it is kept warm on its own switch.","isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.0.keep_warm","typeLabel":"boolean"},"keep_warm_stopped_at":{"oneOf":[{"type":"number","title":"Keep Warm Stopped At","description":"When its own keep warm switched off because the next hour couldn't be reserved, while it stays off. Otherwise null.","isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.0.keep_warm_stopped_at.oneOf.0","typeLabel":"number"},{"type":"null","title":"Keep Warm Stopped At","description":"When its own keep warm switched off because the next hour couldn't be reserved, while it stays off. Otherwise null.","isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.0.keep_warm_stopped_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.0.keep_warm_stopped_at","typeLabel":"number | null"},"used_at":{"oneOf":[{"type":"number","title":"Used At","description":"Its idle clock: the latest of its last production call by an API key that named it, its last evaluation that named it, and when it was switched on.","isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.0.used_at.oneOf.0","typeLabel":"number"},{"type":"null","title":"Used At","description":"Its idle clock: the latest of its last production call by an API key that named it, its last evaluation that named it, and when it was switched on.","isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.0.used_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.0.used_at","typeLabel":"number | null"},"switches_off_at":{"oneOf":[{"type":"number","title":"Switches Off At","description":"When idling switches it off unless it's used. Null while it is off or kept warm on its own switch, and when idling never switches anything off. A family's is also null while it serves no model.","isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.0.switches_off_at.oneOf.0","typeLabel":"number"},{"type":"null","title":"Switches Off At","description":"When idling switches it off unless it's used. Null while it is off or kept warm on its own switch, and when idling never switches anything off. A family's is also null while it serves no model.","isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.0.switches_off_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.0.switches_off_at","typeLabel":"number | null"},"off_reason":{"oneOf":[{"type":"string","title":"Off Reason","description":"Why it is off: owner when it was switched off by hand, idle when nothing used it for too long. Null otherwise.","enum":["owner","idle"],"isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.0.off_reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Off Reason","description":"Why it is off: owner when it was switched off by hand, idle when nothing used it for too long. Null otherwise.","isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.0.off_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.0.off_reason","typeLabel":"enum\u003cstring> | null"},"off_at":{"oneOf":[{"type":"number","title":"Off At","description":"When it went off, with off_reason. Null otherwise.","isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.0.off_at.oneOf.0","typeLabel":"number"},{"type":"null","title":"Off At","description":"When it went off, with off_reason. Null otherwise.","isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.0.off_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.0.off_at","typeLabel":"number | null"},"parent":{"oneOf":[{"type":"string","title":"Parent","isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.0.parent.oneOf.0","typeLabel":"string"},{"type":"null","title":"Parent","isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.0.parent.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.0.parent","typeLabel":"string | null"},"created_at":{"oneOf":[{"type":"number","title":"Created At","isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.0.created_at.oneOf.0","typeLabel":"number"},{"type":"null","title":"Created At","isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.0.created_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.0.created_at","typeLabel":"number | null"},"gate":{"oneOf":[{"type":"object","title":"Gate","required":["passed","against","reasons"],"properties":{"passed":{"type":"boolean","title":"Passed","isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.0.gate.oneOf.0.passed","typeLabel":"boolean"},"against":{"type":"string","enum":["parent","base"],"title":"Against","isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.0.gate.oneOf.0.against","typeLabel":"enum\u003cstring>"},"reasons":{"items":{"type":"string","uniqueKey":"models.items.[INDEX].oneOf.0.gate.oneOf.0.reasons.items.[INDEX]","typeLabel":"string"},"type":"array","title":"Reasons","isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.0.gate.oneOf.0.reasons","typeLabel":"string[]"},"groups":{"additionalProperties":{"additionalProperties":true,"type":"object","uniqueKey":"models.items.[INDEX].oneOf.0.gate.oneOf.0.groups.additionalProperties","typeLabel":"object"},"type":"object","title":"Groups","uniqueKey":"models.items.[INDEX].oneOf.0.gate.oneOf.0.groups","typeLabel":"Groups · object"},"ece":{"additionalProperties":{"oneOf":[{"type":"number","uniqueKey":"models.items.[INDEX].oneOf.0.gate.oneOf.0.ece.additionalProperties.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"models.items.[INDEX].oneOf.0.gate.oneOf.0.ece.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"models.items.[INDEX].oneOf.0.gate.oneOf.0.ece.additionalProperties","typeLabel":"number | null"},"type":"object","title":"Ece","uniqueKey":"models.items.[INDEX].oneOf.0.gate.oneOf.0.ece","typeLabel":"Ece · object"}},"isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.0.gate.oneOf.0","typeLabel":"Gate · object"},{"type":"null","isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.0.gate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.0.gate","typeLabel":"Gate · object | null"},"heldout":{"additionalProperties":{"type":"number","uniqueKey":"models.items.[INDEX].oneOf.0.heldout.additionalProperties","typeLabel":"number"},"type":"object","title":"Heldout","isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.0.heldout","typeLabel":"Heldout · object"},"discarded_at":{"type":"number","title":"Discarded At","uniqueKey":"models.items.[INDEX].oneOf.0.discarded_at","typeLabel":"number"},"keep_warm_trial":{"oneOf":[{"type":"object","title":"KeepWarmTrial","required":["slot","started_at","ends_at","state"],"properties":{"slot":{"type":"integer","title":"Slot","isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.0.keep_warm_trial.oneOf.0.slot","typeLabel":"integer"},"started_at":{"type":"number","title":"Started At","description":"The successful test that started seven free days.","isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.0.keep_warm_trial.oneOf.0.started_at","typeLabel":"number"},"ends_at":{"type":"number","title":"Ends At","description":"The fixed expiry; more tests never extend it.","isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.0.keep_warm_trial.oneOf.0.ends_at","typeLabel":"number"},"state":{"type":"string","enum":["pending","reserved","inactive","expired"],"title":"State","description":"Pending waits for pool capacity; reserved has capacity for the normal placement follow. Neither guarantees GPU residency. Inactive is switched off, blocked or otherwise unusable. Expired has ended. This never changes paid keep warm or starts billing.","isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.0.keep_warm_trial.oneOf.0.state","typeLabel":"enum\u003cstring>"}},"uniqueKey":"models.items.[INDEX].oneOf.0.keep_warm_trial.oneOf.0","typeLabel":"KeepWarmTrial · object"},{"type":"null","uniqueKey":"models.items.[INDEX].oneOf.0.keep_warm_trial.oneOf.1","typeLabel":"null"}],"uniqueKey":"models.items.[INDEX].oneOf.0.keep_warm_trial","typeLabel":"KeepWarmTrial · object | null"}},"uniqueKey":"models.items.[INDEX].oneOf.0","typeLabel":"ModelVersion · object"},{"type":"object","title":"DeletedModelVersion","description":"A model you deleted, as its family's line shows it: where it stood, and when it went.","required":["version","ref","adapter","parent","status","deleted_at"],"properties":{"version":{"type":"integer","title":"Version","isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.1.version","typeLabel":"integer"},"ref":{"type":"string","title":"Ref","isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.1.ref","typeLabel":"string"},"adapter":{"type":"string","title":"Adapter","isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.1.adapter","typeLabel":"string"},"parent":{"oneOf":[{"type":"string","title":"Parent","description":"The id of the model it trained from, or null from a base.","isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.1.parent.oneOf.0","typeLabel":"string"},{"type":"null","title":"Parent","description":"The id of the model it trained from, or null from a base.","isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.1.parent.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.1.parent","typeLabel":"string | null"},"status":{"type":"string","const":"deleted","title":"Status","isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.1.status","typeLabel":"string"},"deleted_at":{"type":"number","title":"Deleted At","isRequired":true,"uniqueKey":"models.items.[INDEX].oneOf.1.deleted_at","typeLabel":"number"}},"uniqueKey":"models.items.[INDEX].oneOf.1","typeLabel":"DeletedModelVersion · object"}],"uniqueKey":"models.items.[INDEX]","typeLabel":"ModelVersion · object | DeletedModelVersion · object"},"type":"array","title":"Models","description":"Every model of its line, oldest first. A deleted one shows only where it stood.","isRequired":true,"uniqueKey":"models","typeLabel":"(ModelVersion · object | DeletedModelVersion · object)[]"},"keep_warm":{"type":"boolean","title":"Keep Warm","isRequired":true,"uniqueKey":"keep_warm","typeLabel":"boolean"},"keep_warm_window":{"oneOf":[{"type":"object","title":"KeepWarmWindow","description":"The hour of keep warm being billed for the model the family serves, while the family is kept warm. Null otherwise: a model kept warm on its own shows its own hour.","required":["started_at","ends_at","reserved_usd"],"properties":{"started_at":{"type":"number","title":"Started At","isRequired":true,"uniqueKey":"keep_warm_window.oneOf.0.started_at","typeLabel":"number"},"ends_at":{"type":"number","title":"Ends At","description":"When this hour's hold ends and the next is reserved.","isRequired":true,"uniqueKey":"keep_warm_window.oneOf.0.ends_at","typeLabel":"number"},"reserved_usd":{"type":"string","title":"Reserved Usd","description":"The hour's fee held, as exact USD. The minutes used are charged when the hour rolls over or keep warm is switched off.","isRequired":true,"uniqueKey":"keep_warm_window.oneOf.0.reserved_usd","typeLabel":"string"}},"isRequired":true,"uniqueKey":"keep_warm_window.oneOf.0","typeLabel":"KeepWarmWindow · object"},{"type":"null","description":"The hour of keep warm being billed for the model the family serves, while the family is kept warm. Null otherwise: a model kept warm on its own shows its own hour.","isRequired":true,"uniqueKey":"keep_warm_window.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"keep_warm_window","typeLabel":"KeepWarmWindow · object | null"},"keep_warm_stopped_at":{"oneOf":[{"type":"number","title":"Keep Warm Stopped At","description":"When keep warm switched off because the next hour couldn't be reserved, while it stays off. Otherwise null.","isRequired":true,"uniqueKey":"keep_warm_stopped_at.oneOf.0","typeLabel":"number"},{"type":"null","title":"Keep Warm Stopped At","description":"When keep warm switched off because the next hour couldn't be reserved, while it stays off. Otherwise null.","isRequired":true,"uniqueKey":"keep_warm_stopped_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"keep_warm_stopped_at","typeLabel":"number | null"},"move":{"oneOf":[{"type":"object","title":"FamilyMove","description":"The move to its latest model it waits to make, and what it waits for. Null while it serves its latest model, or is switched off.","required":["to","waiting_for","reason"],"properties":{"to":{"type":"string","title":"To","description":"The model it moves to, its latest, such as router@5.","isRequired":true,"uniqueKey":"move.oneOf.0.to","typeLabel":"string"},"waiting_for":{"type":"string","enum":["place","warm_place","warm_capacity","engines"],"title":"Waiting For","description":"`place` while the account has no place left for the move, which takes one only if the model the family serves keeps answering by its own switch, or it serves none yet. The move waits until a model is switched off or the tier goes up. A kept-warm family takes a warm place only if the model it serves stays warm by its own keep warm. `warm_place` while the account keeps as many models warm as its tier allows. That wait ends when a model's keep warm is turned off or the tier goes up. `warm_capacity` while the model's size has no kept-warm place free on our engines. That wait ends when one frees. Turning the family's keep warm off ends either wait. `engines` otherwise: the model loads, or waits to be tried again after a failed load.","isRequired":true,"uniqueKey":"move.oneOf.0.waiting_for","typeLabel":"enum\u003cstring>"},"reason":{"oneOf":[{"type":"string","title":"Reason","description":"The code of the refusal that holds a waiting move: `live_limit` for `place`, `warm_limit` for `warm_place` and `warm_capacity` for `warm_capacity`, as switching on, keep warm and rollback name them. Null while it waits for engines.","enum":["live_limit","warm_limit","warm_capacity"],"isRequired":true,"uniqueKey":"move.oneOf.0.reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Reason","description":"The code of the refusal that holds a waiting move: `live_limit` for `place`, `warm_limit` for `warm_place` and `warm_capacity` for `warm_capacity`, as switching on, keep warm and rollback name them. Null while it waits for engines.","isRequired":true,"uniqueKey":"move.oneOf.0.reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"move.oneOf.0.reason","typeLabel":"enum\u003cstring> | null"}},"isRequired":true,"uniqueKey":"move.oneOf.0","typeLabel":"FamilyMove · object"},{"type":"null","description":"The move to its latest model it waits to make, and what it waits for. Null while it serves its latest model, or is switched off.","isRequired":true,"uniqueKey":"move.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"move","typeLabel":"FamilyMove · object | null"},"moved":{"oneOf":[{"type":"object","title":"FamilyMoved","description":"When it last moved by itself to the model it serves, and from which. Null when it never did, or serves another model or was rolled back since.","required":["at","from"],"properties":{"at":{"type":"number","title":"At","description":"When it moved.","isRequired":true,"uniqueKey":"moved.oneOf.0.at","typeLabel":"number"},"from":{"oneOf":[{"type":"string","title":"From","description":"The model it served before, such as router@4, or null when it served none.","isRequired":true,"uniqueKey":"moved.oneOf.0.from.oneOf.0","typeLabel":"string"},{"type":"null","title":"From","description":"The model it served before, such as router@4, or null when it served none.","isRequired":true,"uniqueKey":"moved.oneOf.0.from.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"moved.oneOf.0.from","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"moved.oneOf.0","typeLabel":"FamilyMoved · object"},{"type":"null","description":"When it last moved by itself to the model it serves, and from which. Null when it never did, or serves another model or was rolled back since.","isRequired":true,"uniqueKey":"moved.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"moved","typeLabel":"FamilyMoved · object | null"},"continue":{"oneOf":[{"type":"object","title":"Continuation","description":"What continuing it would do now, from the family's dataset and jobs. It doesn't check credit, storage allowance or queue room, which the start refuses with insufficient_credit, storage_allowance, queue_full or tenant_queue_full. A list of families reads no dataset: there `new_data` and `retry` only say a version no finished job used is waiting, and the counts and fee are null. The answers of a switch, keep warm or rollback leave it out.","required":["state","version","added_at","evaluation_decisions","needed","rows","price_usd"],"properties":{"state":{"type":"string","enum":["new_data","retry","no_new_data","not_enough_evaluation_data","queued","training","origin_gone","dataset_deleted","dataset_archived","dataset_not_reachable","fine_tuning_off"],"title":"State","description":"`new_data` when it can start on a version no finished job of the family used, and `retry` when it can start on the version its last run failed or was cancelled on. Otherwise what refuses it now: no training rows newer than the family last trained on, fewer evaluation decisions than its gate needs, a fine-tune of the family queued or training, an empty family whose origin model was deleted or discarded, its dataset deleted or archived, its dataset in the organisation's own storage while that can't be read, or fine-tuning off on this server. A family whose dataset was deleted never continues again: start a new family from its latest model.","isRequired":true,"uniqueKey":"continue.oneOf.0.state","typeLabel":"enum\u003cstring>"},"version":{"type":"integer","title":"Version","description":"The dataset version a continuation trains on unless it names another: its newest.","isRequired":true,"uniqueKey":"continue.oneOf.0.version","typeLabel":"integer"},"added_at":{"oneOf":[{"type":"number","title":"Added At","description":"When that version was added.","isRequired":true,"uniqueKey":"continue.oneOf.0.added_at.oneOf.0","typeLabel":"number"},{"type":"null","title":"Added At","description":"When that version was added.","isRequired":true,"uniqueKey":"continue.oneOf.0.added_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"continue.oneOf.0.added_at","typeLabel":"number | null"},"evaluation_decisions":{"oneOf":[{"type":"integer","title":"Evaluation Decisions","description":"The evaluation decisions about new contexts its gate could judge. Null while a job is queued or training, and when it is refused whatever the data.","isRequired":true,"uniqueKey":"continue.oneOf.0.evaluation_decisions.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Evaluation Decisions","description":"The evaluation decisions about new contexts its gate could judge. Null while a job is queued or training, and when it is refused whatever the data.","isRequired":true,"uniqueKey":"continue.oneOf.0.evaluation_decisions.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"continue.oneOf.0.evaluation_decisions","typeLabel":"integer | null"},"needed":{"type":"integer","title":"Needed","description":"How many of those the gate needs.","isRequired":true,"uniqueKey":"continue.oneOf.0.needed","typeLabel":"integer"},"rows":{"oneOf":[{"type":"object","title":"ContinueRows","description":"The rows it would take. Null when evaluation_decisions is.","required":["new","earlier","evaluation"],"properties":{"new":{"type":"integer","title":"New","description":"Training rows added since the family last trained.","isRequired":true,"uniqueKey":"continue.oneOf.0.rows.oneOf.0.new","typeLabel":"integer"},"earlier":{"type":"integer","title":"Earlier","description":"Earlier training rows sampled to train on with them.","isRequired":true,"uniqueKey":"continue.oneOf.0.rows.oneOf.0.earlier","typeLabel":"integer"},"evaluation":{"type":"integer","title":"Evaluation","description":"Evaluation rows its gate would measure on.","isRequired":true,"uniqueKey":"continue.oneOf.0.rows.oneOf.0.evaluation","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"continue.oneOf.0.rows.oneOf.0","typeLabel":"ContinueRows · object"},{"type":"null","description":"The rows it would take. Null when evaluation_decisions is.","isRequired":true,"uniqueKey":"continue.oneOf.0.rows.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"continue.oneOf.0.rows","typeLabel":"ContinueRows · object | null"},"price_usd":{"oneOf":[{"type":"string","title":"Price Usd","description":"0, as exact USD, when a continuation that can start would be free. Otherwise null: a priced fine-tune's fee depends on the hyperparameters it is sent with. `POST /v1/families/{family}/continue/estimate` gives the exact fee for them; send it as max_price_usd.","isRequired":true,"uniqueKey":"continue.oneOf.0.price_usd.oneOf.0","typeLabel":"string"},{"type":"null","title":"Price Usd","description":"0, as exact USD, when a continuation that can start would be free. Otherwise null: a priced fine-tune's fee depends on the hyperparameters it is sent with. `POST /v1/families/{family}/continue/estimate` gives the exact fee for them; send it as max_price_usd.","isRequired":true,"uniqueKey":"continue.oneOf.0.price_usd.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"continue.oneOf.0.price_usd","typeLabel":"string | null"}},"uniqueKey":"continue.oneOf.0","typeLabel":"Continuation · object"},{"type":"null","description":"What continuing it would do now, from the family's dataset and jobs. It doesn't check credit, storage allowance or queue room, which the start refuses with insufficient_credit, storage_allowance, queue_full or tenant_queue_full. A list of families reads no dataset: there `new_data` and `retry` only say a version no finished job used is waiting, and the counts and fee are null. The answers of a switch, keep warm or rollback leave it out.","uniqueKey":"continue.oneOf.1","typeLabel":"null"}],"uniqueKey":"continue","typeLabel":"Continuation · object | null"},"jobs":{"items":{"properties":{"id":{"type":"string","title":"Id","isRequired":true,"uniqueKey":"jobs.items.[INDEX].id","typeLabel":"string"},"status":{"type":"string","enum":["queued","running","cancelling","succeeded","failed","cancelled"],"title":"Status","isRequired":true,"uniqueKey":"jobs.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"outcome":{"oneOf":[{"type":"string","title":"Outcome","description":"How it ended: its model joined the family, failed its gate, the run failed or was cancelled, or a rollback discarded the model it made. Null while it runs.","enum":["joined","gate_failed","failed","cancelled","rolled_back"],"isRequired":true,"uniqueKey":"jobs.items.[INDEX].outcome.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Outcome","description":"How it ended: its model joined the family, failed its gate, the run failed or was cancelled, or a rollback discarded the model it made. Null while it runs.","isRequired":true,"uniqueKey":"jobs.items.[INDEX].outcome.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"jobs.items.[INDEX].outcome","typeLabel":"enum\u003cstring> | null"},"reason":{"oneOf":[{"type":"string","title":"Reason","description":"Why it made no model, in one line: the gate's first reason, or the first line of the error of a run that failed. Otherwise null.","isRequired":true,"uniqueKey":"jobs.items.[INDEX].reason.oneOf.0","typeLabel":"string"},{"type":"null","title":"Reason","description":"Why it made no model, in one line: the gate's first reason, or the first line of the error of a run that failed. Otherwise null.","isRequired":true,"uniqueKey":"jobs.items.[INDEX].reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"jobs.items.[INDEX].reason","typeLabel":"string | null"},"dataset_version":{"type":"integer","title":"Dataset Version","isRequired":true,"uniqueKey":"jobs.items.[INDEX].dataset_version","typeLabel":"integer"},"output_model":{"oneOf":[{"type":"string","title":"Output Model","isRequired":true,"uniqueKey":"jobs.items.[INDEX].output_model.oneOf.0","typeLabel":"string"},{"type":"null","title":"Output Model","isRequired":true,"uniqueKey":"jobs.items.[INDEX].output_model.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"jobs.items.[INDEX].output_model","typeLabel":"string | null"},"created_at":{"type":"number","title":"Created At","isRequired":true,"uniqueKey":"jobs.items.[INDEX].created_at","typeLabel":"number"},"price_usd":{"type":"string","title":"Price Usd","description":"The fee held for this job, as exact USD.","isRequired":true,"uniqueKey":"jobs.items.[INDEX].price_usd","typeLabel":"string"},"charge":{"type":"string","enum":["free","reserved","charged","released"],"title":"Charge","description":"What the fee is doing: held while the job runs, charged once training finishes, whatever the gate says, released if the run fails or is cancelled.","isRequired":true,"uniqueKey":"jobs.items.[INDEX].charge","typeLabel":"enum\u003cstring>"}},"type":"object","required":["id","status","outcome","reason","dataset_version","output_model","created_at","price_usd","charge"],"title":"FamilyJob","uniqueKey":"jobs.items.[INDEX]","typeLabel":"FamilyJob · object"},"type":"array","title":"Jobs","description":"Its fine-tunes, newest first, with how each ended. Lists of families, and the answers of a switch, keep warm or rollback, leave it out.","uniqueKey":"jobs","typeLabel":"FamilyJob · object[]"}},"type":"object","required":["id","object","switched_on","used_at","switches_off_at","off_reason","off_at","dataset_id","origin","created_at","served","latest","models","keep_warm","keep_warm_window","keep_warm_stopped_at","move","moved"],"title":"Family","uniqueKey":"","typeLabel":"Family · object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","object":"family","switched_on":true,"used_at":123,"switches_off_at":123,"off_reason":"owner","off_at":123,"dataset_id":"\u003cstring>","origin":"\u003cstring>","created_at":123,"served":{"version":123,"ref":"\u003cstring>","adapter":"\u003cstring>","status":"\u003cstring>","on_at":123,"keep_warm":true,"keep_warm_stopped_at":123,"used_at":123,"switches_off_at":123,"off_reason":"owner","off_at":123,"parent":"\u003cstring>","created_at":123,"gate":{"passed":true,"against":"parent","reasons":["\u003cstring>"],"groups":{},"ece":{}},"heldout":{},"discarded_at":123,"keep_warm_trial":{"slot":123,"started_at":123,"ends_at":123,"state":"pending"}},"latest":{"version":123,"ref":"\u003cstring>","adapter":"\u003cstring>","status":"\u003cstring>","on_at":123,"keep_warm":true,"keep_warm_stopped_at":123,"used_at":123,"switches_off_at":123,"off_reason":"owner","off_at":123,"parent":"\u003cstring>","created_at":123,"gate":{"passed":true,"against":"parent","reasons":["\u003cstring>"],"groups":{},"ece":{}},"heldout":{},"discarded_at":123,"keep_warm_trial":{"slot":123,"started_at":123,"ends_at":123,"state":"pending"}},"models":[{"version":123,"ref":"\u003cstring>","adapter":"\u003cstring>","status":"\u003cstring>","on_at":123,"keep_warm":true,"keep_warm_stopped_at":123,"used_at":123,"switches_off_at":123,"off_reason":"owner","off_at":123,"parent":"\u003cstring>","created_at":123,"gate":{"passed":true,"against":"parent","reasons":["\u003cstring>"],"groups":{},"ece":{}},"heldout":{},"discarded_at":123,"keep_warm_trial":{"slot":123,"started_at":123,"ends_at":123,"state":"pending"}}],"keep_warm":true,"keep_warm_window":{"started_at":123,"ends_at":123,"reserved_usd":"\u003cstring>"},"keep_warm_stopped_at":123,"move":{"to":"\u003cstring>","waiting_for":"place","reason":"live_limit"},"moved":{"at":123,"from":"\u003cstring>"},"continue":{"state":"new_data","version":123,"added_at":123,"evaluation_decisions":123,"needed":123,"rows":{"new":123,"earlier":123,"evaluation":123},"price_usd":"\u003cstring>"},"jobs":[{"id":"\u003cstring>","status":"queued","outcome":"joined","reason":"\u003cstring>","dataset_version":123,"output_model":"\u003cstring>","created_at":123,"price_usd":"\u003cstring>","charge":"free"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"dc9bd3a4-310d-4ef8-859f-18a26f1c4ef5":{"description":"Client error. On a 422, `error.details` lists each field that failed.","content":{"application/json":{"schema":{"description":"The body of every error.","properties":{"error":{"properties":{"code":{"description":"A stable code to branch on, such as invalid_request.","title":"Code","type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"description":"What went wrong and what to change, in plain words.","title":"Message","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"description":"True when another attempt may succeed; it does not prove that no work was done. Respect Retry-After when present. Only operations that support Idempotency-Key replay a prior result, including /v1/decide for 24 hours, but not a decision of an organisation with zero data retention, which keeps no answer.","title":"Retryable","type":"boolean","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"request_id":{"description":"Also sent as X-Request-ID. Quote it in bug reports.","title":"Request Id","type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"details":{"oneOf":[{"type":"array","items":{"properties":{"path":{"description":"Where the problem is, such as [\"body\", \"decisions\", 0, \"outcomes\"].","items":{"oneOf":[{"type":"string","uniqueKey":"error.details.oneOf.0.items.[INDEX].path.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"error.details.oneOf.0.items.[INDEX].path.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"error.details.oneOf.0.items.[INDEX].path.items.[INDEX]","typeLabel":"string | integer"},"title":"Path","type":"array","isRequired":true,"uniqueKey":"error.details.oneOf.0.items.[INDEX].path","typeLabel":"(string | integer)[]"},"message":{"title":"Message","type":"string","isRequired":true,"uniqueKey":"error.details.oneOf.0.items.[INDEX].message","typeLabel":"string"},"type":{"oneOf":[{"type":"string","title":"Type","uniqueKey":"error.details.oneOf.0.items.[INDEX].type.oneOf.0","typeLabel":"string"},{"type":"null","title":"Type","uniqueKey":"error.details.oneOf.0.items.[INDEX].type.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details.oneOf.0.items.[INDEX].type","typeLabel":"string | null"}},"required":["path","message"],"title":"ErrorDetail","type":"object","uniqueKey":"error.details.oneOf.0.items.[INDEX]","typeLabel":"ErrorDetail · object"},"title":"Details","description":"On validation errors, one entry for each field that failed.","uniqueKey":"error.details.oneOf.0","typeLabel":"ErrorDetail · object[]"},{"type":"null","title":"Details","description":"On validation errors, one entry for each field that failed.","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"ErrorDetail · object[] | null"}},"required":["code","message","retryable","request_id"],"title":"ErrorBody","type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"ErrorBody · object"}},"required":["error"],"title":"ErrorResponse","type":"object","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","retryable":true,"request_id":"\u003cstring>","details":[{"path":["\u003cstring>"],"message":"\u003cstring>","type":"\u003cstring>"}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"577b321b-65eb-4dd1-938e-bbc9ce625235":{"description":"Server error. A 503 names what is not running on this server.","content":{"application/json":{"schema":{"description":"The body of every error.","properties":{"error":{"properties":{"code":{"description":"A stable code to branch on, such as invalid_request.","title":"Code","type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"description":"What went wrong and what to change, in plain words.","title":"Message","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"description":"True when another attempt may succeed; it does not prove that no work was done. Respect Retry-After when present. Only operations that support Idempotency-Key replay a prior result, including /v1/decide for 24 hours, but not a decision of an organisation with zero data retention, which keeps no answer.","title":"Retryable","type":"boolean","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"request_id":{"description":"Also sent as X-Request-ID. Quote it in bug reports.","title":"Request Id","type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"details":{"oneOf":[{"type":"array","items":{"properties":{"path":{"description":"Where the problem is, such as [\"body\", \"decisions\", 0, \"outcomes\"].","items":{"oneOf":[{"type":"string","uniqueKey":"error.details.oneOf.0.items.[INDEX].path.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"error.details.oneOf.0.items.[INDEX].path.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"error.details.oneOf.0.items.[INDEX].path.items.[INDEX]","typeLabel":"string | integer"},"title":"Path","type":"array","isRequired":true,"uniqueKey":"error.details.oneOf.0.items.[INDEX].path","typeLabel":"(string | integer)[]"},"message":{"title":"Message","type":"string","isRequired":true,"uniqueKey":"error.details.oneOf.0.items.[INDEX].message","typeLabel":"string"},"type":{"oneOf":[{"type":"string","title":"Type","uniqueKey":"error.details.oneOf.0.items.[INDEX].type.oneOf.0","typeLabel":"string"},{"type":"null","title":"Type","uniqueKey":"error.details.oneOf.0.items.[INDEX].type.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details.oneOf.0.items.[INDEX].type","typeLabel":"string | null"}},"required":["path","message"],"title":"ErrorDetail","type":"object","uniqueKey":"error.details.oneOf.0.items.[INDEX]","typeLabel":"ErrorDetail · object"},"title":"Details","description":"On validation errors, one entry for each field that failed.","uniqueKey":"error.details.oneOf.0","typeLabel":"ErrorDetail · object[]"},{"type":"null","title":"Details","description":"On validation errors, one entry for each field that failed.","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"ErrorDetail · object[] | null"}},"required":["code","message","retryable","request_id"],"title":"ErrorBody","type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"ErrorBody · object"}},"required":["error"],"title":"ErrorResponse","type":"object","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","retryable":true,"request_id":"\u003cstring>","details":[{"path":["\u003cstring>"],"message":"\u003cstring>","type":"\u003cstring>"}]}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"8283907c-5f0e-4d80-97d9-c7972e703429":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"onehot_sk_...","description":"Create an API key in the console.","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"b46254f4-e116-4546-b0af-1d5e8cbad909":{"url":"https://api.sqwish.ai"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"onehot_sk_...","description":"Create an API key in the console.","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Create an API key in the console.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"sqwishai","siteName":"OneHot","title":"Get family - OneHot","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-15T20:24:49.296Z","originalFileLocation":"api-reference/families/get-family.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"A family: its dataset and where it started, its switch and the model it serves, its models with their own switches, keep warm, its fine-tunes with how each ended, what each cost and why it made no model, and what continuing it would do now (continue): train on the dataset\u0026#x27;s newest version, or why it can\u0026#x27;t yet, with the rows it would take and the fee it would hold.\">\u003cmeta data-mint-head name=\"application-name\" content=\"OneHot\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/sqwishai/YdfbdoMtzuqoaza3/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/sqwishai/YdfbdoMtzuqoaza3/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/sqwishai/YdfbdoMtzuqoaza3/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/sqwishai/YdfbdoMtzuqoaza3/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/sqwishai/YdfbdoMtzuqoaza3/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/sqwishai/YdfbdoMtzuqoaza3/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/sqwishai/YdfbdoMtzuqoaza3/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/sqwishai/YdfbdoMtzuqoaza3/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/sqwishai/YdfbdoMtzuqoaza3/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get family - OneHot\">\u003cmeta data-mint-head property=\"og:description\" content=\"A family: its dataset and where it started, its switch and the model it serves, its models with their own switches, keep warm, its fine-tunes with how each ended, what each cost and why it made no model, and what continuing it would do now (continue): train on the dataset\u0026#x27;s newest version, or why it can\u0026#x27;t yet, with the rows it would take and the fee it would hold.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"OneHot\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.sqwish.ai/api-reference/families/get-family\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://sqwishai.mintlify.site/_mintlify/api/og/v2?division=Families\u0026amp;title=Get+family\u0026amp;description=A+family%3A+its+dataset+and+where+it+started%2C+its+switch+and+the+model+it+serves%2C+its%0Amodels+with+their+own+switches%2C+keep+warm%2C+its+fine-tunes+with+how+each+ende\u0026amp;theme=780ede062e11bed2c104ce33\u0026amp;signature=e1d12bd1a1de19b85b1954c403f0c0544b23dc7acc11266e9a2b17fca17fca6f\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get family - OneHot\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"A family: its dataset and where it started, its switch and the model it serves, its models with their own switches, keep warm, its fine-tunes with how each ended, what each cost and why it made no model, and what continuing it would do now (continue): train on the dataset\u0026#x27;s newest version, or why it can\u0026#x27;t yet, with the rows it would take and the fee it would hold.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://sqwishai.mintlify.site/_mintlify/api/og/v2?division=Families\u0026amp;title=Get+family\u0026amp;description=A+family%3A+its+dataset+and+where+it+started%2C+its+switch+and+the+model+it+serves%2C+its%0Amodels+with+their+own+switches%2C+keep+warm%2C+its+fine-tunes+with+how+each+ende\u0026amp;theme=780ede062e11bed2c104ce33\u0026amp;signature=e1d12bd1a1de19b85b1954c403f0c0544b23dc7acc11266e9a2b17fca17fca6f\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/sqwishai/YdfbdoMtzuqoaza3/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"OneHot\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#555555\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.sqwish.ai/api-reference/families/get-family\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/families/get-family.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.sqwish.ai/#organization\",\"name\":\"OneHot\",\"url\":\"https://docs.sqwish.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/sqwishai/DckT8DnfX584QrKL/images/sqwish.png?fit=max\u0026auto=format\u0026n=DckT8DnfX584QrKL\u0026q=85\u0026s=bc446299f18ab06437c9fc4cd723c188\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.sqwish.ai#website\",\"name\":\"OneHot\",\"url\":\"https://docs.sqwish.ai\",\"publisher\":{\"@id\":\"https://docs.sqwish.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.sqwish.ai/api-reference/families/get-family#webpage\",\"url\":\"https://docs.sqwish.ai/api-reference/families/get-family\",\"name\":\"Get family\",\"description\":\"A family: its dataset and where it started, its switch and the model it serves, its models with their own switches, keep warm, its fine-tunes with how each ended, what each cost and why it made no model, and what continuing it would do now (continue): train on the dataset's newest version, or why it can't yet, with the rows it would take and the fee it would hold.\",\"dateModified\":\"2026-11-15T20:24:49.296Z\",\"isPartOf\":{\"@id\":\"https://docs.sqwish.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.sqwish.ai/api-reference/families/get-family#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.sqwish.ai/api-reference/families/get-family#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Families\",\"item\":\"https://docs.sqwish.ai/api-reference/families/list-families\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get family\",\"item\":\"https://docs.sqwish.ai/api-reference/families/get-family\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.sqwish.ai/api-reference/families/get-family#apireference\",\"headline\":\"Get family\",\"name\":\"Get family\",\"description\":\"A family: its dataset and where it started, its switch and the model it serves, its models with their own switches, keep warm, its fine-tunes with how each ended, what each cost and why it made no model, and what continuing it would do now (continue): train on the dataset's newest version, or why it can't yet, with the rows it would take and the fee it would hold.\",\"url\":\"https://docs.sqwish.ai/api-reference/families/get-family\",\"mainEntityOfPage\":{\"@id\":\"https://docs.sqwish.ai/api-reference/families/get-family#webpage\"},\"dateModified\":\"2026-11-15T20:24:49.296Z\",\"publisher\":{\"@id\":\"https://docs.sqwish.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.sqwish.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"OneHot\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"OneHot\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/families/get-family.md","siteName":"OneHot","nav":{"global":{"anchors":[{"anchor":"llms.txt","icon":"file-lines","href":"https://api.sqwish.ai/llms.txt"},{"anchor":"openapi.json","icon":"file-code","href":"https://api.sqwish.ai/openapi.json"}]},"tabs":[{"tab":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","icon":"code","groups":[{"group":"Overview","pages":[{"title":"API reference","href":"/api-reference/overview"}]},{"group":"Decisions","pages":[{"title":"List recipes","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/recipes","href":"/api-reference/decisions/list-recipes"},{"title":"Run decisions","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/decide","href":"/api-reference/decisions/run-decisions"},{"title":"Estimate the cost of decisions","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/decide/estimate","href":"/api-reference/decisions/estimate-the-cost-of-decisions"},{"title":"Lint decisions","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/lint","href":"/api-reference/decisions/lint-decisions"},{"title":"Run Jev decisions","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/systemone","href":"/api-reference/decisions/run-jev-decisions"},{"title":"Estimate the cost of Jev decisions","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/systemone/estimate","href":"/api-reference/decisions/estimate-the-cost-of-jev-decisions"},{"title":"Translate Jev requests","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/systemone/translate","href":"/api-reference/decisions/translate-jev-requests"}]},{"group":"Models","pages":[{"title":"List models","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/models","href":"/api-reference/models/list-models"},{"title":"Get model","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/models/{model_id}","href":"/api-reference/models/get-model"},{"title":"Delete model version","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/models/{model_id}","href":"/api-reference/models/delete-model-version"},{"title":"Check model readiness","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/models/{model_id}/ready","href":"/api-reference/models/check-model-readiness"},{"title":"Get model activity","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/models/{model_id}/activity","href":"/api-reference/models/get-model-activity"},{"title":"Switch a model","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/models/{model}/switch","href":"/api-reference/models/switch-a-model"},{"title":"Keep a model warm","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/models/{model}/keep-warm","href":"/api-reference/models/keep-a-model-warm"}]},{"group":"Families","pages":[{"title":"List families","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/families","href":"/api-reference/families/list-families"},{"title":"Start a family","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/families","href":"/api-reference/families/start-a-family"},{"title":"Continue a family","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/families/{family}/continue","href":"/api-reference/families/continue-a-family"},{"title":"Estimate the fee of starting a family","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/families/estimate","href":"/api-reference/families/estimate-the-fee-of-starting-a-family"},{"title":"Estimate the fee of continuing a family","description":"The exact fee `POST /v1/families/{family}/continue` would hold for the same body now,\nwithout max_price_usd, worked out as the continuation does: the same new rows and the same\nsample of earlier rows. Nothing is queued or held. The estimate is exact if nothing\nchanges before you start; pass it as max_price_usd to cap the price. While a large dataset\nversion's training tokens are first counted, it answers 503 tokens_counting with\nRetry-After: ask again then.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/families/{family}/continue/estimate","href":"/api-reference/families/estimate-the-fee-of-continuing-a-family"},{"title":"Get family","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/families/{family}","href":"/api-reference/families/get-family"},{"title":"Delete a family","description":"Delete a family. One no model ever joined goes, and its name is free again. A model\nthat failed its gate never joined. Otherwise every model of its line goes with it,\ndiscarded ones included, and you can't bring them back. Its name is never given again,\nand calls to it, and reads and changes of it, get 410 family_deleted. Its dataset and\nits fine-tunes, with their charges, stay. 409 family_answers while it or one of its\nmodels answers calls, naming them: switch them off first. 409 family_training while one\nof its fine-tunes is queued or running, and 409 version_in_use while an evaluation\nscores one of its models. With `dataset_id`, the dataset the family grew on when the\ncaller looked, only while it still does, and with `latest`, the id of its latest model\nthe caller saw, only while it still is: 409 family_changed otherwise. Deleting a family\na model joined again changes nothing; an empty one is gone, so it gets 404 not_found.","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/families/{family}","href":"/api-reference/families/delete-a-family"},{"title":"Switch a family","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/families/{family}/switch","href":"/api-reference/families/switch-a-family"},{"title":"Keep a family warm","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/families/{family}/keep-warm","href":"/api-reference/families/keep-a-family-warm"},{"title":"Roll back a family","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/families/{family}/rollback","href":"/api-reference/families/roll-back-a-family"}]},{"group":"Datasets","pages":[{"title":"List datasets","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/datasets","href":"/api-reference/datasets/list-datasets"},{"title":"Create dataset","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/datasets","href":"/api-reference/datasets/create-dataset"},{"title":"List dataset versions","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/datasets/{dataset_id}/versions","href":"/api-reference/datasets/list-dataset-versions"},{"title":"Add rows to a dataset","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/datasets/{dataset_id}/versions","href":"/api-reference/datasets/add-rows-to-a-dataset"},{"title":"Get dataset","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/datasets/{dataset_id}","href":"/api-reference/datasets/get-dataset"},{"title":"Delete dataset","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/datasets/{dataset_id}","href":"/api-reference/datasets/delete-dataset"},{"title":"Rename dataset","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/datasets/{dataset_id}","href":"/api-reference/datasets/rename-dataset"},{"title":"Restore dataset","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/datasets/{dataset_id}/restore","href":"/api-reference/datasets/restore-dataset"},{"title":"Download dataset","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/datasets/{dataset_id}/download","href":"/api-reference/datasets/download-dataset"},{"title":"List dataset rows","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/datasets/{dataset_id}/rows","href":"/api-reference/datasets/list-dataset-rows"},{"title":"List labels to check","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/datasets/{dataset_id}/labels-to-check","href":"/api-reference/datasets/list-labels-to-check"}]},{"group":"Evaluations","pages":[{"title":"List evaluations","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/evaluations","href":"/api-reference/evaluations/list-evaluations"},{"title":"Evaluate models on a dataset","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/evaluations","href":"/api-reference/evaluations/evaluate-models-on-a-dataset"},{"title":"Get an evaluation","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/evaluations/{evaluation_id}","href":"/api-reference/evaluations/get-an-evaluation"},{"title":"Cancel an evaluation","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/evaluations/{evaluation_id}/cancel","href":"/api-reference/evaluations/cancel-an-evaluation"},{"title":"Retry an evaluation","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/evaluations/{evaluation_id}/retry","href":"/api-reference/evaluations/retry-an-evaluation"}]},{"group":"Fine-tuning","pages":[{"title":"List fine-tuning jobs","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/fine-tuning/jobs","href":"/api-reference/fine-tuning/list-fine-tuning-jobs"},{"title":"Get fine-tuning job","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/fine-tuning/jobs/{job_id}","href":"/api-reference/fine-tuning/get-fine-tuning-job"},{"title":"List job events","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/fine-tuning/jobs/{job_id}/events","href":"/api-reference/fine-tuning/list-job-events"},{"title":"List held-out records","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/fine-tuning/jobs/{job_id}/records","href":"/api-reference/fine-tuning/list-held-out-records"},{"title":"Cancel fine-tuning job","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/fine-tuning/jobs/{job_id}/cancel","href":"/api-reference/fine-tuning/cancel-fine-tuning-job"}]},{"group":"Prompt tuning","pages":[{"title":"List prompt-tuning jobs","deprecated":true,"version":null,"openapi":"/openapi.json get /v1/prompt-tuning/jobs","href":"/api-reference/prompt-tuning/list-prompt-tuning-jobs"},{"title":"Create prompt-tuning job","deprecated":true,"version":null,"openapi":"/openapi.json post /v1/prompt-tuning/jobs","href":"/api-reference/prompt-tuning/create-prompt-tuning-job"},{"title":"Get prompt-tuning job","deprecated":true,"version":null,"openapi":"/openapi.json get /v1/prompt-tuning/jobs/{job_id}","href":"/api-reference/prompt-tuning/get-prompt-tuning-job"},{"title":"Dismiss label issues","deprecated":true,"version":null,"openapi":"/openapi.json patch /v1/prompt-tuning/jobs/{job_id}","href":"/api-reference/prompt-tuning/dismiss-label-issues"},{"title":"Cancel prompt-tuning job","deprecated":true,"version":null,"openapi":"/openapi.json post /v1/prompt-tuning/jobs/{job_id}/cancel","href":"/api-reference/prompt-tuning/cancel-prompt-tuning-job"}]},{"group":"Labelling","pages":[{"title":"List teachers","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/labeling/teachers","href":"/api-reference/labelling/list-teachers"},{"title":"List query sources","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/labeling/sources","href":"/api-reference/labelling/list-query-sources"},{"title":"Upload queries","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/labeling/sources","href":"/api-reference/labelling/upload-queries"},{"title":"Get query source","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/labeling/sources/{source_id}","href":"/api-reference/labelling/get-query-source"},{"title":"Delete query source","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/labeling/sources/{source_id}","href":"/api-reference/labelling/delete-query-source"},{"title":"List labeling jobs","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/labeling/jobs","href":"/api-reference/labelling/list-labeling-jobs"},{"title":"Create labeling job","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/labeling/jobs","href":"/api-reference/labelling/create-labeling-job"},{"title":"Get labeling job","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/labeling/jobs/{job_id}","href":"/api-reference/labelling/get-labeling-job"},{"title":"List labeling results","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/labeling/jobs/{job_id}/results","href":"/api-reference/labelling/list-labeling-results"},{"title":"Cancel labeling job","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/labeling/jobs/{job_id}/cancel","href":"/api-reference/labelling/cancel-labeling-job"},{"title":"Discard labeling job","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/labeling/jobs/{job_id}/discard","href":"/api-reference/labelling/discard-labeling-job"},{"title":"Finalize labeling job","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/labeling/jobs/{job_id}/finalize","href":"/api-reference/labelling/finalize-labeling-job"}]},{"group":"Accounts","pages":[{"title":"Get usage","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization/usage","href":"/api-reference/accounts/get-usage"},{"title":"List requests","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization/usage/requests","href":"/api-reference/accounts/list-requests"},{"title":"List API keys","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization/keys","href":"/api-reference/accounts/list-api-keys"},{"title":"Get account","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/account","href":"/api-reference/accounts/get-account"}]},{"group":"Billing","pages":[{"title":"Get the low-balance alert and this month's spending","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization/spending","href":"/api-reference/billing/get-the-low-balance-alert-and-this-months-spending"},{"title":"Get referrals","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/account/referrals","href":"/api-reference/billing/get-referrals"},{"title":"Get credit balance","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization/wallet","href":"/api-reference/billing/get-credit-balance"},{"title":"List purchases","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization/payments","href":"/api-reference/billing/list-purchases"},{"title":"Get purchase","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization/payments/{purchase_id}","href":"/api-reference/billing/get-purchase"},{"title":"Get automatic top-up","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization/automatic-topup","href":"/api-reference/billing/get-automatic-top-up"}]},{"group":"Organizations","pages":[{"title":"Get organization","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization","href":"/api-reference/organizations/get-organization"},{"title":"Get organization summary","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization/summary","href":"/api-reference/organizations/get-organization-summary"}]},{"group":"Projects","pages":[{"title":"List the organisation's projects","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/projects","href":"/api-reference/projects/list-the-organisations-projects"},{"title":"Get a project's spending limit and this month's spending","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/projects/{project_id}/spending","href":"/api-reference/projects/get-a-projects-spending-limit-and-this-months-spending"}]},{"group":"Integrations","pages":[{"title":"Check tool call","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/hooks/claude-code","href":"/api-reference/integrations/check-tool-call"}]},{"group":"System","pages":[{"title":"Check health","deprecated":null,"version":null,"openapi":"/openapi.json get /healthz","href":"/api-reference/system/check-health"},{"title":"Discover capabilities","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/onehot","href":"/api-reference/system/discover-capabilities"}]}]},{"tab":"Examples","icon":"flask","pages":[{"title":"Examples","href":"/examples/overview"}]}]},"basePath":"","title":"Get family - OneHot","deploymentId":"dpl_Em2U4NQQ2N2DE3HPbPUJVZLnAtvc","buildId":"dpl_Em2U4NQQ2N2DE3HPbPUJVZLnAtvc","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-_HcdDqS2.js","snippetPresets-CXnm-WO6.js","utils-Dg59J__o.js","style-to-object-BY3JEAdk.js","utils-D8TRpdk7.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-B6QaxWc5.js","conditional-requirements-CFM0id0Q.js","cloneDeep-DeMZ-lcM.js","_Uint8Array-BjA2mcVW.js","isObject-FP1Yky1u.js","Page-DuqezyvM.js","CodeSnippet-B373COAT.js","DynamicMarkdown-5yMTCLas.js","SectionHeading-BxT1HYfP.js","icon-DYJTTD3g.js","ApiExamples-cjPyMv63.js","usePlaygroundInputsStore-D7BWoaw4.js","shallow-Z1ceDNSG.js","isEqual-BObTuQrO.js","CodeSnippets-D1UZ1AE-.js","getApiPlaygroundDisplay-CfL-UuDS.js","MethodPill-4AyycJeu.js","getPastedJson-Bp3WV6cN.js","Check2Icon-PhZu6Gry.js","axios-CsQoIw0U.js","Markdown-Dy9a8hT8.js","AssistantPageLink-87tSPwGm.js","dist-CXMB3QQU.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}