Run one agent turn. Returns 200 with job_id and call_id when the turn starts, or 202 with queue_id and position when a turn is already running on the chat and this one was queued behind it. The turn executes in the background - poll GET /api/agent/status/{callId} for the result.
Other workspaces the agent may reach in this chat, each at workspaces/<alias>/ - the alias is assigned by the server the first time a workspace is added and never reused for another workspace in the same chat. Replaces the chat's current set when the turn starts; omit it to keep that set. Up to 5. A workspace you cannot read is dropped, and edit falls back to read without write access. Every write into one waits for the user's approval, so on an API call with no one to approve it the write is refused. Ignored on a chat a service account owns.
Send a completion push to the acting user's registered devices after a successful answer. Defaults to false. No email or inbox row is created; service accounts do not receive this alert.
Client-supplied UUID for the user message. Generated when omitted.
Response
Successful response
The response is of type object.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"arg.ai","colors":{"primary":"#18181B","light":"#A1A1AA","dark":"#27272A"},"logo":{"light":"https://mintcdn.com/relevanceai-docs/zsccF0hnTHoJIc4d/logo/light.svg?fit=max\u0026auto=format\u0026n=zsccF0hnTHoJIc4d\u0026q=85\u0026s=0e8f44bd3b309a747d1f730aff1238ce","dark":"https://mintcdn.com/relevanceai-docs/zsccF0hnTHoJIc4d/logo/dark.svg?fit=max\u0026auto=format\u0026n=zsccF0hnTHoJIc4d\u0026q=85\u0026s=3b87c38bf2bcd7b17b07a319d5550e4e"},"favicon":"https://mintcdn.com/relevanceai-docs/zsccF0hnTHoJIc4d/favicon.svg?fit=max\u0026auto=format\u0026n=zsccF0hnTHoJIc4d\u0026q=85\u0026s=f42be0aa1bc2118fed1fd28467715463","api":{"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","python","javascript"],"prefill":true,"autogenerate":true}},"navbar":{"links":[{"href":"mailto:[email protected]","label":"Support"}],"primary":{"type":"button","label":"Open arg.ai","href":"https://arg.ai"}},"footer":{"socials":{"github":"https://github.com/arg-ai"}},"seo":{"metatags":{"og:type":"website","og:site_name":"arg.ai docs","twitter:card":"summary_large_image"},"indexing":"navigable"},"banner":{"content":"New: the [Agent API](/guides/agents/runs) and [Actions](/guides/actions) guides, plus a fully regenerated API reference. [See the changelog](/changelog).","dismissible":true},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode","download-spec"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"API Reference","icon":"terminal","href":"/api-reference/introduction"},{"anchor":"GitHub","icon":"github","href":"https://github.com/arg-ai"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"relevanceai-docs","hasAudioNarration":false,"actualSubdomain":"relevanceai-docs","customDomains":["developers.arg.ai"],"gitSource":{"type":"github","owner":"relevanceai","repo":"arg","deployBranch":"main","contentDirectory":"mintlify-docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aed57a32ff3555c21a911a0","clientVersion":"0.0.4087","searchFilterCounts":[{"language":"default","tag":"API Reference","count":156},{"language":"default","tag":"Documentation","count":76},{"language":"default","tag":"Integrations","count":32},{"language":"default","tag":"Files","count":27},{"language":"default","tag":"Organizations","count":21},{"language":"default","tag":"Automations","count":14},{"language":"default","tag":"Agent","count":12},{"language":"default","tag":"Sites","count":12},{"language":"default","tag":"Arg SDK","count":11},{"language":"default","tag":"Workspaces","count":10}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":"[data-component-part=\"update-tag\"]{padding:2px 10px!important;border-radius:9999px!important;border:1px solid color-mix(in srgb, currentColor 24%, transparent);background:color-mix(in srgb, currentColor 12%, transparent);font-weight:500;line-height:1.5}[data-component-part=\"update-tag\"][data-tag=\"docs\"]{color:#6366f1}[data-component-part=\"update-tag\"][data-tag=\"files\"]{color:#0ea5e9}[data-component-part=\"update-tag\"][data-tag=\"models\"]{color:#8b5cf6}[data-component-part=\"update-tag\"][data-tag=\"workspaces\"]{color:#10b981}[data-component-part=\"update-tag\"][data-tag=\"sdk\"]{color:#f59e0b}[data-component-part=\"update-tag\"][data-tag=\"automations\"]{color:#ec4899}[data-component-part=\"update-tag\"][data-tag=\"api\"]{color:#14b8a6}:root{--arg-terminal-bg: #09090b;--arg-terminal-bar: #18181b;--arg-terminal-border: #27272a;--arg-terminal-title: #d4d4d8}.code-block:has(code[language=\"shellscript\"]),.code-block:has(code[language=\"bash\"]),.code-block:has(code[language=\"sh\"]),.code-block:has(code[language=\"shell\"]),.code-block:has(code[language=\"console\"]),.code-block:has(code[language=\"zsh\"]){background:var(--arg-terminal-bg)!important;border:1px solid var(--arg-terminal-border);box-shadow:0 1px 2px rgb(60 45 20 / 0.05),\n 0 6px 16px -4px rgb(60 45 20 / 0.1),\n 0 30px 70px -18px rgb(50 38 18 / 0.38)}.code-block:has(code[language=\"shellscript\"]) [data-component-part=\"code-block-root\"],.code-block:has(code[language=\"bash\"]) [data-component-part=\"code-block-root\"],.code-block:has(code[language=\"sh\"]) [data-component-part=\"code-block-root\"],.code-block:has(code[language=\"shell\"]) [data-component-part=\"code-block-root\"],.code-block:has(code[language=\"console\"]) [data-component-part=\"code-block-root\"],.code-block:has(code[language=\"zsh\"]) [data-component-part=\"code-block-root\"],.code-block:has(code[language=\"shellscript\"]) pre.shiki,.code-block:has(code[language=\"bash\"]) pre.shiki,.code-block:has(code[language=\"sh\"]) pre.shiki,.code-block:has(code[language=\"shell\"]) pre.shiki,.code-block:has(code[language=\"console\"]) pre.shiki,.code-block:has(code[language=\"zsh\"]) pre.shiki{background:transparent!important}.code-block:has(code[language=\"shellscript\"]) pre.shiki,.code-block:has(code[language=\"bash\"]) pre.shiki,.code-block:has(code[language=\"sh\"]) pre.shiki,.code-block:has(code[language=\"shell\"]) pre.shiki,.code-block:has(code[language=\"console\"]) pre.shiki,.code-block:has(code[language=\"zsh\"]) pre.shiki,.code-block:has(code[language=\"shellscript\"]) pre.shiki span,.code-block:has(code[language=\"bash\"]) pre.shiki span,.code-block:has(code[language=\"sh\"]) pre.shiki span,.code-block:has(code[language=\"shell\"]) pre.shiki span,.code-block:has(code[language=\"console\"]) pre.shiki span,.code-block:has(code[language=\"zsh\"]) pre.shiki span{color:var(--shiki-dark)!important}.code-block:has(code[language=\"shellscript\"]) .code-block-fade-overlay,.code-block:has(code[language=\"bash\"]) .code-block-fade-overlay,.code-block:has(code[language=\"sh\"]) .code-block-fade-overlay,.code-block:has(code[language=\"shell\"]) .code-block-fade-overlay,.code-block:has(code[language=\"console\"]) .code-block-fade-overlay,.code-block:has(code[language=\"zsh\"]) .code-block-fade-overlay{background:linear-gradient(\n to right,\n rgb(9 9 11 / 0) 0,\n rgb(9 9 11 / 0.85) 24px,\n var(--arg-terminal-bg) 48px\n )!important}.code-block:has(code[language=\"shellscript\"]) [data-component-part=\"code-block-header\"],.code-block:has(code[language=\"bash\"]) [data-component-part=\"code-block-header\"],.code-block:has(code[language=\"sh\"]) [data-component-part=\"code-block-header\"],.code-block:has(code[language=\"shell\"]) [data-component-part=\"code-block-header\"],.code-block:has(code[language=\"console\"]) [data-component-part=\"code-block-header\"],.code-block:has(code[language=\"zsh\"]) [data-component-part=\"code-block-header\"]{background:var(--arg-terminal-bar);border-bottom:1px solid var(--arg-terminal-border);padding:0.375rem 0.625rem 0.375rem 0.75rem}.code-block:has(code[language=\"shellscript\"]) [data-component-part=\"code-block-header-filename\"],.code-block:has(code[language=\"bash\"]) [data-component-part=\"code-block-header-filename\"],.code-block:has(code[language=\"sh\"]) [data-component-part=\"code-block-header-filename\"],.code-block:has(code[language=\"shell\"]) [data-component-part=\"code-block-header-filename\"],.code-block:has(code[language=\"console\"]) [data-component-part=\"code-block-header-filename\"],.code-block:has(code[language=\"zsh\"]) [data-component-part=\"code-block-header-filename\"]{color:var(--arg-terminal-title)!important;font-family:ui-monospace, SFMono-Regular, Menlo, monospace;font-size:0.75rem;user-select:none}.code-block:has(code[language=\"shellscript\"]) [data-component-part=\"code-block-header-filename\"]::before,.code-block:has(code[language=\"bash\"]) [data-component-part=\"code-block-header-filename\"]::before,.code-block:has(code[language=\"sh\"]) [data-component-part=\"code-block-header-filename\"]::before,.code-block:has(code[language=\"shell\"]) [data-component-part=\"code-block-header-filename\"]::before,.code-block:has(code[language=\"console\"]) [data-component-part=\"code-block-header-filename\"]::before,.code-block:has(code[language=\"zsh\"]) [data-component-part=\"code-block-header-filename\"]::before{content:\"\";flex:none;width:9px;height:9px;border-radius:9999px;background:#ff5f57;box-shadow:14px 0 0 #febc2e,\n 28px 0 0 #28c840;margin-right:2.375rem}"}],"page":{"pagePath":"api-reference/agent/send-message","slug":"/api-reference/agent/send-message","pageMetadata":{"title":"Start an agent run","openapi":"POST /api/agent/message","description":"Run one agent turn. Returns `200` with `job_id` and `call_id` when the turn starts, or `202` with `queue_id` and `position` when a turn is already running on the chat and this one was queued behind it. The turn executes in the background - poll `GET /api/agent/status/{callId}` for the result.","href":"/api-reference/agent/send-message"},"description":{"compiledSource":"\"use strict\";\nconst {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(_components.p, {\n children: [\"Run one agent turn. Returns \", _jsx(_components.code, {\n children: \"200\"\n }), \" with \", _jsx(_components.code, {\n children: \"job_id\"\n }), \" and \", _jsx(_components.code, {\n children: \"call_id\"\n }), \" when the turn starts, or \", _jsx(_components.code, {\n children: \"202\"\n }), \" with \", _jsx(_components.code, {\n children: \"queue_id\"\n }), \" and \", _jsx(_components.code, {\n children: \"position\"\n }), \" when a turn is already running on the chat and this one was queued behind it. The turn executes in the background - poll \", _jsx(_components.code, {\n children: \"GET /api/agent/status/{callId}\"\n }), \" for the result.\"]\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":"Start an agent run","openapi":"POST /api/agent/message","description":"Run one agent turn. Returns `200` with `job_id` and `call_id` when the turn starts, or `202` with `queue_id` and `position` when a turn is already running on the chat and this one was queued behind it. The turn executes in the background - poll `GET /api/agent/status/{callId}` for the result.","href":"/api-reference/agent/send-message"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/relevanceai-docs/b158b20cc35b89b7/custom.js"],"openApiReferenceData":{"operation":{"operationId":"postApiAgentMessage","summary":"Start an agent run","description":"Run one agent turn. Returns `200` with `job_id` and `call_id` when the turn starts, or `202` with `queue_id` and `position` when a turn is already running on the chat and this one was queued behind it. The turn executes in the background - poll `GET /api/agent/status/{callId}` for the result.","tags":["agent"],"parameters":[],"requestBody":"74de528f-f6a2-4a43-b64e-fd27448aa4b5","responses":{"200":"6cf83bc6-b91c-41a0-b6ce-e9f1e8c887e3","default":"2b2a6148-a35b-4303-a9e8-29f49be4c0c4"},"security":["c5b2fb8b-5fc6-4ab4-b042-7252d13503e8","dcb42fb2-61f7-47ad-8c34-d474d280f705"],"method":"post","type":"path","servers":["7d5ad1f9-7da4-4aa6-8520-9972dae38171"],"path":"/api/agent/message","baseUrlOptions":["https://api.arg.ai"],"title":"Start an agent run","codeSamples":[],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.message":"\u003cstring>","body.chat_id":"\u003cstring>","body.workspace_id":"\u003cstring>","body.attached_workspaces.items.0.workspace_id":"\u003cstring>","body.organization_id":"\u003cstring>","body.model":"\u003cstring>","body.max_tool_iterations":123,"body.read_only":true,"body.notify_on_complete":true,"body.disabled_skills.items.0":"\u003cstring>","body.disabled_agents.items.0":"\u003cstring>","body.message_id":"\u003cstring>"}]},"dependencies":{"parameters":{},"requestBody":{"description":"Send `message` for plain text. `chat_id` is optional - omit it and a new chat is created on the first send.","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The user message to run. Required unless you send `parts`.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"chat_id":{"type":"string","description":"Chat to run the turn on. A new chat is created when omitted.","uniqueKey":"chat_id","typeLabel":"string"},"workspace_id":{"type":"string","description":"Workspace the agent works in. Without it the agent has no files and no sandbox.","uniqueKey":"workspace_id","typeLabel":"string"},"attached_workspaces":{"type":"array","description":"Other workspaces the agent may reach in this chat, each at `workspaces/\u003calias>/` - the alias is assigned by the server the first time a workspace is added and never reused for another workspace in the same chat. Replaces the chat's current set when the turn starts; omit it to keep that set. Up to 5. A workspace you cannot read is dropped, and `edit` falls back to `read` without write access. Every write into one waits for the user's approval, so on an API call with no one to approve it the write is refused. Ignored on a chat a service account owns.","items":{"type":"object","properties":{"workspace_id":{"type":"string","description":"Workspace to add.","isRequired":true,"uniqueKey":"attached_workspaces.items.[INDEX].workspace_id","typeLabel":"string"},"mode":{"type":"string","description":"`read` (the default) or `edit`.","enum":["read","edit"],"uniqueKey":"attached_workspaces.items.[INDEX].mode","typeLabel":"enum\u003cstring>"}},"required":["workspace_id"],"uniqueKey":"attached_workspaces.items.[INDEX]","typeLabel":"object"},"uniqueKey":"attached_workspaces","typeLabel":"object[]"},"organization_id":{"type":"string","description":"Organization context. Defaults to the credential's organization.","uniqueKey":"organization_id","typeLabel":"string"},"model":{"type":"string","description":"Model id, for example `anthropic/claude-haiku-4.5`. Defaults per organization.","uniqueKey":"model","typeLabel":"string"},"reasoning_effort":{"type":"string","description":"Reasoning depth. Clamped to what the selected model supports.","enum":["none","low","medium","high"],"uniqueKey":"reasoning_effort","typeLabel":"enum\u003cstring>"},"max_tool_iterations":{"type":"integer","description":"Maximum tool-use rounds for this turn, from 1 to 100.","uniqueKey":"max_tool_iterations","typeLabel":"integer"},"read_only":{"type":"boolean","description":"Run with read-only tools, so the turn cannot modify the workspace.","uniqueKey":"read_only","typeLabel":"boolean"},"notify_on_complete":{"type":"boolean","description":"Send a completion push to the acting user's registered devices after a successful answer. Defaults to false. No email or inbox row is created; service accounts do not receive this alert.","uniqueKey":"notify_on_complete","typeLabel":"boolean"},"disabled_skills":{"type":"array","description":"Workspace skill names to withhold from this turn.","items":{"type":"string","uniqueKey":"disabled_skills.items.[INDEX]","typeLabel":"string"},"uniqueKey":"disabled_skills","typeLabel":"string[]"},"disabled_agents":{"type":"array","description":"Subagent names to withhold from this turn.","items":{"type":"string","uniqueKey":"disabled_agents.items.[INDEX]","typeLabel":"string"},"uniqueKey":"disabled_agents","typeLabel":"string[]"},"message_id":{"type":"string","description":"Client-supplied UUID for the user message. Generated when omitted.","uniqueKey":"message_id","typeLabel":"string"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","chat_id":"\u003cstring>","workspace_id":"\u003cstring>","attached_workspaces":[{"workspace_id":"\u003cstring>"}],"organization_id":"\u003cstring>","model":"\u003cstring>","max_tool_iterations":123,"read_only":true,"notify_on_complete":true,"disabled_skills":["\u003cstring>"],"disabled_agents":["\u003cstring>"],"message_id":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"6cf83bc6-b91c-41a0-b6ce-e9f1e8c887e3":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{}}},"exampleType":"generated"}},"exampleType":"generated"},"2b2a6148-a35b-4303-a9e8-29f49be4c0c4":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","uniqueKey":"detail","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"detail":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"c5b2fb8b-5fc6-4ab4-b042-7252d13503e8":{"Bearer-token":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"Bearer-token"}},"dcb42fb2-61f7-47ad-8c34-d474d280f705":{"API-key":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[],"schemeName":"API-key"}}},"servers":{"7d5ad1f9-7da4-4aa6-8520-9972dae38171":{"url":"https://api.arg.ai"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"Bearer-token"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"Bearer-token","name":"Authorization"}],"title":"Bearer-token"},{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[],"schemeName":"API-key"},"schema":{"title":"x-api-key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"API-key","name":"x-api-key"}],"title":"API-key"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"relevanceai-docs","siteName":"arg.ai","title":"Start an agent run - arg.ai","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-12T14:52:02.385Z","originalFileLocation":"api-reference/agent/send-message.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Run one agent turn. Returns 200 with job_id and call_id when the turn starts, or 202 with queue_id and position when a turn is already running on the chat and this one was queued behind it. The turn executes in the background - poll GET /api/agent/status/{callId} for the result.\">\u003cmeta data-mint-head name=\"application-name\" content=\"arg.ai\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/relevanceai-docs/AkHi6r04eAFa6tzw/_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/relevanceai-docs/AkHi6r04eAFa6tzw/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/relevanceai-docs/AkHi6r04eAFa6tzw/_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/relevanceai-docs/AkHi6r04eAFa6tzw/_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/relevanceai-docs/AkHi6r04eAFa6tzw/_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/relevanceai-docs/AkHi6r04eAFa6tzw/_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/relevanceai-docs/AkHi6r04eAFa6tzw/_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/relevanceai-docs/AkHi6r04eAFa6tzw/_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/relevanceai-docs/AkHi6r04eAFa6tzw/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Start an agent run - arg.ai\">\u003cmeta data-mint-head property=\"og:description\" content=\"Run one agent turn. Returns 200 with job_id and call_id when the turn starts, or 202 with queue_id and position when a turn is already running on the chat and this one was queued behind it. The turn executes in the background - poll GET /api/agent/status/{callId} for the result.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"arg.ai docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.arg.ai/api-reference/agent/send-message\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://relevanceai-docs.mintlify.site/_mintlify/api/og/v2?division=Agent\u0026amp;title=Start+an+agent+run\u0026amp;description=Run+one+agent+turn.+Returns+%60200%60+with+%60job_id%60+and+%60call_id%60+when+the+turn+starts%2C+or+%60202%60+with+%60queue_id%60+and+%60position%60+when+a+turn+is+already+running+on+th\u0026amp;theme=977ce49dde30d3c62b6e0fad\u0026amp;signature=5ff802f37f9ae21adcca08c306dbe1b6ff7fc8ce41cd5d17e04b62323ec7cf48\">\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=\"Start an agent run - arg.ai\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Run one agent turn. Returns 200 with job_id and call_id when the turn starts, or 202 with queue_id and position when a turn is already running on the chat and this one was queued behind it. The turn executes in the background - poll GET /api/agent/status/{callId} for the result.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://relevanceai-docs.mintlify.site/_mintlify/api/og/v2?division=Agent\u0026amp;title=Start+an+agent+run\u0026amp;description=Run+one+agent+turn.+Returns+%60200%60+with+%60job_id%60+and+%60call_id%60+when+the+turn+starts%2C+or+%60202%60+with+%60queue_id%60+and+%60position%60+when+a+turn+is+already+running+on+th\u0026amp;theme=977ce49dde30d3c62b6e0fad\u0026amp;signature=5ff802f37f9ae21adcca08c306dbe1b6ff7fc8ce41cd5d17e04b62323ec7cf48\">\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/relevanceai-docs/AkHi6r04eAFa6tzw/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"arg.ai\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#18181B\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.arg.ai/api-reference/agent/send-message\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/agent/send-message.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.arg.ai/#organization\",\"name\":\"arg.ai\",\"url\":\"https://developers.arg.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/relevanceai-docs/zsccF0hnTHoJIc4d/logo/light.svg?fit=max\u0026auto=format\u0026n=zsccF0hnTHoJIc4d\u0026q=85\u0026s=0e8f44bd3b309a747d1f730aff1238ce\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.arg.ai#website\",\"name\":\"arg.ai\",\"url\":\"https://developers.arg.ai\",\"publisher\":{\"@id\":\"https://developers.arg.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.arg.ai/api-reference/agent/send-message#webpage\",\"url\":\"https://developers.arg.ai/api-reference/agent/send-message\",\"name\":\"Start an agent run\",\"description\":\"Run one agent turn. Returns 200 with job_id and call_id when the turn starts, or 202 with queue_id and position when a turn is already running on the chat and this one was queued behind it. The turn executes in the background - poll GET /api/agent/status/{callId} for the result.\",\"dateModified\":\"2026-08-12T14:52:02.385Z\",\"isPartOf\":{\"@id\":\"https://developers.arg.ai#website\"},\"breadcrumb\":{\"@id\":\"https://developers.arg.ai/api-reference/agent/send-message#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.arg.ai/api-reference/agent/send-message#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Agent\",\"item\":\"https://developers.arg.ai/api-reference/agent/create-chat\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Start an agent run\",\"item\":\"https://developers.arg.ai/api-reference/agent/send-message\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.arg.ai/api-reference/agent/send-message#apireference\",\"headline\":\"Start an agent run\",\"name\":\"Start an agent run\",\"description\":\"Run one agent turn. Returns 200 with job_id and call_id when the turn starts, or 202 with queue_id and position when a turn is already running on the chat and this one was queued behind it. The turn executes in the background - poll GET /api/agent/status/{callId} for the result.\",\"url\":\"https://developers.arg.ai/api-reference/agent/send-message\",\"mainEntityOfPage\":{\"@id\":\"https://developers.arg.ai/api-reference/agent/send-message#webpage\"},\"dateModified\":\"2026-08-12T14:52:02.385Z\",\"publisher\":{\"@id\":\"https://developers.arg.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.arg.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"arg.ai\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"arg.ai","nav":{"global":{"anchors":[{"anchor":"API Reference","icon":"terminal","href":"/api-reference/introduction"},{"anchor":"GitHub","icon":"github","href":"https://github.com/arg-ai"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API Reference","href":"/api-reference/introduction"}]},{"group":"Agent","pages":[{"title":"Create a chat","openapi":"POST /api/agent","description":"Create the chat an agent run happens in. You can skip this and let `POST /api/agent/message` create one implicitly on the first send.","href":"/api-reference/agent/create-chat"},{"title":"Start an agent run","openapi":"POST /api/agent/message","href":"/api-reference/agent/send-message"},{"title":"Get run status","openapi":"GET /api/agent/status/{callId}","description":"Poll a run. `status` is `pending` while it is in flight, then `completed` or `error`. A completed run carries `result.response` and `result.toolOutputs`.","href":"/api-reference/agent/get-run-status"},{"title":"Get the pending run for a chat","openapi":"GET /api/agent/pending/{chatId}","href":"/api-reference/agent/get-pending-run"},{"title":"Stop a running turn","openapi":"POST /api/agent/stop/{jobId}","href":"/api-reference/agent/stop-run"},{"title":"Release a finished run","openapi":"POST /api/agent/cleanup/{jobId}","href":"/api-reference/agent/cleanup-run"},{"title":"List queued messages","openapi":"GET /api/agent/queue/{chatId}","href":"/api-reference/agent/list-queue"},{"title":"Steer the running turn","openapi":"POST /api/agent/queue/{chatId}/{queueId}/steer","href":"/api-reference/agent/steer-queued-message"},{"title":"Interrupt the running tool call","openapi":"POST /api/agent/interrupt/{chatId}","href":"/api-reference/agent/interrupt-running-tool"},{"title":"Reorder a queued message","openapi":"PATCH /api/agent/queue/{chatId}/{queueId}/reorder","href":"/api-reference/agent/reorder-queued-message"},{"title":"Remove a queued message","openapi":"DELETE /api/agent/queue/{chatId}/{queueId}","href":"/api-reference/agent/remove-queued-message"},{"title":"Report context usage","openapi":"GET /api/agent/context/{chatId}","href":"/api-reference/agent/get-context-report"}]},{"group":"Agent Tools","pages":[{"title":"Run a shell command","openapi":"POST /api/workspaces/{workspaceId}/tools/run-bash","href":"/api-reference/tools/run-bash"},{"title":"Read a text file","openapi":"POST /api/workspaces/{workspaceId}/tools/read-file","href":"/api-reference/tools/read-file"},{"title":"Write a text file","openapi":"POST /api/workspaces/{workspaceId}/tools/write-file","href":"/api-reference/tools/write-file"},{"title":"Replace a string in a file","openapi":"POST /api/workspaces/{workspaceId}/tools/edit-file","href":"/api-reference/tools/edit-file"},{"title":"Apply several edits to one file","openapi":"POST /api/workspaces/{workspaceId}/tools/multi-edit","href":"/api-reference/tools/multi-edit"},{"title":"Search file contents","openapi":"POST /api/workspaces/{workspaceId}/tools/grep","href":"/api-reference/tools/grep"}]},{"group":"Actions","pages":[{"title":"List Actions","openapi":"GET /api/actions","href":"/api-reference/actions/list-actions"},{"title":"Get an Action's schemas","openapi":"GET /api/actions/{actionId}/schema","href":"/api-reference/actions/get-action-schema"},{"title":"Run an Action","openapi":"POST /api/workspaces/{workspaceId}/actions/{actionId}/run","href":"/api-reference/actions/run-action"},{"title":"Run several Actions","openapi":"POST /api/workspaces/{workspaceId}/actions/run-batch","href":"/api-reference/actions/run-action-batch"},{"title":"Describe an Action's dynamic fields","openapi":"GET /api/workspaces/{workspaceId}/actions/{actionId}/describe","href":"/api-reference/actions/describe-action-field"},{"title":"List Action runs","openapi":"GET /api/workspaces/{workspaceId}/actions/runs","href":"/api-reference/actions/list-action-runs"},{"title":"Get an Action run","openapi":"GET /api/workspaces/{workspaceId}/actions/runs/{runId}","href":"/api-reference/actions/get-action-run"}]},{"group":"Search","pages":[{"title":"Search a workspace","openapi":"POST /api/workspaces/{workspaceId}/search","href":"/api-reference/search/search-workspace"},{"title":"Search an organization","openapi":"POST /api/organizations/{orgId}/search","href":"/api-reference/search/search-organization"},{"title":"Reindex a workspace","openapi":"POST /api/workspaces/{workspaceId}/search/reindex","href":"/api-reference/search/reindex-workspace"},{"title":"Get search settings","openapi":"GET /api/workspaces/{workspaceId}/search/settings","href":"/api-reference/search/get-search-settings"},{"title":"Update search settings","openapi":"PUT /api/workspaces/{workspaceId}/search/settings","href":"/api-reference/search/update-search-settings"},{"title":"List indexable file types","openapi":"GET /api/workspaces/{workspaceId}/search/supported-types","href":"/api-reference/search/list-indexable-types"}]},{"group":"Workspaces","pages":[{"title":"List workspaces","openapi":"GET /api/workspaces","href":"/api-reference/workspaces/list-workspaces"},{"title":"Create a personal workspace","openapi":"POST /api/workspaces","href":"/api-reference/workspaces/create-workspace"},{"title":"Update a workspace","openapi":"PATCH /api/workspaces/{workspaceId}","href":"/api-reference/workspaces/update-workspace"},{"title":"Delete a workspace","openapi":"DELETE /api/workspaces/{workspaceId}","href":"/api-reference/workspaces/delete-workspace"},{"title":"Set workspace visibility","openapi":"PATCH /api/workspaces/{workspaceId}/visibility","href":"/api-reference/workspaces/set-visibility"},{"title":"List workspace members","openapi":"GET /api/workspaces/{workspaceId}/members","href":"/api-reference/workspaces/list-workspace-members"},{"title":"List workspace activity","openapi":"GET /api/workspaces/{workspaceId}/activity","href":"/api-reference/workspaces/list-workspace-activity"},{"title":"List workspace skills and subagents","openapi":"GET /api/workspaces/{workspaceId}/skills-and-agents","href":"/api-reference/workspaces/list-skills-and-agents"},{"title":"List organization workspaces","openapi":"GET /api/organizations/{orgId}/workspaces","href":"/api-reference/workspaces/list-org-workspaces"},{"title":"Create an organization workspace","openapi":"POST /api/organizations/{orgId}/workspaces","href":"/api-reference/workspaces/create-org-workspace"}]},{"group":"Files","pages":[{"title":"List a folder","openapi":"GET /api/workspaces/{workspaceId}/files","href":"/api-reference/files/list-files"},{"title":"Get the file tree","openapi":"GET /api/workspaces/{workspaceId}/files/tree","href":"/api-reference/files/get-file-tree"},{"title":"Get file metadata","openapi":"GET /api/workspaces/{workspaceId}/files/info","href":"/api-reference/files/get-file-info"},{"title":"Read file content","openapi":"GET /api/workspaces/{workspaceId}/files/content","href":"/api-reference/files/get-file-content"},{"title":"Write file content","openapi":"PUT /api/workspaces/{workspaceId}/files/content","href":"/api-reference/files/update-file-content"},{"title":"Upload a file","openapi":"POST /api/workspaces/{workspaceId}/files/upload","href":"/api-reference/files/upload-file"},{"title":"Start a multipart upload","openapi":"POST /api/workspaces/{workspaceId}/files/upload/initiate","href":"/api-reference/files/initiate-multipart-upload"},{"title":"Upload a part","openapi":"POST /api/workspaces/{workspaceId}/files/upload/part","href":"/api-reference/files/upload-part"},{"title":"Complete a multipart upload","openapi":"POST /api/workspaces/{workspaceId}/files/upload/complete","href":"/api-reference/files/complete-multipart-upload"},{"title":"Abort a multipart upload","openapi":"POST /api/workspaces/{workspaceId}/files/upload/abort","href":"/api-reference/files/abort-multipart-upload"},{"title":"Download a file","openapi":"GET /api/workspaces/{workspaceId}/files/download","href":"/api-reference/files/download-file"},{"title":"Download a folder","openapi":"GET /api/workspaces/{workspaceId}/files/download-folder","href":"/api-reference/files/download-folder"},{"title":"Create a folder","openapi":"POST /api/workspaces/{workspaceId}/files/mkdir","href":"/api-reference/files/create-folder"},{"title":"Move or rename a file","openapi":"POST /api/workspaces/{workspaceId}/files/move","href":"/api-reference/files/move-file"},{"title":"Copy a file","openapi":"POST /api/workspaces/{workspaceId}/files/copy","href":"/api-reference/files/copy-file"},{"title":"Delete files","openapi":"DELETE /api/workspaces/{workspaceId}/files","href":"/api-reference/files/delete-files"},{"title":"List file versions","openapi":"GET /api/workspaces/{workspaceId}/files/versions","href":"/api-reference/files/list-file-versions"},{"title":"Read a file version","openapi":"GET /api/workspaces/{workspaceId}/files/versions/{versionId}/content","href":"/api-reference/files/get-file-version"},{"title":"Restore a file version","openapi":"POST /api/workspaces/{workspaceId}/files/versions/{versionId}/restore","href":"/api-reference/files/restore-file-version"},{"title":"List a file's change history","openapi":"GET /api/workspaces/{workspaceId}/files/history","href":"/api-reference/files/get-file-history"},{"title":"Get a file's stable id","openapi":"POST /api/workspaces/{workspaceId}/files/get-id","href":"/api-reference/files/get-file-id"},{"title":"Resolve a file id to a path","openapi":"GET /api/workspaces/{workspaceId}/files/resolve-id","href":"/api-reference/files/resolve-file-id"},{"title":"List files a file points at","openapi":"GET /api/workspaces/{workspaceId}/files/references","href":"/api-reference/files/list-file-references"},{"title":"List files that point at a file","openapi":"GET /api/workspaces/{workspaceId}/files/referenced-by","href":"/api-reference/files/list-referencing-files"},{"title":"Lock a file","openapi":"POST /api/workspaces/{workspaceId}/files/lock","href":"/api-reference/files/lock-file"},{"title":"Unlock a file","openapi":"POST /api/workspaces/{workspaceId}/files/unlock","href":"/api-reference/files/unlock-file"},{"title":"List file locks","openapi":"GET /api/workspaces/{workspaceId}/files/protections","href":"/api-reference/files/list-file-locks"}]},{"group":"Sharing","pages":[{"title":"Create a share link","openapi":"POST /api/workspaces/{workspaceId}/files/share","href":"/api-reference/sharing/create-share-link"},{"title":"List share links","openapi":"GET /api/workspaces/{workspaceId}/shares","href":"/api-reference/sharing/list-shares"},{"title":"Delete a share link","openapi":"DELETE /api/workspaces/{workspaceId}/shares/{shareId}","href":"/api-reference/sharing/delete-share"},{"title":"Get share link details","openapi":"GET /api/share/{shareId}/info","href":"/api-reference/sharing/get-share-info"},{"title":"Download a shared file","openapi":"POST /api/share/{shareId}/download","href":"/api-reference/sharing/download-shared-file"}]},{"group":"Chats","pages":[{"title":"List chats","openapi":"GET /api/chats","href":"/api-reference/chats/list-chats"},{"title":"Create a chat","openapi":"POST /api/chats","href":"/api-reference/chats/create-chat"},{"title":"Get a chat","openapi":"GET /api/chats/{chatId}","href":"/api-reference/chats/get-chat"},{"title":"Rename a chat","openapi":"PATCH /api/chats/{chatId}","href":"/api-reference/chats/update-chat"},{"title":"Pin or unpin a chat","openapi":"PUT /api/chats/{chatId}/pin","href":"/api-reference/chats/pin-chat"},{"title":"Archive or unarchive a chat","openapi":"POST /api/chats/{chatId}/archive","href":"/api-reference/chats/archive-chat"},{"title":"Delete a chat","openapi":"DELETE /api/chats/{chatId}","href":"/api-reference/chats/delete-chat"}]},{"group":"Automations","pages":[{"title":"Run an automation","openapi":"POST /api/automation/trigger","href":"/api-reference/automations/run-automation"},{"title":"Get automation run status","openapi":"GET /api/automation/status/{jobId}","href":"/api-reference/automations/get-run-status"},{"title":"Stream automation events","openapi":"GET /api/automation/poll/{jobId}","href":"/api-reference/automations/stream-run-events"},{"title":"Stop an automation run","openapi":"POST /api/automation/stop/{jobId}","href":"/api-reference/automations/stop-run"},{"title":"Release a finished automation run","openapi":"POST /api/automation/cleanup/{jobId}","href":"/api-reference/automations/cleanup-run"},{"title":"List automation runs","openapi":"GET /api/automation/history","href":"/api-reference/automations/list-runs"},{"title":"Get one automation run","openapi":"GET /api/automation/history/{jobId}","href":"/api-reference/automations/get-run"},{"title":"Deploy an automation","openapi":"POST /api/automation/deploy","href":"/api-reference/automations/deploy-automation"},{"title":"List deployed automations","openapi":"GET /api/automation/deployments","href":"/api-reference/automations/list-deployments"},{"title":"Pause a deployed automation","openapi":"POST /api/automation/deployments/pause","href":"/api-reference/automations/pause-deployment"},{"title":"Resume a deployed automation","openapi":"POST /api/automation/deployments/resume","href":"/api-reference/automations/resume-deployment"},{"title":"Stop a deployed automation","openapi":"POST /api/automation/deployments/stop","href":"/api-reference/automations/stop-deployment"},{"title":"Delete a deployed automation","openapi":"DELETE /api/automation/deployments","href":"/api-reference/automations/delete-deployment"},{"title":"List registered triggers","openapi":"GET /api/automation/triggers","href":"/api-reference/automations/list-triggers"}]},{"group":"Servers","pages":[{"title":"Start a server","openapi":"POST /api/tunnels","href":"/api-reference/tunnels/create-tunnel"},{"title":"List servers","openapi":"GET /api/tunnels","href":"/api-reference/tunnels/list-tunnels"},{"title":"Get a server","openapi":"GET /api/tunnels/{tunnelId}","href":"/api-reference/tunnels/get-tunnel"},{"title":"Stop a server","openapi":"DELETE /api/tunnels/{tunnelId}","href":"/api-reference/tunnels/delete-tunnel"},{"title":"Get a URL for a protected server","openapi":"POST /api/tunnels/{tunnelId}/access-url","href":"/api-reference/tunnels/get-access-url"}]},{"group":"Sites","pages":[{"title":"Create a site","openapi":"POST /api/sites","href":"/api-reference/sites/create-site"},{"title":"List sites","openapi":"GET /api/sites","href":"/api-reference/sites/list-sites"},{"title":"Get a site","openapi":"GET /api/sites/{id}","href":"/api-reference/sites/get-site"},{"title":"Update a site","openapi":"PATCH /api/sites/{id}","href":"/api-reference/sites/update-site"},{"title":"Delete a site","openapi":"DELETE /api/sites/{id}","href":"/api-reference/sites/delete-site"},{"title":"Build a new version","openapi":"POST /api/sites/{id}/versions","href":"/api-reference/sites/build-version"},{"title":"Get a version","openapi":"GET /api/sites/{id}/versions/{vid}","href":"/api-reference/sites/get-version"},{"title":"Get build logs","openapi":"GET /api/sites/{id}/versions/{vid}/logs","href":"/api-reference/sites/get-build-logs"},{"title":"Promote a version","openapi":"POST /api/sites/{id}/promote","href":"/api-reference/sites/promote-version"},{"title":"List environment variables","openapi":"GET /api/sites/{id}/env","href":"/api-reference/sites/list-env-vars"},{"title":"Set environment variables","openapi":"PUT /api/sites/{id}/env","href":"/api-reference/sites/set-env-vars"},{"title":"Delete an environment variable","openapi":"DELETE /api/sites/{id}/env/{name}","href":"/api-reference/sites/delete-env-var"}]},{"group":"Notifications","pages":[{"title":"List notifications","openapi":"GET /api/notifications","href":"/api-reference/notifications/list-notifications"},{"title":"Send a notification","openapi":"POST /api/notifications","href":"/api-reference/notifications/send-notification"},{"title":"Mark a notification as read","openapi":"PATCH /api/notifications/{id}/read","href":"/api-reference/notifications/mark-read"},{"title":"Mark all notifications as read","openapi":"POST /api/notifications/read-all","href":"/api-reference/notifications/mark-all-read"},{"title":"Get notification preferences","openapi":"GET /api/notifications/preferences","href":"/api-reference/notifications/get-preferences"},{"title":"Update notification preferences","openapi":"PUT /api/notifications/preferences","href":"/api-reference/notifications/update-preferences"}]},{"group":"API Keys","pages":[{"title":"Create a service account","openapi":"POST /api/service-accounts","href":"/api-reference/api-keys/create-service-account"},{"title":"List service accounts","openapi":"GET /api/service-accounts","href":"/api-reference/api-keys/list-service-accounts"},{"title":"Delete a service account","openapi":"DELETE /api/service-accounts/{serviceAccountId}","href":"/api-reference/api-keys/delete-service-account"},{"title":"Create an API key","openapi":"POST /api/keys","href":"/api-reference/api-keys/create-api-key"},{"title":"List API keys","openapi":"GET /api/keys","href":"/api-reference/api-keys/list-api-keys"},{"title":"Revoke an API key","openapi":"POST /api/keys/{keyId}/revoke","href":"/api-reference/api-keys/revoke-api-key"},{"title":"Delete an API key","openapi":"DELETE /api/keys/{keyId}","href":"/api-reference/api-keys/delete-api-key"}]},{"group":"Organizations","pages":[{"title":"List organizations","openapi":"GET /api/organizations","href":"/api-reference/organizations/list-organizations"},{"title":"Create an organization","openapi":"POST /api/organizations","href":"/api-reference/organizations/create-organization"},{"title":"Get an organization","openapi":"GET /api/organizations/{orgId}","href":"/api-reference/organizations/get-organization"},{"title":"Update an organization","openapi":"PATCH /api/organizations/{orgId}","href":"/api-reference/organizations/update-organization"},{"title":"Delete an organization","openapi":"DELETE /api/organizations/{orgId}","href":"/api-reference/organizations/delete-organization"},{"title":"Get your permissions","openapi":"GET /api/organizations/{orgId}/my-permissions","href":"/api-reference/organizations/get-my-permissions"},{"title":"List members","openapi":"GET /api/organizations/{orgId}/members","href":"/api-reference/organizations/list-members"},{"title":"Change a member's role","openapi":"PATCH /api/organizations/{orgId}/members/{userId}","href":"/api-reference/organizations/update-member-role"},{"title":"Remove a member","openapi":"DELETE /api/organizations/{orgId}/members/{userId}","href":"/api-reference/organizations/remove-member"},{"title":"Invite someone","openapi":"POST /api/organizations/{orgId}/invitations","href":"/api-reference/organizations/create-invitation"},{"title":"List invitations","openapi":"GET /api/organizations/{orgId}/invitations","href":"/api-reference/organizations/list-invitations"},{"title":"Revoke an invitation","openapi":"DELETE /api/organizations/{orgId}/invitations/{invitationId}","href":"/api-reference/organizations/revoke-invitation"},{"title":"Get invitation details","openapi":"GET /api/invitations/{token}","href":"/api-reference/organizations/get-invitation-info"},{"title":"Accept an invitation","openapi":"POST /api/invitations/{token}/accept","href":"/api-reference/organizations/accept-invitation"},{"title":"List custom roles","openapi":"GET /api/organizations/{orgId}/roles","href":"/api-reference/organizations/list-roles"},{"title":"Create a custom role","openapi":"POST /api/organizations/{orgId}/roles","href":"/api-reference/organizations/create-role"},{"title":"Update a custom role","openapi":"PATCH /api/organizations/{orgId}/roles/{roleId}","href":"/api-reference/organizations/update-role"},{"title":"Delete a custom role","openapi":"DELETE /api/organizations/{orgId}/roles/{roleId}","href":"/api-reference/organizations/delete-role"},{"title":"List secrets","openapi":"GET /api/organizations/{orgId}/secrets","href":"/api-reference/organizations/list-secrets"},{"title":"Create or rotate a secret","openapi":"PUT /api/organizations/{orgId}/secrets/{name}","href":"/api-reference/organizations/set-secret"},{"title":"Delete a secret","openapi":"DELETE /api/organizations/{orgId}/secrets/{name}","href":"/api-reference/organizations/delete-secret"}]},{"group":"Models","pages":[{"title":"List models","openapi":"GET /api/models","href":"/api-reference/models/list-models"},{"title":"Get enabled models","openapi":"GET /api/organizations/{orgId}/models","href":"/api-reference/models/get-org-models"},{"title":"Update enabled models","openapi":"PUT /api/organizations/{orgId}/models","href":"/api-reference/models/update-org-models"}]},{"group":"Account","pages":[{"title":"Identify the calling credential","openapi":"GET /api/auth/principal","href":"/api-reference/auth/get-principal"},{"title":"Get the current user","openapi":"GET /api/auth/me","href":"/api-reference/auth/get-current-user"},{"title":"Update your profile","openapi":"PATCH /api/auth/me/profile","href":"/api-reference/auth/update-profile"},{"title":"Request a password reset","openapi":"POST /api/auth/me/password-reset","href":"/api-reference/auth/request-password-reset"},{"title":"List your sessions","openapi":"GET /api/auth/me/sessions","href":"/api-reference/auth/list-sessions"},{"title":"Revoke all other sessions","openapi":"DELETE /api/auth/me/sessions","href":"/api-reference/auth/revoke-all-sessions"},{"title":"Revoke a session","openapi":"DELETE /api/auth/me/sessions/{sessionId}","href":"/api-reference/auth/revoke-session"}]}]}]},"basePath":"","title":"Start an agent run - arg.ai","buildId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","deploymentId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","dynamics":["10e4515597","c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["BannerMarkdown-C79IUEr8.js","dist-DE3EVdvd.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","clsx-DK3K4Z1S.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-CBsVopKK.js","utils-DZAk68jJ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-D32AYZrP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D_A5_cny.js","snippetPresets-xNRfS9th.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BIB25-tq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CydJ4w4j.js","shallow-CYPBeQSG.js","getApiPlaygroundDisplay-A5xJVBOu.js","CodeSnippet-BVRTgi3m.js","CodeSnippets-DjD6BSlt.js","Page-Dr40SSJq.js","getPastedJson-D4V4JyrR.js","icon-uhcnG22T.js","MethodPill-CM-ZQdGH.js","DuplicateIcon-B_WnOiNf.js","createIcon-CJsb8utt.js","DynamicMarkdown-D-2HDKEp.js","SectionHeading-KP5xmMgQ.js","axios-vUo_bRtp.js","Markdown-D_k0dg6k.js","AssistantPageLink-fN9H9n9g.js"]}