Update a custom model record; vendor-configuration changes are applied asynchronously by redeploying the model.
This supports three kinds of update: changing model metadata only, renaming the model, and changing the vendor configuration. A vendor-configuration change is asynchronous — it puts the model back into a deploying status, records an update job, and starts a Temporal workflow to redeploy, so the new configuration is not live when this returns; metadata-only and rename changes take effect immediately. The vendor configuration supplied must match the model’s own vendor (launch or llmengine), and only those two vendors are supported. A model that is currently deploying cannot be modified and the request fails until deployment finishes. When renaming with on_conflict set to swap, the name is exchanged with an existing model of the same name and vendor instead of failing on the uniqueness constraint.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Scale AI","colors":{"primary":"#3f2e7b","light":"#ca62ff","dark":"#3f2e7b"},"logo":{"light":"https://mintcdn.com/scalegp/TBmst1qiYXwYqUB5/logo/light.png?fit=max\u0026auto=format\u0026n=TBmst1qiYXwYqUB5\u0026q=85\u0026s=46027042c16b373ac463148db5ad1d6b","dark":"https://mintcdn.com/scalegp/TBmst1qiYXwYqUB5/logo/dark.png?fit=max\u0026auto=format\u0026n=TBmst1qiYXwYqUB5\u0026q=85\u0026s=02733f39d684d796ec742853eabf0de5"},"favicon":"https://mintcdn.com/scalegp/1vQnbXFkjbQbcgd1/favicon.png?fit=max\u0026auto=format\u0026n=1vQnbXFkjbQbcgd1\u0026q=85\u0026s=f52c84ba46a7cca58551673616dabe9c","background":{"decoration":"windows"},"navbar":{"links":[],"primary":{"type":"button","label":"Platform","href":"https://app.sgp.scale.com/"}},"footer":{"socials":{"x":"https://x.com/scale_ai","facebook":"https://www.facebook.com/scaleapi","linkedin":"https://www.linkedin.com/company/scaleai"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"scalegp","hasAudioNarration":false,"actualSubdomain":"scalegp","customDomains":["docs.gp.scale.com"],"gitSource":{"type":"github","owner":"scaleapi","repo":"sgp-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aecf0ec6829c68a2fb0d3c8","clientVersion":"0.0.4087","searchFilterCounts":[{"language":"default","tag":"API Reference","count":235},{"language":"default","tag":"AgentOps API","count":141},{"language":"default","tag":"Guides","count":131},{"language":"default","tag":"Agentex API","count":97},{"language":"default","tag":"Evaluations","count":72},{"language":"default","tag":"Dex API","count":48},{"language":"default","tag":"Agents","count":44},{"language":"default","tag":"Evaluation Datasets","count":34},{"language":"default","tag":"Models","count":32},{"language":"default","tag":"Knowledge Bases","count":31}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","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":"llms-txt-v2","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":"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":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"styles.css","content":"@font-face{font-family:'Aeonik';src:url('https://fonts.gstatic.com/s/inter/v18/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1ZL7W0Q5nw.woff2');font-weight:normal;font-style:normal;font-display:swap}h1,h2,h3{font-family:'aeonik';letter-spacing:normal!important}"}],"page":{"pagePath":"reference/v5/models/update-a-custom-model","slug":"/reference/v5/models/update-a-custom-model","pageMetadata":{"title":"Update a custom model","description":"Update a custom model record; vendor-configuration changes are applied asynchronously by redeploying the model.\n\nThis supports three kinds of update: changing model metadata only, renaming the model, and changing the vendor configuration. A vendor-configuration change is asynchronous — it puts the model back into a deploying status, records an update job, and starts a Temporal workflow to redeploy, so the new configuration is not live when this returns; metadata-only and rename changes take effect immediately. The vendor configuration supplied must match the model's own vendor (`launch` or `llmengine`), and only those two vendors are supported. A model that is currently deploying cannot be modified and the request fails until deployment finishes. When renaming with `on_conflict` set to `swap`, the name is exchanged with an existing model of the same name and vendor instead of failing on the uniqueness constraint.","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml patch /v5/models/{model_id}","href":"/reference/v5/models/update-a-custom-model","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, 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(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Update a custom model record; vendor-configuration changes are applied asynchronously by redeploying the model.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"This supports three kinds of update: changing model metadata only, renaming the model, and changing the vendor configuration. A vendor-configuration change is asynchronous — it puts the model back into a deploying status, records an update job, and starts a Temporal workflow to redeploy, so the new configuration is not live when this returns; metadata-only and rename changes take effect immediately. The vendor configuration supplied must match the model’s own vendor (\", _jsx(_components.code, {\n children: \"launch\"\n }), \" or \", _jsx(_components.code, {\n children: \"llmengine\"\n }), \"), and only those two vendors are supported. A model that is currently deploying cannot be modified and the request fails until deployment finishes. When renaming with \", _jsx(_components.code, {\n children: \"on_conflict\"\n }), \" set to \", _jsx(_components.code, {\n children: \"swap\"\n }), \", the name is exchanged with an existing model of the same name and vendor instead of failing on the uniqueness constraint.\"]\n })]\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":"Update a custom model","description":"Update a custom model record; vendor-configuration changes are applied asynchronously by redeploying the model.\n\nThis supports three kinds of update: changing model metadata only, renaming the model, and changing the vendor configuration. A vendor-configuration change is asynchronous — it puts the model back into a deploying status, records an update job, and starts a Temporal workflow to redeploy, so the new configuration is not live when this returns; metadata-only and rename changes take effect immediately. The vendor configuration supplied must match the model's own vendor (`launch` or `llmengine`), and only those two vendors are supported. A model that is currently deploying cannot be modified and the request fails until deployment finishes. When renaming with `on_conflict` set to `swap`, the name is exchanged with an existing model of the same name and vendor instead of failing on the uniqueness constraint.","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml patch /v5/models/{model_id}","href":"/reference/v5/models/update-a-custom-model","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Models"],"summary":"Update a custom model","description":"Update a custom model record; vendor-configuration changes are applied asynchronously by redeploying the model.\n\nThis supports three kinds of update: changing model metadata only, renaming the model, and changing the vendor configuration. A vendor-configuration change is asynchronous — it puts the model back into a deploying status, records an update job, and starts a Temporal workflow to redeploy, so the new configuration is not live when this returns; metadata-only and rename changes take effect immediately. The vendor configuration supplied must match the model's own vendor (`launch` or `llmengine`), and only those two vendors are supported. A model that is currently deploying cannot be modified and the request fails until deployment finishes. When renaming with `on_conflict` set to `swap`, the name is exchanged with an existing model of the same name and vendor instead of failing on the uniqueness constraint.","operationId":"PATCH-V5-/v5/models/model_id","security":["f6e1bcf9-e728-45da-95e4-839318ec0105"],"parameters":["b4c5011c-e106-4f36-9d38-1e5365728367","0df57ac6-a853-4a20-b808-d2ccc9584cf2"],"requestBody":"ac4a3ef3-8a3b-466f-a1c9-4ae7c6b49796","responses":{"200":"8a798f81-4746-48f7-957b-eb0b94096642","422":"8e7185b3-df2f-4842-9dc9-7e1946124894"},"method":"patch","type":"path","servers":["53d4b40c-6ecb-41f0-8721-9b4723f67775"],"path":"/v5/models/{model_id}","baseUrlOptions":["https://api.egp.scale.com"],"title":"Update a custom model","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"b4c5011c-e106-4f36-9d38-1e5365728367":{"name":"model_id","in":"path","required":true,"schema":{"type":"string","title":"Model Id","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"0df57ac6-a853-4a20-b808-d2ccc9584cf2":{"name":"x-selected-account-id","in":"header","required":false,"schema":{"oneOf":[{"type":"string","title":"Account ID Header","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Account ID Header","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"DefaultModelPatchRequest","properties":{"model_metadata":{"oneOf":[{"type":"object","title":"Model Metadata","additionalProperties":true,"uniqueKey":"oneOf.0.model_metadata.oneOf.0","typeLabel":"Model Metadata · object"},{"type":"null","title":"Model Metadata","uniqueKey":"oneOf.0.model_metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.model_metadata","typeLabel":"Model Metadata · object | null"}},"uniqueKey":"oneOf.0","typeLabel":"DefaultModelPatchRequest · object"},{"type":"object","title":"ModelConfigurationPatchRequest","required":["vendor_configuration"],"properties":{"vendor_configuration":{"oneOf":[{"type":"object","title":"PartialLaunchVendorConfiguration","properties":{"model_image":{"oneOf":[{"type":"object","title":"PartialLaunchModelBundleConfiguration","properties":{"registry":{"oneOf":[{"type":"string","title":"Registry","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_image.oneOf.0.registry.oneOf.0","typeLabel":"string"},{"type":"null","title":"Registry","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_image.oneOf.0.registry.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_image.oneOf.0.registry","typeLabel":"string | null"},"repository":{"oneOf":[{"type":"string","title":"Repository","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_image.oneOf.0.repository.oneOf.0","typeLabel":"string"},{"type":"null","title":"Repository","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_image.oneOf.0.repository.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_image.oneOf.0.repository","typeLabel":"string | null"},"tag":{"oneOf":[{"type":"string","title":"Tag","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_image.oneOf.0.tag.oneOf.0","typeLabel":"string"},{"type":"null","title":"Tag","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_image.oneOf.0.tag.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_image.oneOf.0.tag","typeLabel":"string | null"},"predict_route":{"oneOf":[{"type":"string","title":"Predict Route","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_image.oneOf.0.predict_route.oneOf.0","typeLabel":"string"},{"type":"null","title":"Predict Route","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_image.oneOf.0.predict_route.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_image.oneOf.0.predict_route","typeLabel":"string | null"},"command":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_image.oneOf.0.command.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Command","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_image.oneOf.0.command.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Command","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_image.oneOf.0.command.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_image.oneOf.0.command","typeLabel":"string[] | null"},"streaming_predict_route":{"oneOf":[{"type":"string","title":"Streaming Predict Route","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_image.oneOf.0.streaming_predict_route.oneOf.0","typeLabel":"string"},{"type":"null","title":"Streaming Predict Route","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_image.oneOf.0.streaming_predict_route.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_image.oneOf.0.streaming_predict_route","typeLabel":"string | null"},"streaming_command":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_image.oneOf.0.streaming_command.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Streaming Command","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_image.oneOf.0.streaming_command.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Streaming Command","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_image.oneOf.0.streaming_command.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_image.oneOf.0.streaming_command","typeLabel":"string[] | null"},"request_schema":{"oneOf":[{"type":"object","title":"Request Schema","additionalProperties":true,"uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_image.oneOf.0.request_schema.oneOf.0","typeLabel":"Request Schema · object"},{"type":"null","title":"Request Schema","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_image.oneOf.0.request_schema.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_image.oneOf.0.request_schema","typeLabel":"Request Schema · object | null"},"response_schema":{"oneOf":[{"type":"object","title":"Response Schema","additionalProperties":true,"uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_image.oneOf.0.response_schema.oneOf.0","typeLabel":"Response Schema · object"},{"type":"null","title":"Response Schema","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_image.oneOf.0.response_schema.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_image.oneOf.0.response_schema","typeLabel":"Response Schema · object | null"},"env_vars":{"oneOf":[{"type":"object","title":"Env Vars","additionalProperties":true,"uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_image.oneOf.0.env_vars.oneOf.0","typeLabel":"Env Vars · object"},{"type":"null","title":"Env Vars","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_image.oneOf.0.env_vars.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_image.oneOf.0.env_vars","typeLabel":"Env Vars · object | null"},"readiness_delay":{"oneOf":[{"type":"integer","title":"Readiness Delay","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_image.oneOf.0.readiness_delay.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Readiness Delay","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_image.oneOf.0.readiness_delay.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_image.oneOf.0.readiness_delay","typeLabel":"integer | null"},"healthcheck_route":{"oneOf":[{"type":"string","title":"Healthcheck Route","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_image.oneOf.0.healthcheck_route.oneOf.0","typeLabel":"string"},{"type":"null","title":"Healthcheck Route","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_image.oneOf.0.healthcheck_route.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_image.oneOf.0.healthcheck_route","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_image.oneOf.0","typeLabel":"PartialLaunchModelBundleConfiguration · object"},{"type":"null","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_image.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_image","typeLabel":"PartialLaunchModelBundleConfiguration · object | null"},"model_infra":{"oneOf":[{"type":"object","title":"PartialLaunchModelEndpointConfiguration","properties":{"endpoint_type":{"oneOf":[{"type":"string","title":"Endpoint Type","enum":["async","sync","streaming"],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_infra.oneOf.0.endpoint_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Endpoint Type","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_infra.oneOf.0.endpoint_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_infra.oneOf.0.endpoint_type","typeLabel":"enum\u003cstring> | null"},"cpus":{"oneOf":[{"type":"string","title":"Cpus","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_infra.oneOf.0.cpus.oneOf.0","typeLabel":"string"},{"type":"integer","title":"Cpus","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_infra.oneOf.0.cpus.oneOf.1","typeLabel":"integer"},{"type":"null","title":"Cpus","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_infra.oneOf.0.cpus.oneOf.2","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_infra.oneOf.0.cpus","typeLabel":"string | integer | null"},"gpus":{"oneOf":[{"type":"integer","title":"Gpus","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_infra.oneOf.0.gpus.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Gpus","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_infra.oneOf.0.gpus.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_infra.oneOf.0.gpus","typeLabel":"integer | null"},"gpu_type":{"oneOf":[{"type":"string","title":"Gpu Type","enum":["nvidia-tesla-t4","nvidia-ampere-a10","nvidia-ampere-a100","nvidia-ampere-a100e","nvidia-hopper-h100","nvidia-hopper-h100-1g20gb","nvidia-hopper-h100-3g40gb"],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_infra.oneOf.0.gpu_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Gpu Type","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_infra.oneOf.0.gpu_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_infra.oneOf.0.gpu_type","typeLabel":"enum\u003cstring> | null"},"memory":{"oneOf":[{"type":"string","title":"Memory","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_infra.oneOf.0.memory.oneOf.0","typeLabel":"string"},{"type":"null","title":"Memory","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_infra.oneOf.0.memory.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_infra.oneOf.0.memory","typeLabel":"string | null"},"storage":{"oneOf":[{"type":"string","title":"Storage","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_infra.oneOf.0.storage.oneOf.0","typeLabel":"string"},{"type":"null","title":"Storage","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_infra.oneOf.0.storage.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_infra.oneOf.0.storage","typeLabel":"string | null"},"min_workers":{"oneOf":[{"type":"integer","title":"Min Workers","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_infra.oneOf.0.min_workers.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Min Workers","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_infra.oneOf.0.min_workers.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_infra.oneOf.0.min_workers","typeLabel":"integer | null"},"max_workers":{"oneOf":[{"type":"integer","title":"Max Workers","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_infra.oneOf.0.max_workers.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Max Workers","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_infra.oneOf.0.max_workers.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_infra.oneOf.0.max_workers","typeLabel":"integer | null"},"per_worker":{"oneOf":[{"type":"integer","title":"Per Worker","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_infra.oneOf.0.per_worker.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Per Worker","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_infra.oneOf.0.per_worker.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_infra.oneOf.0.per_worker","typeLabel":"integer | null"},"high_priority":{"oneOf":[{"type":"boolean","title":"High Priority","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_infra.oneOf.0.high_priority.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"High Priority","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_infra.oneOf.0.high_priority.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_infra.oneOf.0.high_priority","typeLabel":"boolean | null"},"labels":{"oneOf":[{"type":"object","title":"Labels","additionalProperties":{"type":"string","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_infra.oneOf.0.labels.oneOf.0.additionalProperties","typeLabel":"string"},"uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_infra.oneOf.0.labels.oneOf.0","typeLabel":"Labels · object"},{"type":"null","title":"Labels","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_infra.oneOf.0.labels.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_infra.oneOf.0.labels","typeLabel":"Labels · object | null"},"public_inference":{"oneOf":[{"type":"boolean","title":"Public Inference","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_infra.oneOf.0.public_inference.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Public Inference","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_infra.oneOf.0.public_inference.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_infra.oneOf.0.public_inference","typeLabel":"boolean | null"}},"additionalProperties":false,"uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_infra.oneOf.0","typeLabel":"PartialLaunchModelEndpointConfiguration · object"},{"type":"null","uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_infra.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.0.model_infra","typeLabel":"PartialLaunchModelEndpointConfiguration · object | null"}},"isRequired":true,"uniqueKey":"oneOf.1.vendor_configuration.oneOf.0","typeLabel":"PartialLaunchVendorConfiguration · object"},{"type":"object","title":"PartialLLMEngineVendorConfiguration","properties":{"model":{"oneOf":[{"type":"string","title":"Model","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.model.oneOf.0","typeLabel":"string"},{"type":"null","title":"Model","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.model","typeLabel":"string | null"},"inference_framework_image_tag":{"oneOf":[{"type":"string","title":"Inference Framework Image Tag","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.inference_framework_image_tag.oneOf.0","typeLabel":"string"},{"type":"null","title":"Inference Framework Image Tag","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.inference_framework_image_tag.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.inference_framework_image_tag","typeLabel":"string | null"},"nodes_per_worker":{"oneOf":[{"type":"integer","title":"Nodes Per Worker","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.nodes_per_worker.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Nodes Per Worker","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.nodes_per_worker.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.nodes_per_worker","typeLabel":"integer | null"},"min_workers":{"oneOf":[{"type":"integer","title":"Min Workers","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.min_workers.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Min Workers","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.min_workers.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.min_workers","typeLabel":"integer | null"},"max_workers":{"oneOf":[{"type":"integer","title":"Max Workers","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.max_workers.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Max Workers","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.max_workers.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.max_workers","typeLabel":"integer | null"},"per_worker":{"oneOf":[{"type":"integer","title":"Per Worker","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.per_worker.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Per Worker","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.per_worker.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.per_worker","typeLabel":"integer | null"},"num_shards":{"oneOf":[{"type":"integer","title":"Num Shards","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.num_shards.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Num Shards","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.num_shards.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.num_shards","typeLabel":"integer | null"},"labels":{"oneOf":[{"type":"object","title":"Labels","additionalProperties":{"type":"string","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.labels.oneOf.0.additionalProperties","typeLabel":"string"},"uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.labels.oneOf.0","typeLabel":"Labels · object"},{"type":"null","title":"Labels","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.labels.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.labels","typeLabel":"Labels · object | null"},"source":{"oneOf":[{"type":"string","title":"Source","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.source.oneOf.0","typeLabel":"string"},{"type":"null","title":"Source","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.source.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.source","typeLabel":"string | null"},"inference_framework":{"oneOf":[{"type":"string","title":"Inference Framework","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.inference_framework.oneOf.0","typeLabel":"string"},{"type":"null","title":"Inference Framework","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.inference_framework.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.inference_framework","typeLabel":"string | null"},"endpoint_type":{"oneOf":[{"type":"string","title":"Endpoint Type","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.endpoint_type.oneOf.0","typeLabel":"string"},{"type":"null","title":"Endpoint Type","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.endpoint_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.endpoint_type","typeLabel":"string | null"},"quantize":{"oneOf":[{"type":"string","title":"Quantize","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.quantize.oneOf.0","typeLabel":"string"},{"type":"null","title":"Quantize","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.quantize.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.quantize","typeLabel":"string | null"},"checkpoint_path":{"oneOf":[{"type":"string","title":"Checkpoint Path","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.checkpoint_path.oneOf.0","typeLabel":"string"},{"type":"null","title":"Checkpoint Path","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.checkpoint_path.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.checkpoint_path","typeLabel":"string | null"},"chat_template_override":{"oneOf":[{"type":"string","title":"Chat Template Override","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.chat_template_override.oneOf.0","typeLabel":"string"},{"type":"null","title":"Chat Template Override","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.chat_template_override.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.chat_template_override","typeLabel":"string | null"},"post_inference_hooks":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.post_inference_hooks.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Post Inference Hooks","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.post_inference_hooks.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Post Inference Hooks","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.post_inference_hooks.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.post_inference_hooks","typeLabel":"string[] | null"},"cpus":{"oneOf":[{"type":"integer","title":"Cpus","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.cpus.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Cpus","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.cpus.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.cpus","typeLabel":"integer | null"},"gpus":{"oneOf":[{"type":"integer","title":"Gpus","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.gpus.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Gpus","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.gpus.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.gpus","typeLabel":"integer | null"},"memory":{"oneOf":[{"type":"string","title":"Memory","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.memory.oneOf.0","typeLabel":"string"},{"type":"null","title":"Memory","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.memory.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.memory","typeLabel":"string | null"},"gpu_type":{"oneOf":[{"type":"string","title":"Gpu Type","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.gpu_type.oneOf.0","typeLabel":"string"},{"type":"null","title":"Gpu Type","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.gpu_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.gpu_type","typeLabel":"string | null"},"storage":{"oneOf":[{"type":"string","title":"Storage","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.storage.oneOf.0","typeLabel":"string"},{"type":"null","title":"Storage","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.storage.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.storage","typeLabel":"string | null"},"high_priority":{"oneOf":[{"type":"boolean","title":"High Priority","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.high_priority.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"High Priority","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.high_priority.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.high_priority","typeLabel":"boolean | null"},"default_callback_url":{"oneOf":[{"type":"string","title":"Default Callback Url","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.default_callback_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Default Callback Url","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.default_callback_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.default_callback_url","typeLabel":"string | null"},"public_inference":{"oneOf":[{"type":"boolean","title":"Public Inference","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.public_inference.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Public Inference","uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.public_inference.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.vendor_configuration.oneOf.1.public_inference","typeLabel":"boolean | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"oneOf.1.vendor_configuration.oneOf.1","typeLabel":"PartialLLMEngineVendorConfiguration · object"}],"isRequired":true,"uniqueKey":"oneOf.1.vendor_configuration","typeLabel":"PartialLaunchVendorConfiguration · object | PartialLLMEngineVendorConfiguration · object"},"model_metadata":{"oneOf":[{"type":"object","title":"Model Metadata","additionalProperties":true,"uniqueKey":"oneOf.1.model_metadata.oneOf.0","typeLabel":"Model Metadata · object"},{"type":"null","title":"Model Metadata","uniqueKey":"oneOf.1.model_metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.model_metadata","typeLabel":"Model Metadata · object | null"}},"uniqueKey":"oneOf.1","typeLabel":"ModelConfigurationPatchRequest · object"},{"type":"object","title":"SwapNamesModelPatchRequest","required":["name"],"properties":{"name":{"type":"string","title":"Name","isRequired":true,"uniqueKey":"oneOf.2.name","typeLabel":"string"},"on_conflict":{"type":"string","enum":["error","swap"],"title":"On Conflict","default":"error","uniqueKey":"oneOf.2.on_conflict","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.2","typeLabel":"SwapNamesModelPatchRequest · object"}],"uniqueKey":"","typeLabel":"DefaultModelPatchRequest · object | ModelConfigurationPatchRequest · object | SwapNamesModelPatchRequest · object"},"examples":{"Example":{"title":"Example","value":{"model_metadata":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"8a798f81-4746-48f7-957b-eb0b94096642":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the entity.","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"name":{"type":"string","title":"Name","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"model_type":{"type":"string","enum":["generic","completion","chat_completion"],"title":"InferenceModelType","isRequired":true,"uniqueKey":"model_type","typeLabel":"enum\u003cstring>"},"model_vendor":{"type":"string","enum":["openai","cohere","vertex_ai","anthropic","azure","gemini","launch","llmengine","model_zoo","bedrock","xai","fireworks_ai","oci"],"title":"InferenceModelVendor","isRequired":true,"uniqueKey":"model_vendor","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["failed","ready","deploying","deployment_timeout"],"title":"InferenceModelStatus","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"The date and time when the entity was created in ISO format.","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"created_by_user_id":{"type":"string","title":"Created By User Id","description":"The user who originally created the entity.","isRequired":true,"uniqueKey":"created_by_user_id","typeLabel":"string"},"created_by_identity_type":{"type":"string","enum":["user","service_account"],"title":"IdentifierTypeEnum","description":"The type of identity that created the entity.","isRequired":true,"uniqueKey":"created_by_identity_type","typeLabel":"enum\u003cstring>"},"object":{"type":"string","const":"model","title":"Object","default":"model","uniqueKey":"object","typeLabel":"string"},"vendor_configuration":{"oneOf":[{"type":"object","title":"LaunchVendorConfiguration","required":["model_image","model_infra"],"properties":{"model_image":{"properties":{"registry":{"type":"string","title":"Registry","isRequired":true,"uniqueKey":"vendor_configuration.oneOf.0.model_image.registry","typeLabel":"string"},"repository":{"type":"string","title":"Repository","isRequired":true,"uniqueKey":"vendor_configuration.oneOf.0.model_image.repository","typeLabel":"string"},"tag":{"type":"string","title":"Tag","isRequired":true,"uniqueKey":"vendor_configuration.oneOf.0.model_image.tag","typeLabel":"string"},"command":{"items":{"type":"string","uniqueKey":"vendor_configuration.oneOf.0.model_image.command.items.[INDEX]","typeLabel":"string"},"type":"array","title":"Command","isRequired":true,"uniqueKey":"vendor_configuration.oneOf.0.model_image.command","typeLabel":"string[]"},"predict_route":{"type":"string","title":"Predict Route","default":"/predict","uniqueKey":"vendor_configuration.oneOf.0.model_image.predict_route","typeLabel":"string"},"streaming_predict_route":{"oneOf":[{"type":"string","title":"Streaming Predict Route","uniqueKey":"vendor_configuration.oneOf.0.model_image.streaming_predict_route.oneOf.0","typeLabel":"string"},{"type":"null","title":"Streaming Predict Route","uniqueKey":"vendor_configuration.oneOf.0.model_image.streaming_predict_route.oneOf.1","typeLabel":"null"}],"uniqueKey":"vendor_configuration.oneOf.0.model_image.streaming_predict_route","typeLabel":"string | null"},"streaming_command":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"vendor_configuration.oneOf.0.model_image.streaming_command.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Streaming Command","uniqueKey":"vendor_configuration.oneOf.0.model_image.streaming_command.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Streaming Command","uniqueKey":"vendor_configuration.oneOf.0.model_image.streaming_command.oneOf.1","typeLabel":"null"}],"uniqueKey":"vendor_configuration.oneOf.0.model_image.streaming_command","typeLabel":"string[] | null"},"request_schema":{"additionalProperties":true,"type":"object","title":"Request Schema","default":{},"uniqueKey":"vendor_configuration.oneOf.0.model_image.request_schema","typeLabel":"Request Schema · object"},"response_schema":{"additionalProperties":true,"type":"object","title":"Response Schema","default":{},"uniqueKey":"vendor_configuration.oneOf.0.model_image.response_schema","typeLabel":"Response Schema · object"},"env_vars":{"additionalProperties":true,"type":"object","title":"Env Vars","default":{},"uniqueKey":"vendor_configuration.oneOf.0.model_image.env_vars","typeLabel":"Env Vars · object"},"readiness_delay":{"type":"integer","title":"Readiness Delay","default":120,"uniqueKey":"vendor_configuration.oneOf.0.model_image.readiness_delay","typeLabel":"integer"},"healthcheck_route":{"type":"string","title":"Healthcheck Route","default":"/readyz","uniqueKey":"vendor_configuration.oneOf.0.model_image.healthcheck_route","typeLabel":"string"}},"type":"object","required":["registry","repository","tag","command"],"title":"LaunchModelBundleConfiguration","isRequired":true,"uniqueKey":"vendor_configuration.oneOf.0.model_image","typeLabel":"LaunchModelBundleConfiguration · object"},"model_infra":{"properties":{"endpoint_type":{"type":"string","enum":["async","sync","streaming"],"title":"Endpoint Type","default":"sync","uniqueKey":"vendor_configuration.oneOf.0.model_infra.endpoint_type","typeLabel":"enum\u003cstring>"},"cpus":{"oneOf":[{"type":"string","title":"Cpus","default":3,"uniqueKey":"vendor_configuration.oneOf.0.model_infra.cpus.oneOf.0","typeLabel":"string"},{"type":"integer","title":"Cpus","default":3,"uniqueKey":"vendor_configuration.oneOf.0.model_infra.cpus.oneOf.1","typeLabel":"integer"}],"uniqueKey":"vendor_configuration.oneOf.0.model_infra.cpus","typeLabel":"string | integer"},"gpus":{"type":"integer","title":"Gpus","default":0,"uniqueKey":"vendor_configuration.oneOf.0.model_infra.gpus","typeLabel":"integer"},"gpu_type":{"oneOf":[{"type":"string","title":"Gpu Type","enum":["nvidia-tesla-t4","nvidia-ampere-a10","nvidia-ampere-a100","nvidia-ampere-a100e","nvidia-hopper-h100","nvidia-hopper-h100-1g20gb","nvidia-hopper-h100-3g40gb"],"uniqueKey":"vendor_configuration.oneOf.0.model_infra.gpu_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Gpu Type","uniqueKey":"vendor_configuration.oneOf.0.model_infra.gpu_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"vendor_configuration.oneOf.0.model_infra.gpu_type","typeLabel":"enum\u003cstring> | null"},"memory":{"type":"string","title":"Memory","default":"8Gi","uniqueKey":"vendor_configuration.oneOf.0.model_infra.memory","typeLabel":"string"},"storage":{"type":"string","title":"Storage","default":"16Gi","uniqueKey":"vendor_configuration.oneOf.0.model_infra.storage","typeLabel":"string"},"min_workers":{"type":"integer","title":"Min Workers","default":0,"uniqueKey":"vendor_configuration.oneOf.0.model_infra.min_workers","typeLabel":"integer"},"max_workers":{"type":"integer","title":"Max Workers","default":1,"uniqueKey":"vendor_configuration.oneOf.0.model_infra.max_workers","typeLabel":"integer"},"per_worker":{"type":"integer","title":"Per Worker","default":10,"uniqueKey":"vendor_configuration.oneOf.0.model_infra.per_worker","typeLabel":"integer"},"high_priority":{"oneOf":[{"type":"boolean","title":"High Priority","default":false,"uniqueKey":"vendor_configuration.oneOf.0.model_infra.high_priority.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"High Priority","default":false,"uniqueKey":"vendor_configuration.oneOf.0.model_infra.high_priority.oneOf.1","typeLabel":"null"}],"uniqueKey":"vendor_configuration.oneOf.0.model_infra.high_priority","typeLabel":"boolean | null"},"labels":{"oneOf":[{"type":"object","title":"Labels","additionalProperties":{"type":"string","uniqueKey":"vendor_configuration.oneOf.0.model_infra.labels.oneOf.0.additionalProperties","typeLabel":"string"},"uniqueKey":"vendor_configuration.oneOf.0.model_infra.labels.oneOf.0","typeLabel":"Labels · object"},{"type":"null","title":"Labels","uniqueKey":"vendor_configuration.oneOf.0.model_infra.labels.oneOf.1","typeLabel":"null"}],"uniqueKey":"vendor_configuration.oneOf.0.model_infra.labels","typeLabel":"Labels · object | null"},"public_inference":{"oneOf":[{"type":"boolean","title":"Public Inference","default":false,"uniqueKey":"vendor_configuration.oneOf.0.model_infra.public_inference.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Public Inference","default":false,"uniqueKey":"vendor_configuration.oneOf.0.model_infra.public_inference.oneOf.1","typeLabel":"null"}],"uniqueKey":"vendor_configuration.oneOf.0.model_infra.public_inference","typeLabel":"boolean | null"}},"type":"object","title":"LaunchModelEndpointConfiguration","isRequired":true,"uniqueKey":"vendor_configuration.oneOf.0.model_infra","typeLabel":"LaunchModelEndpointConfiguration · object"}},"uniqueKey":"vendor_configuration.oneOf.0","typeLabel":"LaunchVendorConfiguration · object"},{"type":"object","title":"LLMEngineVendorConfiguration","required":["model"],"properties":{"model":{"type":"string","title":"Model","isRequired":true,"uniqueKey":"vendor_configuration.oneOf.1.model","typeLabel":"string"},"inference_framework_image_tag":{"type":"string","title":"Inference Framework Image Tag","default":"latest","uniqueKey":"vendor_configuration.oneOf.1.inference_framework_image_tag","typeLabel":"string"},"nodes_per_worker":{"type":"integer","title":"Nodes Per Worker","default":1,"uniqueKey":"vendor_configuration.oneOf.1.nodes_per_worker","typeLabel":"integer"},"min_workers":{"type":"integer","title":"Min Workers","default":0,"uniqueKey":"vendor_configuration.oneOf.1.min_workers","typeLabel":"integer"},"max_workers":{"type":"integer","title":"Max Workers","default":1,"uniqueKey":"vendor_configuration.oneOf.1.max_workers","typeLabel":"integer"},"per_worker":{"type":"integer","title":"Per Worker","default":2,"uniqueKey":"vendor_configuration.oneOf.1.per_worker","typeLabel":"integer"},"num_shards":{"type":"integer","title":"Num Shards","default":1,"uniqueKey":"vendor_configuration.oneOf.1.num_shards","typeLabel":"integer"},"labels":{"additionalProperties":{"type":"string","uniqueKey":"vendor_configuration.oneOf.1.labels.additionalProperties","typeLabel":"string"},"type":"object","title":"Labels","default":{},"uniqueKey":"vendor_configuration.oneOf.1.labels","typeLabel":"Labels · object"},"source":{"type":"string","title":"Source","default":"hugging_face","uniqueKey":"vendor_configuration.oneOf.1.source","typeLabel":"string"},"inference_framework":{"type":"string","title":"Inference Framework","default":"vllm","uniqueKey":"vendor_configuration.oneOf.1.inference_framework","typeLabel":"string"},"endpoint_type":{"type":"string","title":"Endpoint Type","default":"streaming","uniqueKey":"vendor_configuration.oneOf.1.endpoint_type","typeLabel":"string"},"quantize":{"oneOf":[{"type":"string","title":"Quantize","uniqueKey":"vendor_configuration.oneOf.1.quantize.oneOf.0","typeLabel":"string"},{"type":"null","title":"Quantize","uniqueKey":"vendor_configuration.oneOf.1.quantize.oneOf.1","typeLabel":"null"}],"uniqueKey":"vendor_configuration.oneOf.1.quantize","typeLabel":"string | null"},"checkpoint_path":{"oneOf":[{"type":"string","title":"Checkpoint Path","uniqueKey":"vendor_configuration.oneOf.1.checkpoint_path.oneOf.0","typeLabel":"string"},{"type":"null","title":"Checkpoint Path","uniqueKey":"vendor_configuration.oneOf.1.checkpoint_path.oneOf.1","typeLabel":"null"}],"uniqueKey":"vendor_configuration.oneOf.1.checkpoint_path","typeLabel":"string | null"},"chat_template_override":{"oneOf":[{"type":"string","title":"Chat Template Override","uniqueKey":"vendor_configuration.oneOf.1.chat_template_override.oneOf.0","typeLabel":"string"},{"type":"null","title":"Chat Template Override","uniqueKey":"vendor_configuration.oneOf.1.chat_template_override.oneOf.1","typeLabel":"null"}],"uniqueKey":"vendor_configuration.oneOf.1.chat_template_override","typeLabel":"string | null"},"post_inference_hooks":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"vendor_configuration.oneOf.1.post_inference_hooks.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Post Inference Hooks","uniqueKey":"vendor_configuration.oneOf.1.post_inference_hooks.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Post Inference Hooks","uniqueKey":"vendor_configuration.oneOf.1.post_inference_hooks.oneOf.1","typeLabel":"null"}],"uniqueKey":"vendor_configuration.oneOf.1.post_inference_hooks","typeLabel":"string[] | null"},"cpus":{"oneOf":[{"type":"integer","title":"Cpus","uniqueKey":"vendor_configuration.oneOf.1.cpus.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Cpus","uniqueKey":"vendor_configuration.oneOf.1.cpus.oneOf.1","typeLabel":"null"}],"uniqueKey":"vendor_configuration.oneOf.1.cpus","typeLabel":"integer | null"},"gpus":{"oneOf":[{"type":"integer","title":"Gpus","uniqueKey":"vendor_configuration.oneOf.1.gpus.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Gpus","uniqueKey":"vendor_configuration.oneOf.1.gpus.oneOf.1","typeLabel":"null"}],"uniqueKey":"vendor_configuration.oneOf.1.gpus","typeLabel":"integer | null"},"memory":{"oneOf":[{"type":"string","title":"Memory","uniqueKey":"vendor_configuration.oneOf.1.memory.oneOf.0","typeLabel":"string"},{"type":"null","title":"Memory","uniqueKey":"vendor_configuration.oneOf.1.memory.oneOf.1","typeLabel":"null"}],"uniqueKey":"vendor_configuration.oneOf.1.memory","typeLabel":"string | null"},"gpu_type":{"oneOf":[{"type":"string","title":"Gpu Type","uniqueKey":"vendor_configuration.oneOf.1.gpu_type.oneOf.0","typeLabel":"string"},{"type":"null","title":"Gpu Type","uniqueKey":"vendor_configuration.oneOf.1.gpu_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"vendor_configuration.oneOf.1.gpu_type","typeLabel":"string | null"},"storage":{"oneOf":[{"type":"string","title":"Storage","uniqueKey":"vendor_configuration.oneOf.1.storage.oneOf.0","typeLabel":"string"},{"type":"null","title":"Storage","uniqueKey":"vendor_configuration.oneOf.1.storage.oneOf.1","typeLabel":"null"}],"uniqueKey":"vendor_configuration.oneOf.1.storage","typeLabel":"string | null"},"high_priority":{"oneOf":[{"type":"boolean","title":"High Priority","default":false,"uniqueKey":"vendor_configuration.oneOf.1.high_priority.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"High Priority","default":false,"uniqueKey":"vendor_configuration.oneOf.1.high_priority.oneOf.1","typeLabel":"null"}],"uniqueKey":"vendor_configuration.oneOf.1.high_priority","typeLabel":"boolean | null"},"default_callback_url":{"oneOf":[{"type":"string","title":"Default Callback Url","uniqueKey":"vendor_configuration.oneOf.1.default_callback_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Default Callback Url","uniqueKey":"vendor_configuration.oneOf.1.default_callback_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"vendor_configuration.oneOf.1.default_callback_url","typeLabel":"string | null"},"public_inference":{"oneOf":[{"type":"boolean","title":"Public Inference","uniqueKey":"vendor_configuration.oneOf.1.public_inference.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Public Inference","uniqueKey":"vendor_configuration.oneOf.1.public_inference.oneOf.1","typeLabel":"null"}],"uniqueKey":"vendor_configuration.oneOf.1.public_inference","typeLabel":"boolean | null"}},"additionalProperties":true,"uniqueKey":"vendor_configuration.oneOf.1","typeLabel":"LLMEngineVendorConfiguration · object"},{"type":"null","title":"Vendor Configuration","uniqueKey":"vendor_configuration.oneOf.2","typeLabel":"null"}],"uniqueKey":"vendor_configuration","typeLabel":"LaunchVendorConfiguration · object | LLMEngineVendorConfiguration · object | null"},"status_reason":{"oneOf":[{"type":"string","title":"Status Reason","uniqueKey":"status_reason.oneOf.0","typeLabel":"string"},{"type":"null","title":"Status Reason","uniqueKey":"status_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"status_reason","typeLabel":"string | null"},"model_metadata":{"oneOf":[{"type":"object","title":"Model Metadata","additionalProperties":true,"uniqueKey":"model_metadata.oneOf.0","typeLabel":"Model Metadata · object"},{"type":"null","title":"Model Metadata","uniqueKey":"model_metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"model_metadata","typeLabel":"Model Metadata · object | null"},"model_availability":{"oneOf":[{"type":"string","title":"InferenceModelAvailability","enum":["unknown","available","unavailable"],"uniqueKey":"model_availability.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"model_availability.oneOf.1","typeLabel":"null"}],"uniqueKey":"model_availability","typeLabel":"enum\u003cstring> | null"}},"type":"object","required":["name","model_type","model_vendor","status","id","created_at","created_by_user_id","created_by_identity_type"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","name":"\u003cstring>","model_type":"generic","model_vendor":"openai","status":"failed","created_at":"2023-11-07T05:31:56Z","created_by_user_id":"\u003cstring>","created_by_identity_type":"user","object":"model","vendor_configuration":{"model_image":{"registry":"\u003cstring>","repository":"\u003cstring>","tag":"\u003cstring>","command":["\u003cstring>"],"predict_route":"/predict","streaming_predict_route":"\u003cstring>","streaming_command":["\u003cstring>"],"request_schema":{},"response_schema":{},"env_vars":{},"readiness_delay":120,"healthcheck_route":"/readyz"},"model_infra":{"endpoint_type":"sync","cpus":3,"gpus":0,"gpu_type":"nvidia-tesla-t4","memory":"8Gi","storage":"16Gi","min_workers":0,"max_workers":1,"per_worker":10,"high_priority":false,"labels":{},"public_inference":false}},"status_reason":"\u003cstring>","model_metadata":{},"model_availability":"unknown"}}},"exampleType":"generated"}},"exampleType":"generated"},"8e7185b3-df2f-4842-9dc9-7e1946124894":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"},"input":{"oneOf":[{"title":"Input"}],"uniqueKey":"detail.items.[INDEX].input","typeLabel":"any"},"ctx":{"type":"object","title":"Context","additionalProperties":true,"uniqueKey":"detail.items.[INDEX].ctx","typeLabel":"Context · object"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"type":"array","title":"Detail","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"type":"object","title":"HTTPValidationError","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>","input":"\u003cunknown>","ctx":{}}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"f6e1bcf9-e728-45da-95e4-839318ec0105":{"APIKeyHeader":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[],"schemeName":"APIKeyHeader"}}},"servers":{"53d4b40c-6ecb-41f0-8721-9b4723f67775":{"url":"https://api.egp.scale.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[],"schemeName":"APIKeyHeader"},"schema":{"title":"x-api-key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"APIKeyHeader","name":"x-api-key"}],"title":"APIKeyHeader"}]},"originalFileLocation":"openapi/v5.yaml"},"subdomain":"scalegp","siteName":"Scale AI","title":"Update a custom model - Scale AI","navMaps":{"firstHrefInVersion":{"V5":{"href":"/reference/v5/models/update-a-custom-model","matchLevel":0},"V4 (legacy)":{"href":"/reference/v4/models/execute-model-deployment","matchLevel":2}},"firstHrefInLanguage":{}},"lastModified":"2026-09-28T19:56:25.587Z","originalFileLocation":"reference/v5/models/update-a-custom-model.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=\"system\"}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=\"Update a custom model record; vendor-configuration changes are applied asynchronously by redeploying the model. This supports three kinds of update: changing model metadata only, renaming the model, and changing the vendor configuration. A vendor-configuration change is asynchronous — it puts the model back into a deploying status, records an update job, and starts a Temporal workflow to redeploy, so the new configuration is not live when this returns; metadata-only and rename changes take effect immediately. The vendor configuration supplied must match the model\u0026#x27;s own vendor (launch or llmengine), and only those two vendors are supported. A model that is currently deploying cannot be modified and the request fails until deployment finishes. When renaming with on_conflict set to swap, the name is exchanged with an existing model of the same name and vendor instead of failing on the uniqueness constraint.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Scale AI\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/scalegp/UksUEh3sxckFW0X-/_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/scalegp/UksUEh3sxckFW0X-/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/scalegp/UksUEh3sxckFW0X-/_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/scalegp/UksUEh3sxckFW0X-/_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/scalegp/UksUEh3sxckFW0X-/_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/scalegp/UksUEh3sxckFW0X-/_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/scalegp/UksUEh3sxckFW0X-/_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/scalegp/UksUEh3sxckFW0X-/_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/scalegp/UksUEh3sxckFW0X-/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update a custom model - Scale AI\">\u003cmeta data-mint-head property=\"og:description\" content=\"Update a custom model record; vendor-configuration changes are applied asynchronously by redeploying the model. This supports three kinds of update: changing model metadata only, renaming the model, and changing the vendor configuration. A vendor-configuration change is asynchronous — it puts the model back into a deploying status, records an update job, and starts a Temporal workflow to redeploy, so the new configuration is not live when this returns; metadata-only and rename changes take effect immediately. The vendor configuration supplied must match the model\u0026#x27;s own vendor (launch or llmengine), and only those two vendors are supported. A model that is currently deploying cannot be modified and the request fails until deployment finishes. When renaming with on_conflict set to swap, the name is exchanged with an existing model of the same name and vendor instead of failing on the uniqueness constraint.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Scale AI\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.gp.scale.com/reference/v5/models/update-a-custom-model\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://scalegp.mintlify.site/_mintlify/api/og/v2?division=Models\u0026amp;title=Update+a+custom+model\u0026amp;description=Update+a+custom+model+record%3B+vendor-configuration+changes+are+applied+asynchronously+by+redeploying+the+model.%0A%0AThis+supports+three+kinds+of+update%3A+changing+m\u0026amp;theme=b7e87dd2f9a2a23155199f59\u0026amp;signature=6c9c8e18c2e9e8fd0097a85b87b026c6c7c4436e36074f0d2ba811b7b5481be8\">\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=\"Update a custom model - Scale AI\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Update a custom model record; vendor-configuration changes are applied asynchronously by redeploying the model. This supports three kinds of update: changing model metadata only, renaming the model, and changing the vendor configuration. A vendor-configuration change is asynchronous — it puts the model back into a deploying status, records an update job, and starts a Temporal workflow to redeploy, so the new configuration is not live when this returns; metadata-only and rename changes take effect immediately. The vendor configuration supplied must match the model\u0026#x27;s own vendor (launch or llmengine), and only those two vendors are supported. A model that is currently deploying cannot be modified and the request fails until deployment finishes. When renaming with on_conflict set to swap, the name is exchanged with an existing model of the same name and vendor instead of failing on the uniqueness constraint.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://scalegp.mintlify.site/_mintlify/api/og/v2?division=Models\u0026amp;title=Update+a+custom+model\u0026amp;description=Update+a+custom+model+record%3B+vendor-configuration+changes+are+applied+asynchronously+by+redeploying+the+model.%0A%0AThis+supports+three+kinds+of+update%3A+changing+m\u0026amp;theme=b7e87dd2f9a2a23155199f59\u0026amp;signature=6c9c8e18c2e9e8fd0097a85b87b026c6c7c4436e36074f0d2ba811b7b5481be8\">\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/scalegp/UksUEh3sxckFW0X-/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Scale AI\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3f2e7b\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.gp.scale.com/reference/v5/models/update-a-custom-model\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/v5/models/update-a-custom-model.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.gp.scale.com/#organization\",\"name\":\"Scale AI\",\"url\":\"https://docs.gp.scale.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/scalegp/TBmst1qiYXwYqUB5/logo/light.png?fit=max\u0026auto=format\u0026n=TBmst1qiYXwYqUB5\u0026q=85\u0026s=46027042c16b373ac463148db5ad1d6b\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.gp.scale.com#website\",\"name\":\"Scale AI\",\"url\":\"https://docs.gp.scale.com\",\"publisher\":{\"@id\":\"https://docs.gp.scale.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.gp.scale.com/reference/v5/models/update-a-custom-model#webpage\",\"url\":\"https://docs.gp.scale.com/reference/v5/models/update-a-custom-model\",\"name\":\"Update a custom model\",\"description\":\"Update a custom model record; vendor-configuration changes are applied asynchronously by redeploying the model. This supports three kinds of update: changing model metadata only, renaming the model, and changing the vendor configuration. A vendor-configuration change is asynchronous — it puts the model back into a deploying status, records an update job, and starts a Temporal workflow to redeploy, so the new configuration is not live when this returns; metadata-only and rename changes take effect immediately. The vendor configuration supplied must match the model's own vendor (launch or llmengine), and only those two vendors are supported. A model that is currently deploying cannot be modified and the request fails until deployment finishes. When renaming with on_conflict set to swap, the name is exchanged with an existing model of the same name and vendor instead of failing on the uniqueness constraint.\",\"dateModified\":\"2026-09-28T19:56:25.587Z\",\"isPartOf\":{\"@id\":\"https://docs.gp.scale.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.gp.scale.com/reference/v5/models/update-a-custom-model#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.gp.scale.com/reference/v5/models/update-a-custom-model#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Models\",\"item\":\"https://docs.gp.scale.com/reference/v5/models/list-custom-models\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Update a custom model\",\"item\":\"https://docs.gp.scale.com/reference/v5/models/update-a-custom-model\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.gp.scale.com/reference/v5/models/update-a-custom-model#apireference\",\"headline\":\"Update a custom model\",\"name\":\"Update a custom model\",\"description\":\"Update a custom model record; vendor-configuration changes are applied asynchronously by redeploying the model. This supports three kinds of update: changing model metadata only, renaming the model, and changing the vendor configuration. A vendor-configuration change is asynchronous — it puts the model back into a deploying status, records an update job, and starts a Temporal workflow to redeploy, so the new configuration is not live when this returns; metadata-only and rename changes take effect immediately. The vendor configuration supplied must match the model's own vendor (launch or llmengine), and only those two vendors are supported. A model that is currently deploying cannot be modified and the request fails until deployment finishes. When renaming with on_conflict set to swap, the name is exchanged with an existing model of the same name and vendor instead of failing on the uniqueness constraint.\",\"url\":\"https://docs.gp.scale.com/reference/v5/models/update-a-custom-model\",\"mainEntityOfPage\":{\"@id\":\"https://docs.gp.scale.com/reference/v5/models/update-a-custom-model#webpage\"},\"dateModified\":\"2026-09-28T19:56:25.587Z\",\"publisher\":{\"@id\":\"https://docs.gp.scale.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.gp.scale.com#website\"}}]}\u003c/script>","siteName":"Scale AI","nav":{"global":null,"versions":[{"version":"V5","tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/docs/v5/overview"}]},{"tab":"AgentOps API","groups":[{"group":"Inference","pages":[{"title":"Run inference with free-form payload","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml post /v5/inference","href":"/reference/v5/inference/run-inference-with-free-form-payload"},{"title":"Generate OpenAI chat completion from messages","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml post /v5/chat/completions","href":"/reference/v5/inference/generate-openai-chat-completion-from-messages"},{"title":"Run OpenAI Responses API (OpenAI only)","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml post /v5/responses","href":"/reference/v5/inference/run-openai-responses-api-openai-only"},{"title":"Generate legacy text completion from prompt","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml post /v5/completions","href":"/reference/v5/inference/generate-legacy-text-completion-from-prompt"},{"title":"List available chat completion models","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/chat/completions/models","href":"/reference/v5/inference/list-available-chat-completion-models"}]},{"group":"Questions","pages":[{"title":"List questions","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/questions","href":"/reference/v5/questions/list-questions"},{"title":"Create a question","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml post /v5/questions","href":"/reference/v5/questions/create-a-question"},{"title":"Get a question","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/questions/{question_id}","href":"/reference/v5/questions/get-a-question"},{"title":"Archive a question","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml delete /v5/questions/{question_id}","href":"/reference/v5/questions/archive-a-question"},{"title":"Update a question","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml patch /v5/questions/{question_id}","href":"/reference/v5/questions/update-a-question"},{"title":"Restore an archived question","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml post /v5/questions/{question_id}/restore","href":"/reference/v5/questions/restore-an-archived-question"}]},{"group":"Rubrics","pages":[{"title":"List rubrics","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/rubrics","href":"/reference/v5/rubrics/list-rubrics"},{"title":"Create a rubric","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml post /v5/rubrics","href":"/reference/v5/rubrics/create-a-rubric"},{"title":"Get a rubric","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/rubrics/{rubric_id}","href":"/reference/v5/rubrics/get-a-rubric"},{"title":"Archive a rubric","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml delete /v5/rubrics/{rubric_id}","href":"/reference/v5/rubrics/archive-a-rubric"},{"title":"Update or restore a rubric","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml patch /v5/rubrics/{rubric_id}","href":"/reference/v5/rubrics/update-or-restore-a-rubric"},{"title":"Add a criterion to a rubric","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml post /v5/rubrics/{rubric_id}/criteria","href":"/reference/v5/rubrics/add-a-criterion-to-a-rubric"},{"title":"Update a criterion","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml patch /v5/rubrics/{rubric_id}/criteria/{rubric_criteria_id}","href":"/reference/v5/rubrics/update-a-criterion"},{"title":"List criterion versions","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/rubrics/{rubric_id}/criteria/{rubric_criteria_id}/versions","href":"/reference/v5/rubrics/list-criterion-versions"}]},{"group":"Vector Stores","pages":[{"title":"List Vector Stores","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/vector-stores","href":"/reference/v5/vector-stores/list-vector-stores"},{"title":"Create Vector Store","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml post /v5/vector-stores/create","href":"/reference/v5/vector-stores/create-vector-store"},{"title":"Get Vector Store","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/vector-stores/{vector_store_name}","href":"/reference/v5/vector-stores/get-vector-store"},{"title":"Configure Vector Store","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml post /v5/vector-stores/{vector_store_name}/configure","href":"/reference/v5/vector-stores/configure-vector-store"},{"title":"Drop Vector Store","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml post /v5/vector-stores/{vector_store_name}/drop","href":"/reference/v5/vector-stores/drop-vector-store"},{"title":"Upsert Vectors","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml post /v5/vector-stores/{vector_store_name}/upsert","href":"/reference/v5/vector-stores/upsert-vectors"},{"title":"Delete Vectors","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml post /v5/vector-stores/{vector_store_name}/delete","href":"/reference/v5/vector-stores/delete-vectors"},{"title":"List Vectors","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/vector-stores/{vector_store_name}/vectors","href":"/reference/v5/vector-stores/list-vectors"},{"title":"Get Vector","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/vector-stores/{vector_store_name}/vectors/{vector_id}","href":"/reference/v5/vector-stores/get-vector"},{"title":"Count Vectors","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml post /v5/vector-stores/{vector_store_name}/count","href":"/reference/v5/vector-stores/count-vectors"},{"title":"Query Vectors","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml post /v5/vector-stores/{vector_store_name}/query","href":"/reference/v5/vector-stores/query-vectors"}]},{"group":"Files","pages":[{"title":"List files","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/files","href":"/reference/v5/files/list-files"},{"title":"Upload file bytes directly","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml post /v5/files","href":"/reference/v5/files/upload-file-bytes-directly"},{"title":"Import files from cloud storage","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml post /v5/files/cloud_imports","href":"/reference/v5/files/import-files-from-cloud-storage"},{"title":"Get file metadata","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/files/{file_id}","href":"/reference/v5/files/get-file-metadata"},{"title":"Delete a file","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml delete /v5/files/{file_id}","href":"/reference/v5/files/delete-a-file"},{"title":"Update a file","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml patch /v5/files/{file_id}","href":"/reference/v5/files/update-a-file"},{"title":"Download file content","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/files/{file_id}/content","href":"/reference/v5/files/download-file-content"}]},{"group":"Models","pages":[{"title":"List custom models","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/models","href":"/reference/v5/models/list-custom-models"},{"title":"Create a custom model","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml post /v5/models","href":"/reference/v5/models/create-a-custom-model"},{"title":"Get a custom model","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/models/{model_id}","href":"/reference/v5/models/get-a-custom-model"},{"title":"Delete a custom model","description":"Permanently delete a custom model record and tear down its deployment at the serving vendor.\n\nThis is a hard delete: the model row is removed from your account entirely and cannot be restored afterward. Before the record is removed, if the model has an associated vendor deployment that deployment is torn down at its serving vendor. A model that is currently deploying cannot be deleted and the request fails until deployment finishes. This operates on the model records managed by this API, distinct from the `GET /v5/chat/completions/models` catalog of models callable for chat completions.","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml delete /v5/models/{model_id}","href":"/reference/v5/models/delete-a-custom-model"},{"title":"Update a custom model","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml patch /v5/models/{model_id}","href":"/reference/v5/models/update-a-custom-model"}]},{"group":"Agent Configs","pages":[{"title":"List Agent Configs","description":"List agent configurations visible to the caller, with cursor-based pagination.\n\nA user caller sees only the configs they created unless fine-grained access\ncontrol (FGAC) grants them access to others; a service-account caller sees\nevery config under the account. This returns the stored config records as-is —\nuse ``{agent_config_id}/resolve`` instead when you need a config projected into\nthe params a task would run with. Because deleting a config removes it outright\nrather than archiving it, there are no archived configs to page through here.","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/agent_configs","href":"/reference/v5/agent-configs/list-agent-configs"},{"title":"Create Agent Config","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml post /v5/agent_configs","href":"/reference/v5/agent-configs/create-agent-config"},{"title":"List MCP Tool Names","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/agent_configs/mcp_tools","href":"/reference/v5/agent-configs/list-mcp-tool-names"},{"title":"Get Agent Config","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/agent_configs/{agent_config_id}","href":"/reference/v5/agent-configs/get-agent-config"},{"title":"Delete Agent Config (hard delete)","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml delete /v5/agent_configs/{agent_config_id}","href":"/reference/v5/agent-configs/delete-agent-config-hard-delete"},{"title":"Update Agent Config","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml patch /v5/agent_configs/{agent_config_id}","href":"/reference/v5/agent-configs/update-agent-config"}]},{"group":"Datasets","pages":[{"title":"List datasets","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/datasets","href":"/reference/v5/datasets/list-datasets"},{"title":"Create a dataset","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml post /v5/datasets","href":"/reference/v5/datasets/create-a-dataset"},{"title":"Get a dataset","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/datasets/{dataset_id}","href":"/reference/v5/datasets/get-a-dataset"},{"title":"Archive a dataset","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml delete /v5/datasets/{dataset_id}","href":"/reference/v5/datasets/archive-a-dataset"},{"title":"Update or restore a dataset","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml patch /v5/datasets/{dataset_id}","href":"/reference/v5/datasets/update-or-restore-a-dataset"}]},{"group":"Dataset Items","pages":[{"title":"Add items to an existing dataset","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml post /v5/dataset-items/batch","href":"/reference/v5/dataset-items/add-items-to-an-existing-dataset"},{"title":"Get a dataset item","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/dataset-items/{dataset_item_id}","href":"/reference/v5/dataset-items/get-a-dataset-item"},{"title":"Delete a dataset item","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml delete /v5/dataset-items/{dataset_item_id}","href":"/reference/v5/dataset-items/delete-a-dataset-item"},{"title":"Update a dataset item","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml patch /v5/dataset-items/{dataset_item_id}","href":"/reference/v5/dataset-items/update-a-dataset-item"},{"title":"List dataset items","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/dataset-items","href":"/reference/v5/dataset-items/list-dataset-items"}]},{"group":"Evaluations","pages":[{"title":"List Evaluations","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/evaluations","href":"/reference/v5/evaluations/list-evaluations"},{"title":"Create Evaluation","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml post /v5/evaluations","href":"/reference/v5/evaluations/create-evaluation"},{"title":"Get Evaluation","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/evaluations/{evaluation_id}","href":"/reference/v5/evaluations/get-evaluation"},{"title":"Archive Evaluation","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml delete /v5/evaluations/{evaluation_id}","href":"/reference/v5/evaluations/archive-evaluation"},{"title":"Update or Restore Evaluation","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml patch /v5/evaluations/{evaluation_id}","href":"/reference/v5/evaluations/update-or-restore-evaluation"},{"title":"Add Test Criteria to Evaluation","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml post /v5/evaluations/{evaluation_id}/tasks","href":"/reference/v5/evaluations/add-test-criteria-to-evaluation"},{"title":"Update Test Criteria Configuration","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml patch /v5/evaluations/{evaluation_id}/tasks/{alias}","href":"/reference/v5/evaluations/update-test-criteria-configuration"},{"title":"Get Available Metadata Keys","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/evaluations/metadata-keys","href":"/reference/v5/evaluations/get-available-metadata-keys"},{"title":"Get Available Evaluation Statuses","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/evaluations/statuses","href":"/reference/v5/evaluations/get-available-evaluation-statuses"},{"title":"Get Evaluation Data Schema","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/evaluations/{evaluation_id}/schema","href":"/reference/v5/evaluations/get-evaluation-data-schema"},{"title":"Get Evaluation Taxonomy","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/evaluations/{evaluation_id}/taxonomy","href":"/reference/v5/evaluations/get-evaluation-taxonomy"},{"title":"Filter Evaluations","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml post /v5/evaluations/filter","href":"/reference/v5/evaluations/filter-evaluations"},{"title":"Dry-run a custom-function evaluation task","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml post /v5/evaluations/tasks/dry-run","href":"/reference/v5/evaluations/dry-run-a-custom-function-evaluation-task"}]},{"group":"Evaluation Groups","pages":[{"title":"List Evaluation Groups","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/evaluation-groups","href":"/reference/v5/evaluation-groups/list-evaluation-groups"},{"title":"Create Evaluation Group","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml post /v5/evaluation-groups","href":"/reference/v5/evaluation-groups/create-evaluation-group"},{"title":"Get Evaluation Group","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/evaluation-groups/{group_id}","href":"/reference/v5/evaluation-groups/get-evaluation-group"},{"title":"Update Evaluation Group","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml put /v5/evaluation-groups/{group_id}","href":"/reference/v5/evaluation-groups/update-evaluation-group"},{"title":"Archive Evaluation Group","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml delete /v5/evaluation-groups/{group_id}","href":"/reference/v5/evaluation-groups/archive-evaluation-group"},{"title":"Patch Evaluation Group","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml patch /v5/evaluation-groups/{group_id}","href":"/reference/v5/evaluation-groups/patch-evaluation-group"},{"title":"Get Evaluation Group Schema","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/evaluation-groups/{group_id}/schema","href":"/reference/v5/evaluation-groups/get-evaluation-group-schema"}]},{"group":"Evaluation Charts","pages":[{"title":"List Evaluation Charts","deprecated":true,"version":null,"openapi":"/openapi/v5.yaml get /v5/evaluation-charts","href":"/reference/v5/evaluation-charts/list-evaluation-charts"},{"title":"Create Evaluation Chart","deprecated":true,"version":null,"openapi":"/openapi/v5.yaml post /v5/evaluation-charts","href":"/reference/v5/evaluation-charts/create-evaluation-chart"},{"title":"Get Evaluation Chart","deprecated":true,"version":null,"openapi":"/openapi/v5.yaml get /v5/evaluation-charts/{chart_id}","href":"/reference/v5/evaluation-charts/get-evaluation-chart"},{"title":"Replace Evaluation Chart","deprecated":true,"version":null,"openapi":"/openapi/v5.yaml put /v5/evaluation-charts/{chart_id}","href":"/reference/v5/evaluation-charts/replace-evaluation-chart"},{"title":"Delete Evaluation Chart","deprecated":true,"version":null,"openapi":"/openapi/v5.yaml delete /v5/evaluation-charts/{chart_id}","href":"/reference/v5/evaluation-charts/delete-evaluation-chart"},{"title":"Patch Evaluation Chart","deprecated":true,"version":null,"openapi":"/openapi/v5.yaml patch /v5/evaluation-charts/{chart_id}","href":"/reference/v5/evaluation-charts/patch-evaluation-chart"}]},{"group":"Evaluation Dashboards","pages":[{"title":"List Evaluation Dashboards","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/evaluation-dashboards","href":"/reference/v5/evaluation-dashboards/list-evaluation-dashboards"},{"title":"Create Evaluation Dashboard","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml post /v5/evaluation-dashboards","href":"/reference/v5/evaluation-dashboards/create-evaluation-dashboard"},{"title":"Get Evaluation Dashboard","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/evaluation-dashboards/{dashboard_id}","href":"/reference/v5/evaluation-dashboards/get-evaluation-dashboard"},{"title":"Delete Evaluation Dashboard","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml delete /v5/evaluation-dashboards/{dashboard_id}","href":"/reference/v5/evaluation-dashboards/delete-evaluation-dashboard"},{"title":"Patch Evaluation Dashboard","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml patch /v5/evaluation-dashboards/{dashboard_id}","href":"/reference/v5/evaluation-dashboards/patch-evaluation-dashboard"},{"title":"Add Widget to Dashboard","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml post /v5/evaluation-dashboards/{dashboard_id}/widgets","href":"/reference/v5/evaluation-dashboards/add-widget-to-dashboard"},{"title":"Remove Widget from Dashboard","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml delete /v5/evaluation-dashboards/{dashboard_id}/widgets/{widget_id}","href":"/reference/v5/evaluation-dashboards/remove-widget-from-dashboard"},{"title":"Update Dashboard Widget","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml patch /v5/evaluation-dashboards/{dashboard_id}/widgets/{widget_id}","href":"/reference/v5/evaluation-dashboards/update-dashboard-widget"}]},{"group":"Evaluation Items","pages":[{"title":"Get a single evaluation item","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/evaluation-items/{evaluation_item_id}","href":"/reference/v5/evaluation-items/get-a-single-evaluation-item"},{"title":"List and filter evaluation items","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/evaluation-items","href":"/reference/v5/evaluation-items/list-and-filter-evaluation-items"},{"title":"Export evaluation items to a file","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml post /v5/evaluation-items/export","href":"/reference/v5/evaluation-items/export-evaluation-items-to-a-file"}]},{"group":"Spans","pages":[{"title":"Create a span","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml post /v5/spans","href":"/reference/v5/spans/create-a-span"},{"title":"Upsert spans in a batch","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml put /v5/spans/batch","href":"/reference/v5/spans/upsert-spans-in-a-batch"},{"title":"Create spans in a batch","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml post /v5/spans/batch","href":"/reference/v5/spans/create-spans-in-a-batch"},{"title":"List trace deletion requests","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/spans/deletions","href":"/reference/v5/spans/list-trace-deletion-requests"},{"title":"Create trace deletion request","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml post /v5/spans/deletions","href":"/reference/v5/spans/create-trace-deletion-request"},{"title":"Get trace deletion request status","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/spans/deletions/{deletion_request_id}","href":"/reference/v5/spans/get-trace-deletion-request-status"},{"title":"Get a span","deprecated":true,"version":null,"openapi":"/openapi/v5.yaml get /v5/spans/{span_id}","href":"/reference/v5/spans/get-a-span"},{"title":"Update a span","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml patch /v5/spans/{span_id}","href":"/reference/v5/spans/update-a-span"},{"title":"Get a span within a trace","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/traces/{trace_id}/spans/{span_id}","href":"/reference/v5/spans/get-a-span-within-a-trace"},{"title":"List span summaries for a trace","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/traces/{trace_id}/spans","href":"/reference/v5/spans/list-span-summaries-for-a-trace"},{"title":"Search spans","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml post /v5/spans/search","href":"/reference/v5/spans/search-spans"},{"title":"Export spans","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml post /v5/spans/export","href":"/reference/v5/spans/export-spans"},{"title":"Get span export status","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/spans/export/{export_id}","href":"/reference/v5/spans/get-span-export-status"},{"title":"Get time-bucketed span metrics","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml post /v5/spans/metrics","href":"/reference/v5/spans/get-time-bucketed-span-metrics"},{"title":"Get span metrics grouped by name","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml post /v5/spans/metrics/by-span","href":"/reference/v5/spans/get-span-metrics-grouped-by-name"}]},{"group":"Span Assessment","pages":[{"title":"List span or trace assessments","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/span-assessments","href":"/reference/v5/span-assessment/list-span-or-trace-assessments"},{"title":"Create span assessment","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml post /v5/span-assessments","href":"/reference/v5/span-assessment/create-span-assessment"},{"title":"Get span assessment by ID","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/span-assessments/{span_assessment_id}","href":"/reference/v5/span-assessment/get-span-assessment-by-id"},{"title":"Permanently delete span assessment","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml delete /v5/span-assessments/{span_assessment_id}","href":"/reference/v5/span-assessment/permanently-delete-span-assessment"},{"title":"Update span assessment","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml patch /v5/span-assessments/{span_assessment_id}","href":"/reference/v5/span-assessment/update-span-assessment"}]},{"group":"Annotation Tasks","pages":[{"title":"Update or assign annotation tasks in bulk","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml patch /v5/annotation-tasks/batch","href":"/reference/v5/annotation-tasks/update-or-assign-annotation-tasks-in-bulk"}]},{"group":"Credentials","pages":[{"title":"List Credentials","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/credentials","href":"/reference/v5/credentials/list-credentials"},{"title":"Create Credential","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml post /v5/credentials","href":"/reference/v5/credentials/create-credential"},{"title":"Get Credential by Name","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/credentials/name/{credential_name}","href":"/reference/v5/credentials/get-credential-by-name"},{"title":"Get Credential by ID","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/credentials/{credential_id}","href":"/reference/v5/credentials/get-credential-by-id"},{"title":"Delete Credential","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml delete /v5/credentials/{credential_id}","href":"/reference/v5/credentials/delete-credential"},{"title":"Update Credential","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml patch /v5/credentials/{credential_id}","href":"/reference/v5/credentials/update-credential"},{"title":"Get Credential Secret by ID","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml post /v5/credentials/{credential_id}/secret","href":"/reference/v5/credentials/get-credential-secret-by-id"},{"title":"Get Credential Secret by Name","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml post /v5/credentials/name/{credential_name}/secret","href":"/reference/v5/credentials/get-credential-secret-by-name"}]},{"group":"Agentex Cloud Build","pages":[{"title":"List container image builds","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/builds","href":"/reference/v5/agentex-cloud-build/list-container-image-builds"},{"title":"Submit container image build","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml post /v5/builds","href":"/reference/v5/agentex-cloud-build/submit-container-image-build"},{"title":"List agents built but not deployed","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/builds/undeployed","href":"/reference/v5/agentex-cloud-build/list-agents-built-but-not-deployed"},{"title":"Get a build","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/builds/{build_id}","href":"/reference/v5/agentex-cloud-build/get-a-build"},{"title":"Stream build logs","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/builds/{build_id}/logs","href":"/reference/v5/agentex-cloud-build/stream-build-logs"},{"title":"Cancel a build","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml post /v5/builds/{build_id}/cancel","href":"/reference/v5/agentex-cloud-build/cancel-a-build"}]},{"group":"Agentex Cloud Deploy","pages":[{"title":"List agent deployments","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/agentex/deployments","href":"/reference/v5/agentex-cloud-deploy/list-agent-deployments"},{"title":"Deploy a built agent image","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml post /v5/agentex/deployments","href":"/reference/v5/agentex-cloud-deploy/deploy-a-built-agent-image"},{"title":"Get an agent deployment","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/agentex/deployments/{deployment_id}","href":"/reference/v5/agentex-cloud-deploy/get-an-agent-deployment"},{"title":"Delete and tear down a deployment","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml delete /v5/agentex/deployments/{deployment_id}","href":"/reference/v5/agentex-cloud-deploy/delete-and-tear-down-a-deployment"},{"title":"Get agent deployment logs","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml get /v5/agentex/deployments/{deployment_id}/logs","href":"/reference/v5/agentex-cloud-deploy/get-agent-deployment-logs"}]},{"group":"Agentex Agent","pages":[{"title":"Delete Agent","deprecated":null,"version":null,"openapi":"/openapi/v5.yaml delete /v5/agentex/agents/{agent_id}","href":"/reference/v5/agentex-agent/delete-agent"}]},{"group":"SGP Cloud Secrets","pages":[{"title":"List Secrets","deprecated":true,"version":null,"openapi":"/openapi/v5.yaml get /v5/sgp/secrets","href":"/reference/v5/sgp-cloud-secrets/list-secrets"},{"title":"Create Secret","deprecated":true,"version":null,"openapi":"/openapi/v5.yaml post /v5/sgp/secrets","href":"/reference/v5/sgp-cloud-secrets/create-secret"},{"title":"Get Secret","deprecated":true,"version":null,"openapi":"/openapi/v5.yaml get /v5/sgp/secrets/{secret_id}","href":"/reference/v5/sgp-cloud-secrets/get-secret"},{"title":"Delete Secret","deprecated":true,"version":null,"openapi":"/openapi/v5.yaml delete /v5/sgp/secrets/{secret_id}","href":"/reference/v5/sgp-cloud-secrets/delete-secret"},{"title":"Update Secret","deprecated":true,"version":null,"openapi":"/openapi/v5.yaml patch /v5/sgp/secrets/{secret_id}","href":"/reference/v5/sgp-cloud-secrets/update-secret"}]}]},{"tab":"AgentOps SDK","href":"https://scaleapi.github.io/sgp-sdk-docs/api/python/"},{"tab":"Agentex API","pages":[{"title":"Agentex API","href":"/reference/agentex/agents/get-agent-by-id"}]},{"tab":"Agentex SDK","href":"https://scaleapi.github.io/agentex-sdk-docs/api/python/"},{"tab":"Capabilities","pages":[{"title":"Capabilities","href":"/docs/capabilities/overview"}]},{"tab":"Dex API","pages":[{"title":"Dex API","href":"/reference/dex/projects/list-projects"}]}]},{"version":"V4 (legacy)","pages":[{"title":"V4 (legacy)","href":"/reference/v4/models/execute-model-deployment"}]}]},"basePath":"","title":"Update a custom model - Scale AI","buildId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","deploymentId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CBsVopKK.js","utils-DZAk68jJ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-D32AYZrP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D_A5_cny.js","snippetPresets-xNRfS9th.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BIB25-tq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CydJ4w4j.js","shallow-CYPBeQSG.js","getApiPlaygroundDisplay-A5xJVBOu.js","CodeSnippet-BVRTgi3m.js","CodeSnippets-DjD6BSlt.js","Page-Dr40SSJq.js","getPastedJson-D4V4JyrR.js","icon-uhcnG22T.js","MethodPill-CM-ZQdGH.js","DuplicateIcon-B_WnOiNf.js","createIcon-CJsb8utt.js","DynamicMarkdown-D-2HDKEp.js","SectionHeading-KP5xmMgQ.js","axios-vUo_bRtp.js","Markdown-D_k0dg6k.js","clsx-DK3K4Z1S.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DE3EVdvd.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-fN9H9n9g.js"]}