Build a workflow, run it in a playground, find the run in the debugger and commit it, then do the same from Python and a terminal.
You will build a small workflow in the BlobHub web app and send it a message from a playground. Then you will find
the run in the debugger, where every run is recorded, commit what you built, and run it again from Python and from
a terminal.
Before you start
A Google account. You sign in with Google to create anything. Without signing in, the web app gives you a
shared, read-only identity that can look at public content and create nothing.
The demo organization, Acme (acme-corp), a fictional outdoor-equipment manufacturer, if you want to see
finished workflows, runs and apps first. It is public, so you can look around without signing in.
An organization of your own for everything you create. You make it in the second step below.
Build and run a workflow
1
Sign in
Open blobhub.io and sign in with Google. Your profile is created the first time you sign
in.
2
Create an organization
On your profile’s Organizations tab, choose New (the page is /p/<you>/org/create). Give the
organization an alias of your own: six to 42 characters of lower-case letters, digits, - and _, unique across
BlobHub. acme-corp is taken by the demo. Pick a visibility and choose Create Organization. The alias is
part of every URL inside the organization.
3
Create a workflow
In your organization, choose New (the page is /<org>/blob/create). Give the workflow an alias such as
hello-workflow, pick the type Workflow (blobhub.compute.workflow) and choose Create Blob.In BlobHub’s terms you have created a blob of type Workflow, and its first revision is a draft: the one version
you can edit and run. How BlobHub works explains
both words.
4
Build a definition
The Workflows tab opens the editor on a definition named default, created for you. From the palette, add a
Flow Start, a Code component and a Flow End (flow.start, logic.code and flow.end in the
components reference) and connect them in that order. The code
component’s Python can stay as it is: with no set_result call, it takes the first route connected to it.Add a Message component (data.message) too, with the alias question and its persistence set to
Execution, so in each run it holds the value that run was started with. The chat in the next step starts
every run with what you type, under this alias. Save changes to store the definition in the draft.
5
Run it from a playground
Open the Playgrounds tab. Its first playground, default, is created for you, and New Playground in its
menu adds more. From the palette, add a Chat widget and set two of its ports: send_message_workflow to
default, the definition it runs, and user_input to question, the component that receives your message.
Save changes.Choose New Session from the session menu, then type a message into the chat and send it. The chat starts a
run in that session and shows its status, from Workflow is running… to Workflow execution completed.
A playground shows a session's threads as runs fill them.
The picture is the demo organization’s triage-inbox playground, where workflows post tickets and replies to
threads that its widgets display. Yours has one chat widget so far.
6
Find the run in the debugger
Choose Open in Debugger on the chat, or open the Debugger tab. It lists the draft’s sessions and each
session’s executions. For one execution it shows the graph the run used beside the events the run recorded as it
passed through each component.
Every run is in the debugger, drawn from the definition it actually ran.
On the Revisions tab, choose Commit. Committing freezes the draft, its content and its runtime alike:
the session you used is closed with it, along with any run still going in it. Its definitions can still be
run, but only from a session of a draft.
Committing freezes the draft; a new draft is branched when you want to keep editing.
Committing does not create a new draft. New on the same tab branches one from the committed revision,
copying its definitions, when you want to keep editing; Create Revision is
the same operation in the API.
The same from Python
Install the SDK and give it an API key. Create a key with the Write role under API Keys in your profile’s
settings, then export it as BLOBHUB_API_KEY, or store it as a profile with
blobhub login from the CLI below.
pip install blobhub
The revision you just committed no longer runs, so start a new draft from it and run your definition there:
import blobhubfrom blobhub.types.workflow import Workflowhub = blobhub.connect()blob = hub.blob("<your-org>", "hello-workflow")draft = blob.create_revision("run from Python") # a new draft, copied from the committed revisionrun = Workflow(draft).execute("default")print(run.wait(timeout=300), run.url) # the final status, and the run in the debugger
execute creates a new session for the run unless you name one. See Workflow for sessions, input
data and events, and the Python SDK for the rest of what it covers, or call the
REST API from any language.
The same from a terminal
The CLI keeps a workflow in your repository. Install it and store your key:
pip install blobhub-cliblobhub login
A manifest names the workflow, its revision, and the definitions you keep as files:
deploy writes to a draft. The Python step made one; if you skipped it, choose New on the Revisions tab first.
execute prints the run’s debugger URL, and --watch follows its events until it ends, for up to fifteen minutes.
The workflow overview covers what the CLI is for: building a code component from an
ordinary Python package in your repository.
What you just built
Your organization owns the workflow. You edit and run it in its draft, each run happens in a session of that draft, and
each run leaves its events on the record. A schedule starts the same kind of run on a timer, or posts a thread item or
writes an object in a session, as Schedules explains. A model is versioned the same way without
running anything.
How BlobHub works
Organizations, blobs, types and revisions.
Workflows
What a definition is made of, and how it runs.
Debugger
Every run, read back from its record.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"BlobHub","colors":{"primary":"#0D9373","light":"#07C983","dark":"#0D9373"},"logo":{"light":"https://mintcdn.com/blobhub/Sd5QitJpTcTiIfMu/logo/logo_light.png?fit=max\u0026auto=format\u0026n=Sd5QitJpTcTiIfMu\u0026q=85\u0026s=3571f9d7e85ff7676591fb0eddbfddbc","dark":"https://mintcdn.com/blobhub/Sd5QitJpTcTiIfMu/logo/logo_dark.png?fit=max\u0026auto=format\u0026n=Sd5QitJpTcTiIfMu\u0026q=85\u0026s=510ec2128148a85086c7cce6f53fcf52"},"favicon":"https://mintcdn.com/blobhub/Sd5QitJpTcTiIfMu/logo/logo.png?fit=max\u0026auto=format\u0026n=Sd5QitJpTcTiIfMu\u0026q=85\u0026s=b825c51cf5480df0f06015267d470a3d","background":{"color":{"light":"#ffffff","dark":"#171719"}},"navbar":{"links":[{"href":"mailto:support@blobhub.io","label":"Support"}],"primary":{"type":"button","label":"Profile","href":"https://blobhub.io/p/me"}},"footer":{"socials":{"github":"https://github.com/blobhubio","linkedin":"https://linkedin.com/company/blobhub"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Main","icon":"globe-pointer","href":"https://blobhub.io/"},{"anchor":"Featured","icon":"bookmark","href":"https://blobhub.io/p/blobhub"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"blobhub","hasAudioNarration":false,"actualSubdomain":"blobhub","customDomains":["docs.blobhub.io"],"gitSource":{"type":"github","owner":"blobhubio","repo":"blobhub-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6afbb82f1745d988314d664e","clientVersion":"0.0.4248","searchFilterCounts":[{"language":"default","tag":"Workflow","count":78},{"language":"default","tag":"Blob Types","count":74},{"language":"default","tag":"API Reference","count":60},{"language":"default","tag":"REST API","count":55},{"language":"default","tag":"Operations","count":35},{"language":"default","tag":"CLI","count":32},{"language":"default","tag":"General","count":21},{"language":"default","tag":"Worker","count":20},{"language":"default","tag":"Workflows","count":19},{"language":"default","tag":"Overview","count":18}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".mermaid>svg{margin-inline:auto}html:not(.dark) span[data-ramka-trigger]:has(img.dark\\:mint-block)+button[data-ramka-trigger],html.dark span[data-ramka-trigger]:has(img.dark\\:mint-hidden)+button[data-ramka-trigger]{display:none}"}]}
{"page":{"pagePath":"general/quickstart","slug":"/general/quickstart","pageMetadata":{"title":"Quickstart","description":"Build a workflow, run it in a playground, find the run in the debugger and commit it, then do the same from Python and a terminal.","href":"/general/quickstart"},"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: \"Build a workflow, run it in a playground, find the run in the debugger and commit it, then do the same from Python and a terminal.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];const Shot=({caption,children})=>{const{Frame}=_provideComponents()||{};if(!Frame)_missingMdxReference(`Frame`,true);return _jsx(Frame,{caption,children})};function _createMdxContent(props){const _components={a:`a`,code:`code`,em:`em`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{Card,CardGroup,CodeBlock,Heading,Mermaid,OptimizedImage,Step,Steps,_MdxComponentBoundary}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Mermaid)_missingMdxReference(`Mermaid`,true);if(!OptimizedImage)_missingMdxReference(`OptimizedImage`,true);if(!Step)_missingMdxReference(`Step`,true);if(!Steps)_missingMdxReference(`Steps`,true);if(!_MdxComponentBoundary)_missingMdxReference(`_MdxComponentBoundary`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`You will build a small workflow in the BlobHub web app and send it a message from a playground. Then you will find\nthe run in the debugger, where every run is recorded, commit what you built, and run it again from Python and from\na terminal.`}),`\n`,_jsx(Heading,{level:`2`,id:`before-you-start`,children:`Before you start`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`A Google account.`}),` You sign in with Google to create anything. Without signing in, the web app gives you a\nshared, read-only identity that can look at public content and create nothing.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`The demo organization`}),`, `,_jsx(_components.em,{children:`Acme`}),` (`,_jsx(_components.code,{children:`acme-corp`}),`), a fictional outdoor-equipment manufacturer, if you want to see\nfinished workflows, runs and apps first. It is public, so you can look around without signing in.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`An organization of your own`}),` for everything you create. You make it in the second step below.`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`build-and-run-a-workflow`,children:`Build and run a workflow`}),`\n`,_jsxs(Steps,{children:[_jsx(Step,{title:`Sign in`,children:_jsxs(_components.p,{children:[`Open `,_jsx(_components.a,{href:`https://blobhub.io`,children:`blobhub.io`}),` and sign in with Google. Your profile is created the first time you sign\nin.`]})}),_jsx(Step,{title:`Create an organization`,children:_jsxs(_components.p,{children:[`On your profile’s `,_jsx(_components.strong,{children:`Organizations`}),` tab, choose `,_jsx(_components.strong,{children:`New`}),` (the page is `,_jsx(_components.code,{children:`/p/\u003cyou>/org/create`}),`). Give the\norganization an alias of your own: six to 42 characters of lower-case letters, digits, `,_jsx(_components.code,{children:`-`}),` and `,_jsx(_components.code,{children:`_`}),`, unique across\nBlobHub. `,_jsx(_components.code,{children:`acme-corp`}),` is taken by the demo. Pick a visibility and choose `,_jsx(_components.strong,{children:`Create Organization`}),`. The alias is\npart of every URL inside the organization.`]})}),_jsxs(Step,{title:`Create a workflow`,children:[_jsxs(_components.p,{children:[`In your organization, choose `,_jsx(_components.strong,{children:`New`}),` (the page is `,_jsx(_components.code,{children:`/\u003corg>/blob/create`}),`). Give the workflow an alias such as\n`,_jsx(_components.code,{children:`hello-workflow`}),`, pick the type `,_jsx(_components.strong,{children:`Workflow`}),` (`,_jsx(_components.code,{children:`blobhub.compute.workflow`}),`) and choose `,_jsx(_components.strong,{children:`Create Blob`}),`.`]}),_jsxs(_components.p,{children:[`In BlobHub’s terms you have created a blob of type Workflow, and its first revision is a draft: the one version\nyou can edit and run. `,_jsx(_components.a,{href:`/general/how-it-works#revisions-and-the-revision-lifecycle`,children:`How BlobHub works`}),` explains\nboth words.`]})]}),_jsxs(Step,{title:`Build a definition`,children:[_jsxs(_components.p,{children:[`The `,_jsx(_components.strong,{children:`Workflows`}),` tab opens the editor on a definition named `,_jsx(_components.code,{children:`default`}),`, created for you. From the palette, add a\n`,_jsx(_components.strong,{children:`Flow Start`}),`, a `,_jsx(_components.strong,{children:`Code`}),` component and a `,_jsx(_components.strong,{children:`Flow End`}),` (`,_jsx(_components.code,{children:`flow.start`}),`, `,_jsx(_components.code,{children:`logic.code`}),` and `,_jsx(_components.code,{children:`flow.end`}),` in the\n`,_jsx(_components.a,{href:`/blob-types/workflow/workflows/components`,children:`components`}),` reference) and connect them in that order. The code\ncomponent’s Python can stay as it is: with no `,_jsx(_components.code,{children:`set_result`}),` call, it takes the first route connected to it.`]}),_jsxs(_components.p,{children:[`Add a `,_jsx(_components.strong,{children:`Message`}),` component (`,_jsx(_components.code,{children:`data.message`}),`) too, with the alias `,_jsx(_components.code,{children:`question`}),` and its persistence set to\n`,_jsx(_components.strong,{children:`Execution`}),`, so in each run it holds the value that run was started with. The chat in the next step starts\nevery run with what you type, under this alias. `,_jsx(_components.strong,{children:`Save changes`}),` to store the definition in the draft.`]})]}),_jsxs(Step,{title:`Run it from a playground`,children:[_jsxs(_components.p,{children:[`Open the `,_jsx(_components.strong,{children:`Playgrounds`}),` tab. Its first playground, `,_jsx(_components.code,{children:`default`}),`, is created for you, and `,_jsx(_components.strong,{children:`New Playground`}),` in its\nmenu adds more. From the palette, add a `,_jsx(_components.strong,{children:`Chat`}),` widget and set two of its ports: `,_jsx(_components.code,{children:`send_message_workflow`}),` to\n`,_jsx(_components.code,{children:`default`}),`, the definition it runs, and `,_jsx(_components.code,{children:`user_input`}),` to `,_jsx(_components.code,{children:`question`}),`, the component that receives your message.\n`,_jsx(_components.strong,{children:`Save changes`}),`.`]}),_jsxs(_components.p,{children:[`Choose `,_jsx(_components.strong,{children:`New Session`}),` from the session menu, then type a message into the chat and send it. The chat starts a\nrun in that session and shows its status, from `,_jsx(_components.em,{children:`Workflow is running…`}),` to `,_jsx(_components.em,{children:`Workflow execution completed`}),`.`]}),_jsx(_MdxComponentBoundary,{name:`Shot`,children:_jsxs(Shot,{caption:`A playground shows a session's threads as runs fill them.`,children:[_jsx(OptimizedImage,{className:`mint-block dark:mint-hidden`,src:`https://mintcdn.com/blobhub/WoQqmkuSJNQ1SRqd/general/images/quickstart/playground.png?fit=max\u0026auto=format\u0026n=WoQqmkuSJNQ1SRqd\u0026q=85\u0026s=84e159b9cbe8f7feeba03638d1dc2b30`,alt:`The triage-inbox playground: threads of tickets, replies and holds after real runs`,\"data-og-width\":`2880`,width:`2880`,\"data-og-height\":`1800`,height:`1800`,\"data-path\":`general/images/quickstart/playground.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/blobhub/WoQqmkuSJNQ1SRqd/general/images/quickstart/playground.png?w=280\u0026fit=max\u0026auto=format\u0026n=WoQqmkuSJNQ1SRqd\u0026q=85\u0026s=61954b5b5d7c09e98017ea7329d9fb07 280w, https://mintcdn.com/blobhub/WoQqmkuSJNQ1SRqd/general/images/quickstart/playground.png?w=560\u0026fit=max\u0026auto=format\u0026n=WoQqmkuSJNQ1SRqd\u0026q=85\u0026s=0925bdcdf4760542bbe3f71a8b00100c 560w, https://mintcdn.com/blobhub/WoQqmkuSJNQ1SRqd/general/images/quickstart/playground.png?w=840\u0026fit=max\u0026auto=format\u0026n=WoQqmkuSJNQ1SRqd\u0026q=85\u0026s=7c3ac88a7605eb18c0540a658e6aee19 840w, https://mintcdn.com/blobhub/WoQqmkuSJNQ1SRqd/general/images/quickstart/playground.png?w=1100\u0026fit=max\u0026auto=format\u0026n=WoQqmkuSJNQ1SRqd\u0026q=85\u0026s=01a423ee38e4ccdbc39ddad0d6fca7c9 1100w, https://mintcdn.com/blobhub/WoQqmkuSJNQ1SRqd/general/images/quickstart/playground.png?w=1650\u0026fit=max\u0026auto=format\u0026n=WoQqmkuSJNQ1SRqd\u0026q=85\u0026s=36ed6f2476794cd173862afc1d043e8d 1650w, https://mintcdn.com/blobhub/WoQqmkuSJNQ1SRqd/general/images/quickstart/playground.png?w=2500\u0026fit=max\u0026auto=format\u0026n=WoQqmkuSJNQ1SRqd\u0026q=85\u0026s=03751396d8c953ba88774475cb3cc01b 2500w`}),_jsx(OptimizedImage,{className:`mint-hidden dark:mint-block`,src:`https://mintcdn.com/blobhub/WoQqmkuSJNQ1SRqd/general/images/quickstart/playground.dark.png?fit=max\u0026auto=format\u0026n=WoQqmkuSJNQ1SRqd\u0026q=85\u0026s=b714591a29c9178aec8dc01bfabc1033`,alt:`The triage-inbox playground: threads of tickets, replies and holds after real runs`,\"data-og-width\":`2880`,width:`2880`,\"data-og-height\":`1800`,height:`1800`,\"data-path\":`general/images/quickstart/playground.dark.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/blobhub/WoQqmkuSJNQ1SRqd/general/images/quickstart/playground.dark.png?w=280\u0026fit=max\u0026auto=format\u0026n=WoQqmkuSJNQ1SRqd\u0026q=85\u0026s=6956cce29405182e9d01597f8884d5c3 280w, https://mintcdn.com/blobhub/WoQqmkuSJNQ1SRqd/general/images/quickstart/playground.dark.png?w=560\u0026fit=max\u0026auto=format\u0026n=WoQqmkuSJNQ1SRqd\u0026q=85\u0026s=77bc0cf808950f76f31026c477d2357f 560w, https://mintcdn.com/blobhub/WoQqmkuSJNQ1SRqd/general/images/quickstart/playground.dark.png?w=840\u0026fit=max\u0026auto=format\u0026n=WoQqmkuSJNQ1SRqd\u0026q=85\u0026s=2c177815a1936179ce411d998cc46753 840w, https://mintcdn.com/blobhub/WoQqmkuSJNQ1SRqd/general/images/quickstart/playground.dark.png?w=1100\u0026fit=max\u0026auto=format\u0026n=WoQqmkuSJNQ1SRqd\u0026q=85\u0026s=fad2e27645d1420a59887068d38437da 1100w, https://mintcdn.com/blobhub/WoQqmkuSJNQ1SRqd/general/images/quickstart/playground.dark.png?w=1650\u0026fit=max\u0026auto=format\u0026n=WoQqmkuSJNQ1SRqd\u0026q=85\u0026s=920e96ee0b1909cd78370af6eb630c55 1650w, https://mintcdn.com/blobhub/WoQqmkuSJNQ1SRqd/general/images/quickstart/playground.dark.png?w=2500\u0026fit=max\u0026auto=format\u0026n=WoQqmkuSJNQ1SRqd\u0026q=85\u0026s=5773262a864d9869711ed48e78b6ae2c 2500w`})]})}),_jsxs(_components.p,{children:[`The picture is the demo organization’s `,_jsx(_components.code,{children:`triage-inbox`}),` playground, where workflows post tickets and replies to\nthreads that its widgets display. Yours has one chat widget so far.`]})]}),_jsxs(Step,{title:`Find the run in the debugger`,children:[_jsxs(_components.p,{children:[`Choose `,_jsx(_components.strong,{children:`Open in Debugger`}),` on the chat, or open the `,_jsx(_components.strong,{children:`Debugger`}),` tab. It lists the draft’s sessions and each\nsession’s executions. For one execution it shows the graph the run used beside the events the run recorded as it\npassed through each component.`]}),_jsx(_MdxComponentBoundary,{name:`Shot`,children:_jsxs(Shot,{caption:`Every run is in the debugger, drawn from the definition it actually ran.`,children:[_jsx(OptimizedImage,{className:`mint-block dark:mint-hidden`,src:`https://mintcdn.com/blobhub/WoQqmkuSJNQ1SRqd/general/images/quickstart/debugger.png?fit=max\u0026auto=format\u0026n=WoQqmkuSJNQ1SRqd\u0026q=85\u0026s=d3a6c5354a27c34eb8cea94536274746`,alt:`The debugger on one execution: the graph it ran and its event list`,\"data-og-width\":`2880`,width:`2880`,\"data-og-height\":`2400`,height:`2400`,\"data-path\":`general/images/quickstart/debugger.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/blobhub/WoQqmkuSJNQ1SRqd/general/images/quickstart/debugger.png?w=280\u0026fit=max\u0026auto=format\u0026n=WoQqmkuSJNQ1SRqd\u0026q=85\u0026s=20d8a3f092779efb67835411dfd3fb20 280w, https://mintcdn.com/blobhub/WoQqmkuSJNQ1SRqd/general/images/quickstart/debugger.png?w=560\u0026fit=max\u0026auto=format\u0026n=WoQqmkuSJNQ1SRqd\u0026q=85\u0026s=1262d9f3d21b0f2cb3a84ed29422d9bc 560w, https://mintcdn.com/blobhub/WoQqmkuSJNQ1SRqd/general/images/quickstart/debugger.png?w=840\u0026fit=max\u0026auto=format\u0026n=WoQqmkuSJNQ1SRqd\u0026q=85\u0026s=b1d6d365ddf94ed9f9707dfe6f3691b1 840w, https://mintcdn.com/blobhub/WoQqmkuSJNQ1SRqd/general/images/quickstart/debugger.png?w=1100\u0026fit=max\u0026auto=format\u0026n=WoQqmkuSJNQ1SRqd\u0026q=85\u0026s=d6e4b84b747b52689907d7da1a0ef552 1100w, https://mintcdn.com/blobhub/WoQqmkuSJNQ1SRqd/general/images/quickstart/debugger.png?w=1650\u0026fit=max\u0026auto=format\u0026n=WoQqmkuSJNQ1SRqd\u0026q=85\u0026s=28c7798863fa6e35b349c28b5c8f8d1d 1650w, https://mintcdn.com/blobhub/WoQqmkuSJNQ1SRqd/general/images/quickstart/debugger.png?w=2500\u0026fit=max\u0026auto=format\u0026n=WoQqmkuSJNQ1SRqd\u0026q=85\u0026s=66f83cd60efaa400afd0e996f642ce32 2500w`}),_jsx(OptimizedImage,{className:`mint-hidden dark:mint-block`,src:`https://mintcdn.com/blobhub/WoQqmkuSJNQ1SRqd/general/images/quickstart/debugger.dark.png?fit=max\u0026auto=format\u0026n=WoQqmkuSJNQ1SRqd\u0026q=85\u0026s=ad0a5499b014370a27cb03cc403e9c88`,alt:`The debugger on one execution: the graph it ran and its event list`,\"data-og-width\":`2880`,width:`2880`,\"data-og-height\":`2400`,height:`2400`,\"data-path\":`general/images/quickstart/debugger.dark.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/blobhub/WoQqmkuSJNQ1SRqd/general/images/quickstart/debugger.dark.png?w=280\u0026fit=max\u0026auto=format\u0026n=WoQqmkuSJNQ1SRqd\u0026q=85\u0026s=58e2f2b2f1ddc472864092e99111bf8f 280w, https://mintcdn.com/blobhub/WoQqmkuSJNQ1SRqd/general/images/quickstart/debugger.dark.png?w=560\u0026fit=max\u0026auto=format\u0026n=WoQqmkuSJNQ1SRqd\u0026q=85\u0026s=3f51c6590d7ac419b6d24bf33eb5c593 560w, https://mintcdn.com/blobhub/WoQqmkuSJNQ1SRqd/general/images/quickstart/debugger.dark.png?w=840\u0026fit=max\u0026auto=format\u0026n=WoQqmkuSJNQ1SRqd\u0026q=85\u0026s=f768967d6de5cefda7821bfdfa0dd839 840w, https://mintcdn.com/blobhub/WoQqmkuSJNQ1SRqd/general/images/quickstart/debugger.dark.png?w=1100\u0026fit=max\u0026auto=format\u0026n=WoQqmkuSJNQ1SRqd\u0026q=85\u0026s=464788aec3b649f1878bdcb4b05733eb 1100w, https://mintcdn.com/blobhub/WoQqmkuSJNQ1SRqd/general/images/quickstart/debugger.dark.png?w=1650\u0026fit=max\u0026auto=format\u0026n=WoQqmkuSJNQ1SRqd\u0026q=85\u0026s=bc4505a88ae6846ca9e462f2de669af5 1650w, https://mintcdn.com/blobhub/WoQqmkuSJNQ1SRqd/general/images/quickstart/debugger.dark.png?w=2500\u0026fit=max\u0026auto=format\u0026n=WoQqmkuSJNQ1SRqd\u0026q=85\u0026s=a0925ce423cc27cecff037ab4b22383c 2500w`})]})}),_jsxs(_components.p,{children:[_jsx(_components.a,{href:`/general/debugger`,children:`Debugger`}),` covers the rest of what it shows.`]})]}),_jsxs(Step,{title:`Commit the draft`,children:[_jsxs(_components.p,{children:[`On the `,_jsx(_components.strong,{children:`Revisions`}),` tab, choose `,_jsx(_components.strong,{children:`Commit`}),`. Committing freezes the draft, its content and its runtime alike:\nthe session you used is closed with it, along with any run still going in it. Its definitions can still be\nrun, but only from a session of a draft.`]}),_jsx(_MdxComponentBoundary,{name:`Shot`,children:_jsxs(Shot,{caption:`Committing freezes the draft; a new draft is branched when you want to keep editing.`,children:[_jsx(OptimizedImage,{className:`mint-block dark:mint-hidden`,src:`https://mintcdn.com/blobhub/WoQqmkuSJNQ1SRqd/general/images/quickstart/commit.png?fit=max\u0026auto=format\u0026n=WoQqmkuSJNQ1SRqd\u0026q=85\u0026s=038664c8231f1a0da476bdc532b195c8`,alt:`The Revisions tab with the commit dialog open on the draft`,\"data-og-width\":`2560`,width:`2560`,\"data-og-height\":`1600`,height:`1600`,\"data-path\":`general/images/quickstart/commit.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/blobhub/WoQqmkuSJNQ1SRqd/general/images/quickstart/commit.png?w=280\u0026fit=max\u0026auto=format\u0026n=WoQqmkuSJNQ1SRqd\u0026q=85\u0026s=6a68617f4f75a99dedff08912727a0eb 280w, https://mintcdn.com/blobhub/WoQqmkuSJNQ1SRqd/general/images/quickstart/commit.png?w=560\u0026fit=max\u0026auto=format\u0026n=WoQqmkuSJNQ1SRqd\u0026q=85\u0026s=e68b31719b3f71c467ed4f785f35e444 560w, https://mintcdn.com/blobhub/WoQqmkuSJNQ1SRqd/general/images/quickstart/commit.png?w=840\u0026fit=max\u0026auto=format\u0026n=WoQqmkuSJNQ1SRqd\u0026q=85\u0026s=0c036a248b785da29f7d66a2671395db 840w, https://mintcdn.com/blobhub/WoQqmkuSJNQ1SRqd/general/images/quickstart/commit.png?w=1100\u0026fit=max\u0026auto=format\u0026n=WoQqmkuSJNQ1SRqd\u0026q=85\u0026s=c6a20d55f7f207ffe3bd220bc572ab1b 1100w, https://mintcdn.com/blobhub/WoQqmkuSJNQ1SRqd/general/images/quickstart/commit.png?w=1650\u0026fit=max\u0026auto=format\u0026n=WoQqmkuSJNQ1SRqd\u0026q=85\u0026s=1822035bdfd6097faff86dddb94adf24 1650w, https://mintcdn.com/blobhub/WoQqmkuSJNQ1SRqd/general/images/quickstart/commit.png?w=2500\u0026fit=max\u0026auto=format\u0026n=WoQqmkuSJNQ1SRqd\u0026q=85\u0026s=9a8382cf93b90f1fdfcea2248de372d4 2500w`}),_jsx(OptimizedImage,{className:`mint-hidden dark:mint-block`,src:`https://mintcdn.com/blobhub/WoQqmkuSJNQ1SRqd/general/images/quickstart/commit.dark.png?fit=max\u0026auto=format\u0026n=WoQqmkuSJNQ1SRqd\u0026q=85\u0026s=45423480f90263c3ff58c96ec424fdc0`,alt:`The Revisions tab with the commit dialog open on the draft`,\"data-og-width\":`2560`,width:`2560`,\"data-og-height\":`1600`,height:`1600`,\"data-path\":`general/images/quickstart/commit.dark.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/blobhub/WoQqmkuSJNQ1SRqd/general/images/quickstart/commit.dark.png?w=280\u0026fit=max\u0026auto=format\u0026n=WoQqmkuSJNQ1SRqd\u0026q=85\u0026s=e5fa24583b992c953bca47627f534c86 280w, https://mintcdn.com/blobhub/WoQqmkuSJNQ1SRqd/general/images/quickstart/commit.dark.png?w=560\u0026fit=max\u0026auto=format\u0026n=WoQqmkuSJNQ1SRqd\u0026q=85\u0026s=9661ee23e0f6b9426a522f69d5689780 560w, https://mintcdn.com/blobhub/WoQqmkuSJNQ1SRqd/general/images/quickstart/commit.dark.png?w=840\u0026fit=max\u0026auto=format\u0026n=WoQqmkuSJNQ1SRqd\u0026q=85\u0026s=d7575b2002eda19da6af50ec2493ec6f 840w, https://mintcdn.com/blobhub/WoQqmkuSJNQ1SRqd/general/images/quickstart/commit.dark.png?w=1100\u0026fit=max\u0026auto=format\u0026n=WoQqmkuSJNQ1SRqd\u0026q=85\u0026s=23c88522c22aa1e3c921f7e97796d07b 1100w, https://mintcdn.com/blobhub/WoQqmkuSJNQ1SRqd/general/images/quickstart/commit.dark.png?w=1650\u0026fit=max\u0026auto=format\u0026n=WoQqmkuSJNQ1SRqd\u0026q=85\u0026s=70f3157d0cbc2dd0cc6c6c83611195ce 1650w, https://mintcdn.com/blobhub/WoQqmkuSJNQ1SRqd/general/images/quickstart/commit.dark.png?w=2500\u0026fit=max\u0026auto=format\u0026n=WoQqmkuSJNQ1SRqd\u0026q=85\u0026s=b0c549241a6f1a8ce064f8e5819aa5f7 2500w`})]})}),_jsxs(_components.p,{children:[`Committing does not create a new draft. `,_jsx(_components.strong,{children:`New`}),` on the same tab branches one from the committed revision,\ncopying its definitions, when you want to keep editing; `,_jsx(_components.a,{href:`/rest-api/blobs/create-revision`,children:`Create Revision`}),` is\nthe same operation in the API.`]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`the-same-from-python`,children:`The same from Python`}),`\n`,_jsxs(_components.p,{children:[`Install the SDK and give it an API key. Create a key with the `,_jsx(_components.strong,{children:`Write`}),` role under `,_jsx(_components.strong,{children:`API Keys`}),` in your profile’s\nsettings, then export it as `,_jsx(_components.code,{children:`BLOBHUB_API_KEY`}),`, or store it as a profile with\n`,_jsx(_components.a,{href:`/cli/auth#blobhub-login`,children:_jsx(_components.code,{children:`blobhub login`})}),` from the CLI below.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`pip`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` install`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` blobhub`})]}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`The revision you just committed no longer runs, so start a new draft from it and run your definition there:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`8`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`8`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` blobhub`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` blobhub.types.workflow `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` Workflow`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`hub `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` blobhub.connect()`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`blob `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` hub.blob(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"\u003cyour-org>\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"hello-workflow\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`draft `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` blob.create_revision(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"run from Python\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`) `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# a new draft, copied from the committed revision`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`run `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` Workflow(draft).execute(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"default\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`print`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(run.wait(`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`timeout`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`300`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`), run.url) `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# the final status, and the run in the debugger`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`execute`}),` creates a new session for the run unless you name one. See `,_jsx(_components.a,{href:`/sdk/workflow`,children:`Workflow`}),` for sessions, input\ndata and events, and the `,_jsx(_components.a,{href:`/sdk/introduction`,children:`Python SDK`}),` for the rest of what it covers, or call the\n`,_jsx(_components.a,{href:`/rest-api/introduction`,children:`REST API`}),` from any language.`]}),`\n`,_jsx(Heading,{level:`2`,id:`the-same-from-a-terminal`,children:`The same from a terminal`}),`\n`,_jsx(_components.p,{children:`The CLI keeps a workflow in your repository. Install it and store your key:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`pip`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` install`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` blobhub-cli`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`blobhub`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` login`})]}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`A manifest names the workflow, its revision, and the definitions you keep as files:`}),`\n`,_jsx(CodeBlock,{filename:`manifest.yaml`,numberOfLines:`7`,language:`yaml`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`yaml`,children:_jsxs(_components.code,{language:`yaml`,numberOfLines:`7`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`type`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`workflow_blob_deployment`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`version`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"1.0\"`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`blob`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\u003cyour-org>/hello-workflow`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`revision`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`default`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`definitions`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` - `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`alias`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`default`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` source`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`definitions/default.json`})]}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`Pull the definition into its file, edit it, deploy the edit, and run it:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`3`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`blobhub`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` workflow`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` pull`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -f`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` manifest.yaml`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # writes definitions/default.json`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`blobhub`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` workflow`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` deploy`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -f`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` manifest.yaml`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # uploads what changed, then checks it`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`blobhub`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` workflow`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` execute`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -f`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` manifest.yaml`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --definition`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` default`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --watch`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`deploy`}),` writes to a draft. The Python step made one; if you skipped it, choose `,_jsx(_components.strong,{children:`New`}),` on the Revisions tab first.\n`,_jsx(_components.code,{children:`execute`}),` prints the run’s debugger URL, and `,_jsx(_components.code,{children:`--watch`}),` follows its events until it ends, for up to fifteen minutes.\nThe `,_jsx(_components.a,{href:`/cli/workflow/overview`,children:`workflow overview`}),` covers what the CLI is for: building a code component from an\nordinary Python package in your repository.`]}),`\n`,_jsx(Heading,{level:`2`,id:`what-you-just-built`,children:`What you just built`}),`\n`,_jsx(Mermaid,{chart:`flowchart LR\n ORG[\"Organization\u003cbr/>your alias\"]\n WF[/\"Workflow\u003cbr/>hello-workflow\"/]\n DRAFT[\"Draft\u003cbr/>then committed\"]\n SESS[\"Session\"]\n EXEC[\"Execution\"]\n EVT[\"Events\"]\n\n ORG --> WF --> DRAFT --> SESS --> EXEC --> EVT`}),`\n`,_jsxs(_components.p,{children:[`Your organization owns the workflow. You edit and run it in its draft, each run happens in a session of that draft, and\neach run leaves its events on the record. A schedule starts the same kind of run on a timer, or posts a thread item or\nwrites an object in a session, as `,_jsx(_components.a,{href:`/general/schedules`,children:`Schedules`}),` explains. A model is versioned the same way without\nrunning anything.`]}),`\n`,_jsxs(CardGroup,{cols:3,children:[_jsx(Card,{title:`How BlobHub works`,icon:`layer-group`,href:`/general/how-it-works`,children:_jsx(_components.p,{children:`Organizations, blobs, types and revisions.`})}),_jsx(Card,{title:`Workflows`,icon:`diagram-project`,href:`/general/workflows`,children:_jsx(_components.p,{children:`What a definition is made of, and how it runs.`})}),_jsx(Card,{title:`Debugger`,icon:`bug`,href:`/general/debugger`,children:_jsx(_components.p,{children:`Every run, read back from its record.`})})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{Shot,default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Quickstart","description":"Build a workflow, run it in a playground, find the run in the debugger and commit it, then do the same from Python and a terminal.","href":"/general/quickstart"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Before you start","slug":"before-you-start","depth":2,"children":[]},{"title":"Build and run a workflow","slug":"build-and-run-a-workflow","depth":2,"children":[]},{"title":"The same from Python","slug":"the-same-from-python","depth":2,"children":[]},{"title":"The same from a terminal","slug":"the-same-from-a-terminal","depth":2,"children":[]},{"title":"What you just built","slug":"what-you-just-built","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"dynamicCss":".mint-block {\n display: block\n}\n.mint-hidden {\n display: none\n}\n.dark\\:mint-block:is(.dark *) {\n display: block\n}\n.dark\\:mint-hidden:is(.dark *) {\n display: none\n}","subdomain":"blobhub","siteName":"BlobHub","title":"Quickstart - BlobHub","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-15T00:31:24.195Z","originalFileLocation":"general/quickstart.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=\"Build a workflow, run it in a playground, find the run in the debugger and commit it, then do the same from Python and a terminal.\">\u003cmeta data-mint-head name=\"application-name\" content=\"BlobHub\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/blobhub/7KtgSuAj0RuD0fgV/_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/blobhub/7KtgSuAj0RuD0fgV/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/blobhub/7KtgSuAj0RuD0fgV/_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/blobhub/7KtgSuAj0RuD0fgV/_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/blobhub/7KtgSuAj0RuD0fgV/_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/blobhub/7KtgSuAj0RuD0fgV/_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/blobhub/7KtgSuAj0RuD0fgV/_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/blobhub/7KtgSuAj0RuD0fgV/_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/blobhub/7KtgSuAj0RuD0fgV/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Quickstart - BlobHub\">\u003cmeta data-mint-head property=\"og:description\" content=\"Build a workflow, run it in a playground, find the run in the debugger and commit it, then do the same from Python and a terminal.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"BlobHub\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.blobhub.io/general/quickstart\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://blobhub.mintlify.site/_mintlify/api/og/v2?division=Get+started\u0026amp;title=Quickstart\u0026amp;description=Build+a+workflow%2C+run+it+in+a+playground%2C+find+the+run+in+the+debugger+and+commit+it%2C+then+do+the+same+from+Python+and+a+terminal.\u0026amp;theme=4495df610ffa358b5e04f999\u0026amp;signature=5bfe12f0f59693fd9b3478f86b7905e2c2001e6abc36982f8390b3ed9d1af3cd\">\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=\"Quickstart - BlobHub\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Build a workflow, run it in a playground, find the run in the debugger and commit it, then do the same from Python and a terminal.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://blobhub.mintlify.site/_mintlify/api/og/v2?division=Get+started\u0026amp;title=Quickstart\u0026amp;description=Build+a+workflow%2C+run+it+in+a+playground%2C+find+the+run+in+the+debugger+and+commit+it%2C+then+do+the+same+from+Python+and+a+terminal.\u0026amp;theme=4495df610ffa358b5e04f999\u0026amp;signature=5bfe12f0f59693fd9b3478f86b7905e2c2001e6abc36982f8390b3ed9d1af3cd\">\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/blobhub/7KtgSuAj0RuD0fgV/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"BlobHub\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0D9373\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.blobhub.io/general/quickstart\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/general/quickstart.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.blobhub.io/#organization\",\"name\":\"BlobHub\",\"url\":\"https://docs.blobhub.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/blobhub/Sd5QitJpTcTiIfMu/logo/logo_light.png?fit=max\u0026auto=format\u0026n=Sd5QitJpTcTiIfMu\u0026q=85\u0026s=3571f9d7e85ff7676591fb0eddbfddbc\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.blobhub.io#website\",\"name\":\"BlobHub\",\"url\":\"https://docs.blobhub.io\",\"publisher\":{\"@id\":\"https://docs.blobhub.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.blobhub.io/general/quickstart#webpage\",\"url\":\"https://docs.blobhub.io/general/quickstart\",\"name\":\"Quickstart\",\"description\":\"Build a workflow, run it in a playground, find the run in the debugger and commit it, then do the same from Python and a terminal.\",\"dateModified\":\"2026-11-15T00:31:24.195Z\",\"isPartOf\":{\"@id\":\"https://docs.blobhub.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.blobhub.io/general/quickstart#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.blobhub.io/general/quickstart#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Get started\",\"item\":\"https://docs.blobhub.io/general/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Quickstart\",\"item\":\"https://docs.blobhub.io/general/quickstart\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.blobhub.io/general/quickstart#article\",\"headline\":\"Quickstart\",\"name\":\"Quickstart\",\"description\":\"Build a workflow, run it in a playground, find the run in the debugger and commit it, then do the same from Python and a terminal.\",\"url\":\"https://docs.blobhub.io/general/quickstart\",\"mainEntityOfPage\":{\"@id\":\"https://docs.blobhub.io/general/quickstart#webpage\"},\"dateModified\":\"2026-11-15T00:31:24.195Z\",\"publisher\":{\"@id\":\"https://docs.blobhub.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.blobhub.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"BlobHub\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"BlobHub\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/general/quickstart.md","siteName":"BlobHub","nav":{"global":{"anchors":[{"anchor":"Main","icon":"globe-pointer","href":"https://blobhub.io/"},{"anchor":"Featured","icon":"bookmark","href":"https://blobhub.io/p/blobhub"}]},"tabs":[{"tab":"General","groups":[{"group":"Get started","pages":[{"title":"Introduction","description":"BlobHub is the one-stop shop for agentic development: the system of record and action for your agents. Build. Govern. Audit.","href":"/general/introduction"},{"title":"Quickstart","href":"/general/quickstart"},{"title":"How BlobHub works","description":"Organizations, blobs and revisions: the storage beneath what you build, and the blob type behind each primitive that has one.","href":"/general/how-it-works"}]},{"group":"Build","pages":[{"title":"Workflows","href":"/general/workflows"},{"title":"Sessions","href":"/general/sessions"},{"title":"Threads \u0026 objects","href":"/general/threads-and-objects"},{"title":"Playgrounds","href":"/general/playgrounds"},{"title":"Schedules","href":"/general/schedules"},{"title":"Agents \u0026 workers","href":"/general/agents-and-workers"},{"title":"Models","href":"/general/models"}]},{"group":"Govern","pages":[{"title":"Organizations \u0026 access","href":"/general/organizations-and-access"},{"title":"Credentials","href":"/general/credentials"},{"title":"Policies \u0026 approvals","href":"/general/policies-and-approvals"},{"title":"Service accounts","href":"/general/service-accounts"},{"title":"Limits","href":"/general/limits"}]},{"group":"Audit","pages":[{"title":"The record","href":"/general/the-record"},{"title":"Debugger","href":"/general/debugger"}]},{"group":"Apps","pages":[{"title":"Apps \u0026 Missions","href":"/general/apps"}]},{"group":"Platform","pages":[{"title":"Surfaces","href":"/general/surfaces"},{"title":"Architecture","href":"/general/architecture"},{"title":"Provisioning","href":"/general/provisioning"}]}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/rest-api/introduction"}]},{"tab":"Blob Types","pages":[{"title":"Blob Types","href":"/blob-types/introduction"}]},{"tab":"SDK","pages":[{"title":"SDK","href":"/sdk/introduction"}]},{"tab":"CLI","pages":[{"title":"CLI","href":"/cli/introduction"}]},{"tab":"Worker","pages":[{"title":"Worker","href":"/worker/introduction"}]}]},"basePath":"","title":"Quickstart - BlobHub","deploymentId":"dpl_2pTxFtyBudBMYZiCw1MyvoA1wxpd","buildId":"dpl_2pTxFtyBudBMYZiCw1MyvoA1wxpd","dynamics":["07c022d89b","a74be98ba7"],"chunks":["Frame-B0oVBAXA.js","DynamicMarkdown-BvJIe00T.js","zoom-image-lightbox-BXthlMNf.js","lightbox-handle-r17bVUz3.js"]}