Open Settings → Larkup Server, switch the toggle to Agent, and select Launch server. Restart it after changing the Agent’s prompt, skills, or tools so the generated runtime picks up the new configuration.
Settings → Larkup Server showing the local endpoint and API key
Copy the endpoint and Server API key from this page. Every request must include the key in the Authorization header.
Open Settings → Agent Customization. It has five tabs that control what the Agent knows and can do.
Prompt
Tools
Skills
MCP
Sandbox
Write the system prompt the Agent follows. Larkup combines it with its own retrieval and tool safety rules.
Agent Customization: Prompt tab
Turn built in tools on or off: semantic search, tabular data queries, chart generation, the Python sandbox, indexed data lookup, corpus analysis, and form filling.
Agent Customization: Tools tab
Add a Skill in the open SKILL.md format: metadata plus task instructions and optional resources. Upload a local file or add a remote one.
Agent Customization: Skills tab
Connect a remote Model Context Protocol server. Add its URL, test it to discover its tools, then enable it. Its tools become available to this Agent, namespaced by connection so they never override a built in tool.
Agent Customization: MCP tab
Give your Agent access to a computer, so it can run code instead of just describing it. Run it locally with Local Sandbox or Local Docker, or hand it to a remote provider such as E2B, Vercel Sandbox, Modal, Daytona, Fly.io Sprites, or Northflank. A remote sandbox is required for a serverless deployment that needs code execution.
Agent Customization: Sandbox tab
Select Verify after saving to confirm the chosen sandbox is reachable.
import { LarkupAgentClient } from '@larkup/sdk';const agent = new LarkupAgentClient({ baseUrl: 'http://localhost:8080', apiKey: 'your-api-key' });console.log(await agent.chatText('What can you find in our knowledge base?'));
from larkup import LarkupAgentClientagent = LarkupAgentClient(base_url="http://localhost:8080", api_key="your-api-key")print(agent.chat_text("What can you find in our knowledge base?"))
The full endpoint list is in the API Reference tab. To connect from the Vercel AI SDK, see Vercel AI SDK.
/health, /readiness, /reference, and /openapi.json stay public for operations and discovery. Every other Knowledge and Agent request needs Authorization: Bearer <key>.
Open Settings → Larkup Server → Server and select Deploy to choose a cloud provider. Larkup generates the runtime from the same Agent configuration used locally, including skills, MCP connections, and model settings. Use the same SDK client with the deployed URL. See Deploy Your Server for provider details.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Larkup","colors":{"primary":"#000000","light":"#000000","dark":"#222222"},"logo":{"light":"https://mintcdn.com/larkup/J0lnyYIE7T-PEajl/documentation/logo/logo-light2.png?fit=max\u0026auto=format\u0026n=J0lnyYIE7T-PEajl\u0026q=85\u0026s=a8d0f36de4d9d0698e8a6ee73e6bf1aa","dark":"https://mintcdn.com/larkup/J0lnyYIE7T-PEajl/documentation/logo/logo-dark2.png?fit=max\u0026auto=format\u0026n=J0lnyYIE7T-PEajl\u0026q=85\u0026s=fa0405df7faa06592472499c015d828c"},"favicon":"https://mintcdn.com/larkup/J0lnyYIE7T-PEajl/documentation/images/favicon.ico?fit=max\u0026auto=format\u0026n=J0lnyYIE7T-PEajl\u0026q=85\u0026s=feef65be53c3a3fe73a8289e38d3fd83","background":{"color":{"light":"#F9FAFB","dark":"#0F1117"}},"navbar":{"links":[{"href":"mailto:abdelrahmanaboneda@gmail.com","label":"Support"}],"primary":{"type":"button","label":"GitHub","href":"https://github.com/Larkup-AI/larkup"}},"footer":{"socials":{"github":"https://github.com/Larkup-AI/larkup"}},"contextual":{"options":["copy"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"larkup","hasAudioNarration":false,"actualSubdomain":"larkup","customDomains":["larkup.de"],"gitSource":{"type":"github","owner":"larkup-ai","repo":"larkup","deployBranch":"main","contentDirectory":"docs","isPrivate":false,"mountPath":"","label":""},"chroma":{"collectionId":"41ed47f6-9e92-488c-bf50-0a09ec845389","liveDeploymentHistoryId":"6ad54ec7cfe0d5be20f803dd","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad54ec7cfe0d5be20f803dd"},"entitlements":{},"buildId":"6ad54ec7cfe0d5be20f803dd","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"Documentation","count":13},{"language":"default","tag":"API Reference","count":11},{"language":"default","tag":"Use Cases","count":6},{"language":"default","tag":"Documents","count":5},{"language":"default","tag":"Getting Started","count":5},{"language":"default","tag":"Marketplace","count":5},{"language":"default","tag":"SDK","count":5},{"language":"default","tag":"Developer Guide","count":4},{"language":"default","tag":"Querying","count":2},{"language":"default","tag":"Overview","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"/documentation","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"documentation/style.css","content":""}],"page":{"pagePath":"documentation/developer/agent-runtime-api","slug":"/documentation/developer/agent-runtime-api","pageMetadata":{"title":"Agent Server API","description":"Launch a Larkup Agent Server, customize it, and connect through REST, the SDK, or Scalar.","href":"/documentation/developer/agent-runtime-api"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Launch a Larkup Agent Server, customize it, and connect through REST, the SDK, or Scalar.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Badge,CodeBlock,CodeGroup,Frame,Heading,OptimizedImage,Tab,Table,Tabs}=_components;if(!Badge)_missingMdxReference(`Badge`,true);if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!CodeGroup)_missingMdxReference(`CodeGroup`,true);if(!Frame)_missingMdxReference(`Frame`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!OptimizedImage)_missingMdxReference(`OptimizedImage`,true);if(!Tab)_missingMdxReference(`Tab`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Tabs)_missingMdxReference(`Tabs`,true);return _jsxs(_Fragment,{children:[_jsx(Badge,{color:`blue`,children:`Developer`}),`\n`,_jsx(Heading,{level:`2`,id:`launch-locally`,children:`Launch locally`}),`\n`,_jsxs(_components.p,{children:[`Open `,_jsx(_components.strong,{children:`Settings → Larkup Server`}),`, switch the toggle to `,_jsx(_components.strong,{children:`Agent`}),`, and select `,_jsx(_components.strong,{children:`Launch server`}),`. Restart it after changing the Agent’s prompt, skills, or tools so the generated runtime picks up the new configuration.`]}),`\n`,_jsx(Frame,{caption:`Settings → Larkup Server showing the local endpoint and API key`,children:_jsx(OptimizedImage,{src:`https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/deploy/server-on.png?fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=bc7e37149d4b25e569f9202296d92404`,alt:`Larkup Server settings with a running server and API key`,\"data-og-width\":`3012`,width:`3012`,\"data-og-height\":`1434`,height:`1434`,\"data-path\":`documentation/images/deploy/server-on.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/deploy/server-on.png?w=280\u0026fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=75ee89ecd2340c406c9c08441884a08f 280w, https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/deploy/server-on.png?w=560\u0026fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=aec8049520b5e291c2a61ba660aa482d 560w, https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/deploy/server-on.png?w=840\u0026fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=233df6f87b72654edc242005c228a03b 840w, https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/deploy/server-on.png?w=1100\u0026fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=dc153bd40c2a8f07ec52b211eec1cda6 1100w, https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/deploy/server-on.png?w=1650\u0026fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=0b028eb5f969e7a149bd30548a1551d7 1650w, https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/deploy/server-on.png?w=2500\u0026fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=1ce5503314bb7fb7322f37018e2056f8 2500w`})}),`\n`,_jsxs(_components.p,{children:[`Copy the endpoint and `,_jsx(_components.strong,{children:`Server API key`}),` from this page. Every request must include the key in the `,_jsx(_components.code,{children:`Authorization`}),` header.`]}),`\n`,_jsx(Heading,{level:`2`,id:`customize-the-agent`,children:`Customize the Agent`}),`\n`,_jsxs(_components.p,{children:[`Open `,_jsx(_components.strong,{children:`Settings → Agent Customization`}),`. It has five tabs that control what the Agent knows and can do.`]}),`\n`,_jsxs(Tabs,{children:[_jsxs(Tab,{title:`Prompt`,id:`prompt`,children:[_jsx(_components.p,{children:`Write the system prompt the Agent follows. Larkup combines it with its own retrieval and tool safety rules.`}),_jsx(Frame,{caption:`Agent Customization: Prompt tab`,children:_jsx(OptimizedImage,{src:`https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/customize-agent/customize-prompt.png?fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=731928b3a7b4e3fc47af1cd50f8869f9`,alt:`System prompt editor`,\"data-og-width\":`2982`,width:`2982`,\"data-og-height\":`1404`,height:`1404`,\"data-path\":`documentation/images/customize-agent/customize-prompt.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/customize-agent/customize-prompt.png?w=280\u0026fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=0597c143962279ed03e5f5b9d849413b 280w, https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/customize-agent/customize-prompt.png?w=560\u0026fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=99b824edbd863cb2553d57b9d06f55cf 560w, https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/customize-agent/customize-prompt.png?w=840\u0026fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=6db4989d82dddcad71fa08f2277e29cb 840w, https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/customize-agent/customize-prompt.png?w=1100\u0026fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=fea827c273d401efcce07ba72fd24f70 1100w, https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/customize-agent/customize-prompt.png?w=1650\u0026fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=6ab27e91b59c20bd8bdbf44e955d8a2b 1650w, https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/customize-agent/customize-prompt.png?w=2500\u0026fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=55f8e6973d4276af3ba50c39e886a1e0 2500w`})})]}),_jsxs(Tab,{title:`Tools`,id:`tools`,children:[_jsx(_components.p,{children:`Turn built in tools on or off: semantic search, tabular data queries, chart generation, the Python sandbox, indexed data lookup, corpus analysis, and form filling.`}),_jsx(Frame,{caption:`Agent Customization: Tools tab`,children:_jsx(OptimizedImage,{src:`https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/customize-agent/customize-tools.png?fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=f3b1fb50093b5a8cc7c3129b8d806309`,alt:`Built in tools with enable toggles`,\"data-og-width\":`2982`,width:`2982`,\"data-og-height\":`1216`,height:`1216`,\"data-path\":`documentation/images/customize-agent/customize-tools.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/customize-agent/customize-tools.png?w=280\u0026fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=0555930b8e809eb4e45540c6d80e28b4 280w, https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/customize-agent/customize-tools.png?w=560\u0026fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=049353ea24b0cdba523e63dfaf06f18b 560w, https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/customize-agent/customize-tools.png?w=840\u0026fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=58de242a0dda34ba764b1207d9872c30 840w, https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/customize-agent/customize-tools.png?w=1100\u0026fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=df00cf2df7add462b9c3210cff2476f9 1100w, https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/customize-agent/customize-tools.png?w=1650\u0026fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=25fdce8464a0a68a760d38ea28fe3c2d 1650w, https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/customize-agent/customize-tools.png?w=2500\u0026fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=89fd4a1807b07a90a028a916d86e2601 2500w`})})]}),_jsxs(Tab,{title:`Skills`,id:`skills`,children:[_jsxs(_components.p,{children:[`Add a Skill in the open `,_jsx(_components.code,{children:`SKILL.md`}),` format: metadata plus task instructions and optional resources. Upload a local file or add a remote one.`]}),_jsx(Frame,{caption:`Agent Customization: Skills tab`,children:_jsx(OptimizedImage,{src:`https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/customize-agent/customize-skills1.png?fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=42697fe20f7250586eb24e2673711039`,alt:`Add an Agent skill dialog`,\"data-og-width\":`2982`,width:`2982`,\"data-og-height\":`1282`,height:`1282`,\"data-path\":`documentation/images/customize-agent/customize-skills1.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/customize-agent/customize-skills1.png?w=280\u0026fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=fef72b7680cb1148208608012e0ba159 280w, https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/customize-agent/customize-skills1.png?w=560\u0026fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=1343b431bc916e54b8f180193b0bc97d 560w, https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/customize-agent/customize-skills1.png?w=840\u0026fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=434b4e335532d6a85afb5bc0ae6f30b0 840w, https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/customize-agent/customize-skills1.png?w=1100\u0026fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=e520a164b87d69bd32b8cf034823bb8e 1100w, https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/customize-agent/customize-skills1.png?w=1650\u0026fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=e5b1278489e3e7915584b1c686160c12 1650w, https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/customize-agent/customize-skills1.png?w=2500\u0026fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=e990fd742681000e569600ea5b97ca83 2500w`})})]}),_jsxs(Tab,{title:`MCP`,id:`mcp`,children:[_jsxs(_components.p,{children:[`Connect a remote `,_jsx(_components.a,{href:`https://modelcontextprotocol.io/`,children:`Model Context Protocol`}),` server. Add its URL, test it to discover its tools, then enable it. Its tools become available to this Agent, namespaced by connection so they never override a built in tool.`]}),_jsx(Frame,{caption:`Agent Customization: MCP tab`,children:_jsx(OptimizedImage,{src:`https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/customize-agent/customize-mcp.png?fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=4355cfa39aaa3f76ad5ba154b0c9fb83`,alt:`MCP connections list`,\"data-og-width\":`2982`,width:`2982`,\"data-og-height\":`1282`,height:`1282`,\"data-path\":`documentation/images/customize-agent/customize-mcp.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/customize-agent/customize-mcp.png?w=280\u0026fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=2af1e7196745cc9bce53e166fff066f2 280w, https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/customize-agent/customize-mcp.png?w=560\u0026fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=d7ab13e58725565aa788c5b21c0ad3a6 560w, https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/customize-agent/customize-mcp.png?w=840\u0026fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=c14ba7d76dfe8a6f106d5fe774c71458 840w, https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/customize-agent/customize-mcp.png?w=1100\u0026fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=3a61d3fe0f32f67c7c10c2b80edc361f 1100w, https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/customize-agent/customize-mcp.png?w=1650\u0026fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=342315cdbd791f23b156e57de6ec9df9 1650w, https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/customize-agent/customize-mcp.png?w=2500\u0026fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=042ca1484897527ce12d42ca1528b82c 2500w`})})]}),_jsxs(Tab,{title:`Sandbox`,id:`sandbox`,children:[_jsx(_components.p,{children:`Give your Agent access to a computer, so it can run code instead of just describing it. Run it locally with Local Sandbox or Local Docker, or hand it to a remote provider such as E2B, Vercel Sandbox, Modal, Daytona, Fly.io Sprites, or Northflank. A remote sandbox is required for a serverless deployment that needs code execution.`}),_jsx(Frame,{caption:`Agent Customization: Sandbox tab`,children:_jsx(OptimizedImage,{src:`https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/customize-agent/customize-sandbox1.png?fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=ae82e2584ee357e46ec57df453451817`,alt:`Sandbox provider picker`,\"data-og-width\":`2982`,width:`2982`,\"data-og-height\":`1384`,height:`1384`,\"data-path\":`documentation/images/customize-agent/customize-sandbox1.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/customize-agent/customize-sandbox1.png?w=280\u0026fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=a6232ba69f74bf0d0c46c0f0fa12cd38 280w, https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/customize-agent/customize-sandbox1.png?w=560\u0026fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=3a89b1e4fd8df4929d5176766cf99a92 560w, https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/customize-agent/customize-sandbox1.png?w=840\u0026fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=e2466f694ee1d32a2f573bc11c6e8fed 840w, https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/customize-agent/customize-sandbox1.png?w=1100\u0026fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=7c9bb4c2dfcbec102c45085a343b52b1 1100w, https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/customize-agent/customize-sandbox1.png?w=1650\u0026fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=bd9440e92b1a9a80cc05ef2e2236ee9a 1650w, https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/customize-agent/customize-sandbox1.png?w=2500\u0026fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=d12757e9c8567815ce991c051c52663d 2500w`})}),_jsxs(_components.p,{children:[`Select `,_jsx(_components.strong,{children:`Verify`}),` after saving to confirm the chosen sandbox is reachable.`]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`endpoints`,children:`Endpoints`}),`\n`,_jsxs(_components.p,{children:[`Every generated server serves an interactive reference at `,_jsx(_components.code,{children:`GET /reference`}),` and a machine readable contract at `,_jsx(_components.code,{children:`GET /openapi.json`}),`.`]}),`\n`,_jsx(Frame,{caption:`The interactive API reference for a running Larkup server`,children:_jsx(OptimizedImage,{src:`https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/rag/scalar-api2.png?fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=f1c624acbe60d505b5c02d3d14bf02a4`,alt:`Scalar API reference for the Larkup server`,\"data-og-width\":`3012`,width:`3012`,\"data-og-height\":`1442`,height:`1442`,\"data-path\":`documentation/images/rag/scalar-api2.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/rag/scalar-api2.png?w=280\u0026fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=a4d3a67169f048b889f4cbee141ed58c 280w, https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/rag/scalar-api2.png?w=560\u0026fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=c9af412215921548389fe069c64120d5 560w, https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/rag/scalar-api2.png?w=840\u0026fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=3222a7d436fe38e3531c1a548d2d4015 840w, https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/rag/scalar-api2.png?w=1100\u0026fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=6ebf6d384c3929a8ae4192b64871edba 1100w, https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/rag/scalar-api2.png?w=1650\u0026fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=5af39bdcbd11b2ae875e575e4d043cdd 1650w, https://mintcdn.com/larkup/13l_fOT1PJRw-f4o/documentation/images/rag/scalar-api2.png?w=2500\u0026fit=max\u0026auto=format\u0026n=13l_fOT1PJRw-f4o\u0026q=85\u0026s=b1fbc72a4f77083af6662995a596e793 2500w`})}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Endpoint`}),_jsx(_components.th,{children:`Purpose`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`GET /agent`})}),_jsx(_components.td,{children:`Read the Agent name, profile, and loaded tools.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`GET /agent/tools`})}),_jsx(_components.td,{children:`List every loaded tool.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`GET /agent/capabilities`})}),_jsx(_components.td,{children:`List enabled skills, sandbox, MCP connections, and plugins.`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`POST /chat`}),` or `,_jsx(_components.code,{children:`POST /agent/chat`})]}),_jsx(_components.td,{children:`Stream a response using the AI SDK message protocol.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`POST /v1/chat/completions`})}),_jsx(_components.td,{children:`OpenAI compatible chat completions, streamed by default.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`POST /query`})}),_jsx(_components.td,{children:`Retrieve the most relevant chunks for a query.`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`connect`,children:`Connect`}),`\n`,_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`4`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`4`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` http://localhost:8080/chat`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer your-api-key\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{\"messages\": [{\"role\": \"user\", \"content\": \"Summarize the Q3 report\"}]}'`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`TypeScript SDK`,numberOfLines:`4`,language:`typescript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`typescript`,children:_jsxs(_components.code,{language:`typescript`,numberOfLines:`4`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`LarkupAgentClient`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` } `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '@larkup/sdk'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` agent`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` new`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` LarkupAgentClient`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`({ `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`baseUrl:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'http://localhost:8080'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`apiKey:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'your-api-key'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` });`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`console`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`log`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`await`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` agent`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`chatText`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'What can you find in our knowledge base?'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`));`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Python SDK`,numberOfLines:`4`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`4`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` larkup `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` LarkupAgentClient`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`agent `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` LarkupAgentClient(`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`base_url`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"http://localhost:8080\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`api_key`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"your-api-key\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`print`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(agent.chat_text(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"What can you find in our knowledge base?\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`))`})]}),`\n`]})})})]}),`\n`,_jsxs(_components.p,{children:[`The full endpoint list is in the `,_jsx(_components.a,{href:`/documentation/api-reference/overview`,children:`API Reference`}),` tab. To connect from the Vercel AI SDK, see `,_jsx(_components.a,{href:`/documentation/sdk/integrations/ai-sdk`,children:`Vercel AI SDK`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`authentication`,children:`Authentication`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`/health`}),`, `,_jsx(_components.code,{children:`/readiness`}),`, `,_jsx(_components.code,{children:`/reference`}),`, and `,_jsx(_components.code,{children:`/openapi.json`}),` stay public for operations and discovery. Every other Knowledge and Agent request needs `,_jsx(_components.code,{children:`Authorization: Bearer \u003ckey>`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`deploy-and-connect-remotely`,children:`Deploy and connect remotely`}),`\n`,_jsxs(_components.p,{children:[`Open `,_jsx(_components.strong,{children:`Settings → Larkup Server → Server`}),` and select `,_jsx(_components.strong,{children:`Deploy`}),` to choose a cloud provider. Larkup generates the runtime from the same Agent configuration used locally, including skills, MCP connections, and model settings. Use the same SDK client with the deployed URL. See `,_jsx(_components.a,{href:`/documentation/developer/deploy`,children:`Deploy Your Server`}),` for provider details.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Agent Server API","description":"Launch a Larkup Agent Server, customize it, and connect through REST, the SDK, or Scalar.","href":"/documentation/developer/agent-runtime-api"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Launch locally","slug":"launch-locally","depth":2,"children":[]},{"title":"Customize the Agent","slug":"customize-the-agent","depth":2,"children":[]},{"title":"Endpoints","slug":"endpoints","depth":2,"children":[]},{"title":"Connect","slug":"connect","depth":2,"children":[]},{"title":"Authentication","slug":"authentication","depth":2,"children":[]},{"title":"Deploy and connect remotely","slug":"deploy-and-connect-remotely","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"larkup","siteName":"Larkup","title":"Agent Server API - Larkup","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-20T01:06:55.791Z","originalFileLocation":"documentation/developer/agent-runtime-api.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=\"Launch a Larkup Agent Server, customize it, and connect through REST, the SDK, or Scalar.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Larkup\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/larkup/O-SbaNQDkZFAZqod/_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/larkup/O-SbaNQDkZFAZqod/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/larkup/O-SbaNQDkZFAZqod/_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/larkup/O-SbaNQDkZFAZqod/_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/larkup/O-SbaNQDkZFAZqod/_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/larkup/O-SbaNQDkZFAZqod/_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/larkup/O-SbaNQDkZFAZqod/_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/larkup/O-SbaNQDkZFAZqod/_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/larkup/O-SbaNQDkZFAZqod/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Agent Server API - Larkup\">\u003cmeta data-mint-head property=\"og:description\" content=\"Launch a Larkup Agent Server, customize it, and connect through REST, the SDK, or Scalar.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Larkup\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://larkup.de/documentation/developer/agent-runtime-api\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://larkup.mintlify.app/_mintlify/api/og/v2?division=Developer+Guide\u0026amp;title=Agent+Server+API\u0026amp;description=Launch+a+Larkup+Agent+Server%2C+customize+it%2C+and+connect+through+REST%2C+the+SDK%2C+or+Scalar.\u0026amp;theme=bde185ca85eb94a198a8ed1e\u0026amp;signature=f1938822c126fc39e8effd1c6758138a6b0191ef2688cc12f49f3aaf6c4db5be\">\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=\"Agent Server API - Larkup\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Launch a Larkup Agent Server, customize it, and connect through REST, the SDK, or Scalar.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://larkup.mintlify.app/_mintlify/api/og/v2?division=Developer+Guide\u0026amp;title=Agent+Server+API\u0026amp;description=Launch+a+Larkup+Agent+Server%2C+customize+it%2C+and+connect+through+REST%2C+the+SDK%2C+or+Scalar.\u0026amp;theme=bde185ca85eb94a198a8ed1e\u0026amp;signature=f1938822c126fc39e8effd1c6758138a6b0191ef2688cc12f49f3aaf6c4db5be\">\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/larkup/O-SbaNQDkZFAZqod/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Larkup\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#000000\">\u003clink data-mint-head rel=\"canonical\" href=\"https://larkup.de/documentation/developer/agent-runtime-api\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/documentation/developer/agent-runtime-api.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://larkup.de/#organization\",\"name\":\"Larkup\",\"url\":\"https://larkup.de\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/larkup/J0lnyYIE7T-PEajl/documentation/logo/logo-light2.png?fit=max\u0026auto=format\u0026n=J0lnyYIE7T-PEajl\u0026q=85\u0026s=a8d0f36de4d9d0698e8a6ee73e6bf1aa\"}},{\"@type\":\"WebSite\",\"@id\":\"https://larkup.de#website\",\"name\":\"Larkup\",\"url\":\"https://larkup.de\",\"publisher\":{\"@id\":\"https://larkup.de/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://larkup.de/documentation/developer/agent-runtime-api#webpage\",\"url\":\"https://larkup.de/documentation/developer/agent-runtime-api\",\"name\":\"Agent Server API\",\"description\":\"Launch a Larkup Agent Server, customize it, and connect through REST, the SDK, or Scalar.\",\"dateModified\":\"2026-08-20T01:06:55.791Z\",\"isPartOf\":{\"@id\":\"https://larkup.de#website\"},\"breadcrumb\":{\"@id\":\"https://larkup.de/documentation/developer/agent-runtime-api#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://larkup.de/documentation/developer/agent-runtime-api#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Larkup\",\"item\":\"https://larkup.de\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Agent Server API\",\"item\":\"https://larkup.de/documentation/developer/agent-runtime-api\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://larkup.de/documentation/developer/agent-runtime-api#article\",\"headline\":\"Agent Server API\",\"name\":\"Agent Server API\",\"description\":\"Launch a Larkup Agent Server, customize it, and connect through REST, the SDK, or Scalar.\",\"url\":\"https://larkup.de/documentation/developer/agent-runtime-api\",\"mainEntityOfPage\":{\"@id\":\"https://larkup.de/documentation/developer/agent-runtime-api#webpage\"},\"dateModified\":\"2026-08-20T01:06:55.791Z\",\"publisher\":{\"@id\":\"https://larkup.de/#organization\"},\"isPartOf\":{\"@id\":\"https://larkup.de#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Larkup\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Larkup","nav":{"global":null,"tabs":[{"tab":"Documentation","groups":[{"group":"Getting Started","pages":[{"title":"Introduction","href":"/documentation"},{"title":"Installation","href":"/documentation/guide/installation"},{"title":"Quickstart","href":"/documentation/guide/quickstart"}]},{"group":"Use Cases","pages":[{"title":"Build Your RAG Server","href":"/documentation/guide/build-rag-server"},{"title":"Web Crawl at Scale","href":"/documentation/guide/data-loading"},{"title":"Chat with Video","href":"/documentation/guide/video-chat"},{"title":"Talk to Your Custom AI from Social Media","sidebarTitle":"AI in Social Media","href":"/documentation/guide/public-webhooks"},{"title":"Sign and Fill Documents","href":"/documentation/guide/document-editor"},{"title":"Analyze Tabular Data","description":"Upload a spreadsheet or CSV and ask analytical questions. Larkup returns charts and summaries directly in Chat.","href":"/documentation/guide/data-analysis"}]},{"group":"Developer Guide","pages":[{"title":"Agent Server API","href":"/documentation/developer/agent-runtime-api"},{"title":"Deploy Your Server","description":"Launch locally, deploy to a cloud provider, or export a portable server.","href":"/documentation/developer/deploy"},{"title":"CLI Reference","href":"/documentation/developer/cli"},{"title":"Configuration Reference","href":"/documentation/developer/configuration"}]}]},{"tab":"Marketplace","pages":[{"title":"Marketplace","href":"/documentation/marketplace/overview"}]},{"tab":"SDK","pages":[{"title":"SDK","href":"/documentation/sdk/overview"}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/documentation/api-reference/overview"}]}]},"title":"Agent Server API - Larkup","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["07c022d89b","a74be98ba7"],"chunks":["Frame-COGkNuA6.js","DynamicMarkdown-85clUA0i.js","zoom-image-lightbox-BZxD9MAj.js","lightbox-handle-r17bVUz3.js"]}
