Update the index schema of one branch. The change applies to this branch only; updating main also updates the collection’s indexConfigs, which mirror main. The same additive rule as the collection route applies within the branch: indexConfigs must preserve the branch’s complete existing schema (the server-managed id field may be included as returned or omitted), new fields may be added at any object depth, and a field description may be set, replaced, or cleared without reindexing. Concurrent additive updates of the same branch are merged. Only a branch can be updated: naming a tag or an alias returns 400 BadRequest. Promoting a branch’s schema to main is a manual step: apply the same additive change to main.
A branch owns its indexConfigs only. Description, tags and snapshot retention stay on the collection route.
indexConfigs
IndexConfigs · object
required
Nonempty full schema. Collection updates preserve all existing fields and their settings while allowing new top-level fields and nested children at any depth. Removing or changing an existing field is rejected; only the optional description of a field may change. Collection responses include the server-managed top-level id field as {"type":"keyword"}. Requests may omit it or send exactly that configuration, so returned indexConfigs can be sent back unchanged; any other id configuration, id inside an object field, or other reserved internal field name is rejected.
Show child attributes
Response
Updated branch with its index schema.
branch
BranchDetails · object
required
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"LambdaDB Documentation","colors":{"primary":"#0D9373","light":"#07C983","dark":"#0D9373"},"logo":{"light":"https://mintcdn.com/lambdadb/fejsT7T9UaNPB1nX/logo/light.svg?fit=max\u0026auto=format\u0026n=fejsT7T9UaNPB1nX\u0026q=85\u0026s=3984578842930966eb2d9d05766af2cd","dark":"https://mintcdn.com/lambdadb/p3ZLnnGiGP71YxJM/logo/dark.svg?fit=max\u0026auto=format\u0026n=p3ZLnnGiGP71YxJM\u0026q=85\u0026s=18498f8b90cd8979b463acbae342f9b1"},"favicon":"https://mintcdn.com/lambdadb/fejsT7T9UaNPB1nX/favicon.svg?fit=max\u0026auto=format\u0026n=fejsT7T9UaNPB1nX\u0026q=85\u0026s=6f7e3b6dbe311b4da3a87224c799b276","api":{"playground":{"display":"simple"}},"navbar":{"links":[{"href":"mailto:support@lambdadb.ai","label":"Support"}]},"footer":{"socials":{"github":"https://github.com/lambdadb","linkedin":"https://www.linkedin.com/company/lambdadb","x":"https://x.com/lambdadbai","reddit":"https://www.reddit.com/r/vectorlake","slack":"https://lambdadbcommunity.slack.com/join/shared_invite/zt-3sg7565zm-sCTW3odRkEQt~auWUVVsTw"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"lambdadb","hasAudioNarration":false,"actualSubdomain":"lambdadb","customDomains":["docs.lambdadb.ai"],"gitSource":{"type":"github","owner":"lambdadb","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{},"buildId":"6afe6d7d5db64e6239cc96d5","clientVersion":"0.0.4205","searchFilterCounts":[{"language":"default","tag":"Guides","count":38},{"language":"default","tag":"Reference","count":30},{"language":"default","tag":"APIs","count":29},{"language":"default","tag":"Documents","count":14},{"language":"default","tag":"Branches, tags \u0026 aliases","count":14},{"language":"default","tag":"Collections","count":11},{"language":"default","tag":"Search","count":10},{"language":"default","tag":"Get started","count":8},{"language":"default","tag":"Migrations","count":6},{"language":"default","tag":"Query","count":5}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"reference/api/endpoint/branch-configure","slug":"/reference/api/endpoint/branch-configure","pageMetadata":{"title":"Update a branch index schema","openapi":"patch /collections/{collectionName}/branches/{branchName}","description":"Update the index schema of one branch. The change applies to this branch only; updating main also updates the collection's indexConfigs, which mirror main. The same additive rule as the collection route applies within the branch: indexConfigs must preserve the branch's complete existing schema (the server-managed id field may be included as returned or omitted), new fields may be added at any object depth, and a field description may be set, replaced, or cleared without reindexing. Concurrent additive updates of the same branch are merged. Only a branch can be updated: naming a tag or an alias returns 400 BadRequest. Promoting a branch's schema to main is a manual step: apply the same additive change to main.","href":"/reference/api/endpoint/branch-configure"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Update the index schema of one branch. The change applies to this branch only; updating main also updates the collection’s indexConfigs, which mirror main. The same additive rule as the collection route applies within the branch: indexConfigs must preserve the branch’s complete existing schema (the server-managed id field may be included as returned or omitted), new fields may be added at any object depth, and a field description may be set, replaced, or cleared without reindexing. Concurrent additive updates of the same branch are merged. Only a branch can be updated: naming a tag or an alias returns 400 BadRequest. Promoting a branch’s schema to main is a manual step: apply the same additive change to main.\"\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 branch index schema","openapi":"patch /collections/{collectionName}/branches/{branchName}","description":"Update the index schema of one branch. The change applies to this branch only; updating main also updates the collection's indexConfigs, which mirror main. The same additive rule as the collection route applies within the branch: indexConfigs must preserve the branch's complete existing schema (the server-managed id field may be included as returned or omitted), new fields may be added at any object depth, and a field description may be set, replaced, or cleared without reindexing. Concurrent additive updates of the same branch are merged. Only a branch can be updated: naming a tag or an alias returns 400 BadRequest. Promoting a branch's schema to main is a manual step: apply the same additive change to main.","href":"/reference/api/endpoint/branch-configure"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["versioning"],"operationId":"updateBranch","description":"Update the index schema of one branch. The change applies to this branch only; updating main also updates the collection's indexConfigs, which mirror main. The same additive rule as the collection route applies within the branch: indexConfigs must preserve the branch's complete existing schema (the server-managed id field may be included as returned or omitted), new fields may be added at any object depth, and a field description may be set, replaced, or cleared without reindexing. Concurrent additive updates of the same branch are merged. Only a branch can be updated: naming a tag or an alias returns 400 BadRequest. Promoting a branch's schema to main is a manual step: apply the same additive change to main.","security":["b915b539-86b9-4304-afa2-b3e9bdea5f58"],"parameters":["825789f1-8b2d-479e-8e66-7b74831b32a4","4ddcfd77-0da0-44bc-b2ce-6cac6ee7f3b6"],"requestBody":"3f7f228f-257e-4576-833e-3133ea1362e2","responses":{"200":"d9063c41-dca8-423a-8a35-5d28cffba038","400":"91c26a89-b96e-4f8c-9bc8-3d3962f42b55","401":"a21daf60-7de6-4281-a04f-a1f2646e9f97","404":"1695baa4-2c2e-437e-996d-89c0cacc33a8","409":"7a6380aa-addf-4bc4-98fd-eed6a57fc4e0","413":"61851d65-147e-4e94-a015-83943eeb32b0","429":"d463704a-2a25-4bcd-b716-80019c1e05d0","500":"f5fd24de-e8e9-4ff9-91f8-5b092bfaf763","502":"61a383ca-70b5-4fb6-a2b3-e0eab8e3a862","503":"33647de5-b8e6-4bee-8006-aa6455874881","504":"b52dbbdf-eb54-46e8-ada5-2efa2dc1d79b"},"summary":"Update a Branch's Index Schema","method":"patch","type":"path","servers":["4f810d0a-99f7-4471-9861-efbb0641caf7"],"path":"/collections/{collectionName}/branches/{branchName}","baseUrlOptions":["https://{projectHost}"],"title":"Update a Branch's Index Schema","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"825789f1-8b2d-479e-8e66-7b74831b32a4":{"in":"path","name":"collectionName","description":"Collection name.","required":true,"schema":{"type":"string","isRequired":true,"description":"Collection name.","uniqueKey":"","typeLabel":"string"}},"4ddcfd77-0da0-44bc-b2ce-6cac6ee7f3b6":{"in":"path","name":"branchName","required":true,"schema":{"type":"string","minLength":3,"maxLength":52,"pattern":"^[a-zA-Z0-9_-]{3,52}$","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"description":"A branch owns its indexConfigs only. Description, tags and snapshot retention stay on the collection route.","properties":{"indexConfigs":{"title":"IndexConfigs","type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"indexConfigs.additionalProperties.oneOf.0.type","typeLabel":"enum\u003cstring>"},"analyzers":{"type":"array","uniqueItems":true,"description":"Fixed analyzer presets for text fields; custom pipelines and analyzer options are not supported. The keyword analyzer does not change a text field into a keyword field. All 49 preset names are supported. See the Choose text analyzers guide for compatible SDK and tool versions. Use the lowercase names listed below. Duplicate names, including case variants, are rejected with HTTP 400. Defaults to [\"standard\"] when omitted. Each selected analyzer indexes the field separately; language detection is not automatic. An empty array does not use the default. See the Choose text analyzers guide for language selection, configuration examples, and the tradeoffs of combining analyzers.","items":{"type":"string","enum":["standard","english","korean","japanese","chinese","cjk","arabic","french","german","hindi","indonesian","italian","portuguese","russian","spanish","turkish","armenian","basque","bengali","brazilian","bulgarian","catalan","czech","danish","dutch","estonian","finnish","galician","greek","hungarian","irish","latvian","lithuanian","norwegian","persian","romanian","serbian","sorani","swedish","thai","simple","whitespace","stop","keyword","pattern","fingerprint","nepali","tamil","telugu"],"uniqueKey":"indexConfigs.additionalProperties.oneOf.0.analyzers.items.[INDEX]","typeLabel":"enum\u003cstring>"},"default":["standard"],"uniqueKey":"indexConfigs.additionalProperties.oneOf.0.analyzers","typeLabel":"enum\u003cstring>[]"},"description":{"oneOf":[{"title":"FieldDescription","type":"string","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"indexConfigs.additionalProperties.oneOf.0.description.oneOf.0","typeLabel":"string"},{"title":"FieldDescription","type":"null","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"indexConfigs.additionalProperties.oneOf.0.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"indexConfigs.additionalProperties.oneOf.0.description","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"indexConfigs.additionalProperties.oneOf.0","typeLabel":"object"},{"type":"object","required":["type","dimensions"],"properties":{"type":{"type":"string","enum":["vector"],"isRequired":true,"uniqueKey":"indexConfigs.additionalProperties.oneOf.1.type","typeLabel":"enum\u003cstring>"},"dimensions":{"type":"integer","description":"Vector dimensions for vector fields with caller-provided values.","minimum":64,"maximum":4096,"isRequired":true,"uniqueKey":"indexConfigs.additionalProperties.oneOf.1.dimensions","typeLabel":"integer"},"managedEmbedding":{"type":"boolean","description":"Set to false or omit for vector fields with caller-provided values.","enum":[false],"uniqueKey":"indexConfigs.additionalProperties.oneOf.1.managedEmbedding","typeLabel":"enum\u003cboolean>"},"similarity":{"type":"string","description":"Vector similarity metric for vector fields with caller-provided values.","enum":["cosine","euclidean"],"default":"cosine","uniqueKey":"indexConfigs.additionalProperties.oneOf.1.similarity","typeLabel":"enum\u003cstring>"},"description":{"oneOf":[{"title":"FieldDescription","type":"string","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"indexConfigs.additionalProperties.oneOf.1.description.oneOf.0","typeLabel":"string"},{"title":"FieldDescription","type":"null","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"indexConfigs.additionalProperties.oneOf.1.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"indexConfigs.additionalProperties.oneOf.1.description","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"indexConfigs.additionalProperties.oneOf.1","typeLabel":"object"},{"type":"object","required":["type","embedding"],"properties":{"type":{"type":"string","enum":["vector"],"isRequired":true,"uniqueKey":"indexConfigs.additionalProperties.oneOf.2.type","typeLabel":"enum\u003cstring>"},"embedding":{"oneOf":[{"type":"object","title":"EmbeddingConfig","description":"Native embedding configuration for vector fields.","required":["provider","model","sourceField"],"properties":{"sourceField":{"type":"string","description":"Legacy single-text source path in the original JSON. Use exactly one non-null sourceField or sources. Missing text is skipped; invalid values fail when inference is needed. An explicitly supplied vector takes precedence over inference.","minLength":1,"pattern":".*\\S.*","isRequired":true,"uniqueKey":"indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.0.sourceField","typeLabel":"string"},"provider":{"type":"string","description":"Embedding provider.","enum":["openai","cohere"],"isRequired":true,"uniqueKey":"indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.0.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"Embedding model name. See /guides/collections/native-embeddings for the current supported providers and models.","isRequired":true,"uniqueKey":"indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.0.model","typeLabel":"string"},"sources":{"type":"null","description":"Ordered source mappings; field paths must be unique. Text sources are scalar strings. Cohere image sources are strings or flat string arrays, expanded in place to create one combined vector. Missing sources and empty image arrays are skipped. At most 16 effective parts, 8 images and 1 MiB decoded image bytes per input; each image is limited to 4,194,304 pixels. Images must be supported data URIs or public HTTPS URLs. URL, field-path, duplicate-path, format and byte/pixel validation remain server checks. OpenAI requires exactly one text source.","maxItems":16,"minItems":1,"uniqueKey":"indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.0.sources","typeLabel":"null"},"dimensions":{"type":"integer","description":"Optional model dimensions, resolved in stored metadata. OpenAI limits depend on the model. Cohere accepts 256, 512, 768, 1024, 1536 or 2048 and defaults to 2048.","minimum":64,"maximum":4096,"uniqueKey":"indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.0.dimensions","typeLabel":"integer"},"similarity":{"type":"string","description":"Resolved vector similarity metric. Optional in requests and resolved in stored collection metadata.","enum":["cosine","euclidean"],"default":"cosine","uniqueKey":"indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.0.similarity","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.0","typeLabel":"EmbeddingConfig · object"},{"type":"object","title":"EmbeddingConfig","description":"Native embedding configuration for vector fields.","required":["provider","model","sources"],"properties":{"sources":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","minLength":1,"pattern":".*\\S.*","description":"Unique dotted path in the original stored JSON; no index declaration is required.","isRequired":true,"uniqueKey":"indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.1.sources.items.[INDEX].field","typeLabel":"string"},"type":{"type":"string","enum":["text","image"],"isRequired":true,"uniqueKey":"indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.1.sources.items.[INDEX].type","typeLabel":"enum\u003cstring>"}},"required":["field","type"],"additionalProperties":false,"uniqueKey":"indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.1.sources.items.[INDEX]","typeLabel":"object"},"description":"Ordered source mappings; field paths must be unique. Text sources are scalar strings. Cohere image sources are strings or flat string arrays, expanded in place to create one combined vector. Missing sources and empty image arrays are skipped. At most 16 effective parts, 8 images and 1 MiB decoded image bytes per input; each image is limited to 4,194,304 pixels. Images must be supported data URIs or public HTTPS URLs. URL, field-path, duplicate-path, format and byte/pixel validation remain server checks. OpenAI requires exactly one text source.","maxItems":16,"minItems":1,"isRequired":true,"uniqueKey":"indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.1.sources","typeLabel":"object[]"},"provider":{"type":"string","description":"Embedding provider.","enum":["openai","cohere"],"isRequired":true,"uniqueKey":"indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.1.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"Embedding model name. See /guides/collections/native-embeddings for the current supported providers and models.","isRequired":true,"uniqueKey":"indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.1.model","typeLabel":"string"},"sourceField":{"type":"null","description":"Legacy single-text source path in the original JSON. Use exactly one non-null sourceField or sources. Missing text is skipped; invalid values fail when inference is needed. An explicitly supplied vector takes precedence over inference.","minLength":1,"pattern":".*\\S.*","uniqueKey":"indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.1.sourceField","typeLabel":"null"},"dimensions":{"type":"integer","description":"Optional model dimensions, resolved in stored metadata. OpenAI limits depend on the model. Cohere accepts 256, 512, 768, 1024, 1536 or 2048 and defaults to 2048.","minimum":64,"maximum":4096,"uniqueKey":"indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.1.dimensions","typeLabel":"integer"},"similarity":{"type":"string","description":"Resolved vector similarity metric. Optional in requests and resolved in stored collection metadata.","enum":["cosine","euclidean"],"default":"cosine","uniqueKey":"indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.1.similarity","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.1","typeLabel":"EmbeddingConfig · object"}],"isRequired":true,"uniqueKey":"indexConfigs.additionalProperties.oneOf.2.embedding","typeLabel":"EmbeddingConfig · object"},"managedEmbedding":{"type":"boolean","description":"An embedding block enables native embeddings when this flag is omitted; explicit false is invalid. Normalized collection responses retain true.","enum":[true],"uniqueKey":"indexConfigs.additionalProperties.oneOf.2.managedEmbedding","typeLabel":"enum\u003cboolean>"},"description":{"oneOf":[{"title":"FieldDescription","type":"string","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"indexConfigs.additionalProperties.oneOf.2.description.oneOf.0","typeLabel":"string"},{"title":"FieldDescription","type":"null","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"indexConfigs.additionalProperties.oneOf.2.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"indexConfigs.additionalProperties.oneOf.2.description","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"indexConfigs.additionalProperties.oneOf.2","typeLabel":"object"},{"type":"object","description":"Types that do not need additional parameters.","required":["type"],"properties":{"type":{"type":"string","enum":["keyword","long","double","datetime","boolean","sparseVector"],"isRequired":true,"uniqueKey":"indexConfigs.additionalProperties.oneOf.3.type","typeLabel":"enum\u003cstring>"},"description":{"oneOf":[{"title":"FieldDescription","type":"string","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"indexConfigs.additionalProperties.oneOf.3.description.oneOf.0","typeLabel":"string"},{"title":"FieldDescription","type":"null","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"indexConfigs.additionalProperties.oneOf.3.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"indexConfigs.additionalProperties.oneOf.3.description","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"indexConfigs.additionalProperties.oneOf.3","typeLabel":"object"},{"type":"object","required":["type","objectIndexConfigs"],"properties":{"type":{"type":"string","enum":["object"],"isRequired":true,"uniqueKey":"indexConfigs.additionalProperties.oneOf.4.type","typeLabel":"enum\u003cstring>"},"objectIndexConfigs":{"type":"object","additionalProperties":true,"isRequired":true,"uniqueKey":"indexConfigs.additionalProperties.oneOf.4.objectIndexConfigs","typeLabel":"object"},"description":{"oneOf":[{"title":"FieldDescription","type":"string","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"indexConfigs.additionalProperties.oneOf.4.description.oneOf.0","typeLabel":"string"},{"title":"FieldDescription","type":"null","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"indexConfigs.additionalProperties.oneOf.4.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"indexConfigs.additionalProperties.oneOf.4.description","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"indexConfigs.additionalProperties.oneOf.4","typeLabel":"object"}],"uniqueKey":"indexConfigs.additionalProperties","typeLabel":"object"},"minProperties":1,"description":"Nonempty full schema. Collection updates preserve all existing fields and their settings while allowing new top-level fields and nested children at any depth. Removing or changing an existing field is rejected; only the optional description of a field may change. Collection responses include the server-managed top-level id field as {\"type\":\"keyword\"}. Requests may omit it or send exactly that configuration, so returned indexConfigs can be sent back unchanged; any other id configuration, id inside an object field, or other reserved internal field name is rejected.","isRequired":true,"uniqueKey":"indexConfigs","typeLabel":"IndexConfigs · object"}},"required":["indexConfigs"],"uniqueKey":"","typeLabel":"object"},"examples":{"example":{"title":"example","value":{"indexConfigs":{"title":{"type":"text","analyzers":["english"],"description":"Book title as printed on the cover"},"category":{"type":"keyword"},"author":{"type":"keyword"}}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"d9063c41-dca8-423a-8a35-5d28cffba038":{"description":"Updated branch with its index schema.","content":{"application/json":{"schema":{"type":"object","properties":{"branch":{"title":"BranchDetails","type":"object","properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"branch.name","typeLabel":"string"},"parentBranch":{"oneOf":[{"type":"object","title":"ParentBranchDetails","description":"Fixed identity and name of the direct source branch, even when its selected snapshot originated on an ancestor or its head was empty. Explicitly null for main, branches created from tags, or when no parent was recorded. Historical metadata only: it does not prevent parent deletion, and recreating the parent's name does not change this identity.","required":["branchId","name"],"properties":{"branchId":{"type":"string","description":"Identity of the direct source branch at creation time.","isRequired":true,"uniqueKey":"branch.parentBranch.oneOf.0.branchId","typeLabel":"string"},"name":{"type":"string","description":"Name of the direct source branch at creation time.","isRequired":true,"uniqueKey":"branch.parentBranch.oneOf.0.name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"branch.parentBranch.oneOf.0","typeLabel":"ParentBranchDetails · object"},{"type":"null","description":"Fixed identity and name of the direct source branch, even when its selected snapshot originated on an ancestor or its head was empty. Explicitly null for main, branches created from tags, or when no parent was recorded. Historical metadata only: it does not prevent parent deletion, and recreating the parent's name does not change this identity.","isRequired":true,"uniqueKey":"branch.parentBranch.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"branch.parentBranch","typeLabel":"ParentBranchDetails · object | null"},"headSnapshot":{"oneOf":[{"type":"object","title":"SnapshotDetails","description":"Current committed head. Explicitly null for an empty branch.","required":["snapshotId","snapshotCommittedAt"],"properties":{"snapshotId":{"type":"string","description":"Immutable snapshot identity.","isRequired":true,"uniqueKey":"branch.headSnapshot.oneOf.0.snapshotId","typeLabel":"string"},"snapshotCommittedAt":{"type":"integer","format":"int64","description":"Snapshot commit time as Unix epoch milliseconds, distinct from ref creation time and collection dataUpdatedAt.","isRequired":true,"uniqueKey":"branch.headSnapshot.oneOf.0.snapshotCommittedAt","typeLabel":"integer\u003cint64>"}},"isRequired":true,"uniqueKey":"branch.headSnapshot.oneOf.0","typeLabel":"SnapshotDetails · object"},{"type":"null","description":"Current committed head. Explicitly null for an empty branch.","isRequired":true,"uniqueKey":"branch.headSnapshot.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"branch.headSnapshot","typeLabel":"SnapshotDetails · object | null"},"parentSnapshot":{"oneOf":[{"type":"object","title":"SnapshotDetails","description":"Fixed snapshot from which the branch was created, not the previous head. Explicitly null for main and branches created from an empty source, even after their head advances. This metadata does not extend snapshot retention.","required":["snapshotId","snapshotCommittedAt"],"properties":{"snapshotId":{"type":"string","description":"Immutable snapshot identity.","isRequired":true,"uniqueKey":"branch.parentSnapshot.oneOf.0.snapshotId","typeLabel":"string"},"snapshotCommittedAt":{"type":"integer","format":"int64","description":"Snapshot commit time as Unix epoch milliseconds, distinct from ref creation time and collection dataUpdatedAt.","isRequired":true,"uniqueKey":"branch.parentSnapshot.oneOf.0.snapshotCommittedAt","typeLabel":"integer\u003cint64>"}},"isRequired":true,"uniqueKey":"branch.parentSnapshot.oneOf.0","typeLabel":"SnapshotDetails · object"},{"type":"null","description":"Fixed snapshot from which the branch was created, not the previous head. Explicitly null for main and branches created from an empty source, even after their head advances. This metadata does not extend snapshot retention.","isRequired":true,"uniqueKey":"branch.parentSnapshot.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"branch.parentSnapshot","typeLabel":"SnapshotDetails · object | null"},"createdAt":{"type":"integer","format":"int64","description":"Branch creation time as Unix epoch milliseconds.","isRequired":true,"uniqueKey":"branch.createdAt","typeLabel":"integer\u003cint64>"},"indexConfigs":{"title":"IndexConfigs","type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.0.type","typeLabel":"enum\u003cstring>"},"analyzers":{"type":"array","uniqueItems":true,"description":"Fixed analyzer presets for text fields; custom pipelines and analyzer options are not supported. The keyword analyzer does not change a text field into a keyword field. All 49 preset names are supported. See the Choose text analyzers guide for compatible SDK and tool versions. Use the lowercase names listed below. Duplicate names, including case variants, are rejected with HTTP 400. Defaults to [\"standard\"] when omitted. Each selected analyzer indexes the field separately; language detection is not automatic. An empty array does not use the default. See the Choose text analyzers guide for language selection, configuration examples, and the tradeoffs of combining analyzers.","items":{"type":"string","enum":["standard","english","korean","japanese","chinese","cjk","arabic","french","german","hindi","indonesian","italian","portuguese","russian","spanish","turkish","armenian","basque","bengali","brazilian","bulgarian","catalan","czech","danish","dutch","estonian","finnish","galician","greek","hungarian","irish","latvian","lithuanian","norwegian","persian","romanian","serbian","sorani","swedish","thai","simple","whitespace","stop","keyword","pattern","fingerprint","nepali","tamil","telugu"],"uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.0.analyzers.items.[INDEX]","typeLabel":"enum\u003cstring>"},"default":["standard"],"uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.0.analyzers","typeLabel":"enum\u003cstring>[]"},"description":{"oneOf":[{"title":"FieldDescription","type":"string","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.0.description.oneOf.0","typeLabel":"string"},{"title":"FieldDescription","type":"null","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.0.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.0.description","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.0","typeLabel":"object"},{"type":"object","required":["type","dimensions"],"properties":{"type":{"type":"string","enum":["vector"],"isRequired":true,"uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.1.type","typeLabel":"enum\u003cstring>"},"dimensions":{"type":"integer","description":"Vector dimensions for vector fields with caller-provided values.","minimum":64,"maximum":4096,"isRequired":true,"uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.1.dimensions","typeLabel":"integer"},"managedEmbedding":{"type":"boolean","description":"Set to false or omit for vector fields with caller-provided values.","enum":[false],"uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.1.managedEmbedding","typeLabel":"enum\u003cboolean>"},"similarity":{"type":"string","description":"Vector similarity metric for vector fields with caller-provided values.","enum":["cosine","euclidean"],"default":"cosine","uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.1.similarity","typeLabel":"enum\u003cstring>"},"description":{"oneOf":[{"title":"FieldDescription","type":"string","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.1.description.oneOf.0","typeLabel":"string"},{"title":"FieldDescription","type":"null","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.1.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.1.description","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.1","typeLabel":"object"},{"type":"object","required":["type","embedding"],"properties":{"type":{"type":"string","enum":["vector"],"isRequired":true,"uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.2.type","typeLabel":"enum\u003cstring>"},"embedding":{"oneOf":[{"type":"object","title":"EmbeddingConfig","description":"Native embedding configuration for vector fields.","required":["provider","model","sourceField"],"properties":{"sourceField":{"type":"string","description":"Legacy single-text source path in the original JSON. Use exactly one non-null sourceField or sources. Missing text is skipped; invalid values fail when inference is needed. An explicitly supplied vector takes precedence over inference.","minLength":1,"pattern":".*\\S.*","isRequired":true,"uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.0.sourceField","typeLabel":"string"},"provider":{"type":"string","description":"Embedding provider.","enum":["openai","cohere"],"isRequired":true,"uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.0.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"Embedding model name. See /guides/collections/native-embeddings for the current supported providers and models.","isRequired":true,"uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.0.model","typeLabel":"string"},"sources":{"type":"null","description":"Ordered source mappings; field paths must be unique. Text sources are scalar strings. Cohere image sources are strings or flat string arrays, expanded in place to create one combined vector. Missing sources and empty image arrays are skipped. At most 16 effective parts, 8 images and 1 MiB decoded image bytes per input; each image is limited to 4,194,304 pixels. Images must be supported data URIs or public HTTPS URLs. URL, field-path, duplicate-path, format and byte/pixel validation remain server checks. OpenAI requires exactly one text source.","maxItems":16,"minItems":1,"uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.0.sources","typeLabel":"null"},"dimensions":{"type":"integer","description":"Optional model dimensions, resolved in stored metadata. OpenAI limits depend on the model. Cohere accepts 256, 512, 768, 1024, 1536 or 2048 and defaults to 2048.","minimum":64,"maximum":4096,"uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.0.dimensions","typeLabel":"integer"},"similarity":{"type":"string","description":"Resolved vector similarity metric. Optional in requests and resolved in stored collection metadata.","enum":["cosine","euclidean"],"default":"cosine","uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.0.similarity","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.0","typeLabel":"EmbeddingConfig · object"},{"type":"object","title":"EmbeddingConfig","description":"Native embedding configuration for vector fields.","required":["provider","model","sources"],"properties":{"sources":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","minLength":1,"pattern":".*\\S.*","description":"Unique dotted path in the original stored JSON; no index declaration is required.","isRequired":true,"uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.1.sources.items.[INDEX].field","typeLabel":"string"},"type":{"type":"string","enum":["text","image"],"isRequired":true,"uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.1.sources.items.[INDEX].type","typeLabel":"enum\u003cstring>"}},"required":["field","type"],"additionalProperties":false,"uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.1.sources.items.[INDEX]","typeLabel":"object"},"description":"Ordered source mappings; field paths must be unique. Text sources are scalar strings. Cohere image sources are strings or flat string arrays, expanded in place to create one combined vector. Missing sources and empty image arrays are skipped. At most 16 effective parts, 8 images and 1 MiB decoded image bytes per input; each image is limited to 4,194,304 pixels. Images must be supported data URIs or public HTTPS URLs. URL, field-path, duplicate-path, format and byte/pixel validation remain server checks. OpenAI requires exactly one text source.","maxItems":16,"minItems":1,"isRequired":true,"uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.1.sources","typeLabel":"object[]"},"provider":{"type":"string","description":"Embedding provider.","enum":["openai","cohere"],"isRequired":true,"uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.1.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"Embedding model name. See /guides/collections/native-embeddings for the current supported providers and models.","isRequired":true,"uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.1.model","typeLabel":"string"},"sourceField":{"type":"null","description":"Legacy single-text source path in the original JSON. Use exactly one non-null sourceField or sources. Missing text is skipped; invalid values fail when inference is needed. An explicitly supplied vector takes precedence over inference.","minLength":1,"pattern":".*\\S.*","uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.1.sourceField","typeLabel":"null"},"dimensions":{"type":"integer","description":"Optional model dimensions, resolved in stored metadata. OpenAI limits depend on the model. Cohere accepts 256, 512, 768, 1024, 1536 or 2048 and defaults to 2048.","minimum":64,"maximum":4096,"uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.1.dimensions","typeLabel":"integer"},"similarity":{"type":"string","description":"Resolved vector similarity metric. Optional in requests and resolved in stored collection metadata.","enum":["cosine","euclidean"],"default":"cosine","uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.1.similarity","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.2.embedding.oneOf.1","typeLabel":"EmbeddingConfig · object"}],"isRequired":true,"uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.2.embedding","typeLabel":"EmbeddingConfig · object"},"managedEmbedding":{"type":"boolean","description":"An embedding block enables native embeddings when this flag is omitted; explicit false is invalid. Normalized collection responses retain true.","enum":[true],"uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.2.managedEmbedding","typeLabel":"enum\u003cboolean>"},"description":{"oneOf":[{"title":"FieldDescription","type":"string","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.2.description.oneOf.0","typeLabel":"string"},{"title":"FieldDescription","type":"null","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.2.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.2.description","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.2","typeLabel":"object"},{"type":"object","description":"Types that do not need additional parameters.","required":["type"],"properties":{"type":{"type":"string","enum":["keyword","long","double","datetime","boolean","sparseVector"],"isRequired":true,"uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.3.type","typeLabel":"enum\u003cstring>"},"description":{"oneOf":[{"title":"FieldDescription","type":"string","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.3.description.oneOf.0","typeLabel":"string"},{"title":"FieldDescription","type":"null","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.3.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.3.description","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.3","typeLabel":"object"},{"type":"object","required":["type","objectIndexConfigs"],"properties":{"type":{"type":"string","enum":["object"],"isRequired":true,"uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.4.type","typeLabel":"enum\u003cstring>"},"objectIndexConfigs":{"type":"object","additionalProperties":true,"isRequired":true,"uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.4.objectIndexConfigs","typeLabel":"object"},"description":{"oneOf":[{"title":"FieldDescription","type":"string","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.4.description.oneOf.0","typeLabel":"string"},{"title":"FieldDescription","type":"null","maxLength":255,"description":"Optional free-form explanation of what the field holds, returned in collection reads so agents and SDK users can discover field meanings. It never affects indexing and can be added, changed, or cleared on an existing field without reindexing. On PATCH, omitting it or sending null keeps the stored description, an empty string clears it, and any other value replaces it. Not accepted on the server-managed id field.","uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.4.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.4.description","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"branch.indexConfigs.additionalProperties.oneOf.4","typeLabel":"object"}],"uniqueKey":"branch.indexConfigs.additionalProperties","typeLabel":"object"},"minProperties":1,"description":"The branch's index schema.","isRequired":true,"uniqueKey":"branch.indexConfigs","typeLabel":"IndexConfigs · object"},"numDocs":{"type":"integer","description":"Document count in this branch's committed head; 0 for an empty branch.","isRequired":true,"uniqueKey":"branch.numDocs","typeLabel":"integer"},"dataUpdatedAt":{"oneOf":[{"type":"integer","description":"Last data update of this branch's committed head as Unix epoch milliseconds. Explicitly null for an empty branch.","format":"int64","isRequired":true,"uniqueKey":"branch.dataUpdatedAt.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"Last data update of this branch's committed head as Unix epoch milliseconds. Explicitly null for an empty branch.","isRequired":true,"uniqueKey":"branch.dataUpdatedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"branch.dataUpdatedAt","typeLabel":"integer\u003cint64> | null"}},"required":["name","parentBranch","headSnapshot","parentSnapshot","numDocs","dataUpdatedAt","indexConfigs","createdAt"],"isRequired":true,"uniqueKey":"branch","typeLabel":"BranchDetails · object"}},"required":["branch"],"uniqueKey":"","typeLabel":"object"},"examples":{"example":{"title":"example","value":{"branch":{"name":"candidate","parentBranch":{"branchId":"main-branch-id","name":"main"},"createdAt":1788336000000,"headSnapshot":{"snapshotId":"snapshot-id","snapshotCommittedAt":1788335940000},"parentSnapshot":{"snapshotId":"snapshot-id","snapshotCommittedAt":1788335940000},"numDocs":1000,"dataUpdatedAt":1788335940000,"indexConfigs":{"title":{"type":"text","analyzers":["english"],"description":"Book title as printed on the cover"},"category":{"type":"keyword"},"id":{"type":"keyword"}}}}}},"exampleType":"examples"}},"exampleType":"examples"},"91c26a89-b96e-4f8c-9bc8-3d3962f42b55":{"description":"Bad request","content":{"application/json":{"schema":{"title":"BadRequest","type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"BadRequest · object"},"examples":{"example":{"title":"example","summary":"Example response for bad request","value":{"message":"Invalid request"}}},"exampleType":"examples"}},"exampleType":"examples"},"a21daf60-7de6-4281-a04f-a1f2646e9f97":{"description":"Unauthenticated","content":{"application/json":{"schema":{"title":"Unauthenticated","type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"Unauthenticated · object"},"examples":{"example":{"title":"example","summary":"Example response for authentication failure","value":{"message":"Authentication failed"}}},"exampleType":"examples"}},"exampleType":"examples"},"1695baa4-2c2e-437e-996d-89c0cacc33a8":{"description":"Resource not found","content":{"application/json":{"schema":{"title":"ResourceNotFound","type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"ResourceNotFound · object"},"examples":{"example":{"title":"example","summary":"Example response for resource not found","value":{"message":"Resource not found"}}},"exampleType":"examples"}},"exampleType":"examples"},"7a6380aa-addf-4bc4-98fd-eed6a57fc4e0":{"description":"Conditional catalog conflict. Refresh the resource state before deciding whether to retry.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"61851d65-147e-4e94-a015-83943eeb32b0":{"description":"Request exceeds the Gateway transport limit. Reduce the request size or use bulk upsert when supported.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"d463704a-2a25-4bcd-b716-80019c1e05d0":{"description":"Too many requests","content":{"application/json":{"schema":{"title":"TooManyRequests","type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"TooManyRequests · object"},"examples":{"example":{"title":"example","summary":"Example response for too many requests","value":{"message":"Too many requests"}}},"exampleType":"examples"}},"headers":{"Retry-After":{"description":"Optional retry delay in seconds. Not present on every 429 response.","schema":{"type":"string"}}},"exampleType":"examples"},"f5fd24de-e8e9-4ff9-91f8-5b092bfaf763":{"description":"Internal server error","content":{"application/json":{"schema":{"title":"InternalServerError","type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"InternalServerError · object"},"examples":{"example":{"title":"example","summary":"Example response for internal server error","value":{"message":"Internal server error"}}},"exampleType":"examples"}},"exampleType":"examples"},"61a383ca-70b5-4fb6-a2b3-e0eab8e3a862":{"description":"Unexpected downstream failure. A failed write response may leave its outcome uncertain.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"33647de5-b8e6-4bee-8006-aa6455874881":{"description":"Transient catalog or storage dependency failure. Use bounded retries where the operation permits.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"b52dbbdf-eb54-46e8-ada5-2efa2dc1d79b":{"description":"Gateway request deadline exceeded. A write may have been applied; verify its outcome before retrying.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"b915b539-86b9-4304-afa2-b3e9bdea5f58":{"ProjectApiKey":{"type":"apiKey","in":"header","name":"x-api-key","description":"Project API Key.","x-speakeasy-example":"\u003cYOUR_PROJECT_API_KEY>","scopes":[],"schemeName":"ProjectApiKey"}}},"servers":{"4f810d0a-99f7-4471-9861-efbb0641caf7":{"url":"https://{projectHost}","description":"LambdaDB API endpoints","variables":{"projectHost":{"description":"The project-scoped URL of the API","default":"api.lambdadb.ai/projects/example-project"}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","description":"Project API Key.","x-speakeasy-example":"\u003cYOUR_PROJECT_API_KEY>","scopes":[],"schemeName":"ProjectApiKey"},"schema":{"title":"x-api-key","type":"string","description":"Project API Key.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ProjectApiKey","name":"x-api-key"}],"title":"ProjectApiKey"}]},"originalFileLocation":"reference/api/openapi.json"},"subdomain":"lambdadb","siteName":"LambdaDB Documentation","title":"Update a branch index schema - LambdaDB Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-18T11:56:25.309Z","originalFileLocation":"reference/api/endpoint/branch-configure.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 the index schema of one branch. The change applies to this branch only; updating main also updates the collection\u0026#x27;s indexConfigs, which mirror main. The same additive rule as the collection route applies within the branch: indexConfigs must preserve the branch\u0026#x27;s complete existing schema (the server-managed id field may be included as returned or omitted), new fields may be added at any object depth, and a field description may be set, replaced, or cleared without reindexing. Concurrent additive updates of the same branch are merged. Only a branch can be updated: naming a tag or an alias returns 400 BadRequest. Promoting a branch\u0026#x27;s schema to main is a manual step: apply the same additive change to main.\">\u003cmeta data-mint-head name=\"application-name\" content=\"LambdaDB Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/lambdadb/HRGCecHRqLCJVNdR/_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/lambdadb/HRGCecHRqLCJVNdR/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/lambdadb/HRGCecHRqLCJVNdR/_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/lambdadb/HRGCecHRqLCJVNdR/_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/lambdadb/HRGCecHRqLCJVNdR/_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/lambdadb/HRGCecHRqLCJVNdR/_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/lambdadb/HRGCecHRqLCJVNdR/_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/lambdadb/HRGCecHRqLCJVNdR/_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/lambdadb/HRGCecHRqLCJVNdR/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update a branch index schema - LambdaDB Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Update the index schema of one branch. The change applies to this branch only; updating main also updates the collection\u0026#x27;s indexConfigs, which mirror main. The same additive rule as the collection route applies within the branch: indexConfigs must preserve the branch\u0026#x27;s complete existing schema (the server-managed id field may be included as returned or omitted), new fields may be added at any object depth, and a field description may be set, replaced, or cleared without reindexing. Concurrent additive updates of the same branch are merged. Only a branch can be updated: naming a tag or an alias returns 400 BadRequest. Promoting a branch\u0026#x27;s schema to main is a manual step: apply the same additive change to main.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"LambdaDB Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.lambdadb.ai/reference/api/endpoint/branch-configure\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://lambdadb.mintlify.site/_mintlify/api/og/v2?division=Branches%2C+tags+%26+aliases\u0026amp;title=Update+a+branch+index+schema\u0026amp;description=Update+the+index+schema+of+one+branch.+The+change+applies+to+this+branch+only%3B+updating+main+also+updates+the+collection%27s+indexConfigs%2C+which+mirror+main.+The+\u0026amp;theme=3cd9b5ccc9d6e8e94ca23c6d\u0026amp;signature=9f1efbe3965579ec62bc53658df410285fbf4de76771ff63daa79114bf157720\">\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 branch index schema - LambdaDB Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Update the index schema of one branch. The change applies to this branch only; updating main also updates the collection\u0026#x27;s indexConfigs, which mirror main. The same additive rule as the collection route applies within the branch: indexConfigs must preserve the branch\u0026#x27;s complete existing schema (the server-managed id field may be included as returned or omitted), new fields may be added at any object depth, and a field description may be set, replaced, or cleared without reindexing. Concurrent additive updates of the same branch are merged. Only a branch can be updated: naming a tag or an alias returns 400 BadRequest. Promoting a branch\u0026#x27;s schema to main is a manual step: apply the same additive change to main.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://lambdadb.mintlify.site/_mintlify/api/og/v2?division=Branches%2C+tags+%26+aliases\u0026amp;title=Update+a+branch+index+schema\u0026amp;description=Update+the+index+schema+of+one+branch.+The+change+applies+to+this+branch+only%3B+updating+main+also+updates+the+collection%27s+indexConfigs%2C+which+mirror+main.+The+\u0026amp;theme=3cd9b5ccc9d6e8e94ca23c6d\u0026amp;signature=9f1efbe3965579ec62bc53658df410285fbf4de76771ff63daa79114bf157720\">\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/lambdadb/HRGCecHRqLCJVNdR/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"LambdaDB Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0D9373\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.lambdadb.ai/reference/api/endpoint/branch-configure\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/api/endpoint/branch-configure.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.lambdadb.ai/#organization\",\"name\":\"LambdaDB Documentation\",\"url\":\"https://docs.lambdadb.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/lambdadb/fejsT7T9UaNPB1nX/logo/light.svg?fit=max\u0026auto=format\u0026n=fejsT7T9UaNPB1nX\u0026q=85\u0026s=3984578842930966eb2d9d05766af2cd\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.lambdadb.ai#website\",\"name\":\"LambdaDB Documentation\",\"url\":\"https://docs.lambdadb.ai\",\"publisher\":{\"@id\":\"https://docs.lambdadb.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.lambdadb.ai/reference/api/endpoint/branch-configure#webpage\",\"url\":\"https://docs.lambdadb.ai/reference/api/endpoint/branch-configure\",\"name\":\"Update a branch index schema\",\"description\":\"Update the index schema of one branch. The change applies to this branch only; updating main also updates the collection's indexConfigs, which mirror main. The same additive rule as the collection route applies within the branch: indexConfigs must preserve the branch's complete existing schema (the server-managed id field may be included as returned or omitted), new fields may be added at any object depth, and a field description may be set, replaced, or cleared without reindexing. Concurrent additive updates of the same branch are merged. Only a branch can be updated: naming a tag or an alias returns 400 BadRequest. Promoting a branch's schema to main is a manual step: apply the same additive change to main.\",\"dateModified\":\"2026-11-18T11:56:25.309Z\",\"isPartOf\":{\"@id\":\"https://docs.lambdadb.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.lambdadb.ai/reference/api/endpoint/branch-configure#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.lambdadb.ai/reference/api/endpoint/branch-configure#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"APIs\",\"item\":\"https://docs.lambdadb.ai/reference/api/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Branches, tags \u0026 aliases\",\"item\":\"https://docs.lambdadb.ai/reference/api/endpoint/branch-create\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Update a branch index schema\",\"item\":\"https://docs.lambdadb.ai/reference/api/endpoint/branch-configure\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.lambdadb.ai/reference/api/endpoint/branch-configure#apireference\",\"headline\":\"Update a branch index schema\",\"name\":\"Update a branch index schema\",\"description\":\"Update the index schema of one branch. The change applies to this branch only; updating main also updates the collection's indexConfigs, which mirror main. The same additive rule as the collection route applies within the branch: indexConfigs must preserve the branch's complete existing schema (the server-managed id field may be included as returned or omitted), new fields may be added at any object depth, and a field description may be set, replaced, or cleared without reindexing. Concurrent additive updates of the same branch are merged. Only a branch can be updated: naming a tag or an alias returns 400 BadRequest. Promoting a branch's schema to main is a manual step: apply the same additive change to main.\",\"url\":\"https://docs.lambdadb.ai/reference/api/endpoint/branch-configure\",\"mainEntityOfPage\":{\"@id\":\"https://docs.lambdadb.ai/reference/api/endpoint/branch-configure#webpage\"},\"dateModified\":\"2026-11-18T11:56:25.309Z\",\"publisher\":{\"@id\":\"https://docs.lambdadb.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.lambdadb.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"LambdaDB Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"LambdaDB Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/reference/api/endpoint/branch-configure.md","siteName":"LambdaDB Documentation","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/get-started/overview"}]},{"tab":"Reference","groups":[{"group":"APIs","pages":[{"title":"API reference","href":"/reference/api/introduction"},{"group":"Collections","pages":[{"title":"List collections","openapi":"get /collections","href":"/reference/api/endpoint/collection-list"},{"title":"Create a collection","openapi":"post /collections","href":"/reference/api/endpoint/collection-create"},{"title":"Describe a collection","openapi":"get /collections/{collectionName}","href":"/reference/api/endpoint/collection-describe"},{"title":"Delete a collection","openapi":"delete /collections/{collectionName}","href":"/reference/api/endpoint/collection-delete"},{"title":"Configure a collection","openapi":"patch /collections/{collectionName}","href":"/reference/api/endpoint/collection-configure"}]},{"group":"Branches, tags \u0026 aliases","pages":[{"title":"Create a branch","openapi":"post /collections/{collectionName}/branches","href":"/reference/api/endpoint/branch-create"},{"title":"List branches","openapi":"get /collections/{collectionName}/branches","href":"/reference/api/endpoint/branch-list"},{"title":"Describe a branch","openapi":"get /collections/{collectionName}/branches/{branchName}","description":"Get a branch with its index schema and data statistics. A branch owns its indexConfigs: a new branch inherits the source branch's current version, the tag's pinned version, or the origin snapshot's version for an asOf branch, and later schema updates of other branches, including main, do not change it. A name that is not a branch returns 404.","href":"/reference/api/endpoint/branch-describe"},{"title":"Update a branch index schema","openapi":"patch /collections/{collectionName}/branches/{branchName}","href":"/reference/api/endpoint/branch-configure"},{"title":"Delete a branch","openapi":"delete /collections/{collectionName}/branches/{branchName}","description":"Delete a branch. Deleting the default main branch returns 400. Deleting another branch returns 409 while any alias references it. Delete or retarget all referencing aliases first.","href":"/reference/api/endpoint/branch-delete"},{"title":"Create a tag","openapi":"post /collections/{collectionName}/tags","href":"/reference/api/endpoint/tag-create"},{"title":"List tags","openapi":"get /collections/{collectionName}/tags","href":"/reference/api/endpoint/tag-list"},{"title":"Describe a tag","openapi":"get /collections/{collectionName}/tags/{tagName}","href":"/reference/api/endpoint/tag-describe"},{"title":"Delete a tag","openapi":"delete /collections/{collectionName}/tags/{tagName}","href":"/reference/api/endpoint/tag-delete"},{"title":"Create an alias","openapi":"post /collections/{collectionName}/aliases","href":"/reference/api/endpoint/alias-create"},{"title":"List aliases","openapi":"get /collections/{collectionName}/aliases","href":"/reference/api/endpoint/alias-list"},{"title":"Describe an alias","openapi":"get /collections/{collectionName}/aliases/{aliasName}","href":"/reference/api/endpoint/alias-describe"},{"title":"Retarget an alias","openapi":"patch /collections/{collectionName}/aliases/{aliasName}","href":"/reference/api/endpoint/alias-retarget"},{"title":"Delete an alias","openapi":"delete /collections/{collectionName}/aliases/{aliasName}","href":"/reference/api/endpoint/alias-delete"}]},{"group":"Documents","pages":[{"title":"Upsert documents","openapi":"post /collections/{collectionName}/docs/upsert","href":"/reference/api/endpoint/document-upsert"},{"title":"Get bulk upsert URL","openapi":"get /collections/{collectionName}/docs/bulk-upsert","href":"/reference/api/endpoint/document-get-bulk-upsert-url"},{"title":"Complete a bulk upsert","openapi":"post /collections/{collectionName}/docs/bulk-upsert","href":"/reference/api/endpoint/document-bulk-upsert"},{"title":"Update documents","openapi":"post /collections/{collectionName}/docs/update","href":"/reference/api/endpoint/document-update"},{"title":"Fetch documents","openapi":"post /collections/{collectionName}/docs/fetch","href":"/reference/api/endpoint/document-fetch"},{"title":"List documents","openapi":"get /collections/{collectionName}/docs","href":"/reference/api/endpoint/document-list"},{"title":"List documents extended","openapi":"post /collections/{collectionName}/docs/list","href":"/reference/api/endpoint/document-list-extended"},{"title":"Delete documents","openapi":"post /collections/{collectionName}/docs/delete","href":"/reference/api/endpoint/document-delete"}]},{"group":"Search","pages":[{"title":"Query a collection","openapi":"post /collections/{collectionName}/query","href":"/reference/api/endpoint/document-query"}]}]},{"group":"SDKs and tools","pages":[{"title":"Overview","href":"/reference/sdk/introduction"}]}]}]},"basePath":"","title":"Update a branch index schema - LambdaDB Documentation","deploymentId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","buildId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B6WFFOBL.js","utils-BN5um1KA.js","cloneDeep-C3md22mN.js","_Uint8Array-DLlL8L26.js","isObject-FP1Yky1u.js","utils-BSmbkXJR.js","addUniqueKeysToSchema-2tqcVnUE.js","snippetPresets-CtWfvr2J.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DkKHBy30.js","isEqual-O3q7y6pq.js","usePlaygroundInputsStore-Brc5H9UJ.js","shallow-C4L4xvbs.js","getApiPlaygroundDisplay-2bxyq_aI.js","CodeSnippet-BJu8ddd5.js","CodeSnippets-dazWmoqB.js","Page-CnLhKuUV.js","getPastedJson-Chy3Qa1S.js","icon-CyO7h3jh.js","MethodPill-Dle0_91v.js","DuplicateIcon-CVvWAf4a.js","createIcon-Di07A27B.js","DynamicMarkdown-C4w9kavL.js","SectionHeading-XiBebVYC.js","axios-vUo_bRtp.js","Markdown-DTeL0SpS.js","dist-OCScizqf.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-KcneGfMY.js"]}