Sends a new message from the user to the coding agent working in the session. The message is stored as a session event with the user_message type, then the agent either starts processing it immediately or the message is queued if the agent is already busy.
Required API key scopes: any of sessions:write, sessions:all, all:write, all:all.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Agen","colors":{"primary":"#009B53","light":"#009B53","dark":"#009B53"},"logo":{"light":"https://mintcdn.com/agen/2MIX_2KJFwHtuKkg/logo/light.svg?fit=max\u0026auto=format\u0026n=2MIX_2KJFwHtuKkg\u0026q=85\u0026s=31ddbe404217afcd3a9fad7570810a5a","dark":"https://mintcdn.com/agen/2MIX_2KJFwHtuKkg/logo/dark.svg?fit=max\u0026auto=format\u0026n=2MIX_2KJFwHtuKkg\u0026q=85\u0026s=aca515dbf28178f321daded8114ccf13"},"favicon":{"light":"https://mintcdn.com/agen/ko-W6P-LE2M7rk_a/favicon-light.svg?fit=max\u0026auto=format\u0026n=ko-W6P-LE2M7rk_a\u0026q=85\u0026s=e13b25995a9d06ad67d10f9eb82c9229","dark":"https://mintcdn.com/agen/ko-W6P-LE2M7rk_a/favicon-dark.svg?fit=max\u0026auto=format\u0026n=ko-W6P-LE2M7rk_a\u0026q=85\u0026s=e3316779db5c6674762b9270449d9ece"},"navbar":{"links":[{"href":"mailto:support@agen.ai","label":"Support"}],"primary":{"type":"button","label":"Agen Dashboard","href":"https://app.agenhq.com"}},"footer":{"socials":{"x":"https://x.com/agenhq","github":"https://github.com/agenhq"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Agen Web Portal","icon":"globe","href":"https://app.agenhq.com"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"agen","hasAudioNarration":false,"actualSubdomain":"agen","customDomains":["docs.agenhq.com"],"gitSource":{"type":"gitlab","owner":"agenhq","repo":"docs","projectId":79798455,"deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21ebb4642f8d7778392d9f","collectionId":"ca06dc91-b1b9-49c5-8e23-8c51a078a714","schemaVersion":"v2"},"entitlements":{},"buildId":"6a21ebb4642f8d7778392d9f:success","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"Coding Agent API","count":39},{"language":"default","tag":"Guides","count":7},{"language":"default","tag":"Repositories","count":7},{"language":"default","tag":"Sessions","count":6},{"language":"default","tag":"Core Concepts","count":4},{"language":"default","tag":"Code Providers","count":4},{"language":"default","tag":"Schemas","count":3},{"language":"default","tag":"Getting started","count":2},{"language":"default","tag":"CLI","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"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":"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":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/sessions/send-a-user-message-to-the-agent-in-a-session","slug":"/api-reference/sessions/send-a-user-message-to-the-agent-in-a-session","pageMetadata":{"title":"Send a user message to the agent in a session","description":"Sends a new message from the user to the coding agent working in the session. The message is stored as a session event with the `user_message` type, then the agent either starts processing it immediately or the message is queued if the agent is already busy.\n\nRequired API key scopes: any of `sessions:write`, `sessions:all`, `all:write`, `all:all`.","deprecated":null,"version":null,"openapi":"/coding-agent-api/openapi.json post /api/v1/sessions/{sessionId}/messages","href":"/api-reference/sessions/send-a-user-message-to-the-agent-in-a-session","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: [\"Sends a new message from the user to the coding agent working in the session. The message is stored as a session event with the \", _jsx(_components.code, {\n children: \"user_message\"\n }), \" type, then the agent either starts processing it immediately or the message is queued if the agent is already busy.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Required API key scopes: any of \", _jsx(_components.code, {\n children: \"sessions:write\"\n }), \", \", _jsx(_components.code, {\n children: \"sessions:all\"\n }), \", \", _jsx(_components.code, {\n children: \"all:write\"\n }), \", \", _jsx(_components.code, {\n children: \"all:all\"\n }), \".\"]\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":"Send a user message to the agent in a session","description":"Sends a new message from the user to the coding agent working in the session. The message is stored as a session event with the `user_message` type, then the agent either starts processing it immediately or the message is queued if the agent is already busy.\n\nRequired API key scopes: any of `sessions:write`, `sessions:all`, `all:write`, `all:all`.","deprecated":null,"version":null,"openapi":"/coding-agent-api/openapi.json post /api/v1/sessions/{sessionId}/messages","href":"/api-reference/sessions/send-a-user-message-to-the-agent-in-a-session","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"createSessionMessage","summary":"Send a user message to the agent in a session","tags":["Sessions"],"description":"Sends a new message from the user to the coding agent working in the session. The message is stored as a session event with the `user_message` type, then the agent either starts processing it immediately or the message is queued if the agent is already busy.\n\nRequired API key scopes: any of `sessions:write`, `sessions:all`, `all:write`, `all:all`.","requestBody":"78fafdd4-a93b-4762-8421-cb3feb3cad70","parameters":["34bc08ee-0e83-4e9e-beaa-8ede4df2dc9c"],"security":["94dc2a52-4ecd-4be1-8f0d-6c673e1a2288"],"responses":{"200":"a7c4bac3-28a0-4146-a682-1a92b964ee93","400":"c5e1548e-9e0c-402b-8897-a6daf74d944c","401":"35b50433-99b4-4939-86e8-1a34aba3b4a3","403":"0f3083a7-4292-4a61-bcfb-d3086ea71b17"},"method":"post","type":"path","servers":["ab5d6f87-97e8-432c-ba1c-963b37626786"],"path":"/api/v1/sessions/{sessionId}/messages","baseUrlOptions":["https://api.agenhq.com"],"title":"Send a user message to the agent in a session","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"34bc08ee-0e83-4e9e-beaa-8ede4df2dc9c":{"schema":{"minLength":1,"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"},"in":"path","name":"sessionId","required":true}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"minLength":1,"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"client_id":{"type":"string","uniqueKey":"client_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","client_id":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"a7c4bac3-28a0-4146-a682-1a92b964ee93":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["id","session_id","type","payload","status","client_id","session_goal_id","session_task_id","created_at","updated_at"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"session_id":{"type":"string","isRequired":true,"uniqueKey":"session_id","typeLabel":"string"},"type":{"enum":["user_message","agent_message","system_message","session_finished","session_closed","merge_request_merged","merge_request_closed","agent_file_tree_browse","agent_file_read","agent_file_edit","agent_file_create","agent_file_remove","agent_file_move","agent_file_copy","agent_file_read_range","agent_read_around_match","agent_search_files","agent_search_files_v2","agent_plan_execution_update","agent_ask_user","user_ask_user_response","agent_branch_diff","agent_uncommitted_changes","agent_conflict_state","agent_check_target_branch_mergeability","agent_merge_remote_branch","agent_pull_from_remote","agent_push_to_remote","agent_abort_conflict_resolution","agent_rollback_uncommitted_changes","agent_http_request","agent_web_browse","agent_run_repository_command","agent_alert_created"],"type":"string","isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"payload":{"oneOf":[{"type":"object","description":"A message sent by the user to the agent within a session. This is the payload created by the send message endpoint.","required":["type","message"],"properties":{"type":{"type":"string","enum":["user_message"],"isRequired":true,"uniqueKey":"payload.oneOf.0.type","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.0.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"payload.oneOf.0","typeLabel":"object"},{"type":"object","description":"A chat message emitted by the agent during a session and shown in the session timeline.","required":["type","message"],"properties":{"type":{"type":"string","enum":["agent_message"],"isRequired":true,"uniqueKey":"payload.oneOf.1.type","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.1.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"payload.oneOf.1","typeLabel":"object"},{"type":"object","description":"A system-generated informational message shown in the session timeline.","required":["type","message"],"properties":{"type":{"type":"string","enum":["system_message"],"isRequired":true,"uniqueKey":"payload.oneOf.2.type","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.2.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"payload.oneOf.2","typeLabel":"object"},{"type":"object","description":"Indicates that the session was finished, including the actor who finished it.","required":["type","actor"],"properties":{"type":{"type":"string","enum":["session_finished"],"isRequired":true,"uniqueKey":"payload.oneOf.3.type","typeLabel":"enum\u003cstring>"},"actor":{"type":"object","required":["id"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.3.actor.id","typeLabel":"string"},"first_name":{"oneOf":[{"type":"string","uniqueKey":"payload.oneOf.3.actor.first_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"payload.oneOf.3.actor.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"payload.oneOf.3.actor.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","uniqueKey":"payload.oneOf.3.actor.last_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"payload.oneOf.3.actor.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"payload.oneOf.3.actor.last_name","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","uniqueKey":"payload.oneOf.3.actor.email.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"payload.oneOf.3.actor.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"payload.oneOf.3.actor.email","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"payload.oneOf.3.actor","typeLabel":"object"}},"isRequired":true,"uniqueKey":"payload.oneOf.3","typeLabel":"object"},{"type":"object","description":"Indicates that the session was closed, including the actor who closed it.","required":["type","actor"],"properties":{"type":{"type":"string","enum":["session_closed"],"isRequired":true,"uniqueKey":"payload.oneOf.4.type","typeLabel":"enum\u003cstring>"},"actor":{"type":"object","required":["id"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.4.actor.id","typeLabel":"string"},"first_name":{"oneOf":[{"type":"string","uniqueKey":"payload.oneOf.4.actor.first_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"payload.oneOf.4.actor.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"payload.oneOf.4.actor.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","uniqueKey":"payload.oneOf.4.actor.last_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"payload.oneOf.4.actor.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"payload.oneOf.4.actor.last_name","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","uniqueKey":"payload.oneOf.4.actor.email.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"payload.oneOf.4.actor.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"payload.oneOf.4.actor.email","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"payload.oneOf.4.actor","typeLabel":"object"}},"isRequired":true,"uniqueKey":"payload.oneOf.4","typeLabel":"object"},{"type":"object","description":"Indicates that the session merge request was merged, including the actor who merged it.","required":["type","actor"],"properties":{"type":{"type":"string","enum":["merge_request_merged"],"isRequired":true,"uniqueKey":"payload.oneOf.5.type","typeLabel":"enum\u003cstring>"},"actor":{"type":"object","required":["id"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.5.actor.id","typeLabel":"string"},"first_name":{"oneOf":[{"type":"string","uniqueKey":"payload.oneOf.5.actor.first_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"payload.oneOf.5.actor.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"payload.oneOf.5.actor.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","uniqueKey":"payload.oneOf.5.actor.last_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"payload.oneOf.5.actor.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"payload.oneOf.5.actor.last_name","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","uniqueKey":"payload.oneOf.5.actor.email.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"payload.oneOf.5.actor.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"payload.oneOf.5.actor.email","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"payload.oneOf.5.actor","typeLabel":"object"}},"isRequired":true,"uniqueKey":"payload.oneOf.5","typeLabel":"object"},{"type":"object","description":"Indicates that the session merge request was closed without merging, including the actor who closed it.","required":["type","actor"],"properties":{"type":{"type":"string","enum":["merge_request_closed"],"isRequired":true,"uniqueKey":"payload.oneOf.6.type","typeLabel":"enum\u003cstring>"},"actor":{"type":"object","required":["id"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.6.actor.id","typeLabel":"string"},"first_name":{"oneOf":[{"type":"string","uniqueKey":"payload.oneOf.6.actor.first_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"payload.oneOf.6.actor.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"payload.oneOf.6.actor.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","uniqueKey":"payload.oneOf.6.actor.last_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"payload.oneOf.6.actor.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"payload.oneOf.6.actor.last_name","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","uniqueKey":"payload.oneOf.6.actor.email.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"payload.oneOf.6.actor.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"payload.oneOf.6.actor.email","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"payload.oneOf.6.actor","typeLabel":"object"}},"isRequired":true,"uniqueKey":"payload.oneOf.6","typeLabel":"object"},{"type":"object","description":"Indicates that the agent browsed the repository file tree at a given path.","required":["type","repository_id","path"],"properties":{"type":{"type":"string","enum":["agent_file_tree_browse"],"isRequired":true,"uniqueKey":"payload.oneOf.7.type","typeLabel":"enum\u003cstring>"},"repository_id":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.7.repository_id","typeLabel":"string"},"path":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.7.path","typeLabel":"string"}},"isRequired":true,"uniqueKey":"payload.oneOf.7","typeLabel":"object"},{"type":"object","description":"Indicates that the agent read one or more files from a repository.","required":["type","repository_id","paths"],"properties":{"type":{"type":"string","enum":["agent_file_read"],"isRequired":true,"uniqueKey":"payload.oneOf.8.type","typeLabel":"enum\u003cstring>"},"repository_id":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.8.repository_id","typeLabel":"string"},"paths":{"type":"array","items":{"type":"string","uniqueKey":"payload.oneOf.8.paths.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"payload.oneOf.8.paths","typeLabel":"string[]"}},"isRequired":true,"uniqueKey":"payload.oneOf.8","typeLabel":"object"},{"type":"object","description":"Indicates that the agent edited an existing file and includes the resulting diff.","required":["type","repository_id","file_path","diff"],"properties":{"type":{"type":"string","enum":["agent_file_edit"],"isRequired":true,"uniqueKey":"payload.oneOf.9.type","typeLabel":"enum\u003cstring>"},"repository_id":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.9.repository_id","typeLabel":"string"},"file_path":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.9.file_path","typeLabel":"string"},"diff":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.9.diff","typeLabel":"string"}},"isRequired":true,"uniqueKey":"payload.oneOf.9","typeLabel":"object"},{"type":"object","description":"Indicates that the agent created a new file and includes the resulting diff.","required":["type","repository_id","file_path","diff"],"properties":{"type":{"type":"string","enum":["agent_file_create"],"isRequired":true,"uniqueKey":"payload.oneOf.10.type","typeLabel":"enum\u003cstring>"},"repository_id":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.10.repository_id","typeLabel":"string"},"file_path":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.10.file_path","typeLabel":"string"},"diff":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.10.diff","typeLabel":"string"}},"isRequired":true,"uniqueKey":"payload.oneOf.10","typeLabel":"object"},{"type":"object","description":"Indicates that the agent removed a file from a repository.","required":["type","repository_id","file_path"],"properties":{"type":{"type":"string","enum":["agent_file_remove"],"isRequired":true,"uniqueKey":"payload.oneOf.11.type","typeLabel":"enum\u003cstring>"},"repository_id":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.11.repository_id","typeLabel":"string"},"file_path":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.11.file_path","typeLabel":"string"}},"isRequired":true,"uniqueKey":"payload.oneOf.11","typeLabel":"object"},{"type":"object","description":"Indicates that the agent moved or renamed a file within a repository.","required":["type","repository_id","source_path","destination_path"],"properties":{"type":{"type":"string","enum":["agent_file_move"],"isRequired":true,"uniqueKey":"payload.oneOf.12.type","typeLabel":"enum\u003cstring>"},"repository_id":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.12.repository_id","typeLabel":"string"},"source_path":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.12.source_path","typeLabel":"string"},"destination_path":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.12.destination_path","typeLabel":"string"},"diff":{"type":"string","uniqueKey":"payload.oneOf.12.diff","typeLabel":"string"}},"isRequired":true,"uniqueKey":"payload.oneOf.12","typeLabel":"object"},{"type":"object","description":"Indicates that the agent copied a file within a repository.","required":["type","repository_id","source_path","destination_path"],"properties":{"type":{"type":"string","enum":["agent_file_copy"],"isRequired":true,"uniqueKey":"payload.oneOf.13.type","typeLabel":"enum\u003cstring>"},"repository_id":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.13.repository_id","typeLabel":"string"},"source_path":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.13.source_path","typeLabel":"string"},"destination_path":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.13.destination_path","typeLabel":"string"},"diff":{"type":"string","uniqueKey":"payload.oneOf.13.diff","typeLabel":"string"}},"isRequired":true,"uniqueKey":"payload.oneOf.13","typeLabel":"object"},{"type":"object","description":"Indicates that the agent read a specific line range from a file.","required":["type","repository_id","path","start_line","end_line"],"properties":{"type":{"type":"string","enum":["agent_file_read_range"],"isRequired":true,"uniqueKey":"payload.oneOf.14.type","typeLabel":"enum\u003cstring>"},"repository_id":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.14.repository_id","typeLabel":"string"},"path":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.14.path","typeLabel":"string"},"start_line":{"type":"number","isRequired":true,"uniqueKey":"payload.oneOf.14.start_line","typeLabel":"number"},"end_line":{"type":"number","isRequired":true,"uniqueKey":"payload.oneOf.14.end_line","typeLabel":"number"}},"isRequired":true,"uniqueKey":"payload.oneOf.14","typeLabel":"object"},{"type":"object","description":"Indicates that the agent searched file contents and returned surrounding context for the matches.","required":["type","repository_id","query","path","matches"],"properties":{"type":{"type":"string","enum":["agent_read_around_match"],"isRequired":true,"uniqueKey":"payload.oneOf.15.type","typeLabel":"enum\u003cstring>"},"repository_id":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.15.repository_id","typeLabel":"string"},"query":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.15.query","typeLabel":"string"},"path":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.15.path","typeLabel":"string"},"matches":{"type":"array","items":{"type":"object","required":["file","match_line","content"],"properties":{"file":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.15.matches.items.[INDEX].file","typeLabel":"string"},"match_line":{"type":"number","isRequired":true,"uniqueKey":"payload.oneOf.15.matches.items.[INDEX].match_line","typeLabel":"number"},"content":{"type":"array","items":{"type":"object","required":["line","content"],"properties":{"line":{"type":"number","isRequired":true,"uniqueKey":"payload.oneOf.15.matches.items.[INDEX].content.items.[INDEX].line","typeLabel":"number"},"content":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.15.matches.items.[INDEX].content.items.[INDEX].content","typeLabel":"string"}},"uniqueKey":"payload.oneOf.15.matches.items.[INDEX].content.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"payload.oneOf.15.matches.items.[INDEX].content","typeLabel":"object[]"}},"uniqueKey":"payload.oneOf.15.matches.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"payload.oneOf.15.matches","typeLabel":"object[]"},"include":{"type":"string","uniqueKey":"payload.oneOf.15.include","typeLabel":"string"}},"isRequired":true,"uniqueKey":"payload.oneOf.15","typeLabel":"object"},{"type":"object","description":"Indicates that the agent searched files for a query and returned matching results.","required":["type","repository_id","query"],"properties":{"type":{"type":"string","enum":["agent_search_files"],"isRequired":true,"uniqueKey":"payload.oneOf.16.type","typeLabel":"enum\u003cstring>"},"repository_id":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.16.repository_id","typeLabel":"string"},"query":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.16.query","typeLabel":"string"},"path":{"type":"string","uniqueKey":"payload.oneOf.16.path","typeLabel":"string"},"include":{"type":"string","uniqueKey":"payload.oneOf.16.include","typeLabel":"string"},"results":{"type":"array","items":{"type":"object","required":["file","line","content"],"properties":{"file":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.16.results.items.[INDEX].file","typeLabel":"string"},"line":{"type":"number","isRequired":true,"uniqueKey":"payload.oneOf.16.results.items.[INDEX].line","typeLabel":"number"},"content":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.16.results.items.[INDEX].content","typeLabel":"string"}},"uniqueKey":"payload.oneOf.16.results.items.[INDEX]","typeLabel":"object"},"uniqueKey":"payload.oneOf.16.results","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"payload.oneOf.16","typeLabel":"object"},{"type":"object","description":"Indicates that the agent ran multiple file searches and returned grouped results for each query item.","required":["type","repository_id","items"],"properties":{"type":{"type":"string","enum":["agent_search_files_v2"],"isRequired":true,"uniqueKey":"payload.oneOf.17.type","typeLabel":"enum\u003cstring>"},"repository_id":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.17.repository_id","typeLabel":"string"},"items":{"type":"array","items":{"type":"object","required":["query"],"properties":{"query":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.17.\\items.items.[INDEX].query","typeLabel":"string"},"path":{"type":"string","uniqueKey":"payload.oneOf.17.\\items.items.[INDEX].path","typeLabel":"string"},"include":{"type":"string","uniqueKey":"payload.oneOf.17.\\items.items.[INDEX].include","typeLabel":"string"},"results":{"type":"array","items":{"type":"object","required":["file","line","content"],"properties":{"file":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.17.\\items.items.[INDEX].results.items.[INDEX].file","typeLabel":"string"},"line":{"type":"number","isRequired":true,"uniqueKey":"payload.oneOf.17.\\items.items.[INDEX].results.items.[INDEX].line","typeLabel":"number"},"content":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.17.\\items.items.[INDEX].results.items.[INDEX].content","typeLabel":"string"}},"uniqueKey":"payload.oneOf.17.\\items.items.[INDEX].results.items.[INDEX]","typeLabel":"object"},"uniqueKey":"payload.oneOf.17.\\items.items.[INDEX].results","typeLabel":"object[]"}},"uniqueKey":"payload.oneOf.17.\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"payload.oneOf.17.\\items","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"payload.oneOf.17","typeLabel":"object"},{"type":"object","description":"Indicates that the agent created or updated its execution plan, including the current goal and task list.","required":["type","goal_title","goal_id","tasks"],"properties":{"type":{"type":"string","enum":["agent_plan_execution_update"],"isRequired":true,"uniqueKey":"payload.oneOf.18.type","typeLabel":"enum\u003cstring>"},"goal_title":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.18.goal_title","typeLabel":"string"},"goal_id":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.18.goal_id","typeLabel":"string"},"tasks":{"type":"array","items":{"type":"object","required":["id","title","status"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.18.tasks.items.[INDEX].id","typeLabel":"string"},"title":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.18.tasks.items.[INDEX].title","typeLabel":"string"},"status":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.18.tasks.items.[INDEX].status","typeLabel":"string"}},"uniqueKey":"payload.oneOf.18.tasks.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"payload.oneOf.18.tasks","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"payload.oneOf.18","typeLabel":"object"},{"type":"object","description":"Indicates that the agent asked the user one or more multiple-choice clarification questions.","required":["type","questions"],"properties":{"type":{"type":"string","enum":["agent_ask_user"],"isRequired":true,"uniqueKey":"payload.oneOf.19.type","typeLabel":"enum\u003cstring>"},"questions":{"type":"array","items":{"type":"object","required":["question","topic","options"],"properties":{"question":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.19.questions.items.[INDEX].question","typeLabel":"string"},"topic":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.19.questions.items.[INDEX].topic","typeLabel":"string"},"options":{"type":"array","items":{"type":"string","uniqueKey":"payload.oneOf.19.questions.items.[INDEX].options.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"payload.oneOf.19.questions.items.[INDEX].options","typeLabel":"string[]"}},"uniqueKey":"payload.oneOf.19.questions.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"payload.oneOf.19.questions","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"payload.oneOf.19","typeLabel":"object"},{"type":"object","description":"Indicates that the user responded to a previous ask-user question set from the agent.","required":["type","answers"],"properties":{"type":{"type":"string","enum":["user_ask_user_response"],"isRequired":true,"uniqueKey":"payload.oneOf.20.type","typeLabel":"enum\u003cstring>"},"answers":{"type":"array","items":{"type":"object","required":["topic","answer"],"properties":{"topic":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.20.answers.items.[INDEX].topic","typeLabel":"string"},"answer":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.20.answers.items.[INDEX].answer","typeLabel":"string"}},"uniqueKey":"payload.oneOf.20.answers.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"payload.oneOf.20.answers","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"payload.oneOf.20","typeLabel":"object"},{"type":"object","description":"Indicates that the agent inspected branch changes, either by listing changed files or returning a diff for a specific file.","required":["type","repository_id","action"],"properties":{"type":{"type":"string","enum":["agent_branch_diff"],"isRequired":true,"uniqueKey":"payload.oneOf.21.type","typeLabel":"enum\u003cstring>"},"repository_id":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.21.repository_id","typeLabel":"string"},"action":{"oneOf":[{"type":"string","enum":["list_files"],"isRequired":true,"uniqueKey":"payload.oneOf.21.action.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","enum":["file_diff"],"isRequired":true,"uniqueKey":"payload.oneOf.21.action.oneOf.1","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"payload.oneOf.21.action","typeLabel":"enum\u003cstring>"},"files":{"type":"array","items":{"type":"object","required":["path"],"properties":{"path":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.21.files.items.[INDEX].path","typeLabel":"string"}},"uniqueKey":"payload.oneOf.21.files.items.[INDEX]","typeLabel":"object"},"uniqueKey":"payload.oneOf.21.files","typeLabel":"object[]"},"file_path":{"type":"string","uniqueKey":"payload.oneOf.21.file_path","typeLabel":"string"},"diff":{"type":"string","uniqueKey":"payload.oneOf.21.diff","typeLabel":"string"}},"isRequired":true,"uniqueKey":"payload.oneOf.21","typeLabel":"object"},{"type":"object","description":"Indicates that the agent inspected the repository working tree and returned staged, unstaged, untracked, and conflict information.","required":["type","repository_id","branch","clean","staged","unstaged","untracked","conflict_state"],"properties":{"type":{"type":"string","enum":["agent_uncommitted_changes"],"isRequired":true,"uniqueKey":"payload.oneOf.22.type","typeLabel":"enum\u003cstring>"},"repository_id":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.22.repository_id","typeLabel":"string"},"branch":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.22.branch","typeLabel":"string"},"clean":{"type":"boolean","isRequired":true,"uniqueKey":"payload.oneOf.22.clean","typeLabel":"boolean"},"staged":{"type":"object","required":["added","modified","deleted","renamed"],"properties":{"added":{"type":"array","items":{"type":"string","uniqueKey":"payload.oneOf.22.staged.added.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"payload.oneOf.22.staged.added","typeLabel":"string[]"},"modified":{"type":"array","items":{"type":"string","uniqueKey":"payload.oneOf.22.staged.modified.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"payload.oneOf.22.staged.modified","typeLabel":"string[]"},"deleted":{"type":"array","items":{"type":"string","uniqueKey":"payload.oneOf.22.staged.deleted.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"payload.oneOf.22.staged.deleted","typeLabel":"string[]"},"renamed":{"type":"array","items":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.22.staged.renamed.items.[INDEX].from","typeLabel":"string"},"to":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.22.staged.renamed.items.[INDEX].to","typeLabel":"string"}},"uniqueKey":"payload.oneOf.22.staged.renamed.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"payload.oneOf.22.staged.renamed","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"payload.oneOf.22.staged","typeLabel":"object"},"unstaged":{"type":"object","required":["added","modified","deleted","renamed"],"properties":{"added":{"type":"array","items":{"type":"string","uniqueKey":"payload.oneOf.22.unstaged.added.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"payload.oneOf.22.unstaged.added","typeLabel":"string[]"},"modified":{"type":"array","items":{"type":"string","uniqueKey":"payload.oneOf.22.unstaged.modified.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"payload.oneOf.22.unstaged.modified","typeLabel":"string[]"},"deleted":{"type":"array","items":{"type":"string","uniqueKey":"payload.oneOf.22.unstaged.deleted.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"payload.oneOf.22.unstaged.deleted","typeLabel":"string[]"},"renamed":{"type":"array","items":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.22.unstaged.renamed.items.[INDEX].from","typeLabel":"string"},"to":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.22.unstaged.renamed.items.[INDEX].to","typeLabel":"string"}},"uniqueKey":"payload.oneOf.22.unstaged.renamed.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"payload.oneOf.22.unstaged.renamed","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"payload.oneOf.22.unstaged","typeLabel":"object"},"untracked":{"type":"array","items":{"type":"string","uniqueKey":"payload.oneOf.22.untracked.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"payload.oneOf.22.untracked","typeLabel":"string[]"},"conflict_state":{"type":"object","required":["conflicted","state"],"properties":{"conflicted":{"type":"array","items":{"type":"string","uniqueKey":"payload.oneOf.22.conflict_state.conflicted.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"payload.oneOf.22.conflict_state.conflicted","typeLabel":"string[]"},"state":{"type":"object","required":["merge","rebase","cherry_pick","revert"],"properties":{"merge":{"type":"boolean","isRequired":true,"uniqueKey":"payload.oneOf.22.conflict_state.state.merge","typeLabel":"boolean"},"rebase":{"type":"boolean","isRequired":true,"uniqueKey":"payload.oneOf.22.conflict_state.state.rebase","typeLabel":"boolean"},"cherry_pick":{"type":"boolean","isRequired":true,"uniqueKey":"payload.oneOf.22.conflict_state.state.cherry_pick","typeLabel":"boolean"},"revert":{"type":"boolean","isRequired":true,"uniqueKey":"payload.oneOf.22.conflict_state.state.revert","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"payload.oneOf.22.conflict_state.state","typeLabel":"object"}},"isRequired":true,"uniqueKey":"payload.oneOf.22.conflict_state","typeLabel":"object"},"diff":{"type":"object","required":["staged","unstaged","truncated"],"properties":{"staged":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.22.diff.staged","typeLabel":"string"},"unstaged":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.22.diff.unstaged","typeLabel":"string"},"truncated":{"type":"boolean","isRequired":true,"uniqueKey":"payload.oneOf.22.diff.truncated","typeLabel":"boolean"}},"uniqueKey":"payload.oneOf.22.diff","typeLabel":"object"}},"isRequired":true,"uniqueKey":"payload.oneOf.22","typeLabel":"object"},{"type":"object","description":"Indicates that the agent checked whether the repository is currently in a git conflict state.","required":["type","repository_id","branch","has_conflicts","conflicted_files","operation_state"],"properties":{"type":{"type":"string","enum":["agent_conflict_state"],"isRequired":true,"uniqueKey":"payload.oneOf.23.type","typeLabel":"enum\u003cstring>"},"repository_id":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.23.repository_id","typeLabel":"string"},"branch":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.23.branch","typeLabel":"string"},"has_conflicts":{"type":"boolean","isRequired":true,"uniqueKey":"payload.oneOf.23.has_conflicts","typeLabel":"boolean"},"conflicted_files":{"type":"array","items":{"type":"string","uniqueKey":"payload.oneOf.23.conflicted_files.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"payload.oneOf.23.conflicted_files","typeLabel":"string[]"},"operation_state":{"type":"object","required":["merge","rebase","cherry_pick","revert"],"properties":{"merge":{"type":"boolean","isRequired":true,"uniqueKey":"payload.oneOf.23.operation_state.merge","typeLabel":"boolean"},"rebase":{"type":"boolean","isRequired":true,"uniqueKey":"payload.oneOf.23.operation_state.rebase","typeLabel":"boolean"},"cherry_pick":{"type":"boolean","isRequired":true,"uniqueKey":"payload.oneOf.23.operation_state.cherry_pick","typeLabel":"boolean"},"revert":{"type":"boolean","isRequired":true,"uniqueKey":"payload.oneOf.23.operation_state.revert","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"payload.oneOf.23.operation_state","typeLabel":"object"}},"isRequired":true,"uniqueKey":"payload.oneOf.23","typeLabel":"object"},{"type":"object","description":"Indicates that the agent checked whether the current branch can be merged with the target branch and whether conflicts would occur.","required":["type","repository_id","current_branch","target_branch","mergeable","has_conflicts","conflicted_files"],"properties":{"type":{"type":"string","enum":["agent_check_target_branch_mergeability"],"isRequired":true,"uniqueKey":"payload.oneOf.24.type","typeLabel":"enum\u003cstring>"},"repository_id":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.24.repository_id","typeLabel":"string"},"current_branch":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.24.current_branch","typeLabel":"string"},"target_branch":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.24.target_branch","typeLabel":"string"},"mergeable":{"type":"boolean","isRequired":true,"uniqueKey":"payload.oneOf.24.mergeable","typeLabel":"boolean"},"has_conflicts":{"type":"boolean","isRequired":true,"uniqueKey":"payload.oneOf.24.has_conflicts","typeLabel":"boolean"},"conflicted_files":{"type":"array","items":{"type":"string","uniqueKey":"payload.oneOf.24.conflicted_files.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"payload.oneOf.24.conflicted_files","typeLabel":"string[]"}},"isRequired":true,"uniqueKey":"payload.oneOf.24","typeLabel":"object"},{"type":"object","description":"Indicates that the agent merged the target branch into the current branch to reproduce or resolve incoming changes.","required":["type","repository_id","current_branch","target_branch"],"properties":{"type":{"type":"string","enum":["agent_merge_remote_branch"],"isRequired":true,"uniqueKey":"payload.oneOf.25.type","typeLabel":"enum\u003cstring>"},"repository_id":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.25.repository_id","typeLabel":"string"},"current_branch":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.25.current_branch","typeLabel":"string"},"target_branch":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.25.target_branch","typeLabel":"string"}},"isRequired":true,"uniqueKey":"payload.oneOf.25","typeLabel":"object"},{"type":"object","description":"Indicates that the agent pulled changes from the remote branch and rebased the local branch onto them.","required":["type","repository_id","rebased","message"],"properties":{"type":{"type":"string","enum":["agent_pull_from_remote"],"isRequired":true,"uniqueKey":"payload.oneOf.26.type","typeLabel":"enum\u003cstring>"},"repository_id":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.26.repository_id","typeLabel":"string"},"rebased":{"type":"boolean","isRequired":true,"uniqueKey":"payload.oneOf.26.rebased","typeLabel":"boolean"},"message":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.26.message","typeLabel":"string"},"branch":{"type":"string","uniqueKey":"payload.oneOf.26.branch","typeLabel":"string"},"before_sha":{"oneOf":[{"type":"string","uniqueKey":"payload.oneOf.26.before_sha.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"payload.oneOf.26.before_sha.oneOf.1","typeLabel":"null"}],"uniqueKey":"payload.oneOf.26.before_sha","typeLabel":"string | null"},"after_sha":{"oneOf":[{"type":"string","uniqueKey":"payload.oneOf.26.after_sha.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"payload.oneOf.26.after_sha.oneOf.1","typeLabel":"null"}],"uniqueKey":"payload.oneOf.26.after_sha","typeLabel":"string | null"},"remote":{"type":"string","uniqueKey":"payload.oneOf.26.remote","typeLabel":"string"}},"isRequired":true,"uniqueKey":"payload.oneOf.26","typeLabel":"object"},{"type":"object","description":"Indicates that the agent pushed committed changes from the current branch to the remote repository.","required":["type","repository_id","pushed","message"],"properties":{"type":{"type":"string","enum":["agent_push_to_remote"],"isRequired":true,"uniqueKey":"payload.oneOf.27.type","typeLabel":"enum\u003cstring>"},"repository_id":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.27.repository_id","typeLabel":"string"},"pushed":{"type":"boolean","isRequired":true,"uniqueKey":"payload.oneOf.27.pushed","typeLabel":"boolean"},"message":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.27.message","typeLabel":"string"},"branch":{"type":"string","uniqueKey":"payload.oneOf.27.branch","typeLabel":"string"},"remote":{"type":"string","uniqueKey":"payload.oneOf.27.remote","typeLabel":"string"},"remote_ref":{"type":"string","uniqueKey":"payload.oneOf.27.remote_ref","typeLabel":"string"}},"isRequired":true,"uniqueKey":"payload.oneOf.27","typeLabel":"object"},{"type":"object","description":"Indicates that the agent aborted an in-progress merge, rebase, cherry-pick, or revert conflict resolution flow.","required":["type","repository_id","aborted","aborted_operation","message"],"properties":{"type":{"type":"string","enum":["agent_abort_conflict_resolution"],"isRequired":true,"uniqueKey":"payload.oneOf.28.type","typeLabel":"enum\u003cstring>"},"repository_id":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.28.repository_id","typeLabel":"string"},"aborted":{"type":"boolean","isRequired":true,"uniqueKey":"payload.oneOf.28.aborted","typeLabel":"boolean"},"aborted_operation":{"oneOf":[{"type":"string","enum":["merge"],"isRequired":true,"uniqueKey":"payload.oneOf.28.aborted_operation.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","enum":["rebase"],"isRequired":true,"uniqueKey":"payload.oneOf.28.aborted_operation.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"string","enum":["cherry-pick"],"isRequired":true,"uniqueKey":"payload.oneOf.28.aborted_operation.oneOf.2","typeLabel":"enum\u003cstring>"},{"type":"string","enum":["revert"],"isRequired":true,"uniqueKey":"payload.oneOf.28.aborted_operation.oneOf.3","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"payload.oneOf.28.aborted_operation.oneOf.4","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.oneOf.28.aborted_operation","typeLabel":"enum\u003cstring> · enum\u003cstring> · enum\u003cstring> · enum\u003cstring> · null"},"message":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.28.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"payload.oneOf.28","typeLabel":"object"},{"type":"object","description":"Indicates that the agent discarded local uncommitted changes for the requested scope.","required":["type","repository_id","scope","rolled_back_paths","removed_untracked_paths","message"],"properties":{"type":{"type":"string","enum":["agent_rollback_uncommitted_changes"],"isRequired":true,"uniqueKey":"payload.oneOf.29.type","typeLabel":"enum\u003cstring>"},"repository_id":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.29.repository_id","typeLabel":"string"},"scope":{"oneOf":[{"type":"string","enum":["unstaged"],"isRequired":true,"uniqueKey":"payload.oneOf.29.scope.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","enum":["staged"],"isRequired":true,"uniqueKey":"payload.oneOf.29.scope.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"string","enum":["all"],"isRequired":true,"uniqueKey":"payload.oneOf.29.scope.oneOf.2","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"payload.oneOf.29.scope","typeLabel":"enum\u003cstring>"},"rolled_back_paths":{"type":"array","items":{"type":"string","uniqueKey":"payload.oneOf.29.rolled_back_paths.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"payload.oneOf.29.rolled_back_paths","typeLabel":"string[]"},"removed_untracked_paths":{"type":"array","items":{"type":"string","uniqueKey":"payload.oneOf.29.removed_untracked_paths.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"payload.oneOf.29.removed_untracked_paths","typeLabel":"string[]"},"message":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.29.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"payload.oneOf.29","typeLabel":"object"},{"type":"object","description":"Indicates that the agent made an HTTP request to an external URL.","required":["type","url","method","status"],"properties":{"type":{"type":"string","enum":["agent_http_request"],"isRequired":true,"uniqueKey":"payload.oneOf.30.type","typeLabel":"enum\u003cstring>"},"url":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.30.url","typeLabel":"string"},"method":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.30.method","typeLabel":"string"},"status":{"type":"number","isRequired":true,"uniqueKey":"payload.oneOf.30.status","typeLabel":"number"}},"isRequired":true,"uniqueKey":"payload.oneOf.30","typeLabel":"object"},{"type":"object","description":"Indicates that the agent fetched and browsed a web page.","required":["type","url","status"],"properties":{"type":{"type":"string","enum":["agent_web_browse"],"isRequired":true,"uniqueKey":"payload.oneOf.31.type","typeLabel":"enum\u003cstring>"},"url":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.31.url","typeLabel":"string"},"status":{"type":"number","isRequired":true,"uniqueKey":"payload.oneOf.31.status","typeLabel":"number"}},"isRequired":true,"uniqueKey":"payload.oneOf.31","typeLabel":"object"},{"type":"object","description":"Indicates that the agent ran a command in a repository and includes the command output.","required":["type","repository_id","executable","args","exit_code","stdout","stderr","output","truncated"],"properties":{"type":{"type":"string","enum":["agent_run_repository_command"],"isRequired":true,"uniqueKey":"payload.oneOf.32.type","typeLabel":"enum\u003cstring>"},"repository_id":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.32.repository_id","typeLabel":"string"},"executable":{"enum":["node","npm","npx","yarn"],"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.32.executable","typeLabel":"enum\u003cstring>"},"args":{"type":"array","items":{"type":"string","uniqueKey":"payload.oneOf.32.args.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"payload.oneOf.32.args","typeLabel":"string[]"},"exit_code":{"type":"number","isRequired":true,"uniqueKey":"payload.oneOf.32.exit_code","typeLabel":"number"},"stdout":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.32.stdout","typeLabel":"string"},"stderr":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.32.stderr","typeLabel":"string"},"output":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.32.output","typeLabel":"string"},"truncated":{"type":"boolean","isRequired":true,"uniqueKey":"payload.oneOf.32.truncated","typeLabel":"boolean"},"working_directory":{"type":"string","uniqueKey":"payload.oneOf.32.working_directory","typeLabel":"string"}},"isRequired":true,"uniqueKey":"payload.oneOf.32","typeLabel":"object"},{"type":"object","description":"Indicates that the agent created an alert that requires human attention or follow-up.","required":["type","alert_id","level","status","title"],"properties":{"type":{"type":"string","enum":["agent_alert_created"],"isRequired":true,"uniqueKey":"payload.oneOf.33.type","typeLabel":"enum\u003cstring>"},"alert_id":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.33.alert_id","typeLabel":"string"},"level":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.33.level","typeLabel":"string"},"status":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.33.status","typeLabel":"string"},"title":{"type":"string","isRequired":true,"uniqueKey":"payload.oneOf.33.title","typeLabel":"string"},"description":{"oneOf":[{"type":"string","uniqueKey":"payload.oneOf.33.description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"payload.oneOf.33.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"payload.oneOf.33.description","typeLabel":"string | null"},"fingerprint":{"oneOf":[{"type":"string","uniqueKey":"payload.oneOf.33.fingerprint.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"payload.oneOf.33.fingerprint.oneOf.1","typeLabel":"null"}],"uniqueKey":"payload.oneOf.33.fingerprint","typeLabel":"string | null"},"repository_id":{"oneOf":[{"type":"string","uniqueKey":"payload.oneOf.33.repository_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"payload.oneOf.33.repository_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"payload.oneOf.33.repository_id","typeLabel":"string | null"},"repository_name":{"oneOf":[{"type":"string","uniqueKey":"payload.oneOf.33.repository_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"payload.oneOf.33.repository_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"payload.oneOf.33.repository_name","typeLabel":"string | null"},"merge_request_id":{"oneOf":[{"type":"string","uniqueKey":"payload.oneOf.33.merge_request_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"payload.oneOf.33.merge_request_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"payload.oneOf.33.merge_request_id","typeLabel":"string | null"},"scheduled_agent_run_id":{"oneOf":[{"type":"string","uniqueKey":"payload.oneOf.33.scheduled_agent_run_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"payload.oneOf.33.scheduled_agent_run_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"payload.oneOf.33.scheduled_agent_run_id","typeLabel":"string | null"},"occurrence_count":{"type":"number","uniqueKey":"payload.oneOf.33.occurrence_count","typeLabel":"number"}},"isRequired":true,"uniqueKey":"payload.oneOf.33","typeLabel":"object"}],"isRequired":true,"uniqueKey":"payload","typeLabel":"object"},"status":{"enum":["completed","queued","processing","canceled"],"type":"string","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"client_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"client_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"client_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"client_id","typeLabel":"string | null"},"session_goal_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"session_goal_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"session_goal_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"session_goal_id","typeLabel":"string | null"},"session_task_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"session_task_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"session_task_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"session_task_id","typeLabel":"string | null"},"created_at":{"type":"string","isRequired":true,"uniqueKey":"created_at","typeLabel":"string"},"updated_at":{"type":"string","isRequired":true,"uniqueKey":"updated_at","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","session_id":"\u003cstring>","type":"user_message","payload":{"type":"user_message","message":"\u003cstring>"},"status":"completed","client_id":"\u003cstring>","session_goal_id":"\u003cstring>","session_task_id":"\u003cstring>","created_at":"\u003cstring>","updated_at":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"c5e1548e-9e0c-402b-8897-a6daf74d944c":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["statusCode","code","error","message"],"properties":{"statusCode":{"type":"number","isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":123,"code":"\u003cstring>","error":"\u003cstring>","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"35b50433-99b4-4939-86e8-1a34aba3b4a3":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"0f3083a7-4292-4a61-bcfb-d3086ea71b17":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"94dc2a52-4ecd-4be1-8f0d-6c673e1a2288":{"apiKey":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[]}}},"servers":{"ab5d6f87-97e8-432c-ba1c-963b37626786":{"url":"https://api.agenhq.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[]},"schema":{"title":"x-api-key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKey","name":"x-api-key"}],"title":"apiKey"}]},"originalFileLocation":"coding-agent-api/openapi.json"},"subdomain":"agen","siteName":"Agen","title":"Send a user message to the agent in a session - Agen","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-04-25T13:52:45.379Z","originalFileLocation":"api-reference/sessions/send-a-user-message-to-the-agent-in-a-session.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=\"Sends a new message from the user to the coding agent working in the session. The message is stored as a session event with the user_message type, then the agent either starts processing it immediately or the message is queued if the agent is already busy. Required API key scopes: any of sessions:write, sessions:all, all:write, all:all.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Agen\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/agen/8pVrgwrNaPNPy_LP/_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/agen/8pVrgwrNaPNPy_LP/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/agen/8pVrgwrNaPNPy_LP/_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/agen/8pVrgwrNaPNPy_LP/_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/agen/8pVrgwrNaPNPy_LP/_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/agen/8pVrgwrNaPNPy_LP/_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/agen/8pVrgwrNaPNPy_LP/_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/agen/8pVrgwrNaPNPy_LP/_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/agen/8pVrgwrNaPNPy_LP/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Send a user message to the agent in a session - Agen\">\u003cmeta data-mint-head property=\"og:description\" content=\"Sends a new message from the user to the coding agent working in the session. The message is stored as a session event with the user_message type, then the agent either starts processing it immediately or the message is queued if the agent is already busy. Required API key scopes: any of sessions:write, sessions:all, all:write, all:all.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Agen\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.agenhq.com/api-reference/sessions/send-a-user-message-to-the-agent-in-a-session\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://agen.mintlify.app/_mintlify/api/og/v2?division=Sessions\u0026amp;title=Send+a+user+message+to+the+agent+in+a+session\u0026amp;description=Sends+a+new+message+from+the+user+to+the+coding+agent+working+in+the+session.+The+message+is+stored+as+a+session+event+with+the+%60user_message%60+type%2C+then+the+ag\u0026amp;theme=cf497355fa79a1ba64b64c86\u0026amp;signature=a5b2499742af1670b31a506f1eb73d45ea93f4d4c8e733e0a110fa61093cb699\">\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=\"Send a user message to the agent in a session - Agen\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Sends a new message from the user to the coding agent working in the session. The message is stored as a session event with the user_message type, then the agent either starts processing it immediately or the message is queued if the agent is already busy. Required API key scopes: any of sessions:write, sessions:all, all:write, all:all.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://agen.mintlify.app/_mintlify/api/og/v2?division=Sessions\u0026amp;title=Send+a+user+message+to+the+agent+in+a+session\u0026amp;description=Sends+a+new+message+from+the+user+to+the+coding+agent+working+in+the+session.+The+message+is+stored+as+a+session+event+with+the+%60user_message%60+type%2C+then+the+ag\u0026amp;theme=cf497355fa79a1ba64b64c86\u0026amp;signature=a5b2499742af1670b31a506f1eb73d45ea93f4d4c8e733e0a110fa61093cb699\">\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/agen/8pVrgwrNaPNPy_LP/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Agen\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#009B53\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.agenhq.com/api-reference/sessions/send-a-user-message-to-the-agent-in-a-session\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/sessions/send-a-user-message-to-the-agent-in-a-session.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.agenhq.com/#organization\",\"name\":\"Agen\",\"url\":\"https://docs.agenhq.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/agen/2MIX_2KJFwHtuKkg/logo/light.svg?fit=max\u0026auto=format\u0026n=2MIX_2KJFwHtuKkg\u0026q=85\u0026s=31ddbe404217afcd3a9fad7570810a5a\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.agenhq.com#website\",\"name\":\"Agen\",\"url\":\"https://docs.agenhq.com\",\"publisher\":{\"@id\":\"https://docs.agenhq.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.agenhq.com/api-reference/sessions/send-a-user-message-to-the-agent-in-a-session#webpage\",\"url\":\"https://docs.agenhq.com/api-reference/sessions/send-a-user-message-to-the-agent-in-a-session\",\"name\":\"Send a user message to the agent in a session\",\"description\":\"Sends a new message from the user to the coding agent working in the session. The message is stored as a session event with the user_message type, then the agent either starts processing it immediately or the message is queued if the agent is already busy. Required API key scopes: any of sessions:write, sessions:all, all:write, all:all.\",\"dateModified\":\"2026-04-25T13:52:45.379Z\",\"isPartOf\":{\"@id\":\"https://docs.agenhq.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.agenhq.com/api-reference/sessions/send-a-user-message-to-the-agent-in-a-session#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.agenhq.com/api-reference/sessions/send-a-user-message-to-the-agent-in-a-session#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Coding Agent API\",\"item\":\"https://docs.agenhq.com/coding-agent-api/get-started\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Sessions\",\"item\":\"https://docs.agenhq.com/api-reference/sessions/get-sessions\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Send a user message to the agent in a session\",\"item\":\"https://docs.agenhq.com/api-reference/sessions/send-a-user-message-to-the-agent-in-a-session\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.agenhq.com/api-reference/sessions/send-a-user-message-to-the-agent-in-a-session#apireference\",\"headline\":\"Send a user message to the agent in a session\",\"name\":\"Send a user message to the agent in a session\",\"description\":\"Sends a new message from the user to the coding agent working in the session. The message is stored as a session event with the user_message type, then the agent either starts processing it immediately or the message is queued if the agent is already busy. Required API key scopes: any of sessions:write, sessions:all, all:write, all:all.\",\"url\":\"https://docs.agenhq.com/api-reference/sessions/send-a-user-message-to-the-agent-in-a-session\",\"mainEntityOfPage\":{\"@id\":\"https://docs.agenhq.com/api-reference/sessions/send-a-user-message-to-the-agent-in-a-session#webpage\"},\"dateModified\":\"2026-04-25T13:52:45.379Z\",\"publisher\":{\"@id\":\"https://docs.agenhq.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.agenhq.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Agen\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Agen","nav":{"global":{"anchors":[{"anchor":"Agen Web Portal","icon":"globe","href":"https://app.agenhq.com"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"Coding Agent API","groups":[{"group":"Coding Agent API","pages":[{"title":"Get started","href":"/coding-agent-api/get-started"},{"group":"Code Providers","pages":[{"title":"List code providers","deprecated":null,"version":null,"openapi":"/coding-agent-api/openapi.json get /api/v1/code-providers","href":"/api-reference/code-providers/list-code-providers"},{"title":"Create code providers","deprecated":null,"version":null,"openapi":"/coding-agent-api/openapi.json post /api/v1/code-providers","href":"/api-reference/code-providers/create-code-providers"},{"title":"Delete code providers","deprecated":null,"version":null,"openapi":"/coding-agent-api/openapi.json delete /api/v1/code-providers/{providerId}","href":"/api-reference/code-providers/delete-code-providers"},{"title":"Update code providers","deprecated":null,"version":null,"openapi":"/coding-agent-api/openapi.json patch /api/v1/code-providers/{providerId}","href":"/api-reference/code-providers/update-code-providers"}]},{"group":"Repositories","pages":[{"title":"List repositories","deprecated":null,"version":null,"openapi":"/coding-agent-api/openapi.json get /api/v1/repositories","href":"/api-reference/repositories/list-repositories"},{"title":"Create repositories","deprecated":null,"version":null,"openapi":"/coding-agent-api/openapi.json post /api/v1/repositories","href":"/api-reference/repositories/create-repositories"},{"title":"Get repositories","deprecated":null,"version":null,"openapi":"/coding-agent-api/openapi.json get /api/v1/repositories/{id}","href":"/api-reference/repositories/get-repositories"},{"title":"Delete repositories","deprecated":null,"version":null,"openapi":"/coding-agent-api/openapi.json delete /api/v1/repositories/{id}","href":"/api-reference/repositories/delete-repositories"},{"title":"Update repositories","deprecated":null,"version":null,"openapi":"/coding-agent-api/openapi.json patch /api/v1/repositories/{id}","href":"/api-reference/repositories/update-repositories"},{"title":"Get repository analysis","deprecated":null,"version":null,"openapi":"/coding-agent-api/openapi.json get /api/v1/repositories/{id}/analysis","href":"/api-reference/repositories/get-repository-analysis"},{"title":"Analyze repository","deprecated":null,"version":null,"openapi":"/coding-agent-api/openapi.json post /api/v1/repositories/{id}/analyze","href":"/api-reference/repositories/analyze-repository"}]},{"group":"Sessions","pages":[{"title":"Get sessions","deprecated":null,"version":null,"openapi":"/coding-agent-api/openapi.json get /api/v1/sessions/{sessionId}","href":"/api-reference/sessions/get-sessions"},{"title":"Update sessions","deprecated":null,"version":null,"openapi":"/coding-agent-api/openapi.json patch /api/v1/sessions/{sessionId}","href":"/api-reference/sessions/update-sessions"},{"title":"List sessions","deprecated":null,"version":null,"openapi":"/coding-agent-api/openapi.json get /api/v1/sessions","href":"/api-reference/sessions/list-sessions"},{"title":"Create sessions","deprecated":null,"version":null,"openapi":"/coding-agent-api/openapi.json post /api/v1/sessions","href":"/api-reference/sessions/create-sessions"},{"title":"Get the session timeline events","description":"Returns the events that make up the session timeline shown to users. This includes user and agent messages, as well as progress events emitted while the agent is working, such as file operations, planning updates, repository actions, and other execution steps. Clients can use these events both to render the conversation and to track the agent's progress through the session.\n\nRequired API key scopes: any of `sessions:read`, `sessions:all`, `all:read`, `all:all`.","deprecated":null,"version":null,"openapi":"/coding-agent-api/openapi.json get /api/v1/sessions/{sessionId}/events","href":"/api-reference/sessions/get-the-session-timeline-events"},{"title":"Send a user message to the agent in a session","deprecated":null,"version":null,"openapi":"/coding-agent-api/openapi.json post /api/v1/sessions/{sessionId}/messages","href":"/api-reference/sessions/send-a-user-message-to-the-agent-in-a-session"}]}]},{"group":"Schemas","pages":[{"description":"A code provider either a gitlab or github personal access token. The code providers are used by the agents to connect to the user code, push changes, create commits, merge pull requests, etc.","title":null,"href":"/coding-agent-api/schemas/code-provider"},{"title":null,"href":"/coding-agent-api/schemas/repository"},{"title":null,"href":"/coding-agent-api/schemas/session"}]}]}]},"basePath":"","title":"Send a user message to the agent in a session - Agen","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}