Schedule a build of the BuildSpec. Re-checks the caller’s access to the spec’s datasets and
rejects the request if the spec already has an active run. Returns the new run in status scheduled.
When true (default), each destination dataset this run replaces is kept, renamed with a -superseded-<epochMillis> suffix. When false, the replaced dataset is deleted right after its replacement is successfully ingested.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Documentation","colors":{"primary":"#607251","light":"#607251","dark":"#C8D5BB"},"logo":{"light":"https://mintcdn.com/datalinks-d7c3bacc/NbL6ZZ8Yl0rUuPZD/logo/landfall_logo.svg?fit=max\u0026auto=format\u0026n=NbL6ZZ8Yl0rUuPZD\u0026q=85\u0026s=756a61980c1cda2d8c91a195650ccaa9","dark":"https://mintcdn.com/datalinks-d7c3bacc/NbL6ZZ8Yl0rUuPZD/logo/landfall_logo_white.svg?fit=max\u0026auto=format\u0026n=NbL6ZZ8Yl0rUuPZD\u0026q=85\u0026s=0e5cb751d7246fa9ca9d1ea1da985cf7"},"favicon":"https://mintcdn.com/datalinks-d7c3bacc/NbL6ZZ8Yl0rUuPZD/logo/favicon.svg?fit=max\u0026auto=format\u0026n=NbL6ZZ8Yl0rUuPZD\u0026q=85\u0026s=6685ce7fb23b401e4b2248c8220474cd","api":{"openapi":{"source":"api-reference/openapi.yml"},"playground":{"proxy":false}},"navbar":{"links":[{"href":"https://landfall.ai","label":"Website"}]},"footer":{"socials":{"linkedin":"https://linkedin.com/company/datasetlinks","github":"https://github.com/DataSetLinks","website":"https://landfall.ai/"}},"integrations":{"gtm":{"tagId":"GTM-M2TM5387"}},"contextual":{"options":[],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"datalinks-d7c3bacc","hasAudioNarration":false,"actualSubdomain":"datalinks-d7c3bacc","customDomains":["docs.landfall.ai"],"gitSource":{"type":"github","owner":"datasetlinks","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae9f41feceed668c026c91c","collectionId":"afb63095-04f6-4ac1-b553-bd1106f18c30","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae9f41feceed668c026c91c"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae9f41feceed668c026c91c","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"API Reference","count":99},{"language":"default","tag":"Endpoints","count":98},{"language":"default","tag":"Docs","count":28},{"language":"default","tag":"buildspecs","count":22},{"language":"default","tag":"data-assets","count":14},{"language":"default","tag":"How-To Guides","count":12},{"language":"default","tag":"Python SDK","count":7},{"language":"default","tag":"dataset","count":7},{"language":"default","tag":"user","count":7},{"language":"default","tag":"permissions","count":6}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":true,"toggles":[],"googleFontsInlined":false},"customCss":[{"filePath":"consent-banner.css","content":":root{--color-white: #ffffff;--color-gray-25: #fafafa;--color-gray-50: #f7f7f7;--color-gray-100: #f0f0f1;--color-gray-200: #ececed;--color-gray-300: #cecfd2;--color-gray-400: #94979c;--color-gray-500: #85888e;--color-gray-600: #61656c;--color-gray-700: #373a41;--color-gray-800: #22262f;--color-gray-900: #13161b;--color-gray-950: #0c0e12;--color-blue-50: #b0d8ff;--color-blue-600: #002454;--color-blue-700: #001433;--color-blue-800: #010a17;--color-green-50: #f2ffe5;--color-green-100: #dfeed1;--color-green-200: #c8d5bb;--color-green-300: #859973;--color-green-400: #607251;--color-green-500: #516441;--color-green-700: #213610}.consent-banner-overlay{position:fixed;bottom:1rem;max-width:480px;right:1rem;padding:0.75rem;z-index:9999;border-radius:0.75rem;font-size:1rem;color:var(--color-gray-600);background:var(--color-white);box-shadow:0px 0px 0px 1px rgba(10, 13, 18, 0.18) inset,\n 0px -2px 0px 0px rgba(10, 13, 18, 0.05) inset,\n 0px 1px 2px 0px rgba(10, 13, 18, 0.05)}.dark .consent-banner-overlay{color:var(--color-gray-400);border:1px solid var(--color-gray-700);background:var(--color-gray-900);box-shadow:0px 12px 16px -4px rgba(10, 13, 18, 0.08),\n 0px 4px 6px -2px rgba(10, 13, 18, 0.03),\n 0px 2px 2px -1px rgba(10, 13, 18, 0.04)}.consent-banner-grid{display:flex;flex-direction:column;flex-wrap:wrap}.consent-options{margin-top:1rem;margin-bottom:0.75rem;display:flex;flex-direction:column;gap:0.5rem}.consent-options label{display:flex;gap:0.75rem}.consent-options input[type=\"checkbox\"]{border-radius:6px;border:1px solid var(--color-gray-700)}.consent-options input[type=\"checkbox\"]:checked{background-color:var(--color-green-500);border-color:var(--color-green-500)}.cookie-icon{margin-bottom:1rem;display:inline-flex;justify-content:center;align-items:center;width:48px;height:48px;border-radius:10px;font-size:1.5rem;flex:0 0 48px;background-color:var(--color-gray-50);box-shadow:0px 0px 0px 1px rgba(10, 13, 18, 0.18) inset,\n 0px -2px 0px 0px rgba(10, 13, 18, 0.05) inset,\n 0px 1px 2px 0px rgba(10, 13, 18, 0.05)}.dark .cookie-icon{background-color:var(--color-gray-800)}.consent-buttons{display:flex;gap:0.75rem}.cookie-btn{flex:1;white-space:nowrap;padding:0.5rem 1rem;border:none;border-radius:0.5rem;cursor:pointer;font-weight:600;font-size:1rem;line-height:1.5;transition:background-color 0.2s;box-shadow:0px 0px 0px 1px rgba(10, 13, 18, 0.12) inset,\n 0px -2px 0px 0px rgba(10, 13, 18, 0.05) inset,\n 0px 1px 2px 0px rgba(10, 13, 18, 0.05);border:1px solid rgba(255, 255, 255, 0.12);background-color:var(--color-gray-50)}.dark .cookie-btn:not(.cookie-btn-accept):not(.cookie-btn-reject){background-color:var(--color-gray-900);color:var(--color-gray-200);border-color:var(--color-gray-700);box-shadow:none}.cookie-btn-accept{background:var(--color-green-700);color:var(--color-white)}.cookie-btn-accept:hover{background:var(--color-green-400)}.cookie-btn-reject{padding-inline:0;box-shadow:none;border-color:transparent;background:transparent}.cookie-btn-reject:hover{text-decoration:underline}@media (max-width: 768px){.consent-buttons{flex-direction:column;gap:1rem;text-align:center}.cookie-btn-reject{padding-block:0}.cookie-btn{font-size:0.85rem}}"}],"page":{"pagePath":"api-reference/buildspecs/schedule-a-build-create-a-buildrun","slug":"/api-reference/buildspecs/schedule-a-build-create-a-buildrun","pageMetadata":{"title":"Schedule a build (create a BuildRun)","description":"Schedule a build of the BuildSpec. Re-checks the caller's access to the spec's datasets and\nrejects the request if the spec already has an active run. Returns the new run in status `scheduled`.\n","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /build-specs/{buildSpecId}/run","href":"/api-reference/buildspecs/schedule-a-build-create-a-buildrun","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Schedule a build of the BuildSpec. Re-checks the caller’s access to the spec’s datasets and\\nrejects the request if the spec already has an active run. Returns the new run in status \", _jsx(_components.code, {\n children: \"scheduled\"\n }), \".\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Schedule a build (create a BuildRun)","description":"Schedule a build of the BuildSpec. Re-checks the caller's access to the spec's datasets and\nrejects the request if the spec already has an active run. Returns the new run in status `scheduled`.\n","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /build-specs/{buildSpecId}/run","href":"/api-reference/buildspecs/schedule-a-build-create-a-buildrun","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/datalinks-d7c3bacc/c24628b788aa4349/gtm-consent-banner.js"],"openApiReferenceData":{"operation":{"tags":["buildspecs"],"summary":"Schedule a build (create a BuildRun)","description":"Schedule a build of the BuildSpec. Re-checks the caller's access to the spec's datasets and\nrejects the request if the spec already has an active run. Returns the new run in status `scheduled`.\n","operationId":"scheduleBuild","parameters":["2a2f961a-fc26-4133-b7d7-c224fdbaada2"],"requestBody":"ad2483bc-6308-42ae-a6aa-44951f6cd08a","responses":{"201":"d4536214-30fc-4df8-bc88-427815c75ebe","401":"1d262ac3-dcfb-4bd9-8441-622b6558a70f","403":"2b9ad105-183c-4fc1-b13f-55d6b8f5527f","404":"0b59b971-5488-47de-a1fd-5876fb4227fc","409":"6ec2cca9-4a65-4cbe-98ff-432e1d5a19c2"},"method":"post","type":"path","servers":["93870666-6042-444b-8726-0ca7cbede54b"],"security":["3edbce03-f3bb-4661-9e62-d8f7bea0eda9","39cafe1f-7dd3-4ee3-a9e3-36b8ad3d9073"],"path":"/build-specs/{buildSpecId}/run","baseUrlOptions":["https://api.datalinks.com/api/v1"],"title":"Schedule a build (create a BuildRun)","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{"2a2f961a-fc26-4133-b7d7-c224fdbaada2":{"name":"buildSpecId","in":"path","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"keepOldDataset":{"type":"boolean","description":"When true (default), each destination dataset this run replaces is kept, renamed with a `-superseded-\u003cepochMillis>` suffix. When false, the replaced dataset is deleted right after its replacement is successfully ingested.","default":true,"uniqueKey":"keepOldDataset","typeLabel":"boolean"},"link":{"type":"object","description":"Optional entity resolution configuration, run on each output once every output of the run is ingested. When omitted, no entity resolution runs.","properties":{"ExactMatch":{"oneOf":[{"type":"object","properties":{"minDistinct":{"type":"number","uniqueKey":"link.ExactMatch.oneOf.0.minDistinct","typeLabel":"number"},"minVariation":{"type":"number","uniqueKey":"link.ExactMatch.oneOf.0.minVariation","typeLabel":"number"}},"uniqueKey":"link.ExactMatch.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"minDistinct":{"type":"number"},"minVariation":{"type":"number"}},"uniqueKey":"link.ExactMatch.oneOf.1","typeLabel":"null"},{"type":"object","properties":{"bidirectional":{"type":"boolean","uniqueKey":"link.ExactMatch.oneOf.2.bidirectional","typeLabel":"boolean"},"targetColumns":{"type":"array","items":{"type":"string","uniqueKey":"link.ExactMatch.oneOf.2.targetColumns.items.[INDEX]","typeLabel":"string"},"uniqueKey":"link.ExactMatch.oneOf.2.targetColumns","typeLabel":"string[]"},"ignorePrivateColumns":{"type":"boolean","uniqueKey":"link.ExactMatch.oneOf.2.ignorePrivateColumns","typeLabel":"boolean"}},"uniqueKey":"link.ExactMatch.oneOf.2","typeLabel":"object"},{"type":"null","uniqueKey":"link.ExactMatch.oneOf.3","typeLabel":"null"}],"uniqueKey":"link.ExactMatch","typeLabel":"object · null · object · null"},"GeoMatch":{"oneOf":[{"type":"object","properties":{"distance":{"type":"number","uniqueKey":"link.GeoMatch.oneOf.0.distance","typeLabel":"number"},"distanceUnit":{"type":"string","uniqueKey":"link.GeoMatch.oneOf.0.distanceUnit","typeLabel":"string"}},"uniqueKey":"link.GeoMatch.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"distance":{"type":"number"},"distanceUnit":{"type":"string"}},"uniqueKey":"link.GeoMatch.oneOf.1","typeLabel":"null"},{"type":"object","properties":{"bidirectional":{"type":"boolean","uniqueKey":"link.GeoMatch.oneOf.2.bidirectional","typeLabel":"boolean"},"targetColumns":{"type":"array","items":{"type":"string","uniqueKey":"link.GeoMatch.oneOf.2.targetColumns.items.[INDEX]","typeLabel":"string"},"uniqueKey":"link.GeoMatch.oneOf.2.targetColumns","typeLabel":"string[]"},"ignorePrivateColumns":{"type":"boolean","uniqueKey":"link.GeoMatch.oneOf.2.ignorePrivateColumns","typeLabel":"boolean"}},"uniqueKey":"link.GeoMatch.oneOf.2","typeLabel":"object"},{"type":"null","uniqueKey":"link.GeoMatch.oneOf.3","typeLabel":"null"}],"uniqueKey":"link.GeoMatch","typeLabel":"object · null · object · null"}},"uniqueKey":"link","typeLabel":"object"}},"description":"Optional settings for a build run.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"keepOldDataset":true,"link":{"ExactMatch":{"minDistinct":123,"minVariation":123},"GeoMatch":{"distance":123,"distanceUnit":"\u003cstring>"}}}}},"exampleType":"generated"}},"required":false,"exampleType":"generated"},"responses":{"d4536214-30fc-4df8-bc88-427815c75ebe":{"description":"The created BuildRun.","content":{"application/json":{"schema":{"required":["buildSpecId","createdAt","id","keepOldDataset","kind","retries","specVersion","status","updatedAt"],"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"buildSpecId":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"buildSpecId","typeLabel":"string\u003cuuid>"},"specVersion":{"type":"integer","description":"The BuildSpec version this run executes (snapshotted at schedule time).","isRequired":true,"uniqueKey":"specVersion","typeLabel":"integer"},"status":{"title":"BuildRunStatus","type":"string","enum":["Scheduled","Exporting","Claimable","Running","Produced","Ingesting","Finished","Failed"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"kind":{"title":"BuildRunKind","type":"string","description":"Whether this run ingests its output (Build) or presents it to the user (Preview).","enum":["Build","Preview"],"isRequired":true,"uniqueKey":"kind","typeLabel":"enum\u003cstring>"},"retries":{"type":"integer","isRequired":true,"uniqueKey":"retries","typeLabel":"integer"},"keepOldDataset":{"type":"boolean","description":"Whether datasets replaced by this run's outputs are kept (renamed as superseded) rather than deleted once their replacement is ingested.","isRequired":true,"uniqueKey":"keepOldDataset","typeLabel":"boolean"},"createdAt":{"type":"string","description":"Timestamp of the BuildRun creation.","format":"date-time","example":"2005-04-02T19:37:00.000Z","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","description":"Timestamp of the BuildRun last update.","format":"date-time","example":"2005-04-02T19:37:00.000Z","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"},"errorMessage":{"type":"string","uniqueKey":"errorMessage","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","buildSpecId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","specVersion":123,"status":"Scheduled","kind":"Build","retries":123,"keepOldDataset":true,"createdAt":"2005-04-02T19:37:00.000Z","updatedAt":"2005-04-02T19:37:00.000Z","errorMessage":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"1d262ac3-dcfb-4bd9-8441-622b6558a70f":{"description":"Unauthorized. This error occurs if the authentication token is missing or invalid.","content":{"application/json":{"schema":{"required":["error_code","message"],"type":"object","properties":{"error_code":{"type":"string","example":"UNAUTHORIZED","isRequired":true,"uniqueKey":"error_code","typeLabel":"string"},"message":{"type":"string","example":"Missing authentication token","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error_message":{"type":"string","example":"","uniqueKey":"error_message","typeLabel":"string"},"sub_errors":{"type":"array","items":{"required":["code","message"],"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"sub_errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"sub_errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"sub_errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"sub_errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error_code":"UNAUTHORIZED","message":"Missing authentication token","error_message":"","sub_errors":[{"code":"\u003cstring>","message":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"2b9ad105-183c-4fc1-b13f-55d6b8f5527f":{"description":"Forbidden. The user does not have access to this resource.","content":{"application/json":{"schema":{"required":["error_code","message"],"type":"object","properties":{"error_code":{"type":"string","example":"UNAUTHORIZED","isRequired":true,"uniqueKey":"error_code","typeLabel":"string"},"message":{"type":"string","example":"Missing authentication token","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error_message":{"type":"string","example":"","uniqueKey":"error_message","typeLabel":"string"},"sub_errors":{"type":"array","items":{"required":["code","message"],"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"sub_errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"sub_errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"sub_errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"sub_errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error_code":"UNAUTHORIZED","message":"Missing authentication token","error_message":"","sub_errors":[{"code":"\u003cstring>","message":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"0b59b971-5488-47de-a1fd-5876fb4227fc":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"required":["error_code","message"],"type":"object","properties":{"error_code":{"type":"string","example":"UNAUTHORIZED","isRequired":true,"uniqueKey":"error_code","typeLabel":"string"},"message":{"type":"string","example":"Missing authentication token","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error_message":{"type":"string","example":"","uniqueKey":"error_message","typeLabel":"string"},"sub_errors":{"type":"array","items":{"required":["code","message"],"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"sub_errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"sub_errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"sub_errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"sub_errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error_code":"UNAUTHORIZED","message":"Missing authentication token","error_message":"","sub_errors":[{"code":"\u003cstring>","message":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"6ec2cca9-4a65-4cbe-98ff-432e1d5a19c2":{"description":"Conflict. The request could not be completed due to a conflict with the current state of the resource.","content":{"application/json":{"schema":{"required":["error_code","message"],"type":"object","properties":{"error_code":{"type":"string","example":"UNAUTHORIZED","isRequired":true,"uniqueKey":"error_code","typeLabel":"string"},"message":{"type":"string","example":"Missing authentication token","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error_message":{"type":"string","example":"","uniqueKey":"error_message","typeLabel":"string"},"sub_errors":{"type":"array","items":{"required":["code","message"],"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"sub_errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"sub_errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"sub_errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"sub_errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error_code":"UNAUTHORIZED","message":"Missing authentication token","error_message":"","sub_errors":[{"code":"\u003cstring>","message":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"3edbce03-f3bb-4661-9e62-d8f7bea0eda9":{"bearerAuth":{"type":"http","description":"Use a Bearer token for authentication. Submit the token using the `Authorization`\nheader: `Authorization: Bearer \u003ctoken>`.\n","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"}},"39cafe1f-7dd3-4ee3-a9e3-36b8ad3d9073":{"openId":{"type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.datalinks.com/realms/datalinks-realm/protocol/openid-connect/auth","scopes":{"openid":"openid"}}},"scopes":["implicit"],"schemeName":"openId"}}},"servers":{"93870666-6042-444b-8726-0ca7cbede54b":{"url":"https://api.datalinks.com/api/v1","description":"production server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","description":"Use a Bearer token for authentication. Submit the token using the `Authorization`\nheader: `Authorization: Bearer \u003ctoken>`.\n","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Use a Bearer token for authentication. Submit the token using the `Authorization`\nheader: `Authorization: Bearer \u003ctoken>`.\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"},{"schemes":[{"scheme":{"type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.datalinks.com/realms/datalinks-realm/protocol/openid-connect/auth","scopes":{"openid":"openid"}}},"scopes":["implicit"],"schemeName":"openId"},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"The access token received from the authorization server in the OAuth 2.0 flow.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"openId","name":"Authorization"}],"title":"openId"}]},"originalFileLocation":"api-reference/openapi.yml"},"subdomain":"datalinks-d7c3bacc","siteName":"Documentation","title":"Schedule a build (create a BuildRun) - Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-03T14:48:06.966Z","originalFileLocation":"api-reference/buildspecs/schedule-a-build-create-a-buildrun.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=\"Schedule a build of the BuildSpec. Re-checks the caller\u0026#x27;s access to the spec\u0026#x27;s datasets and rejects the request if the spec already has an active run. Returns the new run in status scheduled.\">\u003cmeta data-mint-head name=\"application-name\" content=\"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/datalinks-d7c3bacc/UoVzkwi3FIgLQM3H/_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/datalinks-d7c3bacc/UoVzkwi3FIgLQM3H/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/datalinks-d7c3bacc/UoVzkwi3FIgLQM3H/_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/datalinks-d7c3bacc/UoVzkwi3FIgLQM3H/_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/datalinks-d7c3bacc/UoVzkwi3FIgLQM3H/_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/datalinks-d7c3bacc/UoVzkwi3FIgLQM3H/_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/datalinks-d7c3bacc/UoVzkwi3FIgLQM3H/_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/datalinks-d7c3bacc/UoVzkwi3FIgLQM3H/_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/datalinks-d7c3bacc/UoVzkwi3FIgLQM3H/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Schedule a build (create a BuildRun) - Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Schedule a build of the BuildSpec. Re-checks the caller\u0026#x27;s access to the spec\u0026#x27;s datasets and rejects the request if the spec already has an active run. Returns the new run in status scheduled.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.landfall.ai/api-reference/buildspecs/schedule-a-build-create-a-buildrun\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://datalinks-d7c3bacc.mintlify.site/_mintlify/api/og/v2?division=buildspecs\u0026amp;title=Schedule+a+build+%28create+a+BuildRun%29\u0026amp;description=Schedule+a+build+of+the+BuildSpec.+Re-checks+the+caller%27s+access+to+the+spec%27s+datasets+and%0Arejects+the+request+if+the+spec+already+has+an+active+run.+Returns+t\u0026amp;theme=a00ac63b1779b80d0dd1c500\u0026amp;signature=ed6345ce33dd4a036934a5a4ee2f4e7198803e703f13188f9234c69cd3a736a0\">\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=\"Schedule a build (create a BuildRun) - Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Schedule a build of the BuildSpec. Re-checks the caller\u0026#x27;s access to the spec\u0026#x27;s datasets and rejects the request if the spec already has an active run. Returns the new run in status scheduled.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://datalinks-d7c3bacc.mintlify.site/_mintlify/api/og/v2?division=buildspecs\u0026amp;title=Schedule+a+build+%28create+a+BuildRun%29\u0026amp;description=Schedule+a+build+of+the+BuildSpec.+Re-checks+the+caller%27s+access+to+the+spec%27s+datasets+and%0Arejects+the+request+if+the+spec+already+has+an+active+run.+Returns+t\u0026amp;theme=a00ac63b1779b80d0dd1c500\u0026amp;signature=ed6345ce33dd4a036934a5a4ee2f4e7198803e703f13188f9234c69cd3a736a0\">\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/datalinks-d7c3bacc/UoVzkwi3FIgLQM3H/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#607251\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.landfall.ai/api-reference/buildspecs/schedule-a-build-create-a-buildrun\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/buildspecs/schedule-a-build-create-a-buildrun.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.landfall.ai/#organization\",\"name\":\"Documentation\",\"url\":\"https://docs.landfall.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/datalinks-d7c3bacc/NbL6ZZ8Yl0rUuPZD/logo/landfall_logo.svg?fit=max\u0026auto=format\u0026n=NbL6ZZ8Yl0rUuPZD\u0026q=85\u0026s=756a61980c1cda2d8c91a195650ccaa9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.landfall.ai#website\",\"name\":\"Documentation\",\"url\":\"https://docs.landfall.ai\",\"publisher\":{\"@id\":\"https://docs.landfall.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.landfall.ai/api-reference/buildspecs/schedule-a-build-create-a-buildrun#webpage\",\"url\":\"https://docs.landfall.ai/api-reference/buildspecs/schedule-a-build-create-a-buildrun\",\"name\":\"Schedule a build (create a BuildRun)\",\"description\":\"Schedule a build of the BuildSpec. Re-checks the caller's access to the spec's datasets and rejects the request if the spec already has an active run. Returns the new run in status scheduled.\",\"dateModified\":\"2026-11-03T14:48:06.966Z\",\"isPartOf\":{\"@id\":\"https://docs.landfall.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.landfall.ai/api-reference/buildspecs/schedule-a-build-create-a-buildrun#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.landfall.ai/api-reference/buildspecs/schedule-a-build-create-a-buildrun#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.landfall.ai/api-reference/a2a/list-the-agents-exposed-over-a2a\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"buildspecs\",\"item\":\"https://docs.landfall.ai/api-reference/buildspecs/list-the-callers-buildspecs\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Schedule a build (create a BuildRun)\",\"item\":\"https://docs.landfall.ai/api-reference/buildspecs/schedule-a-build-create-a-buildrun\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.landfall.ai/api-reference/buildspecs/schedule-a-build-create-a-buildrun#apireference\",\"headline\":\"Schedule a build (create a BuildRun)\",\"name\":\"Schedule a build (create a BuildRun)\",\"description\":\"Schedule a build of the BuildSpec. Re-checks the caller's access to the spec's datasets and rejects the request if the spec already has an active run. Returns the new run in status scheduled.\",\"url\":\"https://docs.landfall.ai/api-reference/buildspecs/schedule-a-build-create-a-buildrun\",\"mainEntityOfPage\":{\"@id\":\"https://docs.landfall.ai/api-reference/buildspecs/schedule-a-build-create-a-buildrun#webpage\"},\"dateModified\":\"2026-11-03T14:48:06.966Z\",\"publisher\":{\"@id\":\"https://docs.landfall.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.landfall.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Documentation","nav":{"global":null,"tabs":[{"tab":"Docs","icon":"file-lines","pages":[{"title":"Docs","href":""}]},{"tab":"API Reference","icon":"code","groups":[{"group":"Overview","pages":[{"title":"API Reference","href":"/api-reference"}]},{"group":"Endpoints","expanded":true,"pages":[{"group":"a2a","pages":[{"title":"List the agents exposed over A2A","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml get /a2a","href":"/api-reference/a2a/list-the-agents-exposed-over-a2a"},{"title":"Fetch an agent's AgentCard","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml get /a2a/{agentName}/.well-known/agent-card.json","href":"/api-reference/a2a/fetch-an-agents-agentcard"},{"title":"A2A JSON-RPC endpoint for an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /a2a/{agentName}","href":"/api-reference/a2a/a2a-json-rpc-endpoint-for-an-agent"}]},{"group":"agents","pages":[{"title":"Get code files for a cleaning task","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml get /agents/cleaning/{cleaningTaskId}/code","href":"/api-reference/agents/get-code-files-for-a-cleaning-task"},{"title":"Request cleaning on a dataset","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /agents/{username}/{namespace}/{datasetName}/requestCleaning","href":"/api-reference/agents/request-cleaning-on-a-dataset"}]},{"group":"datasets","pages":[{"title":"Fetch datasets","deprecated":true,"version":null,"openapi":"/api-reference/openapi.yml get /data","href":"/api-reference/datasets/fetch-datasets"},{"title":"Fetch datasets in namespace","deprecated":true,"version":null,"openapi":"/api-reference/openapi.yml get /data/{namespace}","href":"/api-reference/datasets/fetch-datasets-in-namespace"}]},{"group":"data","pages":[{"title":"List ingestions for a dataset","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml get /data/{username}/{namespace}/{datasetName}/ingest/attempts","href":"/api-reference/data/list-ingestions-for-a-dataset"}]},{"group":"dataset","pages":[{"title":"Get dataset information","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml get /data/{username}/{namespace}/{datasetName}","href":"/api-reference/dataset/get-dataset-information"},{"title":"Rename a namespace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /data/{username}/{namespace}/rename","href":"/api-reference/dataset/rename-a-namespace"},{"title":"Rename a dataset","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /data/{username}/{namespace}/{datasetName}/rename","href":"/api-reference/dataset/rename-a-dataset"},{"title":"Update inference definition","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml put /data/{username}/{namespace}/{datasetName}/inferDefinition","href":"/api-reference/dataset/update-inference-definition"},{"title":"Clear all data for a dataset","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /data/{username}/{namespace}/{datasetName}/clear","href":"/api-reference/dataset/clear-all-data-for-a-dataset"},{"title":"Delete all data and metadata for a dataset (balefire)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml delete /data/{username}/{namespace}/{datasetName}/balefire","href":"/api-reference/dataset/delete-all-data-and-metadata-for-a-dataset-balefire"},{"title":"Update dataset sort order","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml put /schema/{username}/{namespace}/{datasetName}/sort-order","href":"/api-reference/dataset/update-dataset-sort-order"}]},{"group":"namespace","pages":[{"title":"Delete all data and metadata for a namespace (balefire)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml delete /data/{username}/{namespace}/balefire","href":"/api-reference/namespace/delete-all-data-and-metadata-for-a-namespace-balefire"}]},{"group":"ingest","pages":[{"title":"Preview","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /infer/preview","href":"/api-reference/ingest/preview"},{"title":"Infer dataset description","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /infer/description","href":"/api-reference/ingest/infer-dataset-description"},{"title":"Schema","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /infer/schema","href":"/api-reference/ingest/schema"},{"title":"Create new dataset","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /ingest/new/{namespace}/{datasetName}","href":"/api-reference/ingest/create-new-dataset"},{"title":"Ingest data","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /ingest/{namespace}/{datasetName}","href":"/api-reference/ingest/ingest-data"}]},{"group":"buildspecs","pages":[{"title":"List the caller's BuildSpecs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml get /build-specs","href":"/api-reference/buildspecs/list-the-callers-buildspecs"},{"title":"Create a BuildSpec","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /build-specs","href":"/api-reference/buildspecs/create-a-buildspec"},{"title":"Get a BuildSpec","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml get /build-specs/{buildSpecId}","href":"/api-reference/buildspecs/get-a-buildspec"},{"title":"Edit a BuildSpec","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml put /build-specs/{buildSpecId}","href":"/api-reference/buildspecs/edit-a-buildspec"},{"title":"Delete a BuildSpec","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml delete /build-specs/{buildSpecId}","href":"/api-reference/buildspecs/delete-a-buildspec"},{"title":"Schedule a build (create a BuildRun)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /build-specs/{buildSpecId}/run","href":"/api-reference/buildspecs/schedule-a-build-create-a-buildrun"},{"title":"Preview a build (dry run)","description":"Run the BuildSpec against a small sample of each source (capped at 100 rows) and present the\noutput to the caller WITHOUT ingesting it into any dataset. Requires read (QUERY) access to the\nsources and destination datasets. The saved code may be overridden with inline code for this preview.\nAt most one preview may be active per spec. Returns the new run in status `Scheduled`; poll the run and then\nfetch its outputs once it reaches `Finished`.\n","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /build-specs/{buildSpecId}/preview","href":"/api-reference/buildspecs/preview-a-build-dry-run"},{"title":"List a BuildSpec's runs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml get /build-specs/{buildSpecId}/runs","href":"/api-reference/buildspecs/list-a-buildspecs-runs"},{"title":"Get a BuildRun","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml get /build-runs/{buildRunId}","href":"/api-reference/buildspecs/get-a-buildrun"},{"title":"List the ingestions a BuildRun performed","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml get /build-runs/{buildRunId}/ingestions","href":"/api-reference/buildspecs/list-the-ingestions-a-buildrun-performed"},{"title":"List a preview run's outputs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml get /build-runs/{buildRunId}/outputs","href":"/api-reference/buildspecs/list-a-preview-runs-outputs"},{"title":"Fetch a preview output's download URL","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml get /build-runs/{buildRunId}/outputs/{destinationName}","href":"/api-reference/buildspecs/fetch-a-preview-outputs-download-url"},{"title":"List a pipeline's file-input slot bindings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml get /build-specs/{buildSpecId}/file-inputs","href":"/api-reference/buildspecs/list-a-pipelines-file-input-slot-bindings"},{"title":"Set (replace) the files bound to a file-input slot","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml put /build-specs/{buildSpecId}/file-inputs/{slot}","href":"/api-reference/buildspecs/set-replace-the-files-bound-to-a-file-input-slot"},{"title":"Unbind a file-input slot","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml delete /build-specs/{buildSpecId}/file-inputs/{slot}","href":"/api-reference/buildspecs/unbind-a-file-input-slot"},{"title":"Add a file to a batch file-input slot","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /build-specs/{buildSpecId}/file-inputs/{slot}/members","href":"/api-reference/buildspecs/add-a-file-to-a-batch-file-input-slot"},{"title":"Remove a file from a file-input slot","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml delete /build-specs/{buildSpecId}/file-inputs/{slot}/members/{fileId}","href":"/api-reference/buildspecs/remove-a-file-from-a-file-input-slot"},{"title":"List a pipeline repo's files","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml get /build-specs/{buildSpecId}/files","href":"/api-reference/buildspecs/list-a-pipeline-repos-files"},{"title":"Save edits to a pipeline repo","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml put /build-specs/{buildSpecId}/files","href":"/api-reference/buildspecs/save-edits-to-a-pipeline-repo"},{"title":"Read one file from a pipeline repo","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml get /build-specs/{buildSpecId}/file","href":"/api-reference/buildspecs/read-one-file-from-a-pipeline-repo"},{"title":"Validate a pipeline repo","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /build-specs/{buildSpecId}/files/validate","href":"/api-reference/buildspecs/validate-a-pipeline-repo"},{"title":"Sync a pipeline repo's manifest with the spec","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /build-specs/{buildSpecId}/files/sync-manifest","href":"/api-reference/buildspecs/sync-a-pipeline-repos-manifest-with-the-spec"}]},{"group":"ingestionTracking","pages":[{"title":"Retry ingestion","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /ingestionTracking/{ingestionId}/retry","href":"/api-reference/ingestiontracking/retry-ingestion"},{"title":"Mark ingestion as seen","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /ingestionTracking/{ingestionId}/seen","href":"/api-reference/ingestiontracking/mark-ingestion-as-seen"}]},{"group":"links","pages":[{"title":"Load links","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml get /links/{username}/{namespace}/{datasetName}","href":"/api-reference/links/load-links"},{"title":"Rebuild links","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /links/{username}/{namespace}/{datasetName}","href":"/api-reference/links/rebuild-links"},{"title":"Preview links","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /links/preview/{username}/{namespace}/{datasetName}","href":"/api-reference/links/preview-links"},{"title":"Add a new link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /links/add","href":"/api-reference/links/add-a-new-link"}]},{"group":"ontology","pages":[{"title":"Get dataset ontology","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml get /ontology/{username}/{namespace}/{datasetName}","href":"/api-reference/ontology/get-dataset-ontology"},{"title":"Save dataset ontology","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /ontology/{username}/{namespace}/{datasetName}","href":"/api-reference/ontology/save-dataset-ontology"},{"title":"Curate ontology links","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /ontology/curate-links","href":"/api-reference/ontology/curate-ontology-links"}]},{"group":"schema","pages":[{"title":"List all datasets","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml get /schema/datasets/all","href":"/api-reference/schema/list-all-datasets"},{"title":"List user namespaces","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml get /schema/{user}/namespaces","href":"/api-reference/schema/list-user-namespaces"},{"title":"List datasets within namespace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml get /schema/{user}/{namespace}/datasets","href":"/api-reference/schema/list-datasets-within-namespace"}]},{"group":"permissions","pages":[{"title":"List users with access to a dataset","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml get /permissions/datasets/{username}/{namespace}/{datasetName}/shares","href":"/api-reference/permissions/list-users-with-access-to-a-dataset"},{"title":"Share a dataset with a user","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /permissions/datasets/{username}/{namespace}/{datasetName}/shares","href":"/api-reference/permissions/share-a-dataset-with-a-user"},{"title":"Revoke a user's access to a dataset","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml delete /permissions/datasets/{username}/{namespace}/{datasetName}/shares","href":"/api-reference/permissions/revoke-a-users-access-to-a-dataset"},{"title":"List users with access to a namespace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml get /permissions/namespaces/{username}/{namespace}/shares","href":"/api-reference/permissions/list-users-with-access-to-a-namespace"},{"title":"Share a namespace with a user","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /permissions/namespaces/{username}/{namespace}/shares","href":"/api-reference/permissions/share-a-namespace-with-a-user"},{"title":"Revoke a user's access to a namespace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml delete /permissions/namespaces/{username}/{namespace}/shares","href":"/api-reference/permissions/revoke-a-users-access-to-a-namespace"}]},{"group":"query","pages":[{"title":"Query data","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /query","href":"/api-reference/query/query-data"}]},{"group":"autorag","pages":[{"title":"Run AutoRAG agent over all data","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /query/autorag","href":"/api-reference/autorag/run-autorag-agent-over-all-data"},{"title":"Run AutoRAG agent with streaming response","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /query/ask","href":"/api-reference/autorag/run-autorag-agent-with-streaming-response"}]},{"group":"agentRuns","pages":[{"title":"Get the status of an agent run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml get /query/runs/{runId}","href":"/api-reference/agentruns/get-the-status-of-an-agent-run"},{"title":"Delete an agent run and any resume cache associated with it","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml delete /query/runs/{runId}","href":"/api-reference/agentruns/delete-an-agent-run-and-any-resume-cache-associated-with-it"},{"title":"Resume a previously paused or crashed agent run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /query/runs/{runId}/resume","href":"/api-reference/agentruns/resume-a-previously-paused-or-crashed-agent-run"},{"title":"Submit thumbs up/down feedback on a completed agent run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /query/runs/{runId}/feedback","href":"/api-reference/agentruns/submit-thumbs-updown-feedback-on-a-completed-agent-run"}]},{"group":"conversations","pages":[{"title":"List the caller's conversations within a namespace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml get /query/conversations","href":"/api-reference/conversations/list-the-callers-conversations-within-a-namespace"},{"title":"Get a conversation and its turns","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml get /query/conversations/{conversationId}","href":"/api-reference/conversations/get-a-conversation-and-its-turns"}]},{"group":"user","pages":[{"title":"List user tokens","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml get /user/tokens","href":"/api-reference/user/list-user-tokens"},{"title":"Add a new user token","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /user/token","href":"/api-reference/user/add-a-new-user-token"},{"title":"Delete user token","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml delete /user/token/{tokenId}","href":"/api-reference/user/delete-user-token"},{"title":"List token permissions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml get /user/tokens/{tokenId}/permissions","href":"/api-reference/user/list-token-permissions"},{"title":"Get user usage history","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml get /user/usage/history","href":"/api-reference/user/get-user-usage-history"},{"title":"Get user usage aggregated by day","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml get /user/usage/by-day","href":"/api-reference/user/get-user-usage-aggregated-by-day"},{"title":"Get the current user","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml get /user/me","href":"/api-reference/user/get-the-current-user"}]},{"group":"multipart-upload","pages":[{"title":"Prepare multipart upload","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /upload/multipart/{username}/{namespace}/{datasetName}/prepare","href":"/api-reference/multipart-upload/prepare-multipart-upload"},{"title":"Finish multipart upload","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /upload/multipart/{username}/{namespace}/{datasetName}/finish","href":"/api-reference/multipart-upload/finish-multipart-upload"},{"title":"Abort multipart upload","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /upload/multipart/{username}/{namespace}/{datasetName}/abort","href":"/api-reference/multipart-upload/abort-multipart-upload"}]},{"group":"fileUpload","pages":[{"title":"Prepare session for file upload","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /file-upload/prepare","href":"/api-reference/fileupload/prepare-session-for-file-upload"},{"title":"Finish file upload","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /file-upload/{sessionId}/files/{fileId}/finish","href":"/api-reference/fileupload/finish-file-upload"},{"title":"Abort file upload","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /file-upload/{sessionId}/abort","href":"/api-reference/fileupload/abort-file-upload"},{"title":"List completed files in an upload session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml get /file-upload/{sessionId}/files","href":"/api-reference/fileupload/list-completed-files-in-an-upload-session"}]},{"group":"data-assets","pages":[{"title":"List the committed, non-deleted data assets in a namespace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml get /data-assets/{username}/{namespace}","href":"/api-reference/data-assets/list-the-committed-non-deleted-data-assets-in-a-namespace"},{"title":"Create a data asset and start its first version upload","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /data-assets/{username}/{namespace}","href":"/api-reference/data-assets/create-a-data-asset-and-start-its-first-version-upload"},{"title":"Get a data asset's latest metadata and a presigned download URL","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml get /data-assets/{username}/{namespace}/{assetId}","href":"/api-reference/data-assets/get-a-data-assets-latest-metadata-and-a-presigned-download-url"},{"title":"Soft-delete a data asset (retained briefly, then hard-purged)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml delete /data-assets/{username}/{namespace}/{assetId}","href":"/api-reference/data-assets/soft-delete-a-data-asset-retained-briefly-then-hard-purged"},{"title":"Update a data asset's name and/or description","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml patch /data-assets/{username}/{namespace}/{assetId}","href":"/api-reference/data-assets/update-a-data-assets-name-andor-description"},{"title":"List the versions of a data asset, newest first","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml get /data-assets/{username}/{namespace}/{assetId}/versions","href":"/api-reference/data-assets/list-the-versions-of-a-data-asset-newest-first"},{"title":"Start uploading a new version of a data asset","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /data-assets/{username}/{namespace}/{assetId}/versions","href":"/api-reference/data-assets/start-uploading-a-new-version-of-a-data-asset"},{"title":"Get a presigned download URL for a specific version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml get /data-assets/{username}/{namespace}/{assetId}/versions/{versionNo}","href":"/api-reference/data-assets/get-a-presigned-download-url-for-a-specific-version"},{"title":"Complete a version upload from the client's part manifest","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /data-assets/{username}/{namespace}/{assetId}/versions/{versionNo}/finish","href":"/api-reference/data-assets/complete-a-version-upload-from-the-clients-part-manifest"},{"title":"Acknowledge an uploaded chunk, extending the deadline and getting the next chunk's URL","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /data-assets/{username}/{namespace}/{assetId}/versions/{versionNo}/parts/{partNumber}/done","href":"/api-reference/data-assets/acknowledge-an-uploaded-chunk-extending-the-deadline-and-getting-the-next-chunks-url"},{"title":"Recover a pending upload - what landed, with ETags, and URLs for what did not","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml get /data-assets/{username}/{namespace}/{assetId}/versions/{versionNo}/status","href":"/api-reference/data-assets/recover-a-pending-upload--what-landed-with-etags-and-urls-for-what-did-not"},{"title":"Re-issue upload URLs for specific parts, extending the deadline","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /data-assets/{username}/{namespace}/{assetId}/versions/{versionNo}/parts/presign","href":"/api-reference/data-assets/re-issue-upload-urls-for-specific-parts-extending-the-deadline"},{"title":"Abort a pending version upload","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /data-assets/{username}/{namespace}/{assetId}/versions/{versionNo}/abort","href":"/api-reference/data-assets/abort-a-pending-version-upload"},{"title":"Roll back to a retained version by copying it as a new version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yml post /data-assets/{username}/{namespace}/{assetId}/rollback","href":"/api-reference/data-assets/roll-back-to-a-retained-version-by-copying-it-as-a-new-version"}]}]}]},{"tab":"Python SDK","icon":"python","pages":[{"title":"Python SDK","href":"/pythonsdk"}]}]},"basePath":"","title":"Schedule a build (create a BuildRun) - Documentation","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-i2a3QZ8E.js","utils-ChLwp8m0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DRktVTDc.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CA2pEs4T.js","snippetPresets-ClQ6XrKD.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ct_Lv36y.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Cn2PYw9e.js","shallow-rkyymjXQ.js","getApiPlaygroundDisplay-BB9vkXtE.js","CodeSnippet-Bm5RU7m1.js","CodeSnippets-BgU9Deuz.js","Page-BUDYNlhG.js","getPastedJson-BD-6NNum.js","icon-8Z6tud2e.js","MethodPill-Tuzr4g3V.js","DuplicateIcon-0ceWFYhN.js","createIcon-FBXow_ST.js","DynamicMarkdown-CD8713Yy.js","SectionHeading-7zgzQbH-.js","axios-vUo_bRtp.js","Markdown-D7Ofw1oz.js","clsx-eKJ4rcii.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CwjSCXIK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-9EK5IAXV.js"]}