[{"_1":2,"_3":-5,"_4":-5},"loaderData",{"_5":6,"_7":8,"_9":10},"actionData","errors","root",{"_845":846,"_847":58,"_848":82},"routes/docs.$product.$ref",{"_41":42,"_43":44,"_45":46,"_47":48,"_49":50,"_51":48,"_52":48,"_53":54,"_55":56,"_57":58,"_59":58,"_60":61},"routes/docs.$product.$ref.$",{"_11":12,"_13":14,"_15":16},"doc",{"_17":18,"_19":20,"_21":22,"_23":24,"_25":26,"_27":28,"_29":30},"siteUrl","https://www.useboomerang.io/docs/flow/main/apis/models/ModelUsage","ogImageUrl","https://www.useboomerang.io/img/og.1.jpg","attrs",{"_21":38,"_39":40},"filename","flow/apis/models/ModelUsage.md","title",{"_23":36,"_25":37},"html","\n

Properties

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Notes
aiTaskRuns	Long	[optional]
cachedPromptTokens	Long	[optional]
completionTokens	Long	[optional]
cost	Double	[optional]
model	String	[optional]
promptTokens	Long	[optional]
reasoningTokens	Long	[optional]
totalTokens	Long	[optional]

[Back to Models] [Back to Routes]

","slug","flow/apis/models/ModelUsage","headings",[31],"children",[],{"_32":33,"_23":34,"_25":35},"headingLevel","h2","Properties","properties","Model Usage Model","model-usage-model","Model Usage Model","verified","5.0.0-beta.39","menu",[68,69,70,71,72,73,74,75,76,77],"versions",[46],"latestVersion","3.12.0","releaseBranch","main","branches",[48],"currentRef","githubRef","product","flow","products",[62,63],"isLatest",true,"isEditable","repoUrl","https://github.com/boomerang-io/docs",{"_64":54,"_21":67},{"_64":65,"_21":66},"key","bosun","Boomerang Bosun","Boomerang Flow",{"_17":775,"_19":776,"_25":777,"_81":82,"_29":778},{"_17":725,"_19":726,"_25":727,"_81":82,"_29":728},{"_17":667,"_19":668,"_25":669,"_81":82,"_29":670},{"_17":585,"_19":586,"_25":587,"_81":82,"_29":588},{"_17":459,"_19":460,"_25":461,"_81":82,"_29":462},{"_17":316,"_19":317,"_25":318,"_81":82,"_29":319},{"_17":276,"_19":277,"_25":278,"_81":82,"_29":279},{"_17":172,"_19":173,"_25":174,"_81":82,"_29":175},{"_17":130,"_19":131,"_25":132,"_81":82,"_29":133},{"_17":78,"_19":79,"_25":80,"_81":82,"_29":83},{"_21":128,"_94":129},"flow/tutorials/index.md","tutorials","hasContent",false,[84,85,86,87,88],{"_17":119,"_19":120,"_25":121,"_81":58,"_29":122},{"_17":112,"_19":113,"_25":114,"_81":58,"_29":115},{"_17":105,"_19":106,"_25":107,"_81":58,"_29":108},{"_17":98,"_19":99,"_25":100,"_81":58,"_29":101},{"_17":89,"_19":90,"_25":91,"_81":58,"_29":92},{"_21":93,"_94":95,"_96":97,"_39":40},"flow/tutorials/manual-approval-output.md","tutorials/manual-approval-output",[],"Use an approval's results","order",5,"description","Pause a workflow for a person's approval, then email who decided, when, and what they said.",{"_21":102,"_94":103,"_96":104,"_39":40},"flow/tutorials/github-teams.md","tutorials/github-teams",[],"GitHub teams and members",4,"Create a GitHub team, invite a person to the organisation and the team, then delete the team again.",{"_21":109,"_94":110,"_96":111,"_39":40},"flow/tutorials/box-file-download.md","tutorials/box-file-download",[],"Email a file from Box",3,"Download a file shared on Box into the run workspace, then send it as an email attachment with SendGrid.",{"_21":116,"_94":117,"_96":118,"_39":40},"flow/tutorials/github-issues-bot.md","tutorials/github-issues-bot",[],"GitHub issues bot",2,"Mark inactive GitHub issues as stale each week, and close the ones nobody picked up.",{"_21":123,"_124":125,"_94":126,"_96":127,"_39":40},"flow/tutorials/pass-results-with-an-approval.md","tutorials/pass-results-with-an-approval",[],"Pass results between tasks with an approval","sidebarTitle","Pass results with an approval",1,"Build a workflow in which one task returns a result, a person approves, and a later task prints both, with no accounts outside Flow.","Tutorials",10,{"_21":170,"_94":171},"flow/extend/index.md","extend",[134,135,136,137,138],{"_17":164,"_19":165,"_25":166,"_81":58,"_29":167},{"_17":158,"_19":159,"_25":160,"_81":58,"_29":161},{"_17":152,"_19":153,"_25":154,"_81":58,"_29":155},{"_17":145,"_19":146,"_25":147,"_81":58,"_29":148},{"_17":139,"_19":140,"_25":141,"_81":58,"_29":142},{"_21":143,"_94":95,"_96":144,"_39":40},"flow/extend/embed-flow.md","extend/embed-flow",[],"Embed Flow","Use Flow as the workflow engine inside a host product, choose a deployment shape, call it with flow-sdk, run its tasks and read results back.",{"_21":149,"_124":150,"_94":103,"_96":151,"_39":40},"flow/extend/dispatcher-protocol.md","extend/dispatcher-protocol",[],"Dispatcher protocol reference","Dispatcher protocol","The rules of Flow's dispatcher protocol for registration, polling and filters, claims, start and end, requeues, terminate orders, leases, logs, storage, traces and compatibility.",{"_21":156,"_94":110,"_96":157,"_39":40},"flow/extend/write-a-dispatcher.md","extend/write-a-dispatcher",[],"Write a dispatcher","Write a dispatcher with the Java dispatcher SDK, implement TaskHandler, pick a shape and test it.",{"_21":162,"_94":117,"_96":163,"_39":40},"flow/extend/task-contract.md","extend/task-contract",[],"Task container contract","The exact contract between Flow and a task's container, including environment variables, parameter references, results, size caps, catalogue images and AI tasks.",{"_21":168,"_94":126,"_96":169,"_39":40},"flow/extend/api-quickstart.md","extend/api-quickstart",[],"Make your first API call","Create a workspace token, list your workspaces, start a workflow run and read its status with Flow's REST API, in about 5 minutes.","Extend Flow",9,{"_21":275,"_94":228},"flow/hosting/index.md","hosting",[176,177,178,179,180,181,182,183,184,185,186,187,188],{"_17":269,"_19":270,"_25":271,"_81":58,"_29":272},{"_17":263,"_19":264,"_25":265,"_81":58,"_29":266},{"_17":257,"_19":258,"_25":259,"_81":58,"_29":260},{"_17":251,"_19":252,"_25":253,"_81":58,"_29":254},{"_17":245,"_19":246,"_25":247,"_81":58,"_29":248},{"_17":238,"_19":239,"_25":240,"_81":58,"_29":241},{"_17":230,"_19":231,"_25":232,"_81":58,"_29":233},{"_17":223,"_19":224,"_25":225,"_81":58,"_29":226},{"_17":217,"_19":218,"_25":219,"_81":58,"_29":220},{"_17":210,"_19":211,"_25":212,"_81":58,"_29":213},{"_17":203,"_19":204,"_25":205,"_81":58,"_29":206},{"_17":196,"_19":197,"_25":198,"_81":58,"_29":199},{"_17":189,"_19":190,"_25":191,"_81":58,"_29":192},{"_21":193,"_94":194,"_96":195,"_39":40},"flow/hosting/integrations.md","hosting/integrations",[],"Integrations",13,"Set up the platform's GitHub App and Slack app, and what the Google and Microsoft integrations need.",{"_21":200,"_94":201,"_96":202,"_39":40},"flow/hosting/task-logs.md","hosting/task-logs",[],"Task logs",12,"Keep finished task logs in the artifact store, follow running tasks through the dispatcher, and read live logs from Loki.",{"_21":207,"_94":208,"_96":209,"_39":40},"flow/hosting/dispatcher.md","hosting/dispatcher",[],"Run the dispatcher",11,"Deploy Flow's Kubernetes dispatcher, choose its executor and task types, grant its permissions, and size, place and clean up task pods.",{"_21":214,"_124":215,"_94":129,"_96":216,"_39":40},"flow/hosting/rolling-upgrades.md","hosting/rolling-upgrades",[],"Upgrade between v5 releases","Rolling upgrades","Roll out a later Flow v5 release with a rolling update while the previous release keeps serving.",{"_21":221,"_94":171,"_96":222,"_39":40},"flow/hosting/upgrading.md","hosting/upgrading",[],"Upgrade from v3","Take a Flow v3 installation to v5 in place, from the backup and the encryption pair through the first start to the checks and clean-up afterwards.",{"_21":227,"_94":228,"_96":229,"_39":40},"flow/hosting/machine-tokens.md","hosting/machine-tokens",[],"Machine tokens",8,"Give services and dispatchers their own Flow credentials, declare them in configuration, and rotate them without a gap.",{"_21":234,"_124":235,"_94":236,"_96":237,"_39":40},"flow/hosting/sign-in.md","hosting/sign-in",[],"Sign-in and the first admin","Sign-in",7,"Choose how people sign in to Flow, make the first admin, and decide who else may sign in.",{"_21":242,"_94":243,"_96":244,"_39":40},"flow/hosting/settings-reference.md","hosting/settings-reference",[],"All settings",6,"Every setting in Flow v5's Admin › Settings, by group, with its key, type, default and description.",{"_21":249,"_94":95,"_96":250,"_39":40},"flow/hosting/properties-reference.md","hosting/properties-reference",[],"All properties","Every property in Flow v5 core's and dispatcher's application.properties, with its environment variable, default and description.",{"_21":255,"_94":103,"_96":256,"_39":40},"flow/hosting/configuration-reference.md","hosting/configuration-reference",[],"Configuration reference","The properties and environment variables that configure Flow v5's core, webapp and dispatcher link, grouped by area, with their defaults.",{"_21":261,"_94":110,"_96":262,"_39":40},"flow/hosting/configuring.md","hosting/configuring",[],"Configuring","Set the properties, routes and probes a Flow v5 deployment needs, and connect Flow to its dispatcher.",{"_21":267,"_94":117,"_96":268,"_39":40},"flow/hosting/installing.md","hosting/installing",[],"Installing","What a Flow v5 install needs, how to try it locally with Docker Compose, and how to deploy it to Kubernetes.",{"_21":273,"_94":126,"_96":274,"_39":40},"flow/hosting/quickstart.md","hosting/quickstart",[],"Try Flow locally","Run Boomerang Flow on a laptop with Docker Compose and a local Kubernetes, sign in, and run a first workflow, in about 10 minutes.","Self Hosting",{"_21":315,"_94":236},"flow/architecture/index.md","architecture",[280,281,282,283,284],{"_17":309,"_19":310,"_25":311,"_81":58,"_29":312},{"_17":303,"_19":304,"_25":305,"_81":58,"_29":306},{"_17":297,"_19":298,"_25":299,"_81":58,"_29":300},{"_17":291,"_19":292,"_25":293,"_81":58,"_29":294},{"_17":285,"_19":286,"_25":287,"_81":58,"_29":288},{"_21":289,"_94":243,"_96":290,"_39":40},"flow/architecture/infrastructure.md","architecture/infrastructure",[],"Infrastructure","What a Flow deployment runs on, and what Flow's Kubernetes dispatcher creates in your cluster for each task and run.",{"_21":295,"_94":95,"_96":296,"_39":40},"flow/architecture/security.md","architecture/security",[],"Security","How Flow authenticates callers, authorises requests, protects secrets, isolates tasks and keeps an audit trail.",{"_21":301,"_94":103,"_96":302,"_39":40},"flow/architecture/dispatchers.md","architecture/dispatchers",[],"Dispatchers","What a dispatcher is, where one runs, and how it claims, runs and reports task runs.",{"_21":307,"_94":117,"_96":308,"_39":40},"flow/architecture/eventing.md","architecture/eventing",[],"Webhooks and events","The routes that start and resume runs from other systems, and the CloudEvents Flow sends when a run's status changes.",{"_21":313,"_94":126,"_96":314,"_39":40},"flow/architecture/overview.md","architecture/overview",[],"Overview","How Flow is built, how a workflow run moves from submit to finish, and how Flow scales.","Architecture",{"_21":458,"_94":243},"flow/apis/index.md","apis",[320,321,322,323,324,325,326,327,328,329,330,331,332,333,334,335,336,337,338,339],{"_17":453,"_19":454,"_25":455,"_81":58,"_29":456},{"_17":447,"_19":448,"_25":449,"_81":58,"_29":450},{"_17":441,"_19":442,"_25":443,"_81":58,"_29":444},{"_17":435,"_19":436,"_25":437,"_81":58,"_29":438},{"_17":429,"_19":430,"_25":431,"_81":58,"_29":432},{"_17":423,"_19":424,"_25":425,"_81":58,"_29":426},{"_17":418,"_19":419,"_25":420,"_81":58,"_29":421},{"_17":412,"_19":413,"_25":414,"_81":58,"_29":415},{"_17":406,"_19":407,"_25":408,"_81":58,"_29":409},{"_17":400,"_19":401,"_25":402,"_81":58,"_29":403},{"_17":394,"_19":395,"_25":396,"_81":58,"_29":397},{"_17":388,"_19":389,"_25":390,"_81":58,"_29":391},{"_17":382,"_19":383,"_25":384,"_81":58,"_29":385},{"_17":376,"_19":377,"_25":378,"_81":58,"_29":379},{"_17":370,"_19":371,"_25":372,"_81":58,"_29":373},{"_17":364,"_19":365,"_25":366,"_81":58,"_29":367},{"_17":358,"_19":359,"_25":360,"_81":58,"_29":361},{"_17":352,"_19":353,"_25":354,"_81":58,"_29":355},{"_17":346,"_19":347,"_25":348,"_81":58,"_29":349},{"_17":340,"_19":341,"_25":342,"_81":58,"_29":343},{"_21":344,"_96":345,"_39":40},"flow/apis/WorkspaceTasksRoute.md","apis/WorkspaceTasksRoute",[],"Workspace Tasks","Operations for Workspace Tasks: Create and manage the workspace based Task definitions.",{"_21":350,"_96":351,"_39":40},"flow/apis/WorkspaceManagementRoute.md","apis/WorkspaceManagementRoute",[],"Workspace Management","Operations for Workspace Management: Manage Workspaces, Workspace Members, Quotas, ApprovalGroups and Parameters.",{"_21":356,"_96":357,"_39":40},"flow/apis/WorkflowsRoute.md","apis/WorkflowsRoute",[],"Workflows","Operations for Workflows: Create, list, and manage your Workflows.",{"_21":362,"_96":363,"_39":40},"flow/apis/WorkflowRunsRoute.md","apis/WorkflowRunsRoute",[],"Workflow Runs","Operations for Workflow Runs: Submit requests to execute Workflows and provide the ability to search and retrieve Workflow activities.",{"_21":368,"_96":369,"_39":40},"flow/apis/WebhooksAndEventsRoute.md","apis/WebhooksAndEventsRoute",[],"Webhooks and Events","Operations for Webhooks and Events: Listen for Events or Webhook requests to trigger Workflows and provide the ability to resolve Wait For Event TaskRuns.",{"_21":374,"_96":375,"_39":40},"flow/apis/UsersRoute.md","apis/UsersRoute",[],"Users","Operations for Users: List, Create, update and delete Users.",{"_21":380,"_96":381,"_39":40},"flow/apis/TokenManagementRoute.md","apis/TokenManagementRoute",[],"Token Management","Operations for Token Management: Create and retrieve Tokens.",{"_21":386,"_96":387,"_39":40},"flow/apis/TasksRoute.md","apis/TasksRoute",[],"Tasks","Operations for Tasks: Create and Manage the global Task definitions.",{"_21":392,"_96":393,"_39":40},"flow/apis/TaskRunsRoute.md","apis/TaskRunsRoute",[],"Task Runs","Operations for Task Runs: View, Start, Stop, and Update Status of your Task Runs.",{"_21":398,"_96":399,"_39":40},"flow/apis/SystemRoute.md","apis/SystemRoute",[],"System","Operations for System: Register the instance, retrieve context and navigation, and manage global admin areas.",{"_21":404,"_96":405,"_39":40},"flow/apis/SchedulesRoute.md","apis/SchedulesRoute",[],"Schedules","Operations for Schedules: Create, list and manage your Schedules.",{"_21":410,"_96":411,"_39":40},"flow/apis/ProfileRoute.md","apis/ProfileRoute",[],"Profile","Operations for Profile: Retrieve your profile and update your details.",{"_21":416,"_96":417,"_39":40},"flow/apis/ParametersRoute.md","apis/ParametersRoute",[],"Parameters","Operations for Parameters: Create, update and delete global parameters, available to every workspace and workflow.",{"_21":193,"_96":422,"_39":40},"flow/apis/IntegrationsRoute.md","apis/IntegrationsRoute",[],"Operations for Integrations: Handles the integrations with 3rd parties such as Slack and GitHub.",{"_21":427,"_96":428,"_39":40},"flow/apis/InsightsRoute.md","apis/InsightsRoute",[],"Insights","Operations for Insights: Provide the ability to search and retrieve Insights.",{"_21":433,"_96":434,"_39":40},"flow/apis/AuditRoute.md","apis/AuditRoute",[],"Audit","Operations for Audit: Query the security audit trail: who did what, when, and with what outcome.",{"_21":439,"_96":440,"_39":40},"flow/apis/ArtifactsRoute.md","apis/ArtifactsRoute",[],"Artifacts","Operations for Artifacts: List, download and delete the files tasks upload to runs.",{"_21":445,"_96":446,"_39":40},"flow/apis/ActionsRoute.md","apis/ActionsRoute",[],"Actions","Operations for Actions: Create and manage Manual and Approval Actions.",{"_21":451,"_94":117,"_96":452,"_39":40},"flow/apis/changelog.md","apis/changelog",[],"API changelog","What changed in Flow's REST API from the v4 contract to v5, operation by operation.",{"_21":313,"_94":126,"_96":457,"_39":40},"flow/apis/overview.md","apis/overview",[],"What every Flow API route has in common, and an index of the routes and models.","API Reference",{"_21":583,"_94":95},"flow/catalogue/index.md","catalogue",[463,464,465,466,467,468,469,470,471,472,473,474,475,476,477,478,479],{"_17":579,"_19":580,"_25":581,"_81":58,"_29":582},{"_17":573,"_19":574,"_25":575,"_81":58,"_29":576},{"_17":567,"_19":568,"_25":569,"_81":58,"_29":570},{"_17":561,"_19":562,"_25":563,"_81":58,"_29":564},{"_17":556,"_19":557,"_25":558,"_81":58,"_29":559},{"_17":550,"_19":551,"_25":552,"_81":58,"_29":553},{"_17":544,"_19":545,"_25":546,"_81":58,"_29":547},{"_17":538,"_19":539,"_25":540,"_81":58,"_29":541},{"_17":532,"_19":533,"_25":534,"_81":58,"_29":535},{"_17":526,"_19":527,"_25":528,"_81":58,"_29":529},{"_17":520,"_19":521,"_25":522,"_81":58,"_29":523},{"_17":514,"_19":515,"_25":516,"_81":58,"_29":517},{"_17":508,"_19":509,"_25":510,"_81":58,"_29":511},{"_17":501,"_19":502,"_25":503,"_81":58,"_29":504},{"_17":494,"_19":495,"_25":496,"_81":58,"_29":497},{"_17":487,"_19":488,"_25":489,"_81":58,"_29":490},{"_17":480,"_19":481,"_25":482,"_81":58,"_29":483},{"_21":484,"_94":485,"_96":486,"_39":40},"flow/catalogue/utilities.md","catalogue/utilities",[],"Utilities",17,"The Utilities tasks in the Flow catalogue, with each task's parameters, results and image.",{"_21":491,"_94":492,"_96":493,"_39":40},"flow/catalogue/sharepoint.md","catalogue/sharepoint",[],"SharePoint",16,"The SharePoint tasks in the Flow catalogue, with each task's parameters, results and image.",{"_21":498,"_94":499,"_96":500,"_39":40},"flow/catalogue/servicenow.md","catalogue/servicenow",[],"ServiceNow",15,"The ServiceNow tasks in the Flow catalogue, with each task's parameters, results and image.",{"_21":505,"_94":506,"_96":507,"_39":40},"flow/catalogue/microsoft-teams.md","catalogue/microsoft-teams",[],"Microsoft Teams",14,"The Microsoft Teams tasks in the Flow catalogue, with each task's parameters, results and image.",{"_21":512,"_94":194,"_96":513,"_39":40},"flow/catalogue/ibm-services-essentials.md","catalogue/ibm-services-essentials",[],"IBM Services Essentials","The IBM Services Essentials tasks in the Flow catalogue, with each task's parameters, results and image.",{"_21":518,"_94":201,"_96":519,"_39":40},"flow/catalogue/google-sheets.md","catalogue/google-sheets",[],"Google Sheets","The Google Sheets tasks in the Flow catalogue, with each task's parameters, results and image.",{"_21":524,"_94":208,"_96":525,"_39":40},"flow/catalogue/google-drive.md","catalogue/google-drive",[],"Google Drive","The Google Drive tasks in the Flow catalogue, with each task's parameters, results and image.",{"_21":530,"_94":129,"_96":531,"_39":40},"flow/catalogue/github.md","catalogue/github",[],"GitHub","The GitHub tasks in the Flow catalogue, with each task's parameters, results and image.",{"_21":536,"_94":171,"_96":537,"_39":40},"flow/catalogue/file-utilities.md","catalogue/file-utilities",[],"File Utilities","The File Utilities tasks in the Flow catalogue, with each task's parameters, results and image.",{"_21":542,"_94":228,"_96":543,"_39":40},"flow/catalogue/communication-with-slack.md","catalogue/communication-with-slack",[],"Communication with Slack","The Communication with Slack tasks in the Flow catalogue, with each task's parameters, results and image.",{"_21":548,"_94":236,"_96":549,"_39":40},"flow/catalogue/communication.md","catalogue/communication",[],"Communication","The Communication tasks in the Flow catalogue, with each task's parameters, results and image.",{"_21":554,"_94":243,"_96":555,"_39":40},"flow/catalogue/box.md","catalogue/box",[],"Box","The Box tasks in the Flow catalogue, with each task's parameters, results and image.",{"_21":439,"_94":95,"_96":560,"_39":40},"flow/catalogue/artifacts.md","catalogue/artifacts",[],"The Artifacts tasks in the Flow catalogue, with each task's parameters, results and image.",{"_21":565,"_94":103,"_96":566,"_39":40},"flow/catalogue/artifactory.md","catalogue/artifactory",[],"Artifactory","The Artifactory tasks in the Flow catalogue, with each task's parameters, results and image.",{"_21":571,"_94":110,"_96":572,"_39":40},"flow/catalogue/ai.md","catalogue/ai",[],"AI","The AI tasks in the Flow catalogue, with each task's parameters, results and image.",{"_21":577,"_94":117,"_96":578,"_39":40},"flow/catalogue/workflow.md","catalogue/workflow",[],"Workflow","The Workflow tasks in the Flow catalogue, with each task's parameters, results and image.",{"_21":583,"_124":313,"_94":126,"_96":584,"_39":40},"flow/catalogue/overview.md","catalogue/overview",[],"Task catalogue","The tasks Flow ships in its catalogue, by palette category, and how to read each entry.",{"_21":666,"_94":103},"flow/guides/index.md","guides",[589,590,591,592,593,594,595,596,597,598,599],{"_17":660,"_19":661,"_25":662,"_81":58,"_29":663},{"_17":654,"_19":655,"_25":656,"_81":58,"_29":657},{"_17":648,"_19":649,"_25":650,"_81":58,"_29":651},{"_17":642,"_19":643,"_25":644,"_81":58,"_29":645},{"_17":636,"_19":637,"_25":638,"_81":58,"_29":639},{"_17":630,"_19":631,"_25":632,"_81":58,"_29":633},{"_17":624,"_19":625,"_25":626,"_81":58,"_29":627},{"_17":618,"_19":619,"_25":620,"_81":58,"_29":621},{"_17":612,"_19":613,"_25":614,"_81":58,"_29":615},{"_17":606,"_19":607,"_25":608,"_81":58,"_29":609},{"_17":600,"_19":601,"_25":602,"_81":58,"_29":603},{"_21":604,"_94":208,"_96":605,"_39":40},"flow/guides/tasks.md","guides/tasks",[],"Develop a task","Build a container that Flow runs as a task, read its parameters, return results within the size caps, and add it to a workspace in Task Manager.",{"_21":610,"_94":129,"_96":611,"_39":40},"flow/guides/retry-a-run.md","guides/retry-a-run",[],"Retry a run","Retry a finished run from the start, from the tasks that failed or from a task you choose, and let a task retry its own failures.",{"_21":616,"_94":171,"_96":617,"_39":40},"flow/guides/use-secrets.md","guides/use-secrets",[],"Use secrets","Keep tokens and passwords in secured parameters, use them in tasks, rotate them, and know where Flow can and can't hide them.",{"_21":622,"_94":228,"_96":623,"_39":40},"flow/guides/connect-github.md","guides/connect-github",[],"Connect GitHub","Connect a workspace to GitHub, share the installation token with GitHub tasks, and start workflows from GitHub events.",{"_21":628,"_94":236,"_96":629,"_39":40},"flow/guides/keep-files-between-runs.md","guides/keep-files-between-runs",[],"Keep files between runs","Carry files from one run of a workflow to the next with Download Artifact and Upload Artifact at scope Workflow.",{"_21":634,"_94":243,"_96":635,"_39":40},"flow/guides/use-ai-tasks.md","guides/use-ai-tasks",[],"Use AI tasks","Call an OpenAI-compatible model from a workflow with AI Prompt or AI Agent, use the reply, and see token usage in Insights.",{"_21":640,"_94":95,"_96":641,"_39":40},"flow/guides/repeat-a-task-for-each-item.md","guides/repeat-a-task-for-each-item",[],"Repeat a task for each item","Run one task once per item of a JSON array, in parallel within one run, and collect its results in item order.",{"_21":646,"_94":103,"_96":647,"_39":40},"flow/guides/run.md","guides/run",[],"Run a workflow","Start a run from a workflow's card, give it parameter values, open the run, and find out why Run it is disabled.",{"_21":652,"_94":110,"_96":653,"_39":40},"flow/guides/configure-workflow.md","guides/configure-workflow",[],"Configure a workflow","Set a workflow's name and labels, what starts it, its timeout, retries and concurrency, the run workspace its tasks share, its kept artifacts and its tokens.",{"_21":658,"_94":117,"_96":659,"_39":40},"flow/guides/workflow-editor.md","guides/workflow-editor",[],"Workflow editor","Add and configure tasks in the workflow editor, link them, branch with a switch, add parameters and notes, and save versions.",{"_21":664,"_94":126,"_96":665,"_39":40},"flow/guides/create.md","guides/create",[],"Create a workflow","Create a workflow from scratch, from a starter or from a file, then find, duplicate, export, update and delete the workflows in a workspace.","Guides",{"_21":724,"_94":110},"flow/webapp/index.md","webapp",[671,672,673,674,675,676,677,678],{"_17":718,"_19":719,"_25":720,"_81":58,"_29":721},{"_17":712,"_19":713,"_25":714,"_81":58,"_29":715},{"_17":707,"_19":708,"_25":709,"_81":58,"_29":710},{"_17":702,"_19":703,"_25":704,"_81":58,"_29":705},{"_17":697,"_19":698,"_25":699,"_81":58,"_29":700},{"_17":691,"_19":692,"_25":693,"_81":58,"_29":694},{"_17":685,"_19":686,"_25":687,"_81":58,"_29":688},{"_17":679,"_19":680,"_25":681,"_81":58,"_29":682},{"_21":683,"_94":228,"_96":684,"_39":40},"flow/webapp/administer.md","webapp/administer",[],"Admin","What platform admins manage on Flow's Admin page, from settings, workspaces and users to global parameters, tokens, the task catalogue and the audit trail.",{"_21":689,"_94":236,"_96":690,"_39":40},"flow/webapp/quotas.md","webapp/quotas",[],"Quotas","The limits on what one workspace can use, their defaults, what 0 and an unset quota mean, and where to change them.",{"_21":695,"_94":243,"_96":696,"_39":40},"flow/webapp/manage.md","webapp/manage",[],"Manage workspace","Manage one workspace's members and roles, approver groups, artifacts, quotas, tokens, name, labels and deletion.",{"_21":193,"_94":95,"_96":701,"_39":40},"flow/webapp/integrations.md","webapp/integrations",[],"Connect a workspace to GitHub, Slack, Google or Microsoft, and share their credentials with the catalogue tasks as workspace parameters.",{"_21":404,"_94":103,"_96":706,"_39":40},"flow/webapp/schedules.md","webapp/schedules",[],"Run a workflow once at a set time or on a repeating timetable, with the parameter values each run starts with.",{"_21":427,"_94":110,"_96":711,"_39":40},"flow/webapp/insights.md","webapp/insights",[],"How reliable and how fast a workspace's workflows are over a period, where their time goes, and why they fail.",{"_21":716,"_94":117,"_96":717,"_39":40},"flow/webapp/activity.md","webapp/activity",[],"Activity","Find any run of a workspace's workflows, filter by workflow, status, trigger and date, and open it.",{"_21":722,"_94":126,"_96":723,"_39":40},"flow/webapp/home.md","webapp/home",[],"Home","What the Home page shows when you sign in to Flow, and what you can do from it.","Using the webapp",{"_21":774,"_94":117},"flow/fundamentals/index.md","fundamentals",[729,730,731,732,733,734,735],{"_17":769,"_19":770,"_25":771,"_81":58,"_29":772},{"_17":764,"_19":765,"_25":766,"_81":58,"_29":767},{"_17":758,"_19":759,"_25":760,"_81":58,"_29":761},{"_17":753,"_19":754,"_25":755,"_81":58,"_29":756},{"_17":747,"_19":748,"_25":749,"_81":58,"_29":750},{"_17":741,"_19":742,"_25":743,"_81":58,"_29":744},{"_17":736,"_19":737,"_25":738,"_81":58,"_29":739},{"_21":445,"_94":236,"_96":740,"_39":40},"flow/fundamentals/actions.md","fundamentals/actions",[],"Approvals and manual tasks, the points in a workflow where a person decides, and where to answer them.",{"_21":745,"_124":439,"_94":243,"_96":746,"_39":40},"flow/fundamentals/artifacts.md","fundamentals/artifacts",[],"Artifacts and the run workspace","Share files between the tasks of one run with the run workspace, and keep files after a run, or between runs, as artifacts.",{"_21":751,"_94":95,"_96":752,"_39":40},"flow/fundamentals/triggers.md","fundamentals/triggers",[],"Triggers","The five ways a workflow run can start, and how to call the webhook, event and callback routes.",{"_21":416,"_94":103,"_96":757,"_39":40},"flow/fundamentals/parameters.md","fundamentals/parameters",[],"The layers a parameter comes from, how to reference one, which value wins, when values resolve, and how secured parameters stay hidden.",{"_21":762,"_94":110,"_96":763,"_39":40},"flow/fundamentals/runs.md","fundamentals/runs",[],"Runs","How a workflow run moves from start to finish, and how to pause, cancel, retry, time-limit and nest runs.",{"_21":386,"_94":117,"_96":768,"_39":40},"flow/fundamentals/tasks.md","fundamentals/tasks",[],"What a task is, the catalogue Flow ships, the task types, and how to add your own tasks in Task Manager.",{"_21":356,"_94":126,"_96":773,"_39":40},"flow/fundamentals/workflows.md","fundamentals/workflows",[],"What a workflow is, and how to find, run and manage the workflows in a workspace.","Concepts",{"_21":844,"_94":126},"flow/introduction/index.md","introduction",[779,780,781,782,783,784,785,786,787],{"_17":838,"_19":839,"_25":840,"_81":58,"_29":841},{"_17":832,"_19":833,"_25":834,"_81":58,"_29":835},{"_17":826,"_19":827,"_25":828,"_81":58,"_29":829},{"_17":820,"_19":821,"_25":822,"_81":58,"_29":823},{"_17":813,"_19":814,"_25":815,"_81":58,"_29":816},{"_17":807,"_19":808,"_25":809,"_81":58,"_29":810},{"_17":801,"_19":802,"_25":803,"_81":58,"_29":804},{"_17":795,"_19":796,"_25":797,"_81":58,"_29":798},{"_17":788,"_19":789,"_25":790,"_81":58,"_29":791},{"_21":792,"_94":171,"_96":793,"_39":40,"_794":82},"flow/introduction/glossary.md","introduction/glossary",[],"Glossary","The terms Boomerang Flow and these docs use, each defined in a sentence or two, with a link to the page that explains it.","toc",{"_21":799,"_94":228,"_96":800,"_39":40},"flow/introduction/whats-new.md","introduction/whats-new",[],"What's new","What changed in Boomerang Flow 5.0.0, for anyone coming from Flow 3.",{"_21":805,"_94":236,"_96":806,"_39":40},"flow/introduction/release-notes.md","introduction/release-notes",[],"Release notes","Every change in each Boomerang Flow release, newest first, with the upgrade steps each one needs.",{"_21":811,"_94":243,"_96":812,"_39":40},"flow/introduction/known-issues.md","introduction/known-issues",[],"Known issues","Defects in Boomerang Flow 5.0.0 that you might hit, with a workaround for each where there is one.",{"_21":817,"_124":818,"_94":95,"_96":819,"_39":40},"flow/introduction/faq.md","introduction/faq",[],"Frequently asked questions","FAQ","Short answers to common questions about workflows, tasks, timings and limits in Boomerang Flow.",{"_21":824,"_94":103,"_96":825,"_39":40},"flow/introduction/error-codes.md","introduction/error-codes",[],"Error codes","The error codes Flow's API returns and the status reasons a task or run ends with, each with its message, why it happens and what to do.",{"_21":830,"_94":110,"_96":831,"_39":40},"flow/introduction/troubleshooting.md","introduction/troubleshooting",[],"Troubleshooting","What to check when a run doesn't start, a task fails or waits, a trigger does nothing, sign-in fails or a log is empty, with Flow's exact messages.",{"_21":836,"_94":117,"_96":837,"_39":40},"flow/introduction/getting-started.md","introduction/getting-started",[],"Getting started","Build and run your first workflow, from signing in to a succeeded run in Activity.",{"_21":842,"_94":126,"_96":843,"_39":40},"flow/introduction/flow-in-five-minutes.md","introduction/flow-in-five-minutes",[],"Flow in five minutes","The pieces Boomerang Flow is made of, and what happens when a workflow runs, before you build your first one.","Introduction","host","www.useboomerang.io","isProductionHost","noIndex"]