Create a writable branch from another branch’s committed state in the same collection; pending writes are not copied. Omit source to use main. Only a branch source is allowed; tag and alias sources return 400 BadRequest. Optional source.asOf selects a retained committed snapshot. An empty source can create an empty branch, with parentBranch still recording the source branch.
{"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/fejsT7T9UaNPB1nX/logo/dark.svg?fit=max\u0026auto=format\u0026n=fejsT7T9UaNPB1nX\u0026q=85\u0026s=10cbbc30f3e3f19c3783678ec4c4138f"},"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":""},"chroma":{"liveDeploymentHistoryId":"6ae6343f06a77d479c55b4db","collectionId":"9b2ff86e-7e46-4f1b-8e0d-638c54edbc37","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae6343f06a77d479c55b4db"},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{},"buildId":"6ae6343f06a77d479c55b4db","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"Guides","count":37},{"language":"default","tag":"Reference","count":26},{"language":"default","tag":"APIs","count":25},{"language":"default","tag":"Documents","count":14},{"language":"default","tag":"Collections","count":11},{"language":"default","tag":"Search","count":11},{"language":"default","tag":"Branches, tags \u0026 aliases","count":10},{"language":"default","tag":"Get started","count":6},{"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":"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":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"reference/api/endpoint/branch-create","slug":"/reference/api/endpoint/branch-create","pageMetadata":{"title":"Create a branch","openapi":"post /collections/{collectionName}/branches","description":"Create a writable branch from another branch's committed state in the same collection; pending writes are not copied. Omit source to use main. Only a branch source is allowed; tag and alias sources return 400 BadRequest. Optional source.asOf selects a retained committed snapshot. An empty source can create an empty branch, with parentBranch still recording the source branch.","href":"/reference/api/endpoint/branch-create"},"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: \"Create a writable branch from another branch’s committed state in the same collection; pending writes are not copied. Omit source to use main. Only a branch source is allowed; tag and alias sources return 400 BadRequest. Optional source.asOf selects a retained committed snapshot. An empty source can create an empty branch, with parentBranch still recording the source branch.\"\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":"Create a branch","openapi":"post /collections/{collectionName}/branches","description":"Create a writable branch from another branch's committed state in the same collection; pending writes are not copied. Omit source to use main. Only a branch source is allowed; tag and alias sources return 400 BadRequest. Optional source.asOf selects a retained committed snapshot. An empty source can create an empty branch, with parentBranch still recording the source branch.","href":"/reference/api/endpoint/branch-create"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["versioning"],"operationId":"createBranch","description":"Create a writable branch from another branch's committed state in the same collection; pending writes are not copied. Omit source to use main. Only a branch source is allowed; tag and alias sources return 400 BadRequest. Optional source.asOf selects a retained committed snapshot. An empty source can create an empty branch, with parentBranch still recording the source branch.","security":["efeb911f-135e-43d8-bdbf-9e72ac42cab3"],"parameters":["7da43db5-2d23-423d-b841-57b5316553b2"],"requestBody":"b3f9fc21-dcc6-41ca-bcf3-fc861a9cf0b3","responses":{"201":"12d83398-debd-484e-b681-cb951d97562e","400":"2554a70c-6a33-43d1-9ec1-9a2ac29dd5e5","401":"bc190683-a5e0-4aeb-a35e-e37cef068f10","404":"295a4e5b-d80c-47eb-a166-dc189dc85d97","409":"c77acc6f-cfd0-48a7-8faa-a7daa8f9b0bc","413":"a131146f-8373-48b1-a1ff-7627fa2208f2","429":"f510332e-a64b-442c-bbd0-31b3a140b13c","500":"28211988-4e42-4c7b-b1a8-2482f2035e6b","502":"47310136-cf79-4ca8-9df8-1f35aed63756","503":"cb719cee-14a4-42cf-aa41-c7d6e14fe72d","504":"6bf9ac88-3d96-4927-8d7d-9e391f3b775c"},"summary":"Create a Branch","method":"post","type":"path","servers":["0a729800-b165-4e25-bcc0-62d2e09a14d0"],"path":"/collections/{collectionName}/branches","baseUrlOptions":["https://{projectHost}"],"title":"Create a Branch","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"7da43db5-2d23-423d-b841-57b5316553b2":{"in":"path","name":"collectionName","description":"Collection name.","required":true,"schema":{"type":"string","isRequired":true,"description":"Collection name.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"branchName":{"type":"string","minLength":3,"maxLength":52,"pattern":"^[a-zA-Z0-9_-]{3,52}$","isRequired":true,"uniqueKey":"branchName","typeLabel":"string"},"source":{"title":"Branch source","type":"object","additionalProperties":false,"properties":{"kind":{"type":"string","enum":["branch"],"isRequired":true,"uniqueKey":"source.kind","typeLabel":"enum\u003cstring>"},"name":{"type":"string","minLength":3,"maxLength":52,"pattern":"^[a-zA-Z0-9_-]{3,52}$","isRequired":true,"uniqueKey":"source.name","typeLabel":"string"},"asOf":{"type":"integer","format":"int64","description":"Latest committed snapshot cutoff as Unix epoch milliseconds.","uniqueKey":"source.asOf","typeLabel":"integer\u003cint64>"}},"required":["kind","name"],"uniqueKey":"source","typeLabel":"Branch source · object"}},"required":["branchName"],"uniqueKey":"","typeLabel":"object"},"examples":{"example":{"title":"example","value":{"branchName":"candidate","source":{"kind":"branch","name":"main"}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"12d83398-debd-484e-b681-cb951d97562e":{"description":"Branch created.","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 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 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>"}},"required":["name","parentBranch","headSnapshot","parentSnapshot","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}}}}},"exampleType":"examples"}},"exampleType":"examples"},"2554a70c-6a33-43d1-9ec1-9a2ac29dd5e5":{"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","value":{"message":"Invalid request"}}},"exampleType":"examples"}},"exampleType":"examples"},"bc190683-a5e0-4aeb-a35e-e37cef068f10":{"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","value":{"message":"Authentication failed"}}},"exampleType":"examples"}},"exampleType":"examples"},"295a4e5b-d80c-47eb-a166-dc189dc85d97":{"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","value":{"message":"Resource not found"}}},"exampleType":"examples"}},"exampleType":"examples"},"c77acc6f-cfd0-48a7-8faa-a7daa8f9b0bc":{"description":"Resource already exists","content":{"application/json":{"schema":{"title":"ResourceAlreadyExists","type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"ResourceAlreadyExists · object"},"examples":{"example":{"title":"example","value":{"message":"Resource already exists"}}},"exampleType":"examples"}},"exampleType":"examples"},"a131146f-8373-48b1-a1ff-7627fa2208f2":{"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"},"f510332e-a64b-442c-bbd0-31b3a140b13c":{"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","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"},"28211988-4e42-4c7b-b1a8-2482f2035e6b":{"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","value":{"message":"Internal server error"}}},"exampleType":"examples"}},"exampleType":"examples"},"47310136-cf79-4ca8-9df8-1f35aed63756":{"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"},"cb719cee-14a4-42cf-aa41-c7d6e14fe72d":{"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"},"6bf9ac88-3d96-4927-8d7d-9e391f3b775c":{"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":{"efeb911f-135e-43d8-bdbf-9e72ac42cab3":{"ProjectApiKey":{"type":"apiKey","in":"header","name":"x-api-key","description":"Project API Key.","x-speakeasy-example":"\u003cYOUR_PROJECT_API_KEY>","scopes":[],"schemeName":"ProjectApiKey"}}},"servers":{"0a729800-b165-4e25-bcc0-62d2e09a14d0":{"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":"Create a branch - LambdaDB Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-16T16:43:25.480Z","originalFileLocation":"reference/api/endpoint/branch-create.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=\"Create a writable branch from another branch\u0026#x27;s committed state in the same collection; pending writes are not copied. Omit source to use main. Only a branch source is allowed; tag and alias sources return 400 BadRequest. Optional source.asOf selects a retained committed snapshot. An empty source can create an empty branch, with parentBranch still recording the source branch.\">\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=\"Create a branch - LambdaDB Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a writable branch from another branch\u0026#x27;s committed state in the same collection; pending writes are not copied. Omit source to use main. Only a branch source is allowed; tag and alias sources return 400 BadRequest. Optional source.asOf selects a retained committed snapshot. An empty source can create an empty branch, with parentBranch still recording the source branch.\">\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-create\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://lambdadb.mintlify.app/_mintlify/api/og/v2?division=Branches%2C+tags+%26+aliases\u0026amp;title=Create+a+branch\u0026amp;description=Create+a+writable+branch+from+another+branch%27s+committed+state+in+the+same+collection%3B+pending+writes+are+not+copied.+Omit+source+to+use+main.+Only+a+branch+sou\u0026amp;theme=d3f6cd916d075e4fde43281c\u0026amp;signature=9df5447fc236e24aa5659e433b901937c94b2da3a395a686463c2af87195e48c\">\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=\"Create a branch - LambdaDB Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a writable branch from another branch\u0026#x27;s committed state in the same collection; pending writes are not copied. Omit source to use main. Only a branch source is allowed; tag and alias sources return 400 BadRequest. Optional source.asOf selects a retained committed snapshot. An empty source can create an empty branch, with parentBranch still recording the source branch.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://lambdadb.mintlify.app/_mintlify/api/og/v2?division=Branches%2C+tags+%26+aliases\u0026amp;title=Create+a+branch\u0026amp;description=Create+a+writable+branch+from+another+branch%27s+committed+state+in+the+same+collection%3B+pending+writes+are+not+copied.+Omit+source+to+use+main.+Only+a+branch+sou\u0026amp;theme=d3f6cd916d075e4fde43281c\u0026amp;signature=9df5447fc236e24aa5659e433b901937c94b2da3a395a686463c2af87195e48c\">\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-create\">\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-create.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-create#webpage\",\"url\":\"https://docs.lambdadb.ai/reference/api/endpoint/branch-create\",\"name\":\"Create a branch\",\"description\":\"Create a writable branch from another branch's committed state in the same collection; pending writes are not copied. Omit source to use main. Only a branch source is allowed; tag and alias sources return 400 BadRequest. Optional source.asOf selects a retained committed snapshot. An empty source can create an empty branch, with parentBranch still recording the source branch.\",\"dateModified\":\"2026-09-16T16:43:25.480Z\",\"isPartOf\":{\"@id\":\"https://docs.lambdadb.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.lambdadb.ai/reference/api/endpoint/branch-create#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.lambdadb.ai/reference/api/endpoint/branch-create#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"APIs\",\"item\":\"https://docs.lambdadb.ai/reference/api/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a branch\",\"item\":\"https://docs.lambdadb.ai/reference/api/endpoint/branch-create\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.lambdadb.ai/reference/api/endpoint/branch-create#apireference\",\"headline\":\"Create a branch\",\"name\":\"Create a branch\",\"description\":\"Create a writable branch from another branch's committed state in the same collection; pending writes are not copied. Omit source to use main. Only a branch source is allowed; tag and alias sources return 400 BadRequest. Optional source.asOf selects a retained committed snapshot. An empty source can create an empty branch, with parentBranch still recording the source branch.\",\"url\":\"https://docs.lambdadb.ai/reference/api/endpoint/branch-create\",\"mainEntityOfPage\":{\"@id\":\"https://docs.lambdadb.ai/reference/api/endpoint/branch-create#webpage\"},\"dateModified\":\"2026-09-16T16:43:25.480Z\",\"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\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","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}","description":"Configure a collection.","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","description":"List branches in a collection.","href":"/reference/api/endpoint/branch-list"},{"title":"Delete a branch","openapi":"delete /collections/{collectionName}/branches/{branchName}","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":"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":"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":"Bulk upsert documents","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","pages":[{"title":"SDK reference","href":"/reference/sdk/introduction"}]}]}]},"basePath":"","title":"Create a branch - LambdaDB Documentation","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}