Atomically update any combination of an owned sample’s display name, unified field values, and isotropic microns-per-pixel value. Public share ids are not patchable. OAuth callers need both samples:read and samples:write because the response includes full owned detail and job history. When countable mpp is supplied, an idempotent recount is enqueued even if the stored value is unchanged; after an enqueue-failure 500, retry the identical patch to heal the recount.
Atomically updates any combination of an owned sample’s display name, unified
field values, and isotropic microns-per-pixel value. The response is the full
owned sample detail, including inference-job history.fields is keyed by stable definition key. Each supplied value replaces that
field’s complete value; null clears it. This payload replaces Tags:
Tags values are trimmed and lowercased, duplicates collapse, each value must be
between 1 and 50 characters without commas or control characters, and a sample
may carry
at most 50 distinct Tags values. Public is readable through fields.public but
is not writable through this endpoint; publication uses its protected flow.Use GET /sample-fields to discover keys, value types, origin, storage, and
writability. The retired top-level tags property is rejected with HTTP 400.
Authorizations
ApiKeyOAuth2
Authorization
string
header
required
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Scopes
samples:read
Read slide metadata and estimates
samples:write
Upload and change slides
Path Parameters
id
string<uuid>
required
Body
application/json
name
string | null
Trimmed display name. Null or an empty string reverts to filename. NUL characters are rejected.
Maximum string length: 200
Pattern: ^[^\u0000]*$
fields
object
Complete values for the named fields, not deltas. Null clears a field. fields.tags is the complete desired tag set; fields.public is read-only and returns 403.
mpp
numberobject
User-reported microns per pixel. Object axes must be equal; anisotropic input is rejected.
Required range: 0 < x <= 100
Response
Updated owned sample detail
An owned sample's curated read model and its 50 newest inference jobs. jobCount is the uncapped total.
ownership
enum<string>
required
Available options:
mine
id
string<uuid>
required
appUrl
string<uri>
required
Canonical browser URL for this owned sample.
name
string | null
required
Human-friendly display name, or null if unset (falls back to filename).
filename
string
required
Original uploaded filename.
status
string
required
Lifecycle status: uploading, upload_failed, deid_running, deid_failed, preprocessing, ready, or preprocess_failed.
fileSize
string
required
Uploaded file size in bytes (string-encoded 64-bit integer).
widthPx
integer | null
required
Level-0 width in pixels, or null before the dimensions probe completes.
heightPx
integer | null
required
Level-0 height in pixels, or null before the dimensions probe completes.
mpp
number | null
required
Effective isotropic microns per pixel (user override → calibrated slide value), or null when the sample has no usable scale yet.
originalRetiredAt
string<date-time> | null
required
When original-file retirement was claimed. Null while the original remains available. Canonical H&E still supports viewing, inference and scale changes; retirement does not make the sample read-only.
fields
object
required
Unified field values keyed by stable definition key. Tags is a string array at tags; Public is a boolean at public. Values are validated against the organization's definitions.
createdAt
string<date-time> | null
required
expiresAt
string<date-time> | null
required
When the sample moves to Trash. Null when it never expires.
expiresAtSource
enum<string> | null
required
org_default = derived from the org policy at upload time. custom = set by an explicit expiration call (a date or a never-expire pin). Null when the sample has no expiration and no org policy applies.
Available options:
org_default,
custom,
null
expiresInDays
integer | null
required
Whole days until expiry, clamped at 0 for a sample at/past its date but not yet swept. Null when the sample never expires.
willExpire
boolean
required
True when the sample has an expiration date set.
trashedAt
string<date-time> | null
required
When the sample entered Trash, or null if it is still active. Trashed samples are permanently deleted 7 days after this time.
jobs
object[]
required
Maximum array length: 50
Show child attributes
jobCount
integer
required
Total inference-job count for the sample before the 50-job cap.
Required range: x >= 0
segmentation
object
required
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Strand AI","description":"Spatial proteomics from H\u0026E. Lattice predicts spatially resolved protein-marker maps from routine H\u0026E, delivered as virtual mIF channels.","colors":{"primary":"#004D3B","light":"#006650","dark":"#004D3B"},"logo":{"light":"https://mintcdn.com/strandai/c6Te5vUWVWP-mr0Q/logo-dark.svg?fit=max\u0026auto=format\u0026n=c6Te5vUWVWP-mr0Q\u0026q=85\u0026s=689c0d47abf0f9b5076e963acaffa8d6","dark":"https://mintcdn.com/strandai/c6Te5vUWVWP-mr0Q/logo-white.svg?fit=max\u0026auto=format\u0026n=c6Te5vUWVWP-mr0Q\u0026q=85\u0026s=40bf5ca332d513c816780709e94b8c16","href":"https://strandai.com"},"favicon":"https://mintcdn.com/strandai/vTcOY54DE0LzRJ_f/favicon.svg?fit=max\u0026auto=format\u0026n=vTcOY54DE0LzRJ_f\u0026q=85\u0026s=20b05705652e3edd7ffcd411efa9417b","api":{"openapi":"api-reference/openapi.json","examples":{"languages":["python","curl","javascript","php","go","java","ruby"]}},"background":{"color":{"light":"#F2F1ED","dark":"#00120A"}},"navbar":{"links":[{"href":"mailto:support@strandai.com","label":"Support"}],"primary":{"type":"button","label":"Platform","href":"https://app.strandai.com"}},"footer":{"socials":{"website":"https://strandai.com","github":"https://github.com/strand-ai"}},"seo":{"metatags":{"og:site_name":"Strand AI Docs","og:type":"website","og:image":"https://docs.strandai.com/images/og-card.png","twitter:image":"https://docs.strandai.com/images/og-card.png","twitter:card":"summary_large_image"},"indexing":"all"},"fonts":{"heading":{"family":"PP Telegraf","weight":400,"source":"fonts/PPTelegraf-Regular.woff2","format":"woff2"},"body":{"family":"Source Sans 3"}},"styling":{"codeblocks":"dark","latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"strandai","hasAudioNarration":false,"actualSubdomain":"strandai","customDomains":["docs.strandai.com"],"gitSource":{"type":"github","owner":"strand-ai","repo":"strand-official","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6b010b22d15ec117daff2f0f","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API reference","count":35},{"language":"default","tag":"Endpoints","count":34},{"language":"default","tag":"Guides","count":8},{"language":"default","tag":"SDKs","count":4},{"language":"default","tag":"Programmatic workflows","count":4},{"language":"default","tag":"Plan a run","count":3},{"language":"default","tag":"MCP","count":3},{"language":"default","tag":"Connect an agent","count":3},{"language":"default","tag":"Manage and explore","count":2},{"language":"default","tag":"Get started","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":true},"customCss":[]}
{"page":{"pagePath":"api-reference/endpoint/patchSample","slug":"/api-reference/endpoint/patchSample","pageMetadata":{"title":"Update a sample","openapi":"PATCH /samples/{id}","description":"Atomically update any combination of an owned sample's display name, unified field values, and isotropic microns-per-pixel value. Public share ids are not patchable. OAuth callers need both `samples:read` and `samples:write` because the response includes full owned detail and job history. When countable `mpp` is supplied, an idempotent recount is enqueued even if the stored value is unchanged; after an enqueue-failure 500, retry the identical patch to heal the recount.","href":"/api-reference/endpoint/patchSample"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Atomically update any combination of an owned sample’s display name, unified field values, and isotropic microns-per-pixel value. Public share ids are not patchable. OAuth callers need both \", _jsx(_components.code, {\n children: \"samples:read\"\n }), \" and \", _jsx(_components.code, {\n children: \"samples:write\"\n }), \" because the response includes full owned detail and job history. When countable \", _jsx(_components.code, {\n children: \"mpp\"\n }), \" is supplied, an idempotent recount is enqueued even if the stored value is unchanged; after an enqueue-failure 500, retry the identical patch to heal the recount.\"]\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Atomically updates any combination of an owned sample’s display name, unified\nfield values, and isotropic microns-per-pixel value. The response is the full\nowned sample detail, including inference-job history.`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`fields`}),` is keyed by stable definition key. Each supplied value replaces that\nfield’s complete value; `,_jsx(_components.code,{children:`null`}),` clears it. This payload replaces Tags:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes dark-plus dark-plus`,style:{backgroundColor:`#0B0C0E`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`{ `}),_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:`\"fields\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:`\"tags\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"baseline\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"trial-42\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`] } }`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Tags values are trimmed and lowercased, duplicates collapse, each value must be\nbetween 1 and 50 characters without commas or control characters, and a sample\nmay carry\nat most 50 distinct Tags values. Public is readable through `,_jsx(_components.code,{children:`fields.public`}),` but\nis not writable through this endpoint; publication uses its protected flow.`]}),`\n`,_jsxs(_components.p,{children:[`Use `,_jsx(_components.code,{children:`GET /sample-fields`}),` to discover keys, value types, origin, storage, and\nwritability. The retired top-level `,_jsx(_components.code,{children:`tags`}),` property is rejected with HTTP 400.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":"dark","config":{},"pageMetadata":{"title":"Update a sample","openapi":"PATCH /samples/{id}","description":"Atomically update any combination of an owned sample's display name, unified field values, and isotropic microns-per-pixel value. Public share ids are not patchable. OAuth callers need both `samples:read` and `samples:write` because the response includes full owned detail and job history. When countable `mpp` is supplied, an idempotent recount is enqueued even if the stored value is unchanged; after an enqueue-failure 500, retry the identical patch to heal the recount.","href":"/api-reference/endpoint/patchSample"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/strandai/a92a1cb8d942860f/posthog-pageviews.js"],"openApiReferenceData":{"operation":{"summary":"Update a sample","description":"Atomically update any combination of an owned sample's display name, unified field values, and isotropic microns-per-pixel value. Public share ids are not patchable. OAuth callers need both `samples:read` and `samples:write` because the response includes full owned detail and job history. When countable `mpp` is supplied, an idempotent recount is enqueued even if the stored value is unchanged; after an enqueue-failure 500, retry the identical patch to heal the recount.","security":["f3d7d322-28e8-4019-ac13-c715eca67c7f","b370a03d-7448-4ebf-9d9e-ce11813c2b06"],"parameters":["039ba69a-a642-4206-9601-835aadc86e14"],"requestBody":"9eeddc43-12d4-478e-9aab-937a35dc0672","responses":{"200":"a5b4e66b-beeb-4b45-9ba0-7ab49a14eb26","400":"03fbe880-5fb2-4456-be07-9380682bded6","401":"604621b5-1357-4227-88c2-781a90a90cfe","403":"27ce151b-99f1-4f3c-bd24-d26331675003","404":"f692ee1e-1090-435b-a2c4-cc0ac85d0107","422":"0232184d-f00b-4d0a-ab62-f2876c0dc9fe","500":"f262d521-8369-4e73-b7a5-60e6c9a41f6b"},"method":"patch","type":"path","servers":["913b60f1-f440-4231-8834-21a4f2805b1b"],"path":"/samples/{id}","baseUrlOptions":["https://app.strandai.com/api/v1"],"title":"Update a sample","codeSamples":[],"requestExampleLanguages":["python","bash","javascript","php","go","java","ruby"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"039ba69a-a642-4206-9601-835aadc86e14":{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"minProperties":1,"properties":{"name":{"oneOf":[{"type":"string","maxLength":200,"pattern":"^[^\\u0000]*$","description":"Trimmed display name. Null or an empty string reverts to filename. NUL characters are rejected.","uniqueKey":"name.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":200,"pattern":"^[^\\u0000]*$","description":"Trimmed display name. Null or an empty string reverts to filename. NUL characters are rejected.","uniqueKey":"name.oneOf.1","typeLabel":"null"}],"uniqueKey":"name","typeLabel":"string | null"},"fields":{"type":"object","description":"Complete values for the named fields, not deltas. Null clears a field. `fields.tags` is the complete desired tag set; `fields.public` is read-only and returns 403.","minProperties":1,"additionalProperties":true,"uniqueKey":"fields","typeLabel":"object"},"mpp":{"oneOf":[{"type":"number","description":"User-reported microns per pixel. Object axes must be equal; anisotropic input is rejected.","maximum":100,"minimum":0,"exclusiveMinimum":true,"uniqueKey":"mpp.oneOf.0","typeLabel":"number"},{"type":"object","description":"User-reported microns per pixel. Object axes must be equal; anisotropic input is rejected.","required":["x","y"],"properties":{"x":{"type":"number","exclusiveMinimum":0,"maximum":100,"isRequired":true,"uniqueKey":"mpp.oneOf.1.x","typeLabel":"number"},"y":{"type":"number","exclusiveMinimum":0,"maximum":100,"isRequired":true,"uniqueKey":"mpp.oneOf.1.y","typeLabel":"number"}},"additionalProperties":false,"uniqueKey":"mpp.oneOf.1","typeLabel":"object"}],"uniqueKey":"mpp","typeLabel":"number | object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","mpp":50}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"a5b4e66b-beeb-4b45-9ba0-7ab49a14eb26":{"description":"Updated owned sample detail","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"description":"An owned sample's curated read model and its 50 newest inference jobs. `jobCount` is the uncapped total.","required":["ownership","id","appUrl","name","filename","status","fileSize","widthPx","heightPx","mpp","originalRetiredAt","fields","createdAt","expiresAt","expiresAtSource","expiresInDays","willExpire","trashedAt","jobs","jobCount","segmentation"],"properties":{"ownership":{"type":"string","enum":["mine"],"isRequired":true,"uniqueKey":"ownership","typeLabel":"enum\u003cstring>"},"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"appUrl":{"type":"string","format":"uri","description":"Canonical browser URL for this owned sample.","isRequired":true,"uniqueKey":"appUrl","typeLabel":"string\u003curi>"},"name":{"oneOf":[{"type":"string","description":"Human-friendly display name, or null if unset (falls back to filename).","isRequired":true,"uniqueKey":"name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Human-friendly display name, or null if unset (falls back to filename).","isRequired":true,"uniqueKey":"name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"name","typeLabel":"string | null"},"filename":{"type":"string","description":"Original uploaded filename.","isRequired":true,"uniqueKey":"filename","typeLabel":"string"},"status":{"type":"string","description":"Lifecycle status: `uploading`, `upload_failed`, `deid_running`, `deid_failed`, `preprocessing`, `ready`, or `preprocess_failed`.","isRequired":true,"uniqueKey":"status","typeLabel":"string"},"fileSize":{"type":"string","description":"Uploaded file size in bytes (string-encoded 64-bit integer).","isRequired":true,"uniqueKey":"fileSize","typeLabel":"string"},"widthPx":{"oneOf":[{"type":"integer","description":"Level-0 width in pixels, or null before the dimensions probe completes.","isRequired":true,"uniqueKey":"widthPx.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Level-0 width in pixels, or null before the dimensions probe completes.","isRequired":true,"uniqueKey":"widthPx.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"widthPx","typeLabel":"integer | null"},"heightPx":{"oneOf":[{"type":"integer","description":"Level-0 height in pixels, or null before the dimensions probe completes.","isRequired":true,"uniqueKey":"heightPx.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Level-0 height in pixels, or null before the dimensions probe completes.","isRequired":true,"uniqueKey":"heightPx.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"heightPx","typeLabel":"integer | null"},"mpp":{"oneOf":[{"type":"number","description":"Effective isotropic microns per pixel (user override → calibrated slide value), or null when the sample has no usable scale yet.","isRequired":true,"uniqueKey":"mpp.oneOf.0","typeLabel":"number"},{"type":"null","description":"Effective isotropic microns per pixel (user override → calibrated slide value), or null when the sample has no usable scale yet.","isRequired":true,"uniqueKey":"mpp.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"mpp","typeLabel":"number | null"},"originalRetiredAt":{"oneOf":[{"type":"string","format":"date-time","description":"When original-file retirement was claimed. Null while the original remains available. Canonical H\u0026E still supports viewing, inference and scale changes; retirement does not make the sample read-only.","isRequired":true,"uniqueKey":"originalRetiredAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When original-file retirement was claimed. Null while the original remains available. Canonical H\u0026E still supports viewing, inference and scale changes; retirement does not make the sample read-only.","isRequired":true,"uniqueKey":"originalRetiredAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"originalRetiredAt","typeLabel":"string\u003cdate-time> | null"},"fields":{"type":"object","additionalProperties":true,"description":"Unified field values keyed by stable definition key. Tags is a string array at `tags`; Public is a boolean at `public`. Values are validated against the organization's definitions.","isRequired":true,"uniqueKey":"fields","typeLabel":"object"},"createdAt":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"createdAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"createdAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time> | null"},"expiresAt":{"oneOf":[{"type":"string","format":"date-time","description":"When the sample moves to Trash. Null when it never expires.","isRequired":true,"uniqueKey":"expiresAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the sample moves to Trash. Null when it never expires.","isRequired":true,"uniqueKey":"expiresAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"expiresAt","typeLabel":"string\u003cdate-time> | null"},"expiresAtSource":{"oneOf":[{"type":"string","enum":["org_default","custom",null],"description":"`org_default` = derived from the org policy at upload time. `custom` = set by an explicit expiration call (a date or a never-expire pin). Null when the sample has no expiration and no org policy applies.","isRequired":true,"uniqueKey":"expiresAtSource.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["org_default","custom",null],"description":"`org_default` = derived from the org policy at upload time. `custom` = set by an explicit expiration call (a date or a never-expire pin). Null when the sample has no expiration and no org policy applies.","isRequired":true,"uniqueKey":"expiresAtSource.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"expiresAtSource","typeLabel":"enum\u003cstring> | null"},"expiresInDays":{"oneOf":[{"type":"integer","description":"Whole days until expiry, clamped at 0 for a sample at/past its date but not yet swept. Null when the sample never expires.","isRequired":true,"uniqueKey":"expiresInDays.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Whole days until expiry, clamped at 0 for a sample at/past its date but not yet swept. Null when the sample never expires.","isRequired":true,"uniqueKey":"expiresInDays.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"expiresInDays","typeLabel":"integer | null"},"willExpire":{"type":"boolean","description":"True when the sample has an expiration date set.","isRequired":true,"uniqueKey":"willExpire","typeLabel":"boolean"},"trashedAt":{"oneOf":[{"type":"string","format":"date-time","description":"When the sample entered Trash, or null if it is still active. Trashed samples are permanently deleted 7 days after this time.","isRequired":true,"uniqueKey":"trashedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the sample entered Trash, or null if it is still active. Trashed samples are permanently deleted 7 days after this time.","isRequired":true,"uniqueKey":"trashedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"trashedAt","typeLabel":"string\u003cdate-time> | null"},"jobs":{"type":"array","maxItems":50,"items":{"type":"object","additionalProperties":false,"required":["id","appUrl","status","progress","reservedCredits","markers","createdAt","startedAt","completedAt","errorMessage","resultsAvailable"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"jobs.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"appUrl":{"type":"string","format":"uri","description":"Canonical authenticated Platform URL for this job's sample.","isRequired":true,"uniqueKey":"jobs.items.[INDEX].appUrl","typeLabel":"string\u003curi>"},"status":{"type":"string","description":"Lifecycle: `queued` → `dispatching` → `preprocessing` → `running` → `postprocessing` → terminal. Terminal values: `completed`, `partial_failed`, `failed`, and `cancelled`.","isRequired":true,"uniqueKey":"jobs.items.[INDEX].status","typeLabel":"string"},"progress":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"jobs.items.[INDEX].progress.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"jobs.items.[INDEX].progress.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"jobs.items.[INDEX].progress","typeLabel":"number | null"},"reservedCredits":{"oneOf":[{"type":"integer","isRequired":true,"uniqueKey":"jobs.items.[INDEX].reservedCredits.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"jobs.items.[INDEX].reservedCredits.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"jobs.items.[INDEX].reservedCredits","typeLabel":"integer | null"},"markers":{"type":"array","items":{"type":"string","uniqueKey":"jobs.items.[INDEX].markers.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"jobs.items.[INDEX].markers","typeLabel":"string[]"},"createdAt":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"jobs.items.[INDEX].createdAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"jobs.items.[INDEX].createdAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"jobs.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time> | null"},"startedAt":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"jobs.items.[INDEX].startedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"jobs.items.[INDEX].startedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"jobs.items.[INDEX].startedAt","typeLabel":"string\u003cdate-time> | null"},"completedAt":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"jobs.items.[INDEX].completedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"jobs.items.[INDEX].completedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"jobs.items.[INDEX].completedAt","typeLabel":"string\u003cdate-time> | null"},"errorMessage":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"jobs.items.[INDEX].errorMessage.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"jobs.items.[INDEX].errorMessage.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"jobs.items.[INDEX].errorMessage","typeLabel":"string | null"},"resultsAvailable":{"type":"boolean","isRequired":true,"uniqueKey":"jobs.items.[INDEX].resultsAvailable","typeLabel":"boolean"}},"uniqueKey":"jobs.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"jobs","typeLabel":"object[]"},"jobCount":{"type":"integer","minimum":0,"description":"Total inference-job count for the sample before the 50-job cap.","isRequired":true,"uniqueKey":"jobCount","typeLabel":"integer"},"segmentation":{"type":"object","additionalProperties":false,"required":["status","retryable","creditCost","job","layer"],"properties":{"status":{"type":"string","enum":["not_started","queued","running","postprocessing","completed","failed","cancelled"],"isRequired":true,"uniqueKey":"segmentation.status","typeLabel":"enum\u003cstring>"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"segmentation.retryable","typeLabel":"boolean"},"creditCost":{"type":"integer","enum":[0],"description":"Segmentation is credit-free.","isRequired":true,"uniqueKey":"segmentation.creditCost","typeLabel":"enum\u003cinteger>"},"job":{"oneOf":[{"type":"object","additionalProperties":true,"isRequired":true,"uniqueKey":"segmentation.job.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"isRequired":true,"uniqueKey":"segmentation.job.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"segmentation.job","typeLabel":"object | null"},"layer":{"oneOf":[{"type":"object","additionalProperties":true,"isRequired":true,"uniqueKey":"segmentation.layer.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"isRequired":true,"uniqueKey":"segmentation.layer.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"segmentation.layer","typeLabel":"object | null"}},"isRequired":true,"uniqueKey":"segmentation","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"ownership":"mine","id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","appUrl":"\u003cstring>","name":"\u003cstring>","filename":"\u003cstring>","status":"\u003cstring>","fileSize":"\u003cstring>","widthPx":123,"heightPx":123,"mpp":123,"originalRetiredAt":"2023-11-07T05:31:56Z","fields":{},"createdAt":"2023-11-07T05:31:56Z","expiresAt":"2023-11-07T05:31:56Z","expiresAtSource":"org_default","expiresInDays":123,"willExpire":true,"trashedAt":"2023-11-07T05:31:56Z","jobs":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","appUrl":"\u003cstring>","status":"\u003cstring>","progress":123,"reservedCredits":123,"markers":["\u003cstring>"],"createdAt":"2023-11-07T05:31:56Z","startedAt":"2023-11-07T05:31:56Z","completedAt":"2023-11-07T05:31:56Z","errorMessage":"\u003cstring>","resultsAvailable":true}],"jobCount":1,"segmentation":{"status":"not_started","retryable":true,"creditCost":0,"job":{},"layer":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"03fbe880-5fb2-4456-be07-9380682bded6":{"description":"Body is not JSON, empty, or contains unknown fields","content":{"application/json":{"schema":{"type":"object","required":["error","message"],"properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"reason":{"oneOf":[{"type":"string","uniqueKey":"reason.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"reason","typeLabel":"string | null"},"required":{"oneOf":[{"type":"integer","uniqueKey":"required.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"required.oneOf.1","typeLabel":"null"}],"uniqueKey":"required","typeLabel":"integer | null"},"retryAfterSeconds":{"oneOf":[{"type":"integer","uniqueKey":"retryAfterSeconds.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"retryAfterSeconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"retryAfterSeconds","typeLabel":"integer | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","message":"\u003cstring>","reason":"\u003cstring>","required":123,"retryAfterSeconds":123}}},"exampleType":"generated"}},"exampleType":"generated"},"604621b5-1357-4227-88c2-781a90a90cfe":{"description":"Missing or invalid credential","content":{"application/json":{"schema":{"type":"object","required":["error","message"],"properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"reason":{"oneOf":[{"type":"string","uniqueKey":"reason.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"reason","typeLabel":"string | null"},"required":{"oneOf":[{"type":"integer","uniqueKey":"required.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"required.oneOf.1","typeLabel":"null"}],"uniqueKey":"required","typeLabel":"integer | null"},"retryAfterSeconds":{"oneOf":[{"type":"integer","uniqueKey":"retryAfterSeconds.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"retryAfterSeconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"retryAfterSeconds","typeLabel":"integer | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","message":"\u003cstring>","reason":"\u003cstring>","required":123,"retryAfterSeconds":123}}},"exampleType":"generated"}},"exampleType":"generated"},"27ce151b-99f1-4f3c-bd24-d26331675003":{"description":"OAuth token lacks samples:read or samples:write, or the patch attempts to write a read-only field such as Public","content":{"application/json":{"schema":{"type":"object","required":["error","message"],"properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"reason":{"oneOf":[{"type":"string","uniqueKey":"reason.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"reason","typeLabel":"string | null"},"required":{"oneOf":[{"type":"integer","uniqueKey":"required.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"required.oneOf.1","typeLabel":"null"}],"uniqueKey":"required","typeLabel":"integer | null"},"retryAfterSeconds":{"oneOf":[{"type":"integer","uniqueKey":"retryAfterSeconds.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"retryAfterSeconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"retryAfterSeconds","typeLabel":"integer | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","message":"\u003cstring>","reason":"\u003cstring>","required":123,"retryAfterSeconds":123}}},"exampleType":"generated"}},"exampleType":"generated"},"f692ee1e-1090-435b-a2c4-cc0ac85d0107":{"description":"Owned sample not found in this org","content":{"application/json":{"schema":{"type":"object","required":["error","message"],"properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"reason":{"oneOf":[{"type":"string","uniqueKey":"reason.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"reason","typeLabel":"string | null"},"required":{"oneOf":[{"type":"integer","uniqueKey":"required.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"required.oneOf.1","typeLabel":"null"}],"uniqueKey":"required","typeLabel":"integer | null"},"retryAfterSeconds":{"oneOf":[{"type":"integer","uniqueKey":"retryAfterSeconds.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"retryAfterSeconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"retryAfterSeconds","typeLabel":"integer | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","message":"\u003cstring>","reason":"\u003cstring>","required":123,"retryAfterSeconds":123}}},"exampleType":"generated"}},"exampleType":"generated"},"0232184d-f00b-4d0a-ab62-f2876c0dc9fe":{"description":"A provided field is invalid","content":{"application/json":{"schema":{"type":"object","required":["error","message"],"properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"reason":{"oneOf":[{"type":"string","uniqueKey":"reason.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"reason","typeLabel":"string | null"},"required":{"oneOf":[{"type":"integer","uniqueKey":"required.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"required.oneOf.1","typeLabel":"null"}],"uniqueKey":"required","typeLabel":"integer | null"},"retryAfterSeconds":{"oneOf":[{"type":"integer","uniqueKey":"retryAfterSeconds.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"retryAfterSeconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"retryAfterSeconds","typeLabel":"integer | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","message":"\u003cstring>","reason":"\u003cstring>","required":123,"retryAfterSeconds":123}}},"exampleType":"generated"}},"exampleType":"generated"},"f262d521-8369-4e73-b7a5-60e6c9a41f6b":{"description":"The sample update committed but its MPP tissue recount could not be enqueued. Retry the identical patch to re-attempt the idempotent recount.","content":{"application/json":{"schema":{"type":"object","required":["error","message"],"properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"reason":{"oneOf":[{"type":"string","uniqueKey":"reason.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"reason","typeLabel":"string | null"},"required":{"oneOf":[{"type":"integer","uniqueKey":"required.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"required.oneOf.1","typeLabel":"null"}],"uniqueKey":"required","typeLabel":"integer | null"},"retryAfterSeconds":{"oneOf":[{"type":"integer","uniqueKey":"retryAfterSeconds.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"retryAfterSeconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"retryAfterSeconds","typeLabel":"integer | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","message":"\u003cstring>","reason":"\u003cstring>","required":123,"retryAfterSeconds":123}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"f3d7d322-28e8-4019-ac13-c715eca67c7f":{"ApiKey":{"type":"http","scheme":"bearer","bearerFormat":"sk-strand-XXXXXXXXXXXXXXXXXXXXXXXX","scopes":[],"schemeName":"ApiKey"}},"b370a03d-7448-4ebf-9d9e-ce11813c2b06":{"OAuth2":{"type":"oauth2","description":"Strand AI authorization-code flow with S256 PKCE, explicit organization consent, and RFC 8707 resource binding.","flows":{"authorizationCode":{"authorizationUrl":"https://auth.strandai.com/oauth2/auth","tokenUrl":"https://auth.strandai.com/oauth2/token","scopes":{"samples:read":"Read slide metadata and estimates","samples:write":"Upload and change slides","jobs:read":"Read run status","jobs:write":"Start, export, or cancel runs","results:read":"Read and download results","credits:spend":"Reserve and spend organization credits"}}},"scopes":["samples:read","samples:write"],"schemeName":"OAuth2"}}},"servers":{"913b60f1-f440-4231-8834-21a4f2805b1b":{"url":"https://app.strandai.com/api/v1","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"sk-strand-XXXXXXXXXXXXXXXXXXXXXXXX","scopes":[],"schemeName":"ApiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"ApiKey","name":"Authorization"}],"title":"ApiKey"},{"schemes":[{"scheme":{"type":"oauth2","description":"Strand AI authorization-code flow with S256 PKCE, explicit organization consent, and RFC 8707 resource binding.","flows":{"authorizationCode":{"authorizationUrl":"https://auth.strandai.com/oauth2/auth","tokenUrl":"https://auth.strandai.com/oauth2/token","scopes":{"samples:read":"Read slide metadata and estimates","samples:write":"Upload and change slides","jobs:read":"Read run status","jobs:write":"Start, export, or cancel runs","results:read":"Read and download results","credits:spend":"Reserve and spend organization credits"}}},"scopes":["samples:read","samples:write"],"schemeName":"OAuth2"},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"Strand AI authorization-code flow with S256 PKCE, explicit organization consent, and RFC 8707 resource binding.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"OAuth2","name":"Authorization"}],"title":"OAuth2"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"strandai","siteName":"Strand AI","title":"Update a sample - Strand AI","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-27T19:31:35.901Z","originalFileLocation":"api-reference/endpoint/patchSample.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=\"Atomically update any combination of an owned sample\u0026#x27;s display name, unified field values, and isotropic microns-per-pixel value. Public share ids are not patchable. OAuth callers need both samples:read and samples:write because the response includes full owned detail and job history. When countable mpp is supplied, an idempotent recount is enqueued even if the stored value is unchanged; after an enqueue-failure 500, retry the identical patch to heal the recount.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Strand 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/strandai/-A6LhR9Q97KZhsDo/_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/strandai/-A6LhR9Q97KZhsDo/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/strandai/-A6LhR9Q97KZhsDo/_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/strandai/-A6LhR9Q97KZhsDo/_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/strandai/-A6LhR9Q97KZhsDo/_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/strandai/-A6LhR9Q97KZhsDo/_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/strandai/-A6LhR9Q97KZhsDo/_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/strandai/-A6LhR9Q97KZhsDo/_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/strandai/-A6LhR9Q97KZhsDo/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update a sample - Strand AI\">\u003cmeta data-mint-head property=\"og:description\" content=\"Atomically update any combination of an owned sample\u0026#x27;s display name, unified field values, and isotropic microns-per-pixel value. Public share ids are not patchable. OAuth callers need both samples:read and samples:write because the response includes full owned detail and job history. When countable mpp is supplied, an idempotent recount is enqueued even if the stored value is unchanged; after an enqueue-failure 500, retry the identical patch to heal the recount.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Strand AI Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.strandai.com/api-reference/endpoint/patchSample\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://docs.strandai.com/images/og-card.png\">\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 sample - Strand AI\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Atomically update any combination of an owned sample\u0026#x27;s display name, unified field values, and isotropic microns-per-pixel value. Public share ids are not patchable. OAuth callers need both samples:read and samples:write because the response includes full owned detail and job history. When countable mpp is supplied, an idempotent recount is enqueued even if the stored value is unchanged; after an enqueue-failure 500, retry the identical patch to heal the recount.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://docs.strandai.com/images/og-card.png\">\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/strandai/-A6LhR9Q97KZhsDo/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Strand AI\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#004D3B\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.strandai.com/api-reference/endpoint/patchSample\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoint/patchSample.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.strandai.com/#organization\",\"name\":\"Strand AI\",\"url\":\"https://docs.strandai.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/strandai/c6Te5vUWVWP-mr0Q/logo-dark.svg?fit=max\u0026auto=format\u0026n=c6Te5vUWVWP-mr0Q\u0026q=85\u0026s=689c0d47abf0f9b5076e963acaffa8d6\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.strandai.com#website\",\"name\":\"Strand AI\",\"url\":\"https://docs.strandai.com\",\"publisher\":{\"@id\":\"https://docs.strandai.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.strandai.com/api-reference/endpoint/patchSample#webpage\",\"url\":\"https://docs.strandai.com/api-reference/endpoint/patchSample\",\"name\":\"Update a sample\",\"description\":\"Atomically update any combination of an owned sample's display name, unified field values, and isotropic microns-per-pixel value. Public share ids are not patchable. OAuth callers need both samples:read and samples:write because the response includes full owned detail and job history. When countable mpp is supplied, an idempotent recount is enqueued even if the stored value is unchanged; after an enqueue-failure 500, retry the identical patch to heal the recount.\",\"dateModified\":\"2026-08-27T19:31:35.901Z\",\"isPartOf\":{\"@id\":\"https://docs.strandai.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.strandai.com/api-reference/endpoint/patchSample#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.strandai.com/api-reference/endpoint/patchSample#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.strandai.com/api-reference/endpoint/listMarkers\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Update a sample\",\"item\":\"https://docs.strandai.com/api-reference/endpoint/patchSample\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.strandai.com/api-reference/endpoint/patchSample#apireference\",\"headline\":\"Update a sample\",\"name\":\"Update a sample\",\"description\":\"Atomically update any combination of an owned sample's display name, unified field values, and isotropic microns-per-pixel value. Public share ids are not patchable. OAuth callers need both samples:read and samples:write because the response includes full owned detail and job history. When countable mpp is supplied, an idempotent recount is enqueued even if the stored value is unchanged; after an enqueue-failure 500, retry the identical patch to heal the recount.\",\"url\":\"https://docs.strandai.com/api-reference/endpoint/patchSample\",\"mainEntityOfPage\":{\"@id\":\"https://docs.strandai.com/api-reference/endpoint/patchSample#webpage\"},\"image\":\"https://docs.strandai.com/images/og-card.png\",\"dateModified\":\"2026-08-27T19:31:35.901Z\",\"publisher\":{\"@id\":\"https://docs.strandai.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.strandai.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Strand AI\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Strand AI\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/endpoint/patchSample.md","siteName":"Strand AI","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/introduction"}]},{"tab":"SDKs","pages":[{"title":"SDKs","href":"/sdks/quickstart"}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/mcp/overview"}]},{"tab":"API reference","groups":[{"group":"Overview","pages":[{"title":"REST API overview","href":"/api/overview"}]},{"group":"Endpoints","pages":[{"title":"List markers","openapi":"GET /markers","href":"/api-reference/endpoint/listMarkers"},{"title":"List uploads","openapi":"GET /uploads","href":"/api-reference/endpoint/listUploads"},{"title":"Get an upload","openapi":"GET /uploads/{id}","href":"/api-reference/endpoint/getUpload"},{"title":"Initiate upload","openapi":"POST /uploads","href":"/api-reference/endpoint/createUpload"},{"title":"Renew an upload session","openapi":"POST /uploads/{id}","href":"/api-reference/endpoint/renewUploadSession"},{"title":"Complete an upload","openapi":"POST /uploads/{id}/complete","href":"/api-reference/endpoint/completeUpload"},{"title":"Price or submit a prediction","openapi":"POST /predict","href":"/api-reference/endpoint/submitPrediction"},{"title":"Get job","openapi":"GET /jobs/{id}","href":"/api-reference/endpoint/getJob"},{"title":"Cancel a job","openapi":"POST /jobs/{id}/cancel","href":"/api-reference/endpoint/cancelJob"},{"title":"Stream job (SSE)","openapi":"GET /jobs/{id}/stream","href":"/api-reference/endpoint/streamJob"},{"title":"Get results URL","openapi":"GET /jobs/{id}/results","href":"/api-reference/endpoint/getJobResults"},{"title":"Download result file","openapi":"GET /jobs/{id}/results/files/{path}","href":"/api-reference/endpoint/getJobResultFile"},{"title":"Read result files in a batch","openapi":"POST /jobs/{id}/results/files","href":"/api-reference/endpoint/getJobResultFilesBatch"},{"title":"Preflight signed result files","openapi":"POST /jobs/{id}/results/files/signed","href":"/api-reference/endpoint/getSignedJobResultFiles"},{"title":"Get an owned or public sample","openapi":"GET /samples/{id}","description":"Resolve an org-owned sample id first, returning its curated detail and inference-job history. Otherwise resolve the same path value as a currently-public share UUID and return only public-safe detail.","href":"/api-reference/endpoint/getSample"},{"title":"Update a sample","openapi":"PATCH /samples/{id}","href":"/api-reference/endpoint/patchSample"},{"title":"Request result export","openapi":"POST /jobs/{id}/exports","description":"Select native OME-Zarr, OME-Zarr ZIP, or OME-TIFF and optional H\u0026E/segmentation contents.","href":"/api-reference/endpoint/requestResultExport"},{"title":"Get result export","openapi":"GET /jobs/{id}/exports","href":"/api-reference/endpoint/getResultExport"},{"title":"Cell segmentation lifecycle","openapi":"GET /samples/{id}/segmentation","href":"/api-reference/endpoint/sampleSegmentation"},{"title":"Start or retry cell segmentation","openapi":"POST /samples/{id}/segmentation","href":"/api-reference/endpoint/startSampleSegmentation"},{"title":"Get segmentation manifest","openapi":"GET /samples/{id}/segmentation/{layerId}/manifest","href":"/api-reference/endpoint/getSegmentationManifest"},{"title":"Read segmentation artifact file","openapi":"GET /samples/{id}/segmentation/{layerId}/files/{path}","href":"/api-reference/endpoint/getSegmentationFile"},{"title":"Set sample expiration","openapi":"PATCH /samples/{id}/expiration","href":"/api-reference/endpoint/setSampleExpiration"},{"title":"Set sample expiration (bulk)","openapi":"PATCH /samples/expiration","href":"/api-reference/endpoint/setSamplesExpirationBulk"},{"title":"Restore sample","openapi":"POST /samples/{id}/restore","href":"/api-reference/endpoint/restoreSample"},{"title":"List samples","openapi":"GET /samples","href":"/api-reference/endpoint/listSamples"},{"title":"List custom sample fields","openapi":"GET /sample-fields","href":"/api-reference/endpoint/listSampleFields"},{"title":"Create a custom sample field","openapi":"POST /sample-fields","href":"/api-reference/endpoint/createSampleField"},{"title":"Publish an artifact","openapi":"POST /artifacts","href":"/api-reference/endpoint/createArtifact"},{"title":"List artifacts","openapi":"GET /artifacts","href":"/api-reference/endpoint/listArtifacts"},{"title":"Get an artifact","openapi":"GET /artifacts/{id}","href":"/api-reference/endpoint/getArtifact"},{"title":"Delete an artifact","openapi":"DELETE /artifacts/{id}","href":"/api-reference/endpoint/deleteArtifact"},{"title":"Stream a public sample's OME-Zarr","openapi":"GET /public/samples/{publicId}/zarr/{path}","href":"/api-reference/endpoint/getPublicSampleZarr"},{"title":"Get a public sample thumbnail","openapi":"GET /public/samples/{publicId}/thumbnail","href":"/api-reference/endpoint/getPublicSampleThumbnail"}]}]}]},"basePath":"","title":"Update a sample - Strand AI","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}