{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"VectorShift","colors":{"primary":"#6366f1","light":"#818cf8","dark":"#4f46e5"},"logo":{"light":"https://mintcdn.com/vectorshift/ko1lD3nuBSgpmLV4/logo/vectorshift-logo.png?fit=max\u0026auto=format\u0026n=ko1lD3nuBSgpmLV4\u0026q=85\u0026s=0b909e21221badbcd2332ad0c7b06a8e","dark":"https://mintcdn.com/vectorshift/ko1lD3nuBSgpmLV4/logo/vectorshift-logo.png?fit=max\u0026auto=format\u0026n=ko1lD3nuBSgpmLV4\u0026q=85\u0026s=0b909e21221badbcd2332ad0c7b06a8e"},"favicon":"https://mintcdn.com/vectorshift/PSG1OGMwi51Mi0EL/android-chrome-512x512.png?fit=max\u0026auto=format\u0026n=PSG1OGMwi51Mi0EL\u0026q=85\u0026s=1a5016324923f89a576a8696462ef07e","appearance":{"default":"system","strict":false},"navbar":{"links":[{"href":"/support","label":"Support"},{"href":"https://app.vectorshift.ai/account/api-keys","label":"API Keys"}],"primary":{"type":"button","label":"Platform","href":"https://app.vectorshift.ai"}},"footer":{"socials":{"x":"https://x.com/vectorshiftai","linkedin":"https://linkedin.com/company/vectorshift"}},"search":{"prompt":"Search the SDK, API, and platform docs…"},"seo":{"metatags":{"og:image":"/logo/vectorshift-logo.png"},"indexing":"navigable"},"icons":{"library":"lucide"},"styling":{"codeblocks":{"languages":{}},"latex":true},"contextual":{"options":["copy","view","chatgpt","claude","aistudio","perplexity"],"display":"header"},"navigation":{"global":{"anchors":[{"anchor":"Book a Demo","icon":"calendar","href":"https://calendly.com/albert_mao/vectorshift-intro-chat"},{"anchor":"Changelog","icon":"history","href":"https://vectorshift.ai/blog?tag=changelog"},{"anchor":"Blog","icon":"newspaper","href":"https://vectorshift.ai/blog"},{"anchor":"Tutorials","icon":"youtube","href":"https://www.youtube.com/@VectorShiftAI"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"vectorshift","hasAudioNarration":false,"actualSubdomain":"vectorshift","customDomains":["docs.vectorshift.ai"],"gitSource":{"type":"github","owner":"vectorshift","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae91d0add662a242ab77468:success","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"default","tag":"SDK","count":136},{"language":"default","tag":"Documentation","count":124},{"language":"default","tag":"Examples","count":84},{"language":"default","tag":"Nodes","count":65},{"language":"default","tag":"Platform","count":61},{"language":"default","tag":"Pipeline","count":38},{"language":"default","tag":"API Reference","count":30},{"language":"default","tag":"Agent","count":27},{"language":"default","tag":"Knowledge Base","count":24},{"language":"default","tag":"Interfaces","count":20}]},"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":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"@media (min-width: 1024px){.hidden.xl\\:flex{display:flex!important}div.z-10.hidden:has(>div.xl\\:flex){display:block!important}}"}],"page":{"pagePath":"api-reference/pipelines/run","slug":"/api-reference/pipelines/run","pageMetadata":{"title":"Run a pipeline","openapi":"api-reference/pipelines/pipeline.json POST /pipeline/{id}/run","description":"Execute a pipeline with the specified inputs and configuration","href":"/api-reference/pipelines/run"},"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: \"Execute a pipeline with the specified inputs and configuration\"\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":{"codeStyling":{"languages":{}},"config":{},"pageMetadata":{"title":"Run a pipeline","openapi":"api-reference/pipelines/pipeline.json POST /pipeline/{id}/run","description":"Execute a pipeline with the specified inputs and configuration","href":"/api-reference/pipelines/run"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Run a pipeline","description":"Execute a pipeline with the specified inputs and configuration","parameters":["0b2e5f96-693c-4159-8def-3c37c1dbd79c"],"requestBody":"b4e0c70a-234f-4700-94a4-364e871428d5","responses":{"200":"4428136a-618f-4774-be4f-edf08629e964","400":"850cb21f-9592-4aea-9d47-fe34b3efa297","401":"91cbf2f1-be73-49ed-a1dd-dd22e994b012","500":"923bffcb-df12-4de7-bc5d-2198d272efc2"},"security":["e481782b-3e38-432d-8b2d-e097b1c8f1b2"],"method":"post","type":"path","servers":["04693d02-2f87-4b15-9c1c-cff81399f06f"],"path":"/pipeline/{id}/run","baseUrlOptions":["https://api.vectorshift.ai/v1"],"title":"Run a pipeline","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"0b2e5f96-693c-4159-8def-3c37c1dbd79c":{"name":"id","in":"path","required":true,"schema":{"type":"string","isRequired":true,"description":"Pipeline ID","uniqueKey":"","typeLabel":"string"},"description":"Pipeline ID"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"inputs":{"type":"object","description":"Map of input names to their values","additionalProperties":{"oneOf":[{"type":"string","description":"Represents any valid input/output data type","uniqueKey":"inputs.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"integer","description":"Represents any valid input/output data type","uniqueKey":"inputs.additionalProperties.oneOf.1","typeLabel":"integer"},{"type":"number","description":"Represents any valid input/output data type","uniqueKey":"inputs.additionalProperties.oneOf.2","typeLabel":"number"},{"type":"boolean","description":"Represents any valid input/output data type","uniqueKey":"inputs.additionalProperties.oneOf.3","typeLabel":"boolean"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"inputs.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"any"},"description":"Represents any valid input/output data type","uniqueKey":"inputs.additionalProperties.oneOf.4","typeLabel":"any[]"},{"type":"object","description":"Represents any valid input/output data type","required":["type","items"],"properties":{"type":{"type":"string","enum":["map"],"isRequired":true,"uniqueKey":"inputs.additionalProperties.oneOf.5.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","additionalProperties":{"$circularRef":"076a5236-0e8f-4167-97a3-5f273503114f"},"isRequired":true,"uniqueKey":"inputs.additionalProperties.oneOf.5.\\items","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"inputs.additionalProperties.oneOf.5","typeLabel":"object"},{"type":"object","description":"Represents any valid input/output data type","required":["type","raw_bytes"],"properties":{"type":{"type":"string","enum":["file"],"isRequired":true,"uniqueKey":"inputs.additionalProperties.oneOf.6.type","typeLabel":"enum\u003cstring>"},"raw_bytes":{"type":"string","format":"base64","isRequired":true,"uniqueKey":"inputs.additionalProperties.oneOf.6.raw_bytes","typeLabel":"file"},"metadata":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"inputs.additionalProperties.oneOf.6.metadata.name","typeLabel":"string"},"path":{"type":"string","uniqueKey":"inputs.additionalProperties.oneOf.6.metadata.path","typeLabel":"string"},"mime_type":{"type":"string","uniqueKey":"inputs.additionalProperties.oneOf.6.metadata.mime_type","typeLabel":"string"}},"uniqueKey":"inputs.additionalProperties.oneOf.6.metadata","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"inputs.additionalProperties.oneOf.6","typeLabel":"object"},{"type":"null","description":"Represents any valid input/output data type","uniqueKey":"inputs.additionalProperties.oneOf.7","typeLabel":"null"}],"uniqueKey":"inputs.additionalProperties","typeLabel":"string · integer · number · boolean · any[] · object · object · null"},"uniqueKey":"inputs","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"inputs":{}}}},"exampleType":"generated"},"multipart/form-data":{"schema":{"type":"object","properties":{"inputs":{"type":"string","format":"json","uniqueKey":"inputs","typeLabel":"string\u003cjson>"},"conversation_id":{"type":"string","uniqueKey":"conversation_id","typeLabel":"string"},"inputs.*":{"type":"string","format":"binary","uniqueKey":"inputs\\.*","typeLabel":"file"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"inputs":"\u003cstring>","conversation_id":"\u003cstring>","inputs.*":"\u003cstring>"}}},"exampleType":"generated"},"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"inputs":{"type":"object","description":"Map of input names to their values","additionalProperties":{"oneOf":[{"type":"string","description":"Represents any valid input/output data type","uniqueKey":"inputs.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"integer","description":"Represents any valid input/output data type","uniqueKey":"inputs.additionalProperties.oneOf.1","typeLabel":"integer"},{"type":"number","description":"Represents any valid input/output data type","uniqueKey":"inputs.additionalProperties.oneOf.2","typeLabel":"number"},{"type":"boolean","description":"Represents any valid input/output data type","uniqueKey":"inputs.additionalProperties.oneOf.3","typeLabel":"boolean"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"inputs.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"any"},"description":"Represents any valid input/output data type","uniqueKey":"inputs.additionalProperties.oneOf.4","typeLabel":"any[]"},{"type":"object","description":"Represents any valid input/output data type","required":["type","items"],"properties":{"type":{"type":"string","enum":["map"],"isRequired":true,"uniqueKey":"inputs.additionalProperties.oneOf.5.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","additionalProperties":{"$circularRef":"076a5236-0e8f-4167-97a3-5f273503114f"},"isRequired":true,"uniqueKey":"inputs.additionalProperties.oneOf.5.\\items","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"inputs.additionalProperties.oneOf.5","typeLabel":"object"},{"type":"object","description":"Represents any valid input/output data type","required":["type","raw_bytes"],"properties":{"type":{"type":"string","enum":["file"],"isRequired":true,"uniqueKey":"inputs.additionalProperties.oneOf.6.type","typeLabel":"enum\u003cstring>"},"raw_bytes":{"type":"string","format":"base64","isRequired":true,"uniqueKey":"inputs.additionalProperties.oneOf.6.raw_bytes","typeLabel":"file"},"metadata":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"inputs.additionalProperties.oneOf.6.metadata.name","typeLabel":"string"},"path":{"type":"string","uniqueKey":"inputs.additionalProperties.oneOf.6.metadata.path","typeLabel":"string"},"mime_type":{"type":"string","uniqueKey":"inputs.additionalProperties.oneOf.6.metadata.mime_type","typeLabel":"string"}},"uniqueKey":"inputs.additionalProperties.oneOf.6.metadata","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"inputs.additionalProperties.oneOf.6","typeLabel":"object"},{"type":"null","description":"Represents any valid input/output data type","uniqueKey":"inputs.additionalProperties.oneOf.7","typeLabel":"null"}],"uniqueKey":"inputs.additionalProperties","typeLabel":"string · integer · number · boolean · any[] · object · object · null"},"uniqueKey":"inputs","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"inputs":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"4428136a-618f-4774-be4f-edf08629e964":{"description":"Pipeline run successful","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["success","failed"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"run_id":{"type":"string","isRequired":true,"uniqueKey":"run_id","typeLabel":"string"},"outputs":{"type":"object","additionalProperties":{"oneOf":[{"type":"string","description":"Represents any valid input/output data type","uniqueKey":"outputs.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"integer","description":"Represents any valid input/output data type","uniqueKey":"outputs.additionalProperties.oneOf.1","typeLabel":"integer"},{"type":"number","description":"Represents any valid input/output data type","uniqueKey":"outputs.additionalProperties.oneOf.2","typeLabel":"number"},{"type":"boolean","description":"Represents any valid input/output data type","uniqueKey":"outputs.additionalProperties.oneOf.3","typeLabel":"boolean"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"outputs.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"any"},"description":"Represents any valid input/output data type","uniqueKey":"outputs.additionalProperties.oneOf.4","typeLabel":"any[]"},{"type":"object","description":"Represents any valid input/output data type","required":["type","items"],"properties":{"type":{"type":"string","enum":["map"],"isRequired":true,"uniqueKey":"outputs.additionalProperties.oneOf.5.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","additionalProperties":{"$circularRef":"076a5236-0e8f-4167-97a3-5f273503114f"},"isRequired":true,"uniqueKey":"outputs.additionalProperties.oneOf.5.\\items","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"outputs.additionalProperties.oneOf.5","typeLabel":"object"},{"type":"object","description":"Represents any valid input/output data type","required":["type","raw_bytes"],"properties":{"type":{"type":"string","enum":["file"],"isRequired":true,"uniqueKey":"outputs.additionalProperties.oneOf.6.type","typeLabel":"enum\u003cstring>"},"raw_bytes":{"type":"string","format":"base64","isRequired":true,"uniqueKey":"outputs.additionalProperties.oneOf.6.raw_bytes","typeLabel":"file"},"metadata":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"outputs.additionalProperties.oneOf.6.metadata.name","typeLabel":"string"},"path":{"type":"string","uniqueKey":"outputs.additionalProperties.oneOf.6.metadata.path","typeLabel":"string"},"mime_type":{"type":"string","uniqueKey":"outputs.additionalProperties.oneOf.6.metadata.mime_type","typeLabel":"string"}},"uniqueKey":"outputs.additionalProperties.oneOf.6.metadata","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"outputs.additionalProperties.oneOf.6","typeLabel":"object"},{"type":"null","description":"Represents any valid input/output data type","uniqueKey":"outputs.additionalProperties.oneOf.7","typeLabel":"null"}],"uniqueKey":"outputs.additionalProperties","typeLabel":"string · integer · number · boolean · any[] · object · object · null"},"isRequired":true,"uniqueKey":"outputs","typeLabel":"object"}},"required":["status","run_id","outputs"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"success","run_id":"\u003cstring>","outputs":{}}}},"exampleType":"generated"},"text/event-stream":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["stream","result"],"isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"run_id":{"type":"string","isRequired":true,"uniqueKey":"run_id","typeLabel":"string"},"output_name":{"type":"string","isRequired":true,"uniqueKey":"output_name","typeLabel":"string"},"output_value":{"type":"object","isRequired":true,"uniqueKey":"output_value","typeLabel":"object"}},"required":["type","run_id","output_name","output_value"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"stream","run_id":"\u003cstring>","output_name":"\u003cstring>","output_value":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"850cb21f-9592-4aea-9d47-fe34b3efa297":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["failed"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["status","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"failed","error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"91cbf2f1-be73-49ed-a1dd-dd22e994b012":{"description":"Authentication failed","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["Missing authorization header","Invalid authorization header format","Invalid API key"],"isRequired":true,"uniqueKey":"error","typeLabel":"enum\u003cstring>"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Missing authorization header"}}},"exampleType":"generated"}},"exampleType":"generated"},"923bffcb-df12-4de7-bc5d-2198d272efc2":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["failed"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["status","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"failed","error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"e481782b-3e38-432d-8b2d-e097b1c8f1b2":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token authentication using API key","scopes":[]}}},"servers":{"04693d02-2f87-4b15-9c1c-cff81399f06f":{"url":"https://api.vectorshift.ai/v1"}},"schemas":{"076a5236-0e8f-4167-97a3-5f273503114f":{"oneOf":[{"type":"string","description":"Represents any valid input/output data type"},{"type":"integer","description":"Represents any valid input/output data type"},{"type":"number","description":"Represents any valid input/output data type"},{"type":"boolean","description":"Represents any valid input/output data type"},{"type":"array","items":{"oneOf":[{}]},"description":"Represents any valid input/output data type"},{"type":"object","description":"Represents any valid input/output data type","required":["type","items"],"properties":{"type":{"type":"string","enum":["map"],"isRequired":true},"items":{"type":"object","additionalProperties":{"$circularRef":"076a5236-0e8f-4167-97a3-5f273503114f"},"isRequired":true}},"additionalProperties":false},{"type":"object","description":"Represents any valid input/output data type","required":["type","raw_bytes"],"properties":{"type":{"type":"string","enum":["file"],"isRequired":true},"raw_bytes":{"type":"string","format":"base64","isRequired":true},"metadata":{"type":"object","properties":{"name":{"type":"string"},"path":{"type":"string"},"mime_type":{"type":"string"}}}},"additionalProperties":false},{"type":"null","description":"Represents any valid input/output data type"}]}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token authentication using API key","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer token authentication using API key","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"api-reference/pipelines/pipeline.json"},"subdomain":"vectorshift","siteName":"VectorShift","title":"Run a pipeline - VectorShift","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-06T23:44:19.069Z","originalFileLocation":"api-reference/pipelines/run.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=\"Execute a pipeline with the specified inputs and configuration\">\u003cmeta data-mint-head name=\"application-name\" content=\"VectorShift\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/vectorshift/TwRU3RaBNwnTjf5H/_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/vectorshift/TwRU3RaBNwnTjf5H/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/vectorshift/TwRU3RaBNwnTjf5H/_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/vectorshift/TwRU3RaBNwnTjf5H/_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/vectorshift/TwRU3RaBNwnTjf5H/_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/vectorshift/TwRU3RaBNwnTjf5H/_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/vectorshift/TwRU3RaBNwnTjf5H/_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/vectorshift/TwRU3RaBNwnTjf5H/_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/vectorshift/TwRU3RaBNwnTjf5H/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Run a pipeline - VectorShift\">\u003cmeta data-mint-head property=\"og:description\" content=\"Execute a pipeline with the specified inputs and configuration\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"VectorShift\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.vectorshift.ai/api-reference/pipelines/run\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://vectorshift.mintlify.site/logo/vectorshift-logo.png\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Run a pipeline - VectorShift\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Execute a pipeline with the specified inputs and configuration\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://vectorshift.mintlify.site/logo/vectorshift-logo.png\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/vectorshift/TwRU3RaBNwnTjf5H/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"VectorShift\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6366f1\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.vectorshift.ai/api-reference/pipelines/run\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/pipelines/run.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.vectorshift.ai/#organization\",\"name\":\"VectorShift\",\"url\":\"https://docs.vectorshift.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/vectorshift/ko1lD3nuBSgpmLV4/logo/vectorshift-logo.png?fit=max\u0026auto=format\u0026n=ko1lD3nuBSgpmLV4\u0026q=85\u0026s=0b909e21221badbcd2332ad0c7b06a8e\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.vectorshift.ai#website\",\"name\":\"VectorShift\",\"url\":\"https://docs.vectorshift.ai\",\"publisher\":{\"@id\":\"https://docs.vectorshift.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.vectorshift.ai/api-reference/pipelines/run#webpage\",\"url\":\"https://docs.vectorshift.ai/api-reference/pipelines/run\",\"name\":\"Run a pipeline\",\"description\":\"Execute a pipeline with the specified inputs and configuration\",\"dateModified\":\"2026-01-06T23:44:19.069Z\",\"isPartOf\":{\"@id\":\"https://docs.vectorshift.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.vectorshift.ai/api-reference/pipelines/run#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.vectorshift.ai/api-reference/pipelines/run#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"VectorShift\",\"item\":\"https://docs.vectorshift.ai\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Run a pipeline\",\"item\":\"https://docs.vectorshift.ai/api-reference/pipelines/run\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.vectorshift.ai/api-reference/pipelines/run#apireference\",\"headline\":\"Run a pipeline\",\"name\":\"Run a pipeline\",\"description\":\"Execute a pipeline with the specified inputs and configuration\",\"url\":\"https://docs.vectorshift.ai/api-reference/pipelines/run\",\"mainEntityOfPage\":{\"@id\":\"https://docs.vectorshift.ai/api-reference/pipelines/run#webpage\"},\"image\":\"https://docs.vectorshift.ai/logo/vectorshift-logo.png\",\"dateModified\":\"2026-01-06T23:44:19.069Z\",\"publisher\":{\"@id\":\"https://docs.vectorshift.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.vectorshift.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"VectorShift\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"VectorShift","nav":{"global":{"anchors":[{"anchor":"Book a Demo","icon":"calendar","href":"https://calendly.com/albert_mao/vectorshift-intro-chat"},{"anchor":"Changelog","icon":"history","href":"https://vectorshift.ai/blog?tag=changelog"},{"anchor":"Blog","icon":"newspaper","href":"https://vectorshift.ai/blog"},{"anchor":"Tutorials","icon":"youtube","href":"https://www.youtube.com/@VectorShiftAI"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Overview","description":"Get started with the VectorShift API","href":"/api-reference/overview"}]},{"group":"Pipelines","pages":[{"title":"Run a pipeline","openapi":"api-reference/pipelines/pipeline.json POST /pipeline/{id}/run","href":"/api-reference/pipelines/run"},{"title":"Run a pipeline in bulk","openapi":"api-reference/pipelines/pipeline.json POST /pipeline/{id}/bulk_run","description":"Execute multiple instances of the same pipeline in parallel","href":"/api-reference/pipelines/bulk-run"},{"title":"Terminate a pipeline run","openapi":"api-reference/pipelines/pipeline.json POST /pipeline/{id}/terminate","href":"/api-reference/pipelines/terminate"},{"title":"Pause a pipeline run","openapi":"api-reference/pipelines/pipeline.json POST /pipeline/{id}/pause","href":"/api-reference/pipelines/pause"},{"title":"Resume a paused pipeline run","openapi":"api-reference/pipelines/pipeline.json POST /pipeline/{id}/resume","href":"/api-reference/pipelines/resume"},{"title":"Create a new pipeline","openapi":"api-reference/pipelines/pipeline.json POST /pipeline","href":"/api-reference/pipelines/create"},{"title":"Fetch an existing pipeline","openapi":"api-reference/pipelines/pipeline.json GET /pipeline","href":"/api-reference/pipelines/fetch"},{"title":"List all available pipelines","openapi":"api-reference/pipelines/pipeline.json GET /pipelines","href":"/api-reference/pipelines/list"},{"title":"Delete a pipeline","openapi":"api-reference/pipelines/pipeline.json DELETE /pipeline/{id}","href":"/api-reference/pipelines/delete"}]},{"group":"Knowledge Bases","pages":[{"title":"Add data to a knowledge base","openapi":"api-reference/knowledge-bases/knowledge_base.json POST /knowledge-base/{id}/index","href":"/api-reference/knowledge-bases/index"},{"title":"Query a knowledge base","openapi":"api-reference/knowledge-bases/knowledge_base.json POST /knowledge-base/{id}/query","href":"/api-reference/knowledge-bases/query"},{"title":"Create a knowledge base","openapi":"api-reference/knowledge-bases/knowledge_base.json POST /knowledge-base","href":"/api-reference/knowledge-bases/create"},{"title":"Fetch an existing knowledge base","openapi":"api-reference/knowledge-bases/knowledge_base.json GET /knowledge-base","href":"/api-reference/knowledge-bases/fetch"},{"title":"List all available knowledge bases","openapi":"api-reference/knowledge-bases/knowledge_base.json GET /knowledge-bases","href":"/api-reference/knowledge-bases/list"},{"title":"Find documents in a knowledge base","openapi":"api-reference/knowledge-bases/knowledge_base.json GET /knowledge-base/{id}/documents","href":"/api-reference/knowledge-bases/find-documents"},{"title":"Delete documents from a knowledge base","openapi":"api-reference/knowledge-bases/knowledge_base.json DELETE /knowledge-base/{id}/documents","href":"/api-reference/knowledge-bases/delete-documents"},{"title":"Delete a knowledge base","openapi":"api-reference/knowledge-bases/knowledge_base.json DELETE /knowledge-base/{id}","href":"/api-reference/knowledge-bases/delete"}]},{"group":"Chatbots","pages":[{"title":"Run a chatbot","openapi":"api-reference/chatbots/chatbot.json POST /chatbot/{id}/run","href":"/api-reference/chatbots/run"},{"title":"Upload files to a chatbot","openapi":"api-reference/chatbots/chatbot.json POST /chatbot/{id}/upload","href":"/api-reference/chatbots/upload"},{"title":"Terminate a chatbot session","openapi":"api-reference/chatbots/chatbot.json POST /chatbot/{id}/terminate","href":"/api-reference/chatbots/terminate"},{"title":"Create a new chatbot","openapi":"api-reference/chatbots/chatbot.json POST /chatbot","href":"/api-reference/chatbots/create"},{"title":"Fetch an existing chatbot","openapi":"api-reference/chatbots/chatbot.json GET /chatbot","href":"/api-reference/chatbots/fetch"},{"title":"List all available chatbots","openapi":"api-reference/chatbots/chatbot.json GET /chatbots","href":"/api-reference/chatbots/list"},{"title":"Delete a chatbot","openapi":"api-reference/chatbots/chatbot.json DELETE /chatbot/{id}","href":"/api-reference/chatbots/delete"}]},{"group":"Transformations","pages":[{"title":"Run a transformation","openapi":"api-reference/transformations/transformation.json POST /transformation/{id}/run","href":"/api-reference/transformations/run"},{"title":"Create a new transformation","openapi":"api-reference/transformations/transformation.json POST /transformation","href":"/api-reference/transformations/create"},{"title":"Fetch an existing transformation","openapi":"api-reference/transformations/transformation.json GET /transformation","href":"/api-reference/transformations/fetch"},{"title":"List all available transformations","openapi":"api-reference/transformations/transformation.json GET /transformations","href":"/api-reference/transformations/list"},{"title":"Delete a transformation","openapi":"api-reference/transformations/transformation.json DELETE /transformation/{id}","href":"/api-reference/transformations/delete"}]}]},{"tab":"SDK","pages":[{"title":"SDK","href":"/sdk"}]}]},"basePath":"","title":"Run a pipeline - VectorShift","buildId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","deploymentId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-5FCzAcfS.js","utils-SLtAG4EZ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-2DZi8ZMu.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D7J3nkzE.js","snippetPresets-D0Alv0AH.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BI4qNJ2c.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BD3uyr8j.js","shallow-D8iEBr5z.js","getApiPlaygroundDisplay-CgNP4lzR.js","CodeSnippet-CX-QHuMs.js","CodeSnippets-VlXE-ZUf.js","Page-D9ithiIZ.js","getPastedJson-DYNQkZ1M.js","icon-CzacdwOi.js","MethodPill-2JVqoYKi.js","DuplicateIcon-_xVXs-U8.js","createIcon-BRHrweLo.js","DynamicMarkdown-mQG_iQiE.js","SectionHeading-DMpJzv8f.js","axios-vUo_bRtp.js","Markdown-5FGIym-8.js","clsx-D-TRO5q5.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CdrJecqK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CHlcWBLM.js"]}