[{"data":1,"prerenderedAt":594},["ShallowReactive",2],{"docs-\u002Fdocs\u002Fv2\u002Fapi\u002Frequest":3},{"id":4,"title":5,"body":6,"description":16,"extension":588,"meta":589,"navigation":81,"path":590,"seo":591,"stem":592,"__hash__":593},"docs\u002Fdocs\u002Fv2\u002Fapi\u002Frequest.md","axon.request",{"type":7,"value":8,"toc":584},"minimark",[9,13,17,101,104,169,175,391,396,399,500,504,510,571,580],[10,11,5],"h1",{"id":12},"axonrequest",[14,15,16],"p",{},"Sends a prompt to the agent loop and waits for it to finish. Returns all entries\nproduced during that turn plus the agent's final message as plain text.",[18,19,24],"pre",{"className":20,"code":21,"language":22,"meta":23,"style":23},"language-ts shiki shiki-themes dark-plus","\u002F\u002F Shorthand — string prompt, runs on the execution thread\nconst result = await axon.request(\"summarise the open issues\")\n\n\u002F\u002F result.text      — agent's final message as a plain string\n\u002F\u002F result.entries   — full entry timeline (tool calls, stdout, message, etc.)\n\u002F\u002F result.threadId\n","ts","",[25,26,27,36,76,83,89,95],"code",{"__ignoreMap":23},[28,29,32],"span",{"class":30,"line":31},"line",1,[28,33,35],{"class":34},"sOLPB","\u002F\u002F Shorthand — string prompt, runs on the execution thread\n",[28,37,39,43,47,51,55,59,62,66,69,73],{"class":30,"line":38},2,[28,40,42],{"class":41},"scz_3","const",[28,44,46],{"class":45},"s9McN"," result",[28,48,50],{"class":49},"sTNBD"," = ",[28,52,54],{"class":53},"sYbnZ","await",[28,56,58],{"class":57},"s3F5K"," axon",[28,60,61],{"class":49},".",[28,63,65],{"class":64},"sCudf","request",[28,67,68],{"class":49},"(",[28,70,72],{"class":71},"sKc5r","\"summarise the open issues\"",[28,74,75],{"class":49},")\n",[28,77,79],{"class":30,"line":78},3,[28,80,82],{"emptyLinePlaceholder":81},true,"\n",[28,84,86],{"class":30,"line":85},4,[28,87,88],{"class":34},"\u002F\u002F result.text      — agent's final message as a plain string\n",[28,90,92],{"class":30,"line":91},5,[28,93,94],{"class":34},"\u002F\u002F result.entries   — full entry timeline (tool calls, stdout, message, etc.)\n",[28,96,98],{"class":30,"line":97},6,[28,99,100],{"class":34},"\u002F\u002F result.threadId\n",[14,102,103],{},"With options:",[18,105,107],{"className":20,"code":106,"language":22,"meta":23,"style":23},"const result = await axon.request({\n    prompt: \"summarise the open issues\",\n    thread: \"research\",   \u002F\u002F named thread — omit to use the execution thread\n    policy: { ... },      \u002F\u002F narrow the active policy for this call only\n})\n",[25,108,109,128,139,153,164],{"__ignoreMap":23},[28,110,111,113,115,117,119,121,123,125],{"class":30,"line":31},[28,112,42],{"class":41},[28,114,46],{"class":45},[28,116,50],{"class":49},[28,118,54],{"class":53},[28,120,58],{"class":57},[28,122,61],{"class":49},[28,124,65],{"class":64},[28,126,127],{"class":49},"({\n",[28,129,130,133,136],{"class":30,"line":38},[28,131,132],{"class":57},"    prompt:",[28,134,135],{"class":71}," \"summarise the open issues\"",[28,137,138],{"class":49},",\n",[28,140,141,144,147,150],{"class":30,"line":78},[28,142,143],{"class":57},"    thread:",[28,145,146],{"class":71}," \"research\"",[28,148,149],{"class":49},",   ",[28,151,152],{"class":34},"\u002F\u002F named thread — omit to use the execution thread\n",[28,154,155,158,161],{"class":30,"line":85},[28,156,157],{"class":57},"    policy:",[28,159,160],{"class":49}," { ... },      ",[28,162,163],{"class":34},"\u002F\u002F narrow the active policy for this call only\n",[28,165,166],{"class":30,"line":91},[28,167,168],{"class":49},"})\n",[14,170,171,172,174],{},"Use ",[25,173,65],{}," when you need the full result before continuing — extracting text,\npassing it to the next call, writing it to a file.",[18,176,178],{"className":20,"code":177,"language":22,"meta":23,"style":23},"const { domain } = defineArgs\u003C{ domain: string }>()\nconst learnPrompt = await axon.prompt(\"learn\", { domain })\n\nconst result = await axon.request({ prompt: learnPrompt })\n\nconst match = result.text.match(\u002F```knowledge\\n([\\s\\S]*?)```\u002F)\nif (match) {\n    await writeFile(`data\u002Fknowledge\u002F${domain}.md`, match[1].trim())\n}\n",[25,179,180,211,242,246,272,276,325,339,385],{"__ignoreMap":23},[28,181,182,184,187,190,193,196,199,201,204,208],{"class":30,"line":31},[28,183,42],{"class":41},[28,185,186],{"class":49}," { ",[28,188,189],{"class":45},"domain",[28,191,192],{"class":49}," } = ",[28,194,195],{"class":64},"defineArgs",[28,197,198],{"class":49},"\u003C{ ",[28,200,189],{"class":57},[28,202,203],{"class":49},": ",[28,205,207],{"class":206},"sNl3T","string",[28,209,210],{"class":49}," }>()\n",[28,212,213,215,218,220,222,224,226,229,231,234,237,239],{"class":30,"line":38},[28,214,42],{"class":41},[28,216,217],{"class":45}," learnPrompt",[28,219,50],{"class":49},[28,221,54],{"class":53},[28,223,58],{"class":57},[28,225,61],{"class":49},[28,227,228],{"class":64},"prompt",[28,230,68],{"class":49},[28,232,233],{"class":71},"\"learn\"",[28,235,236],{"class":49},", { ",[28,238,189],{"class":57},[28,240,241],{"class":49}," })\n",[28,243,244],{"class":30,"line":78},[28,245,82],{"emptyLinePlaceholder":81},[28,247,248,250,252,254,256,258,260,262,265,268,270],{"class":30,"line":85},[28,249,42],{"class":41},[28,251,46],{"class":45},[28,253,50],{"class":49},[28,255,54],{"class":53},[28,257,58],{"class":57},[28,259,61],{"class":49},[28,261,65],{"class":64},[28,263,264],{"class":49},"({ ",[28,266,267],{"class":57},"prompt:",[28,269,217],{"class":57},[28,271,241],{"class":49},[28,273,274],{"class":30,"line":91},[28,275,82],{"emptyLinePlaceholder":81},[28,277,278,280,283,285,288,290,293,295,298,300,304,307,310,313,317,320,323],{"class":30,"line":97},[28,279,42],{"class":41},[28,281,282],{"class":45}," match",[28,284,50],{"class":49},[28,286,287],{"class":57},"result",[28,289,61],{"class":49},[28,291,292],{"class":57},"text",[28,294,61],{"class":49},[28,296,297],{"class":64},"match",[28,299,68],{"class":49},[28,301,303],{"class":302},"sxaxS","\u002F```knowledge\\n",[28,305,306],{"class":71},"([",[28,308,309],{"class":302},"\\s\\S",[28,311,312],{"class":71},"]",[28,314,316],{"class":315},"svVle","*?",[28,318,319],{"class":71},")",[28,321,322],{"class":302},"```\u002F",[28,324,75],{"class":49},[28,326,328,331,334,336],{"class":30,"line":327},7,[28,329,330],{"class":53},"if",[28,332,333],{"class":49}," (",[28,335,297],{"class":57},[28,337,338],{"class":49},") {\n",[28,340,342,345,348,350,353,356,358,361,364,367,369,372,376,379,382],{"class":30,"line":341},8,[28,343,344],{"class":53},"    await",[28,346,347],{"class":64}," writeFile",[28,349,68],{"class":49},[28,351,352],{"class":71},"`data\u002Fknowledge\u002F",[28,354,355],{"class":41},"${",[28,357,189],{"class":57},[28,359,360],{"class":41},"}",[28,362,363],{"class":71},".md`",[28,365,366],{"class":49},", ",[28,368,297],{"class":57},[28,370,371],{"class":49},"[",[28,373,375],{"class":374},"sDGX8","1",[28,377,378],{"class":49},"].",[28,380,381],{"class":64},"trim",[28,383,384],{"class":49},"())\n",[28,386,388],{"class":30,"line":387},9,[28,389,390],{"class":49},"}\n",[392,393,395],"h2",{"id":394},"prompt-accepts-an-array","prompt accepts an array",[14,397,398],{},"Pass an array of rendered prompts and Axon concatenates them in order before\nsending. The standard pattern — session context first, task-specific prompt second:",[18,400,402],{"className":20,"code":401,"language":22,"meta":23,"style":23},"const context = await axon.prompt(\"context\")   \u002F\u002F current project state\nconst task    = await axon.prompt(\"close-plan\", { issueId })\n\nconst result = await axon.request({ prompt: [context, task] })\n",[25,403,404,432,462,466],{"__ignoreMap":23},[28,405,406,408,411,413,415,417,419,421,423,426,429],{"class":30,"line":31},[28,407,42],{"class":41},[28,409,410],{"class":45}," context",[28,412,50],{"class":49},[28,414,54],{"class":53},[28,416,58],{"class":57},[28,418,61],{"class":49},[28,420,228],{"class":64},[28,422,68],{"class":49},[28,424,425],{"class":71},"\"context\"",[28,427,428],{"class":49},")   ",[28,430,431],{"class":34},"\u002F\u002F current project state\n",[28,433,434,436,439,442,444,446,448,450,452,455,457,460],{"class":30,"line":38},[28,435,42],{"class":41},[28,437,438],{"class":45}," task",[28,440,441],{"class":49},"    = ",[28,443,54],{"class":53},[28,445,58],{"class":57},[28,447,61],{"class":49},[28,449,228],{"class":64},[28,451,68],{"class":49},[28,453,454],{"class":71},"\"close-plan\"",[28,456,236],{"class":49},[28,458,459],{"class":57},"issueId",[28,461,241],{"class":49},[28,463,464],{"class":30,"line":78},[28,465,82],{"emptyLinePlaceholder":81},[28,467,468,470,472,474,476,478,480,482,484,486,489,492,494,497],{"class":30,"line":85},[28,469,42],{"class":41},[28,471,46],{"class":45},[28,473,50],{"class":49},[28,475,54],{"class":53},[28,477,58],{"class":57},[28,479,61],{"class":49},[28,481,65],{"class":64},[28,483,264],{"class":49},[28,485,267],{"class":57},[28,487,488],{"class":49}," [",[28,490,491],{"class":57},"context",[28,493,366],{"class":49},[28,495,496],{"class":57},"task",[28,498,499],{"class":49},"] })\n",[392,501,503],{"id":502},"entries","Entries",[14,505,506,509],{},[25,507,508],{},"result.entries"," is the full typed timeline for that turn. The most commonly used:",[18,511,513],{"className":20,"code":512,"language":22,"meta":23,"style":23},"\u002F\u002F result.text is shorthand for this entry's payload.content\nentry.type === \"axon:agent:message\"         \u002F\u002F final agent message\nentry.type === \"capsule:stdout\"             \u002F\u002F tool process output — payload.data\nentry.type === \"pathway:complete\"           \u002F\u002F loop finished — payload.durationMs, billing\n",[25,514,515,520,539,555],{"__ignoreMap":23},[28,516,517],{"class":30,"line":31},[28,518,519],{"class":34},"\u002F\u002F result.text is shorthand for this entry's payload.content\n",[28,521,522,525,527,530,533,536],{"class":30,"line":38},[28,523,524],{"class":57},"entry",[28,526,61],{"class":49},[28,528,529],{"class":57},"type",[28,531,532],{"class":49}," === ",[28,534,535],{"class":71},"\"axon:agent:message\"",[28,537,538],{"class":34},"         \u002F\u002F final agent message\n",[28,540,541,543,545,547,549,552],{"class":30,"line":78},[28,542,524],{"class":57},[28,544,61],{"class":49},[28,546,529],{"class":57},[28,548,532],{"class":49},[28,550,551],{"class":71},"\"capsule:stdout\"",[28,553,554],{"class":34},"             \u002F\u002F tool process output — payload.data\n",[28,556,557,559,561,563,565,568],{"class":30,"line":85},[28,558,524],{"class":57},[28,560,61],{"class":49},[28,562,529],{"class":57},[28,564,532],{"class":49},[28,566,567],{"class":71},"\"pathway:complete\"",[28,569,570],{"class":34},"           \u002F\u002F loop finished — payload.durationMs, billing\n",[14,572,573,574,579],{},"See ",[575,576,578],"a",{"href":577},"\u002Fdocs\u002Fv2\u002Fapi\u002Fstream","axon.stream"," for the streaming equivalent.",[581,582,583],"style",{},"html pre.shiki code .sOLPB, html code.shiki .sOLPB{--shiki-default:#6A9955}html pre.shiki code .scz_3, html code.shiki .scz_3{--shiki-default:#569CD6}html pre.shiki code .s9McN, html code.shiki .s9McN{--shiki-default:#4FC1FF}html pre.shiki code .sTNBD, html code.shiki .sTNBD{--shiki-default:#D4D4D4}html pre.shiki code .sYbnZ, html code.shiki .sYbnZ{--shiki-default:#C586C0}html pre.shiki code .s3F5K, html code.shiki .s3F5K{--shiki-default:#9CDCFE}html pre.shiki code .sCudf, html code.shiki .sCudf{--shiki-default:#DCDCAA}html pre.shiki code .sKc5r, html code.shiki .sKc5r{--shiki-default:#CE9178}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html pre.shiki code .sNl3T, html code.shiki .sNl3T{--shiki-default:#4EC9B0}html pre.shiki code .sxaxS, html code.shiki .sxaxS{--shiki-default:#D16969}html pre.shiki code .svVle, html code.shiki .svVle{--shiki-default:#D7BA7D}html pre.shiki code .sDGX8, html code.shiki .sDGX8{--shiki-default:#B5CEA8}",{"title":23,"searchDepth":38,"depth":38,"links":585},[586,587],{"id":394,"depth":38,"text":395},{"id":502,"depth":38,"text":503},"md",{},"\u002Fdocs\u002Fv2\u002Fapi\u002Frequest",{"title":5,"description":16},"docs\u002Fv2\u002Fapi\u002Frequest","QVuodcrLI8SUUh9A8RizPmYCOkPIjUjOkmBUq8xikCc",1785671808330]