Whether to wait for the task to complete before returning the response. If false, the task will be executed in the background and the response will contain only the task ID.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"WebAgent docs","colors":{"primary":"#3b82f6","light":"#8b5cf6","dark":"#8b5cf6"},"logo":{"light":"https://mintcdn.com/webagent/cAV0xGVbWBt6tXr-/logo/logo-webagent.png?fit=max\u0026auto=format\u0026n=cAV0xGVbWBt6tXr-\u0026q=85\u0026s=2883b00d84790dceab585da18f2d19f9","dark":"https://mintcdn.com/webagent/cAV0xGVbWBt6tXr-/logo/logo-webagent.png?fit=max\u0026auto=format\u0026n=cAV0xGVbWBt6tXr-\u0026q=85\u0026s=2883b00d84790dceab585da18f2d19f9"},"favicon":"/logo/logo.png","appearance":{"default":"light","strict":true},"navbar":{"links":[{"href":"mailto:contact@webagent.cloud","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://webagent.cloud"}},"footer":{"socials":{"github":"https://github.com/webagent-cloud/webagent"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Documentation","icon":"book-open-cover","href":"https://docs.webagent.cloud"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"webagent","hasAudioNarration":false,"actualSubdomain":"webagent","customDomains":["docs.webagent.cloud"],"gitSource":{"type":"github","owner":"webagent-cloud","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a20c884fcd0b581d3e6f577","collectionId":"1bdd4883-6c64-405d-bd6a-a55129c3274e","schemaVersion":"v2"},"entitlements":{},"buildId":"6a20c884fcd0b581d3e6f577:success","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"Self-Hosted API Reference","count":9},{"language":"default","tag":"API Reference","count":9},{"language":"default","tag":"Cloud API Reference","count":8},{"language":"default","tag":"Guides","count":7},{"language":"default","tag":"Integrations","count":5},{"language":"default","tag":"run","count":5},{"language":"default","tag":"API Documentation","count":2},{"language":"default","tag":"Get Started","count":2},{"language":"default","tag":"auth-contexts","count":1}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","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":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"self-hosted-api-reference/run-agent","slug":"/self-hosted-api-reference/run-agent","pageMetadata":{"title":"Run Agent","description":null,"deprecated":null,"version":null,"openapi":"self-hosted-api-reference/openapi.json post /api/runs","href":"/self-hosted-api-reference/run-agent","autogeneratedByOpenApi":true,"hidden":false},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Run Agent","description":null,"deprecated":null,"version":null,"openapi":"self-hosted-api-reference/openapi.json post /api/runs","href":"/self-hosted-api-reference/run-agent","autogeneratedByOpenApi":true,"hidden":false}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Run Agent","operationId":"run_agent_api_runs_post","requestBody":"e4545172-ffa2-40d4-8edf-43d8257e67b1","responses":{"200":"4a23a832-821e-4abb-b696-67b8429b3683","422":"e04c109c-a7d6-486c-a5d3-2d014d26a327"},"method":"post","type":"path","servers":[],"security":[],"path":"/api/runs","baseUrlOptions":[],"title":"Run Agent","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"properties":{"prompt":{"type":"string","minLength":3,"title":"Prompt","description":"The task to be performed by the agent","isRequired":true,"uniqueKey":"prompt","typeLabel":"string"},"model":{"type":"string","title":"Model","default":"o3","uniqueKey":"model","typeLabel":"string"},"provider":{"type":"string","enum":["openai","deepseek","anthropic","google","groq","mistral","together"],"title":"ProviderEnum","default":"openai","uniqueKey":"provider","typeLabel":"enum\u003cstring>"},"wait_for_completion":{"oneOf":[{"type":"boolean","title":"Wait For Completion","description":"Whether to wait for the task to complete before returning the response. If false, the task will be executed in the background and the response will contain only the task ID.","default":true,"uniqueKey":"wait_for_completion.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Wait For Completion","description":"Whether to wait for the task to complete before returning the response. If false, the task will be executed in the background and the response will contain only the task ID.","default":true,"uniqueKey":"wait_for_completion.oneOf.1","typeLabel":"null"}],"uniqueKey":"wait_for_completion","typeLabel":"boolean | null"},"webhook_url":{"oneOf":[{"type":"string","title":"Webhook Url","description":"URL to send webhook notification when task is complete","uniqueKey":"webhook_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Webhook Url","description":"URL to send webhook notification when task is complete","uniqueKey":"webhook_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"webhook_url","typeLabel":"string | null"},"response_format":{"oneOf":[{"type":"string","title":"Response Format","description":"Whether to return the result as text or JSON","default":"text","uniqueKey":"response_format.oneOf.0","typeLabel":"string"},{"type":"null","title":"Response Format","description":"Whether to return the result as text or JSON","default":"text","uniqueKey":"response_format.oneOf.1","typeLabel":"null"}],"uniqueKey":"response_format","typeLabel":"string | null"},"json_schema":{"oneOf":[{"type":"string","title":"Json Schema","description":"The JSON schema for the task result","uniqueKey":"json_schema.oneOf.0","typeLabel":"string"},{"type":"object","title":"Json Schema","description":"The JSON schema for the task result","additionalProperties":true,"uniqueKey":"json_schema.oneOf.1","typeLabel":"Json Schema · object"},{"type":"null","title":"Json Schema","description":"The JSON schema for the task result","uniqueKey":"json_schema.oneOf.2","typeLabel":"null"}],"uniqueKey":"json_schema","typeLabel":"string | Json Schema · object | null"},"use_cached_workflow":{"oneOf":[{"type":"boolean","title":"Use Cached Workflow","description":"Internal field: whether to use cached workflow","uniqueKey":"use_cached_workflow.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Use Cached Workflow","description":"Internal field: whether to use cached workflow","uniqueKey":"use_cached_workflow.oneOf.1","typeLabel":"null"}],"uniqueKey":"use_cached_workflow","typeLabel":"boolean | null"},"cached_workflow":{"oneOf":[{"type":"object","title":"Cached Workflow","description":"Internal field: the cached workflow data","additionalProperties":true,"uniqueKey":"cached_workflow.oneOf.0","typeLabel":"Cached Workflow · object"},{"type":"null","title":"Cached Workflow","description":"Internal field: the cached workflow data","uniqueKey":"cached_workflow.oneOf.1","typeLabel":"null"}],"uniqueKey":"cached_workflow","typeLabel":"Cached Workflow · object | null"}},"type":"object","required":["prompt"],"title":"AgentRequest","uniqueKey":"","typeLabel":"AgentRequest · object"},"examples":{"Example":{"title":"Example","value":{"prompt":"\u003cstring>","model":"o3","provider":"openai","wait_for_completion":true,"webhook_url":"\u003cstring>","response_format":"text","json_schema":"\u003cstring>","use_cached_workflow":true,"cached_workflow":{}}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"4a23a832-821e-4abb-b696-67b8429b3683":{"description":"Successful Response","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"AgentResponse","description":"Represents the complete response from the agent.","properties":{"task_id":{"oneOf":[{"type":"integer","title":"Task Id","description":"The ID of the task","uniqueKey":"oneOf.0.task_id.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Task Id","description":"The ID of the task","uniqueKey":"oneOf.0.task_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.task_id","typeLabel":"integer | null"},"task_run_id":{"oneOf":[{"type":"integer","title":"Task Run Id","description":"The ID of the task run","uniqueKey":"oneOf.0.task_run_id.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Task Run Id","description":"The ID of the task run","uniqueKey":"oneOf.0.task_run_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.task_run_id","typeLabel":"integer | null"},"history":{"oneOf":[{"type":"array","items":{"properties":{"description":{"oneOf":[{"type":"string","title":"Description","description":"Description of the step","uniqueKey":"oneOf.0.history.oneOf.0.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","title":"Description","description":"Description of the step","uniqueKey":"oneOf.0.history.oneOf.0.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.history.oneOf.0.items.[INDEX].description","typeLabel":"string | null"},"actions":{"oneOf":[{"type":"array","items":{"properties":{"name":{"type":"string","title":"Name","description":"Name of the action","isRequired":true,"uniqueKey":"oneOf.0.history.oneOf.0.items.[INDEX].actions.oneOf.0.items.[INDEX].name","typeLabel":"string"},"params":{"oneOf":[{"type":"object","title":"Params","description":"Parameters for the action","additionalProperties":true,"uniqueKey":"oneOf.0.history.oneOf.0.items.[INDEX].actions.oneOf.0.items.[INDEX].params.oneOf.0","typeLabel":"Params · object"},{"type":"null","title":"Params","description":"Parameters for the action","uniqueKey":"oneOf.0.history.oneOf.0.items.[INDEX].actions.oneOf.0.items.[INDEX].params.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.history.oneOf.0.items.[INDEX].actions.oneOf.0.items.[INDEX].params","typeLabel":"Params · object | null"},"is_done":{"oneOf":[{"type":"boolean","title":"Is Done","description":"Whether the action is done","uniqueKey":"oneOf.0.history.oneOf.0.items.[INDEX].actions.oneOf.0.items.[INDEX].is_done.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Is Done","description":"Whether the action is done","uniqueKey":"oneOf.0.history.oneOf.0.items.[INDEX].actions.oneOf.0.items.[INDEX].is_done.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.history.oneOf.0.items.[INDEX].actions.oneOf.0.items.[INDEX].is_done","typeLabel":"boolean | null"},"success":{"oneOf":[{"type":"boolean","title":"Success","description":"Whether the action was successful","uniqueKey":"oneOf.0.history.oneOf.0.items.[INDEX].actions.oneOf.0.items.[INDEX].success.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Success","description":"Whether the action was successful","uniqueKey":"oneOf.0.history.oneOf.0.items.[INDEX].actions.oneOf.0.items.[INDEX].success.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.history.oneOf.0.items.[INDEX].actions.oneOf.0.items.[INDEX].success","typeLabel":"boolean | null"},"extracted_content":{"oneOf":[{"type":"string","title":"Extracted Content","description":"Content extracted from the action","uniqueKey":"oneOf.0.history.oneOf.0.items.[INDEX].actions.oneOf.0.items.[INDEX].extracted_content.oneOf.0","typeLabel":"string"},{"type":"null","title":"Extracted Content","description":"Content extracted from the action","uniqueKey":"oneOf.0.history.oneOf.0.items.[INDEX].actions.oneOf.0.items.[INDEX].extracted_content.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.history.oneOf.0.items.[INDEX].actions.oneOf.0.items.[INDEX].extracted_content","typeLabel":"string | null"},"error":{"oneOf":[{"type":"string","title":"Error","description":"Error message if any","uniqueKey":"oneOf.0.history.oneOf.0.items.[INDEX].actions.oneOf.0.items.[INDEX].error.oneOf.0","typeLabel":"string"},{"type":"null","title":"Error","description":"Error message if any","uniqueKey":"oneOf.0.history.oneOf.0.items.[INDEX].actions.oneOf.0.items.[INDEX].error.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.history.oneOf.0.items.[INDEX].actions.oneOf.0.items.[INDEX].error","typeLabel":"string | null"},"include_in_memory":{"oneOf":[{"type":"boolean","title":"Include In Memory","description":"Whether to include this action in memory","uniqueKey":"oneOf.0.history.oneOf.0.items.[INDEX].actions.oneOf.0.items.[INDEX].include_in_memory.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Include In Memory","description":"Whether to include this action in memory","uniqueKey":"oneOf.0.history.oneOf.0.items.[INDEX].actions.oneOf.0.items.[INDEX].include_in_memory.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.history.oneOf.0.items.[INDEX].actions.oneOf.0.items.[INDEX].include_in_memory","typeLabel":"boolean | null"}},"type":"object","required":["name"],"title":"Action","description":"Represents an action","uniqueKey":"oneOf.0.history.oneOf.0.items.[INDEX].actions.oneOf.0.items.[INDEX]","typeLabel":"Action · object"},"title":"Actions","description":"List of actions taken in this step","uniqueKey":"oneOf.0.history.oneOf.0.items.[INDEX].actions.oneOf.0","typeLabel":"Action · object[]"},{"type":"null","title":"Actions","description":"List of actions taken in this step","uniqueKey":"oneOf.0.history.oneOf.0.items.[INDEX].actions.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.history.oneOf.0.items.[INDEX].actions","typeLabel":"Action · object[] | null"}},"type":"object","title":"HistoryItem","description":"Represents an individual step in the agent's history.","uniqueKey":"oneOf.0.history.oneOf.0.items.[INDEX]","typeLabel":"HistoryItem · object"},"title":"History","description":"List of steps in the history","uniqueKey":"oneOf.0.history.oneOf.0","typeLabel":"HistoryItem · object[]"},{"type":"null","title":"History","description":"List of steps in the history","uniqueKey":"oneOf.0.history.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.history","typeLabel":"HistoryItem · object[] | null"},"result":{"oneOf":[{"title":"Result","description":"The final result of the agent's task","uniqueKey":"oneOf.0.result.oneOf.0","typeLabel":"any"},{"type":"null","title":"Result","description":"The final result of the agent's task","uniqueKey":"oneOf.0.result.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.result","typeLabel":"any | null"},"is_done":{"oneOf":[{"type":"boolean","title":"Is Done","description":"Whether the agent has completed its task","uniqueKey":"oneOf.0.is_done.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Is Done","description":"Whether the agent has completed its task","uniqueKey":"oneOf.0.is_done.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.is_done","typeLabel":"boolean | null"},"is_successful":{"oneOf":[{"type":"boolean","title":"Is Successful","description":"Whether the agent was successful in completing its task","uniqueKey":"oneOf.0.is_successful.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Is Successful","description":"Whether the agent was successful in completing its task","uniqueKey":"oneOf.0.is_successful.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.is_successful","typeLabel":"boolean | null"},"status":{"type":"string","enum":["success","failure","in_progress"],"title":"StatusEnum","description":"The status of the agent's task","default":"in_progress","uniqueKey":"oneOf.0.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0","typeLabel":"AgentResponse · object"},{"type":"object","title":"AsyncAgentResponse","description":"Represents the response from the async agent endpoint.","required":["task_id","task_run_id"],"properties":{"task_id":{"type":"integer","title":"Task Id","description":"The ID of the created task","isRequired":true,"uniqueKey":"oneOf.1.task_id","typeLabel":"integer"},"task_run_id":{"type":"integer","title":"Task Run Id","description":"The ID of the created task run","isRequired":true,"uniqueKey":"oneOf.1.task_run_id","typeLabel":"integer"}},"uniqueKey":"oneOf.1","typeLabel":"AsyncAgentResponse · object"}],"uniqueKey":"","typeLabel":"AgentResponse · object | AsyncAgentResponse · object"},"examples":{"Example":{"title":"Example","value":{"task_id":123,"task_run_id":123,"history":[{"description":"\u003cstring>","actions":[{"name":"\u003cstring>","params":{},"is_done":true,"success":true,"extracted_content":"\u003cstring>","error":"\u003cstring>","include_in_memory":true}]}],"result":"\u003cunknown>","is_done":true,"is_successful":true,"status":"in_progress"}}},"exampleType":"generated"}},"exampleType":"generated"},"e04c109c-a7d6-486c-a5d3-2d014d26a327":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"type":"array","title":"Detail","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"type":"object","title":"HTTPValidationError","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{}},"originalFileLocation":"self-hosted-api-reference/openapi.json"},"subdomain":"webagent","siteName":"WebAgent docs","title":"Run Agent - WebAgent docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-02-08T00:41:15.814Z","originalFileLocation":"self-hosted-api-reference/run-agent.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";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=\"light\"}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=\"application-name\" content=\"WebAgent docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/webagent/IxFyQivyCIxc8ZJB/_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/webagent/IxFyQivyCIxc8ZJB/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/webagent/IxFyQivyCIxc8ZJB/_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/webagent/IxFyQivyCIxc8ZJB/_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/webagent/IxFyQivyCIxc8ZJB/_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/webagent/IxFyQivyCIxc8ZJB/_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/webagent/IxFyQivyCIxc8ZJB/_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/webagent/IxFyQivyCIxc8ZJB/_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/webagent/IxFyQivyCIxc8ZJB/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Run Agent - WebAgent docs\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"WebAgent docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.webagent.cloud/self-hosted-api-reference/run-agent\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://webagent.mintlify.app/_mintlify/api/og/v2?division=API+Reference\u0026amp;title=Run+Agent\u0026amp;theme=98ef9d4de10687f5da805ac7\u0026amp;signature=be4db989da6ce8801bbd7016c00c4f6a267b2163c61a7e8d7c0d5db112c7164e\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Run Agent - WebAgent docs\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://webagent.mintlify.app/_mintlify/api/og/v2?division=API+Reference\u0026amp;title=Run+Agent\u0026amp;theme=98ef9d4de10687f5da805ac7\u0026amp;signature=be4db989da6ce8801bbd7016c00c4f6a267b2163c61a7e8d7c0d5db112c7164e\">\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/webagent/IxFyQivyCIxc8ZJB/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"WebAgent docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3b82f6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.webagent.cloud/self-hosted-api-reference/run-agent\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/self-hosted-api-reference/run-agent.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.webagent.cloud/#organization\",\"name\":\"WebAgent docs\",\"url\":\"https://docs.webagent.cloud\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/webagent/cAV0xGVbWBt6tXr-/logo/logo-webagent.png?fit=max\u0026auto=format\u0026n=cAV0xGVbWBt6tXr-\u0026q=85\u0026s=2883b00d84790dceab585da18f2d19f9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.webagent.cloud#website\",\"name\":\"WebAgent docs\",\"url\":\"https://docs.webagent.cloud\",\"publisher\":{\"@id\":\"https://docs.webagent.cloud/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.webagent.cloud/self-hosted-api-reference/run-agent#webpage\",\"url\":\"https://docs.webagent.cloud/self-hosted-api-reference/run-agent\",\"name\":\"Run Agent\",\"dateModified\":\"2026-02-08T00:41:15.814Z\",\"isPartOf\":{\"@id\":\"https://docs.webagent.cloud#website\"},\"breadcrumb\":{\"@id\":\"https://docs.webagent.cloud/self-hosted-api-reference/run-agent#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.webagent.cloud/self-hosted-api-reference/run-agent#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.webagent.cloud/self-hosted-api-reference/list-tasks\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Run Agent\",\"item\":\"https://docs.webagent.cloud/self-hosted-api-reference/run-agent\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.webagent.cloud/self-hosted-api-reference/run-agent#apireference\",\"headline\":\"Run Agent\",\"name\":\"Run Agent\",\"url\":\"https://docs.webagent.cloud/self-hosted-api-reference/run-agent\",\"mainEntityOfPage\":{\"@id\":\"https://docs.webagent.cloud/self-hosted-api-reference/run-agent#webpage\"},\"dateModified\":\"2026-02-08T00:41:15.814Z\",\"publisher\":{\"@id\":\"https://docs.webagent.cloud/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.webagent.cloud#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"WebAgent docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"WebAgent docs","nav":{"global":{"anchors":[{"anchor":"Documentation","icon":"book-open-cover","href":"https://docs.webagent.cloud"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/introduction"}]},{"tab":"Cloud API Reference","pages":[{"title":"Cloud API Reference","href":"/cloud-api-reference/introduction"}]},{"tab":"Self-Hosted API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/self-hosted-api-reference/introduction"}]},{"group":"API Reference","pages":[{"title":"List Tasks","deprecated":null,"version":null,"openapi":"self-hosted-api-reference/openapi.json get /api/tasks","href":"/self-hosted-api-reference/list-tasks"},{"title":"Get Task By Id","deprecated":null,"version":null,"openapi":"self-hosted-api-reference/openapi.json get /api/tasks/{task_id}","href":"/self-hosted-api-reference/get-task-by-id"},{"title":"Update Task By Id","deprecated":null,"version":null,"openapi":"self-hosted-api-reference/openapi.json put /api/tasks/{task_id}","href":"/self-hosted-api-reference/update-task-by-id"},{"title":"Get Runs For Task","deprecated":null,"version":null,"openapi":"self-hosted-api-reference/openapi.json get /api/tasks/{task_id}/runs","href":"/self-hosted-api-reference/get-runs-for-task"},{"title":"Run Task","description":"Run an existing task with optional parameter overrides","deprecated":null,"version":null,"openapi":"self-hosted-api-reference/openapi.json post /api/tasks/{task_id}/runs","href":"/self-hosted-api-reference/run-task"},{"title":"Run Agent","deprecated":null,"version":null,"openapi":"self-hosted-api-reference/openapi.json post /api/runs","href":"/self-hosted-api-reference/run-agent"},{"title":"Get Run By Id","description":"Get a run by ID with all details, steps, and actions","deprecated":null,"version":null,"openapi":"self-hosted-api-reference/openapi.json get /api/runs/{run_id}","href":"/self-hosted-api-reference/get-run-by-id"},{"title":"Set Run As Cached Workflow","deprecated":null,"version":null,"openapi":"self-hosted-api-reference/openapi.json post /api/runs/{run_id}/set-as-cached-workflow","href":"/self-hosted-api-reference/set-run-as-cached-workflow"}]}]}]},"title":"Run Agent - WebAgent docs","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","Page-D5fEM6aW.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}