Run the general Omni agent and wait until it completes, pauses for approval, or fails. Requires agents:invoke.
A waiting call can take several minutes; raise the client timeout. Send decisions with the same thread_id to approve or reject a paused run. Omit config.enabled_tools to use the organization’s agent tools. Attach images on the latest user message as { type: "image", url } HTTP(S) URLs.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"OmniCommerce","description":"Developer documentation for OmniCommerce REST APIs, MCP tools, and agent integrations.","colors":{"primary":"#0F766E","light":"#2DD4BF","dark":"#115E59"},"logo":{"light":"https://mintcdn.com/omnicommerce/B2cjFTJ7Zt2npdeV/logo/light.svg?fit=max\u0026auto=format\u0026n=B2cjFTJ7Zt2npdeV\u0026q=85\u0026s=e012509da06089923275e6b0415addf9","dark":"https://mintcdn.com/omnicommerce/B2cjFTJ7Zt2npdeV/logo/dark.svg?fit=max\u0026auto=format\u0026n=B2cjFTJ7Zt2npdeV\u0026q=85\u0026s=547bdf6cb0b483a43238304bc7679fa1","href":"https://omnicommerce.sg"},"favicon":"https://mintcdn.com/omnicommerce/B2cjFTJ7Zt2npdeV/favicon.svg?fit=max\u0026auto=format\u0026n=B2cjFTJ7Zt2npdeV\u0026q=85\u0026s=2951c661b72ccdfa6777f7594193113c","api":{"params":{"expanded":"closed"},"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","javascript","python"],"prefill":false}},"appearance":{"default":"dark"},"navbar":{"links":[{"href":"https://omnicommerce.sg","label":"App"},{"href":"https://omnicommerce.sg/login","label":"Log In"}],"primary":{"type":"button","label":"API Dashboard","href":"https://omnicommerce.sg/app"}},"footer":{"socials":{"website":"https://omnicommerce.sg"}},"seo":{"metatags":{"og:site_name":"OmniCommerce Docs","twitter:card":"summary_large_image"}},"contextual":{"options":["copy","view","chatgpt","claude","download-spec"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"omnicommerce","hasAudioNarration":false,"actualSubdomain":"omnicommerce","customDomains":["docs.omnicommerce.sg"],"gitSource":{"type":"github","owner":"rmdort","repo":"omnicommerce","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6adbd0b266dc5112c9cd1db7","collectionId":"5a8b52fa-144a-4ed2-99bb-c7d4439f5f99","liveDeploymentHistoryId":"6adbd0b266dc5112c9cd1db7","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6adbd0b266dc5112c9cd1db7","clientVersion":"0.0.3965","searchFilterCounts":[{"language":"default","tag":"API Reference","count":141},{"language":"default","tag":"Endpoints","count":119},{"language":"default","tag":"Documentation","count":39},{"language":"default","tag":"Webhooks","count":31},{"language":"default","tag":"Guides","count":18},{"language":"default","tag":"Products","count":18},{"language":"default","tag":"Developer Platform","count":14},{"language":"default","tag":"Orders","count":11},{"language":"default","tag":"Analytics","count":11},{"language":"default","tag":"Promotions","count":9}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"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":"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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":":root{--docs-radius:6px;--docs-content-max:60rem;--docs-example-width:28rem}#navbar img[src*=logo],header img[src$=\"/logo/dark.svg\"],header img[src$=\"/logo/light.svg\"],header nav-logo img{height:32px!important;max-height:32px!important;width:auto!important}article p:not(.callout-title):not(.callout-body),main p:not(.callout-title):not(.callout-body){font-size:calc(1em - 1pt)}"}],"page":{"pagePath":"api-reference/agents/invoke-the-omni-agent","slug":"/api-reference/agents/invoke-the-omni-agent","pageMetadata":{"title":"Invoke the Omni agent","description":"Run the general Omni agent and wait until it completes, pauses for approval, or fails. Requires `agents:invoke`.\n\nA waiting call can take several minutes; raise the client timeout. Send `decisions` with the same `thread_id` to approve or reject a paused run. Omit `config.enabled_tools` to use the organization's agent tools. Attach images on the latest user message as `{ type: \"image\", url }` HTTP(S) URLs.","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/agents/general/invoke","href":"/api-reference/agents/invoke-the-omni-agent","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Run the general Omni agent and wait until it completes, pauses for approval, or fails. Requires \", _jsx(_components.code, {\n children: \"agents:invoke\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"A waiting call can take several minutes; raise the client timeout. Send \", _jsx(_components.code, {\n children: \"decisions\"\n }), \" with the same \", _jsx(_components.code, {\n children: \"thread_id\"\n }), \" to approve or reject a paused run. Omit \", _jsx(_components.code, {\n children: \"config.enabled_tools\"\n }), \" to use the organization’s agent tools. Attach images on the latest user message as \", _jsx(_components.code, {\n children: \"{ type: \\\"image\\\", url }\"\n }), \" HTTP(S) URLs.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Invoke the Omni agent","description":"Run the general Omni agent and wait until it completes, pauses for approval, or fails. Requires `agents:invoke`.\n\nA waiting call can take several minutes; raise the client timeout. Send `decisions` with the same `thread_id` to approve or reject a paused run. Omit `config.enabled_tools` to use the organization's agent tools. Attach images on the latest user message as `{ type: \"image\", url }` HTTP(S) URLs.","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/agents/general/invoke","href":"/api-reference/agents/invoke-the-omni-agent","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"post_v1_agents_general_invoke","summary":"Invoke the Omni agent","description":"Run the general Omni agent and wait until it completes, pauses for approval, or fails. Requires `agents:invoke`.\n\nA waiting call can take several minutes; raise the client timeout. Send `decisions` with the same `thread_id` to approve or reject a paused run. Omit `config.enabled_tools` to use the organization's agent tools. Attach images on the latest user message as `{ type: \"image\", url }` HTTP(S) URLs.","tags":["agents"],"security":["b1377954-1cf4-43eb-a775-3ffab000e468"],"requestBody":"05a9423c-5177-40db-a8e8-319c4904ec0c","responses":{"200":"19eefeec-95b7-4673-8db6-1f7ac83b4608","400":"35ce5e7d-249e-426e-b734-e6df69da41fd","401":"9a922c13-56ee-4ecc-bbc7-1576115e1e3a","402":"c23da119-d01e-4108-bb65-f2cea13ccd17","403":"f1a3e25c-2cfe-441c-a398-9fc2f48083f7","409":"379530eb-9d12-491e-9d22-6e8f0763f812","500":"48814430-5cc1-4d60-a61b-9db6af6de788","504":"7e7f8a7b-7af2-4151-8b9e-6d015e997667"},"method":"post","type":"path","servers":["39970a03-ff72-4559-a542-364a55d2e30f","1047c457-3777-4869-be4f-4e086fafbbca"],"path":"/api/v1/agents/general/invoke","baseUrlOptions":["https://omnicommerce.sg","http://localhost:3000"],"title":"Invoke the Omni agent","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","maxLength":120,"uniqueKey":"organizationId","typeLabel":"string"},"thread_id":{"oneOf":[{"type":"string","maxLength":200,"minLength":1,"uniqueKey":"thread_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"thread_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"thread_id","typeLabel":"string | null"},"channel":{"type":"string","minLength":1,"maxLength":64,"uniqueKey":"channel","typeLabel":"string"},"messages":{"maxItems":50,"type":"array","items":{"type":"object","properties":{"content":{"oneOf":[{"type":"string","maxLength":100000,"minLength":1,"isRequired":true,"uniqueKey":"messages.items.[INDEX].content.oneOf.0","typeLabel":"string"},{"type":"array","items":{"oneOf":[{"type":"object","required":["type","text"],"properties":{"type":{"type":"string","const":"text","isRequired":true,"uniqueKey":"messages.items.[INDEX].content.oneOf.1.items.[INDEX].oneOf.0.type","typeLabel":"string"},"text":{"type":"string","minLength":1,"maxLength":100000,"isRequired":true,"uniqueKey":"messages.items.[INDEX].content.oneOf.1.items.[INDEX].oneOf.0.text","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"messages.items.[INDEX].content.oneOf.1.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["type","url"],"properties":{"type":{"type":"string","const":"image","isRequired":true,"uniqueKey":"messages.items.[INDEX].content.oneOf.1.items.[INDEX].oneOf.1.type","typeLabel":"string"},"url":{"type":"string","minLength":1,"maxLength":2048,"isRequired":true,"uniqueKey":"messages.items.[INDEX].content.oneOf.1.items.[INDEX].oneOf.1.url","typeLabel":"string"},"filename":{"type":"string","minLength":1,"maxLength":200,"uniqueKey":"messages.items.[INDEX].content.oneOf.1.items.[INDEX].oneOf.1.filename","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"messages.items.[INDEX].content.oneOf.1.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"messages.items.[INDEX].content.oneOf.1.items.[INDEX]","typeLabel":"object"},"maxItems":20,"minItems":1,"isRequired":true,"uniqueKey":"messages.items.[INDEX].content.oneOf.1","typeLabel":"object[]"}],"isRequired":true,"uniqueKey":"messages.items.[INDEX].content","typeLabel":"string | object[]"},"role":{"type":"string","enum":["user","assistant","system"],"uniqueKey":"messages.items.[INDEX].role","typeLabel":"enum\u003cstring>"},"id":{"type":"string","maxLength":200,"uniqueKey":"messages.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","maxLength":200,"uniqueKey":"messages.items.[INDEX].name","typeLabel":"string"}},"required":["content"],"additionalProperties":false,"uniqueKey":"messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"messages","typeLabel":"object[]"},"config":{"type":"object","properties":{"enabled_tools":{"maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"uniqueKey":"config.enabled_tools.items.[INDEX]","typeLabel":"string"},"uniqueKey":"config.enabled_tools","typeLabel":"string[]"},"model":{"oneOf":[{"type":"string","maxLength":200,"minLength":1,"uniqueKey":"config.model.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"config.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"config.model","typeLabel":"string | null"},"system_prompt":{"type":"string","maxLength":20000,"uniqueKey":"config.system_prompt","typeLabel":"string"},"structured_output":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"config.structured_output.oneOf.0.additionalProperties","typeLabel":"any"},"uniqueKey":"config.structured_output.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"config.structured_output.oneOf.1","typeLabel":"null"}],"uniqueKey":"config.structured_output","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"config","typeLabel":"object"},"decisions":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"action":{"type":"string","enum":["approve","reject"],"isRequired":true,"uniqueKey":"decisions.items.[INDEX].action","typeLabel":"enum\u003cstring>"},"reason":{"type":"string","maxLength":2000,"uniqueKey":"decisions.items.[INDEX].reason","typeLabel":"string"}},"required":["action"],"additionalProperties":false,"uniqueKey":"decisions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"decisions","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"messages":[{"role":"user","content":"How many products are missing a price?"}]},"examples":{"Example":{"title":"Example","value":{"messages":[{"role":"user","content":"How many products are missing a price?"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"19eefeec-95b7-4673-8db6-1f7ac83b4608":{"description":"The agent finished or is waiting for approval.","content":{"application/json":{"schema":{"type":"object","properties":{"run_id":{"type":"string","isRequired":true,"uniqueKey":"run_id","typeLabel":"string"},"thread_id":{"type":"string","isRequired":true,"uniqueKey":"thread_id","typeLabel":"string"},"status":{"type":"string","enum":["queued","running","completed","awaiting_approval","failed"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["human","ai","tool","system"],"isRequired":true,"uniqueKey":"messages.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"role":{"type":"string","enum":["user","assistant","tool","system"],"isRequired":true,"uniqueKey":"messages.items.[INDEX].role","typeLabel":"enum\u003cstring>"},"content":{"type":"string","isRequired":true,"uniqueKey":"messages.items.[INDEX].content","typeLabel":"string"},"id":{"type":"string","uniqueKey":"messages.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"messages.items.[INDEX].name","typeLabel":"string"},"tool_calls":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"messages.items.[INDEX].tool_calls.items.[INDEX].name","typeLabel":"string"},"args":{"oneOf":[{"isRequired":true}],"isRequired":true,"uniqueKey":"messages.items.[INDEX].tool_calls.items.[INDEX].args","typeLabel":"any"},"id":{"type":"string","uniqueKey":"messages.items.[INDEX].tool_calls.items.[INDEX].id","typeLabel":"string"}},"required":["name","args"],"uniqueKey":"messages.items.[INDEX].tool_calls.items.[INDEX]","typeLabel":"object"},"uniqueKey":"messages.items.[INDEX].tool_calls","typeLabel":"object[]"},"tool_call_id":{"type":"string","uniqueKey":"messages.items.[INDEX].tool_call_id","typeLabel":"string"}},"required":["type","role","content"],"uniqueKey":"messages.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"messages","typeLabel":"object[]"},"structured_output":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"structured_output.oneOf.0.additionalProperties","typeLabel":"any"},"isRequired":true,"uniqueKey":"structured_output.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"structured_output.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"structured_output","typeLabel":"object | null"},"approvals":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"interrupt_instance_id":{"type":"string","isRequired":true,"uniqueKey":"approvals.oneOf.0.items.[INDEX].interrupt_instance_id","typeLabel":"string"},"tool_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"approvals.oneOf.0.items.[INDEX].tool_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"approvals.oneOf.0.items.[INDEX].tool_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"approvals.oneOf.0.items.[INDEX].tool_name","typeLabel":"string | null"},"tool_args":{"oneOf":[{"isRequired":true}],"isRequired":true,"uniqueKey":"approvals.oneOf.0.items.[INDEX].tool_args","typeLabel":"any"},"message":{"type":"string","isRequired":true,"uniqueKey":"approvals.oneOf.0.items.[INDEX].message","typeLabel":"string"}},"required":["interrupt_instance_id","tool_name","tool_args","message"],"uniqueKey":"approvals.oneOf.0.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"approvals.oneOf.0","typeLabel":"object[]"},{"type":"null","isRequired":true,"uniqueKey":"approvals.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"approvals","typeLabel":"object[] | null"},"error":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"error.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"error.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error","typeLabel":"string | null"}},"required":["run_id","thread_id","status","messages","structured_output","approvals","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"run_id":"\u003cstring>","thread_id":"\u003cstring>","status":"queued","messages":[{"type":"human","role":"user","content":"\u003cstring>","id":"\u003cstring>","name":"\u003cstring>","tool_calls":[{"name":"\u003cstring>","args":"\u003cunknown>","id":"\u003cstring>"}],"tool_call_id":"\u003cstring>"}],"structured_output":{},"approvals":[{"interrupt_instance_id":"\u003cstring>","tool_name":"\u003cstring>","tool_args":"\u003cunknown>","message":"\u003cstring>"}],"error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"35ce5e7d-249e-426e-b734-e6df69da41fd":{"description":"Invalid agent request, unknown tool or model, or a decision count that does not match the pending approvals","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"9a922c13-56ee-4ecc-bbc7-1576115e1e3a":{"description":"Unauthorized","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"c23da119-d01e-4108-bb65-f2cea13ccd17":{"description":"Insufficient AI credits","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"f1a3e25c-2cfe-441c-a398-9fc2f48083f7":{"description":"Missing agents:invoke scope or Assistant access","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"379530eb-9d12-491e-9d22-6e8f0763f812":{"description":"The thread already has an active run, or decisions were sent for a thread with no run awaiting approval","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"48814430-5cc1-4d60-a61b-9db6af6de788":{"description":"The agent run failed. `data.run_id` identifies the stored run","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"7e7f8a7b-7af2-4151-8b9e-6d015e997667":{"description":"The agent run timed out. `data.run_id` identifies the stored run","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"b1377954-1cf4-43eb-a775-3ffab000e468":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"39970a03-ff72-4559-a542-364a55d2e30f":{"url":"https://omnicommerce.sg","description":"Production"},"1047c457-3777-4869-be4f-4e086fafbbca":{"url":"http://localhost:3000","description":"Local development"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"omnicommerce","siteName":"OmniCommerce","title":"Invoke the Omni agent - OmniCommerce","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-23T07:13:57.196Z","originalFileLocation":"api-reference/agents/invoke-the-omni-agent.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=\"dark\"}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=\"Run the general Omni agent and wait until it completes, pauses for approval, or fails. Requires agents:invoke. A waiting call can take several minutes; raise the client timeout. Send decisions with the same thread_id to approve or reject a paused run. Omit config.enabled_tools to use the organization\u0026#x27;s agent tools. Attach images on the latest user message as { type: \u0026quot;image\u0026quot;, url } HTTP(S) URLs.\">\u003cmeta data-mint-head name=\"application-name\" content=\"OmniCommerce\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/omnicommerce/20sPCJ3GohzNbY_P/_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/omnicommerce/20sPCJ3GohzNbY_P/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/omnicommerce/20sPCJ3GohzNbY_P/_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/omnicommerce/20sPCJ3GohzNbY_P/_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/omnicommerce/20sPCJ3GohzNbY_P/_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/omnicommerce/20sPCJ3GohzNbY_P/_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/omnicommerce/20sPCJ3GohzNbY_P/_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/omnicommerce/20sPCJ3GohzNbY_P/_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/omnicommerce/20sPCJ3GohzNbY_P/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Invoke the Omni agent - OmniCommerce\">\u003cmeta data-mint-head property=\"og:description\" content=\"Run the general Omni agent and wait until it completes, pauses for approval, or fails. Requires agents:invoke. A waiting call can take several minutes; raise the client timeout. Send decisions with the same thread_id to approve or reject a paused run. Omit config.enabled_tools to use the organization\u0026#x27;s agent tools. Attach images on the latest user message as { type: \u0026quot;image\u0026quot;, url } HTTP(S) URLs.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"OmniCommerce Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.omnicommerce.sg/api-reference/agents/invoke-the-omni-agent\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://omnicommerce.mintlify.app/_mintlify/api/og/v2?division=Agents\u0026amp;title=Invoke+the+Omni+agent\u0026amp;description=Run+the+general+Omni+agent+and+wait+until+it+completes%2C+pauses+for+approval%2C+or+fails.+Requires+%60agents%3Ainvoke%60.%0A%0AA+waiting+call+can+take+several+minutes%3B+raise\u0026amp;theme=1a59a306fe3109e355163fa6\u0026amp;signature=633a9d5172b4a29e240d43a250de99949debcae67e256ece338986be21384fc6\">\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=\"Invoke the Omni agent - OmniCommerce\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Run the general Omni agent and wait until it completes, pauses for approval, or fails. Requires agents:invoke. A waiting call can take several minutes; raise the client timeout. Send decisions with the same thread_id to approve or reject a paused run. Omit config.enabled_tools to use the organization\u0026#x27;s agent tools. Attach images on the latest user message as { type: \u0026quot;image\u0026quot;, url } HTTP(S) URLs.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://omnicommerce.mintlify.app/_mintlify/api/og/v2?division=Agents\u0026amp;title=Invoke+the+Omni+agent\u0026amp;description=Run+the+general+Omni+agent+and+wait+until+it+completes%2C+pauses+for+approval%2C+or+fails.+Requires+%60agents%3Ainvoke%60.%0A%0AA+waiting+call+can+take+several+minutes%3B+raise\u0026amp;theme=1a59a306fe3109e355163fa6\u0026amp;signature=633a9d5172b4a29e240d43a250de99949debcae67e256ece338986be21384fc6\">\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/omnicommerce/20sPCJ3GohzNbY_P/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"OmniCommerce\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0F766E\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.omnicommerce.sg/api-reference/agents/invoke-the-omni-agent\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/agents/invoke-the-omni-agent.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.omnicommerce.sg/#organization\",\"name\":\"OmniCommerce\",\"url\":\"https://docs.omnicommerce.sg\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/omnicommerce/B2cjFTJ7Zt2npdeV/logo/light.svg?fit=max\u0026auto=format\u0026n=B2cjFTJ7Zt2npdeV\u0026q=85\u0026s=e012509da06089923275e6b0415addf9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.omnicommerce.sg#website\",\"name\":\"OmniCommerce\",\"url\":\"https://docs.omnicommerce.sg\",\"publisher\":{\"@id\":\"https://docs.omnicommerce.sg/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.omnicommerce.sg/api-reference/agents/invoke-the-omni-agent#webpage\",\"url\":\"https://docs.omnicommerce.sg/api-reference/agents/invoke-the-omni-agent\",\"name\":\"Invoke the Omni agent\",\"description\":\"Run the general Omni agent and wait until it completes, pauses for approval, or fails. Requires agents:invoke. A waiting call can take several minutes; raise the client timeout. Send decisions with the same thread_id to approve or reject a paused run. Omit config.enabled_tools to use the organization's agent tools. Attach images on the latest user message as { type: \\\"image\\\", url } HTTP(S) URLs.\",\"dateModified\":\"2026-10-23T07:13:57.196Z\",\"isPartOf\":{\"@id\":\"https://docs.omnicommerce.sg#website\"},\"breadcrumb\":{\"@id\":\"https://docs.omnicommerce.sg/api-reference/agents/invoke-the-omni-agent#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.omnicommerce.sg/api-reference/agents/invoke-the-omni-agent#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"OmniCommerce\",\"item\":\"https://docs.omnicommerce.sg\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Invoke the Omni agent\",\"item\":\"https://docs.omnicommerce.sg/api-reference/agents/invoke-the-omni-agent\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.omnicommerce.sg/api-reference/agents/invoke-the-omni-agent#apireference\",\"headline\":\"Invoke the Omni agent\",\"name\":\"Invoke the Omni agent\",\"description\":\"Run the general Omni agent and wait until it completes, pauses for approval, or fails. Requires agents:invoke. A waiting call can take several minutes; raise the client timeout. Send decisions with the same thread_id to approve or reject a paused run. Omit config.enabled_tools to use the organization's agent tools. Attach images on the latest user message as { type: \\\"image\\\", url } HTTP(S) URLs.\",\"url\":\"https://docs.omnicommerce.sg/api-reference/agents/invoke-the-omni-agent\",\"mainEntityOfPage\":{\"@id\":\"https://docs.omnicommerce.sg/api-reference/agents/invoke-the-omni-agent#webpage\"},\"dateModified\":\"2026-10-23T07:13:57.196Z\",\"publisher\":{\"@id\":\"https://docs.omnicommerce.sg/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.omnicommerce.sg#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"OmniCommerce\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"OmniCommerce","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API Reference","description":"Interactive OpenAPI reference for OmniCommerce public and authenticated developer APIs.","href":"/api-reference"}]},{"group":"Endpoints","pages":[{"group":"Agents","pages":[{"title":"Invoke the Omni agent","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/agents/general/invoke","href":"/api-reference/agents/invoke-the-omni-agent"},{"title":"Start an Omni agent run","description":"Queue the general Omni agent and return immediately with the run in `queued` state. Poll the URL in the `Location` header (`GET /api/v1/agents/general/runs/{runId}`), honoring `Retry-After`. Requires `agents:invoke`. The request body matches invoke.","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/agents/general/runs","href":"/api-reference/agents/start-an-omni-agent-run"},{"title":"Get an Omni agent run","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/agents/general/runs/{runId}","href":"/api-reference/agents/get-an-omni-agent-run"}]},{"group":"Analytics","pages":[{"title":"Get Ads Analytics","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/analytics/ads","href":"/api-reference/analytics/get-ads-analytics"},{"title":"Get AI Traffic Analytics","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/analytics/ai-traffic","href":"/api-reference/analytics/get-ai-traffic-analytics"},{"title":"Get Video and LIVE Analytics","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/analytics/content","href":"/api-reference/analytics/get-video-and-live-analytics"},{"title":"Get Order Analytics","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/analytics/orders","href":"/api-reference/analytics/get-order-analytics"},{"title":"Get Growth Overview","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/analytics/overview","href":"/api-reference/analytics/get-growth-overview"},{"title":"Get Pricing Analytics","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/analytics/pricing","href":"/api-reference/analytics/get-pricing-analytics"},{"title":"Get Product Analytics","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/analytics/products","href":"/api-reference/analytics/get-product-analytics"},{"title":"Get Profit Analytics","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/analytics/profit","href":"/api-reference/analytics/get-profit-analytics"},{"title":"Get Business Report","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/analytics/reports","href":"/api-reference/analytics/get-business-report"},{"title":"Get Store Analytics","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/analytics/stores","href":"/api-reference/analytics/get-store-analytics"},{"title":"Get Traffic Analytics","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/analytics/traffic","href":"/api-reference/analytics/get-traffic-analytics"}]},{"group":"AOPs","pages":[{"title":"Get AOP configuration","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/aop/{aopId}/config","href":"/api-reference/aops/get-aop-configuration"},{"title":"Overwrite AOP configuration","deprecated":null,"version":null,"openapi":"/openapi.json put /api/v1/aop/{aopId}/config","href":"/api-reference/aops/overwrite-aop-configuration"},{"title":"Execute an AOP","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/aop/{aopId}/execute","href":"/api-reference/aops/execute-an-aop"},{"title":"Create AOP","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/aop/create","href":"/api-reference/aops/create-aop"},{"title":"Retry a failed AOP execution","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/aop/retry","href":"/api-reference/aops/retry-a-failed-aop-execution"},{"title":"Get Thread Status","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/threads/{thread_id}/status","href":"/api-reference/aops/get-thread-status"}]},{"group":"Developer Platform","pages":[{"title":"Import BrandsGateway Products","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/brandsgateway/import","href":"/api-reference/developer-platform/import-brandsgateway-products"},{"title":"Evaluate SKU Readiness","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/evaluate","href":"/api-reference/developer-platform/evaluate-sku-readiness"},{"title":"Generate Ghost Mannequin Image","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/images/ghost-mannequin","href":"/api-reference/developer-platform/generate-ghost-mannequin-image"},{"title":"Get Developer Job Status","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/jobs/{jobId}","href":"/api-reference/developer-platform/get-developer-job-status"},{"title":"Cancel Developer Job","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/jobs/{jobId}/cancel","href":"/api-reference/developer-platform/cancel-developer-job"},{"title":"Recommend Marketplace Product Categories","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/manage-product-category/recommend","href":"/api-reference/developer-platform/recommend-marketplace-product-categories"},{"title":"List Connected Marketplaces","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/marketplaces/connected","href":"/api-reference/developer-platform/list-connected-marketplaces"},{"title":"Run AI Shelf Share Monitor","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/monitor","href":"/api-reference/developer-platform/run-ai-shelf-share-monitor"},{"title":"Sync Product Commercial Fields","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/sync","href":"/api-reference/developer-platform/sync-product-commercial-fields"},{"title":"List Webhook Events","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/webhook-events","href":"/api-reference/developer-platform/list-webhook-events"},{"title":"List Developer Webhooks","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/webhooks","href":"/api-reference/developer-platform/list-developer-webhooks"},{"title":"Create Developer Webhook","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/webhooks","href":"/api-reference/developer-platform/create-developer-webhook"},{"title":"Get Selected Zalora Import Status","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/zalora/import","href":"/api-reference/developer-platform/get-selected-zalora-import-status"},{"title":"Import Selected Zalora Products","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/zalora/import","href":"/api-reference/developer-platform/import-selected-zalora-products"}]},{"group":"Campaigns","pages":[{"title":"List Campaigns","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/campaigns","href":"/api-reference/campaigns/list-campaigns"},{"title":"Create Campaign","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/campaigns","href":"/api-reference/campaigns/create-campaign"},{"title":"Get Campaign","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/campaigns/{campaignId}","href":"/api-reference/campaigns/get-campaign"},{"title":"Update Campaign","deprecated":null,"version":null,"openapi":"/openapi.json put /api/v1/campaigns/{campaignId}","href":"/api-reference/campaigns/update-campaign"},{"title":"Act on Campaign","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/campaigns/{campaignId}/actions","href":"/api-reference/campaigns/act-on-campaign"},{"title":"Archive Campaigns","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/campaigns/archive","href":"/api-reference/campaigns/archive-campaigns"},{"title":"Delete Campaigns","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/campaigns/delete","href":"/api-reference/campaigns/delete-campaigns"},{"title":"Get Campaign Options","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/campaigns/options","href":"/api-reference/campaigns/get-campaign-options"}]},{"group":"Products","pages":[{"title":"Export Catalog Items","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/catalog/items","href":"/api-reference/products/export-catalog-items"},{"title":"List Products","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/products","href":"/api-reference/products/list-products"},{"title":"Create Product","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/products","href":"/api-reference/products/create-product"},{"title":"Get Product","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/products/{productId}","href":"/api-reference/products/get-product"},{"title":"Delete Product","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/products/{productId}","href":"/api-reference/products/delete-product"},{"title":"Update Product","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/products/{productId}","href":"/api-reference/products/update-product"},{"title":"Update Product Cost","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/products/{productId}/cost","href":"/api-reference/products/update-product-cost"},{"title":"Delist Product","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/products/{productId}/delist","href":"/api-reference/products/delist-product"},{"title":"Upload Product Image","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/products/{productId}/images","href":"/api-reference/products/upload-product-image"},{"title":"Update Product Inventory","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/products/{productId}/inventory","href":"/api-reference/products/update-product-inventory"},{"title":"Get Product Listings","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/products/{productId}/listings","href":"/api-reference/products/get-product-listings"},{"title":"Update Product Price","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/products/{productId}/price","href":"/api-reference/products/update-product-price"},{"title":"Publish Product","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/products/{productId}/publish","href":"/api-reference/products/publish-product"},{"title":"Bulk Import Products from JSON or CSV","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/products/bulk-import","href":"/api-reference/products/bulk-import-products-from-json-or-csv"},{"title":"Compare Product Market Prices","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/products/compare-prices","href":"/api-reference/products/compare-product-market-prices"},{"title":"Get Product Price Comparison","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/products/compare-prices/jobs/{jobId}","href":"/api-reference/products/get-product-price-comparison"},{"title":"Batch Update Product Cost","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/products/cost","href":"/api-reference/products/batch-update-product-cost"},{"title":"Queue Product Enrichment","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/products/enrich","href":"/api-reference/products/queue-product-enrichment"}]},{"group":"Agentic Checkout","pages":[{"title":"Create Agentic Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/checkout-sessions","href":"/api-reference/agentic-checkout/create-agentic-checkout-session"},{"title":"Get Agentic Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/checkout-sessions/{sessionId}","href":"/api-reference/agentic-checkout/get-agentic-checkout-session"},{"title":"Replace Agentic Checkout Session Fields","deprecated":null,"version":null,"openapi":"/openapi.json put /api/v1/checkout-sessions/{sessionId}","href":"/api-reference/agentic-checkout/replace-agentic-checkout-session-fields"},{"title":"Update Agentic Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/checkout-sessions/{sessionId}","href":"/api-reference/agentic-checkout/update-agentic-checkout-session"},{"title":"Cancel Agentic Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/checkout-sessions/{sessionId}/cancel","href":"/api-reference/agentic-checkout/cancel-agentic-checkout-session"},{"title":"Complete Agentic Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/checkout-sessions/{sessionId}/complete","href":"/api-reference/agentic-checkout/complete-agentic-checkout-session"}]},{"group":"Public Agent","pages":[{"title":"Compare Public Products","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/compare","href":"/api-reference/public-agent/compare-public-products"},{"title":"List Public Merchants","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/directory","href":"/api-reference/public-agent/list-public-merchants"},{"title":"Get Merchant LLM Feed","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/feed/{domain}/llms.txt","href":"/api-reference/public-agent/get-merchant-llm-feed"},{"title":"Get Public Merchant Manifest","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/merchants/{merchantId}/manifest","href":"/api-reference/public-agent/get-public-merchant-manifest"},{"title":"List Public Merchant Products","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/merchants/{merchantId}/products","href":"/api-reference/public-agent/list-public-merchant-products"},{"title":"Search Within Public Merchant Catalog","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/merchants/{merchantId}/search","href":"/api-reference/public-agent/search-within-public-merchant-catalog"},{"title":"Search Public Merchant Products","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/search","href":"/api-reference/public-agent/search-public-merchant-products"},{"title":"Search Public Merchant Products","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/search","href":"/api-reference/public-agent/search-public-merchant-products-1"}]},{"group":"Knowledge Base","pages":[{"title":"Upload Document","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/documents","href":"/api-reference/documents/upload-document"},{"title":"Get Document","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/documents/{documentId}","href":"/api-reference/documents/get-document"}]},{"group":"Looks","pages":[{"title":"List Looks","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/looks","href":"/api-reference/looks/list-looks"},{"title":"Create Look","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/looks","href":"/api-reference/looks/create-look"},{"title":"Get Look","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/looks/{lookId}","href":"/api-reference/looks/get-look"}]},{"group":"OAuth","pages":[{"title":"Revoke Access Token","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/oauth/revoke","href":"/api-reference/oauth/revoke-access-token"},{"title":"Get Access Token","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/oauth/token","href":"/api-reference/oauth/get-access-token"}]},{"group":"Orders","pages":[{"title":"List Orders","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/orders","href":"/api-reference/orders/list-orders"},{"title":"Create Order","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/orders","href":"/api-reference/orders/create-order"},{"title":"Get Order","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/orders/{orderId}","href":"/api-reference/orders/get-order"},{"title":"Update Order","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/orders/{orderId}","href":"/api-reference/orders/update-order"},{"title":"Get Order Action Options","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/orders/{orderId}/action-options","href":"/api-reference/orders/get-order-action-options"},{"title":"List Order Actions","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/orders/{orderId}/actions","href":"/api-reference/orders/list-order-actions"},{"title":"Queue Order Action","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/orders/{orderId}/actions","href":"/api-reference/orders/queue-order-action"}]},{"group":"Organizations","pages":[{"title":"Create Organization","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/organizations","href":"/api-reference/organizations/create-organization"}]},{"group":"Price Books","pages":[{"title":"List Price Book Rules","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/price-books","href":"/api-reference/price-books/list-price-book-rules"},{"title":"Create Price Book Rule","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/price-books","href":"/api-reference/price-books/create-price-book-rule"},{"title":"Get Price Book Rule","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/price-books/{ruleId}","href":"/api-reference/price-books/get-price-book-rule"},{"title":"Delete Price Book Rule","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/price-books/{ruleId}","href":"/api-reference/price-books/delete-price-book-rule"},{"title":"Update Price Book Rule","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/price-books/{ruleId}","href":"/api-reference/price-books/update-price-book-rule"},{"title":"Preview Channel List Price","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/price-books/preview","href":"/api-reference/price-books/preview-channel-list-price"}]},{"group":"Promotions","pages":[{"title":"List Promotions","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/promotions","href":"/api-reference/promotions/list-promotions"},{"title":"Create Promotion","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/promotions","href":"/api-reference/promotions/create-promotion"},{"title":"Get Promotion","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/promotions/{promotionId}","href":"/api-reference/promotions/get-promotion"},{"title":"Delete Promotion","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/promotions/{promotionId}","href":"/api-reference/promotions/delete-promotion"},{"title":"Update Promotion","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/promotions/{promotionId}","href":"/api-reference/promotions/update-promotion"},{"title":"List Promotion Assignments","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/promotions/{promotionId}/products","href":"/api-reference/promotions/list-promotion-assignments"},{"title":"Assign Products to Promotion","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/promotions/{promotionId}/products","href":"/api-reference/promotions/assign-products-to-promotion"},{"title":"Unassign Products from Promotion","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/promotions/{promotionId}/products","href":"/api-reference/promotions/unassign-products-from-promotion"},{"title":"Retry Marketplace Delivery","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/promotions/{promotionId}/retry","href":"/api-reference/promotions/retry-marketplace-delivery"}]},{"group":"Returns","pages":[{"title":"List Returns","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/returns","href":"/api-reference/returns/list-returns"},{"title":"Get Return","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/returns/{returnId}","href":"/api-reference/returns/get-return"}]},{"group":"Reviews","pages":[{"title":"List Reviews","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/reviews","href":"/api-reference/reviews/list-reviews"},{"title":"Get Review","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/reviews/{reviewId}","href":"/api-reference/reviews/get-review"},{"title":"Reply to Review","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/reviews/{reviewId}/reply","href":"/api-reference/reviews/reply-to-review"}]},{"group":"Settlements","pages":[{"title":"List Settlements","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/settlements","href":"/api-reference/settlements/list-settlements"},{"title":"Apply Settlements","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/settlements","href":"/api-reference/settlements/apply-settlements"},{"title":"Get Settlement","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/settlements/{settlementId}","href":"/api-reference/settlements/get-settlement"}]},{"group":"UCP","pages":[{"title":"Create UCP Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json post /ucp/v1/checkout-sessions","href":"/api-reference/ucp/create-ucp-checkout-session"},{"title":"Get UCP Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json get /ucp/v1/checkout-sessions/{sessionId}","href":"/api-reference/ucp/get-ucp-checkout-session"},{"title":"Replace UCP Checkout Session Fields","deprecated":null,"version":null,"openapi":"/openapi.json put /ucp/v1/checkout-sessions/{sessionId}","href":"/api-reference/ucp/replace-ucp-checkout-session-fields"},{"title":"Update UCP Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json patch /ucp/v1/checkout-sessions/{sessionId}","href":"/api-reference/ucp/update-ucp-checkout-session"},{"title":"Cancel UCP Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json post /ucp/v1/checkout-sessions/{sessionId}/cancel","href":"/api-reference/ucp/cancel-ucp-checkout-session"},{"title":"Complete UCP Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json post /ucp/v1/checkout-sessions/{sessionId}/complete","href":"/api-reference/ucp/complete-ucp-checkout-session"},{"title":"Get UCP Order","deprecated":null,"version":null,"openapi":"/openapi.json get /ucp/v1/orders/{orderId}","href":"/api-reference/ucp/get-ucp-order"}]},{"group":"product webhooks","pages":[]},{"group":"enrichment webhooks","pages":[]},{"group":"look webhooks","pages":[]},{"group":"review webhooks","pages":[]},{"group":"order webhooks","pages":[]},{"group":"settlement webhooks","pages":[]},{"group":"return webhooks","pages":[]},{"group":"account statement webhooks","pages":[]}]},{"group":"Webhooks","pages":[{"group":"Product","pages":[{"title":"Product created","openapi":"openapi.json webhook productCreated","href":"/webhooks/reference/product-created"},{"title":"Product updated","openapi":"openapi.json webhook productUpdated","href":"/webhooks/reference/product-updated"},{"title":"Product deleted","openapi":"openapi.json webhook productDeleted","href":"/webhooks/reference/product-deleted"},{"title":"Product delisted","openapi":"openapi.json webhook productDelisted","href":"/webhooks/reference/product-delisted"},{"title":"Product price changed","openapi":"openapi.json webhook productPriceChanged","href":"/webhooks/reference/product-price-changed"},{"title":"Product inventory changed","openapi":"openapi.json webhook productInventoryChanged","href":"/webhooks/reference/product-inventory-changed"}]},{"group":"Orders","pages":[{"title":"Order created","openapi":"openapi.json webhook orderCreated","href":"/webhooks/reference/order-created"},{"title":"Order updated","openapi":"openapi.json webhook orderUpdated","href":"/webhooks/reference/order-updated"},{"title":"Order status changed","openapi":"openapi.json webhook orderStatusChanged","href":"/webhooks/reference/order-status-changed"},{"title":"Order deleted","openapi":"openapi.json webhook orderDeleted","href":"/webhooks/reference/order-deleted"}]},{"group":"Looks","pages":[{"title":"Look created","openapi":"openapi.json webhook lookCreated","href":"/webhooks/reference/look-created"},{"title":"Look deleted","openapi":"openapi.json webhook lookDeleted","href":"/webhooks/reference/look-deleted"}]},{"group":"Review","pages":[{"title":"Review created","openapi":"openapi.json webhook reviewCreated","href":"/webhooks/reference/review-created"},{"title":"Review updated","openapi":"openapi.json webhook reviewUpdated","href":"/webhooks/reference/review-updated"},{"title":"Review status changed","openapi":"openapi.json webhook reviewStatusChanged","href":"/webhooks/reference/review-status-changed"}]},{"group":"Settlements","pages":[{"title":"Settlement created","openapi":"openapi.json webhook settlementCreated","href":"/webhooks/reference/settlement-created"},{"title":"Settlement updated","openapi":"openapi.json webhook settlementUpdated","href":"/webhooks/reference/settlement-updated"},{"title":"Settlement status changed","openapi":"openapi.json webhook settlementStatusChanged","href":"/webhooks/reference/settlement-status-changed"}]},{"group":"Returns","pages":[{"title":"Return created","openapi":"openapi.json webhook returnCreated","href":"/webhooks/reference/return-created"},{"title":"Return updated","openapi":"openapi.json webhook returnUpdated","href":"/webhooks/reference/return-updated"},{"title":"Return status changed","openapi":"openapi.json webhook returnStatusChanged","href":"/webhooks/reference/return-status-changed"}]}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"title":"Invoke the Omni agent - OmniCommerce","buildId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","deploymentId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Bbp7I60D.js","utils-C3RIvJha.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DqD-vLt8.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B31Loprg.js","snippetPresets-DKpk-b8t.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Cj65AhOR.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BXtn5gcC.js","shallow-RY2b03Cp.js","getApiPlaygroundDisplay-B0jeiPk3.js","CodeSnippet-CYgBjjwn.js","CodeSnippets-DOngDrYB.js","Page-n7I5XbKb.js","getPastedJson-DRQbJx-T.js","icon-CQiQCicY.js","MethodPill-BKTLdNtu.js","DuplicateIcon-B9jpAdat.js","createIcon-DCddRrXv.js","DynamicMarkdown-a8hUKrw6.js","SectionHeading-eECVV2eH.js","axios-vUo_bRtp.js","Markdown--GF7ZIpf.js","clsx-DZLdJUrt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-2LoAhjKH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Zwc0ZncM.js"]}