Each Roe Agent uses an Engine that defines which tasks this agent will tackle.
Our built-in Engines are optimized for their
respective functions. In this example, we will use our
Image Extraction Engine to extract data from
images.
1
Create an Agent
Click on the “Add Agent” button in the
top right corner of the Agents page.
2
Choose an Engine
Select the Image Extraction Engine.
3
Configurations
Configure the Agent Inputs and Engine Configurations.
Agent Input Definition: Defines the inputs that your Agent must
accept when running a job. You can define the input key and its type as well as add or remove inputs. All defined inputs must be passed in a value when running the Agent. Learn more
about Input Definitions.
Agent Inputs
Engine Configuration: Configurations specific
to your selected Engine. This sets things like which AI model or prompt instructions the Agent will use when running jobs. You can also dyanmically define the Engine configurations at runtime by using template strings of the Agent input keys. Learn more about configuring
Engines.
Example of dynamic Engine configurations
4
Create the Agent
Hit the Create button. Woohoo, you just built your first Agent! Now, let’s run it.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Roe Documentation","colors":{"primary":"#FF6619","light":"#FF8C5A","dark":"#D9530F"},"logo":{"light":"https://mintcdn.com/roeai/fwCD8GI-1nfdsPAX/logo/light.svg?fit=max\u0026auto=format\u0026n=fwCD8GI-1nfdsPAX\u0026q=85\u0026s=d7b4fe21f708298b16c7b5b7af65cdbb","dark":"https://mintcdn.com/roeai/fwCD8GI-1nfdsPAX/logo/dark.svg?fit=max\u0026auto=format\u0026n=fwCD8GI-1nfdsPAX\u0026q=85\u0026s=f3eab0bc8f0dc6aa2bcd39722374dc62"},"favicon":"https://mintcdn.com/roeai/fwCD8GI-1nfdsPAX/favicon.svg?fit=max\u0026auto=format\u0026n=fwCD8GI-1nfdsPAX\u0026q=85\u0026s=f95b26cc8189388c848892e9d8871685","api":{"openapi":["api-reference/openapi.yml"]},"appearance":{"default":"light"},"navbar":{"links":[{"href":"mailto:support@roe-ai.com","label":"Support"}],"primary":{"type":"button","label":"Workspace","href":"https://app.roe-ai.com"}},"footer":{"socials":{"x":"https://x.com/try_roe_ai","github":"https://github.com/roe-ai","linkedin":"https://www.linkedin.com/company/roe-ai"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Community","icon":"slack","href":"https://join.slack.com/t/roeaiusers/shared_invite/zt-2m0oa9kj4-wltD91LCeJJR~cN1y1R7JQ"},{"anchor":"Blog","icon":"newspaper","href":"https://roeai.substack.com/"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"roeai","hasAudioNarration":false,"actualSubdomain":"roeai","customDomains":["docs.roe-ai.com"],"gitSource":{"type":"github","owner":"roe-ai","repo":"roe-docs-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae62419cf4408c768288cf5","clientVersion":"0.0.4087","searchFilterCounts":[{"language":"default","tag":"Documentation","count":77},{"language":"default","tag":"API Reference","count":44},{"language":"default","tag":"Agents","count":38},{"language":"default","tag":"Release Notes","count":21},{"language":"default","tag":"Engines","count":12},{"language":"default","tag":"SDK integration","count":10},{"language":"default","tag":"Policies","count":10},{"language":"default","tag":"Webhooks","count":9},{"language":"default","tag":"Data Resources","count":9},{"language":"default","tag":"SQL Workspace","count":9}]},"assistantConfig":{},"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":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".prose ul:has(>li>.rn-tag),ul:has(>li>.rn-tag){list-style:none;padding:0!important;padding-inline-start:0!important;margin-top:1rem;margin-left:0!important}.prose ul>li:has(>.rn-tag),li:has(>.rn-tag){display:grid;grid-template-columns:7.5rem minmax(0, 1fr);column-gap:0.875rem;row-gap:0.5rem;align-items:baseline;justify-items:start;list-style:none;padding:0!important;padding-left:0!important;padding-inline-start:0!important;margin-left:0!important;margin-bottom:1.25rem;font-size:1.0625rem;line-height:1.5;letter-spacing:-0.005em;text-align:left}li:has(>.rn-tag):last-child{margin-bottom:0}li:has(>.rn-tag)::before{content:none}li:has(>.rn-tag)>.rn-tag{justify-self:start}.rn-tag{display:inline-block;box-sizing:border-box;width:fit-content;max-width:7.5rem;padding:0.1875rem 0.625rem;border-radius:9999px;font-size:0.65625rem;font-weight:600;line-height:1.45;letter-spacing:0.09em;text-transform:uppercase;text-align:left;white-space:nowrap;vertical-align:baseline}@media (max-width: 640px){li:has(>.rn-tag){grid-template-columns:1fr;row-gap:0.375rem}.rn-tag{max-width:none}}.rn-tag-agents{background:#FFE6DE;color:#A23B1E}.rn-tag-platform{background:#E3E8F2;color:#2F4868}.rn-tag-integrations{background:#D6EEEA;color:#1F5F58}.rn-tag-sops{background:#E5E1F5;color:#443B85}.rn-tag-qa{background:#DDEEDA;color:#2C6230}.rn-tag-deployment{background:#D9E8F5;color:#1E4D77}.rn-tag-dashboard{background:#F8DEEB;color:#8A3A66}.rn-tag-api{background:#F6EAC9;color:#7A5614}.rn-tag-models{background:#EBDEEF;color:#5E2A7A}.rn-tag-security{background:#F5DCDC;color:#8C2A2A}.rn-tag-workflows{background:#E4EED1;color:#4D6622}"}],"page":{"pagePath":"agents/quickstart","slug":"/agents/quickstart","pageMetadata":{"title":"Quickstart","description":"Build your first Roe Agent in under 5 minutes","href":"/agents/quickstart"},"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: \"Build your first Roe Agent in under 5 minutes\"\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`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Frame,Heading,OptimizedImage,Step,Steps}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Frame)_missingMdxReference(`Frame`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!OptimizedImage)_missingMdxReference(`OptimizedImage`,true);if(!Step)_missingMdxReference(`Step`,true);if(!Steps)_missingMdxReference(`Steps`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`build-an-image-extraction-agent`,children:`Build an Image Extraction Agent`}),`\n`,_jsxs(_components.p,{children:[`Each Roe Agent uses an Engine that defines which tasks this agent will tackle.\nOur built-in `,_jsx(_components.a,{href:`/agents/engines/introduction`,children:`Engines`}),` are optimized for their\nrespective functions. In this example, we will use our\n`,_jsx(_components.a,{href:`/agents/engines/multimodal-extraction`,children:`Image Extraction Engine`}),` to extract data from\nimages.`]}),`\n`,_jsxs(Steps,{children:[_jsxs(Step,{title:`Create an Agent`,children:[_jsx(_components.p,{children:`Click on the “Add Agent” button in the\ntop right corner of the Agents page.`}),_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/roeai/qeWYCF2quzHQHhsD/images/add-agent.png?fit=max\u0026auto=format\u0026n=qeWYCF2quzHQHhsD\u0026q=85\u0026s=b3e1ec9b816ed1e57cb1ecfa53ff4288`,\"data-og-width\":`1920`,width:`1920`,\"data-og-height\":`1045`,height:`1045`,\"data-path\":`images/add-agent.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/roeai/qeWYCF2quzHQHhsD/images/add-agent.png?w=280\u0026fit=max\u0026auto=format\u0026n=qeWYCF2quzHQHhsD\u0026q=85\u0026s=b32727af74adc5c95404ea3fad774382 280w, https://mintcdn.com/roeai/qeWYCF2quzHQHhsD/images/add-agent.png?w=560\u0026fit=max\u0026auto=format\u0026n=qeWYCF2quzHQHhsD\u0026q=85\u0026s=9718fb50baeaf8b2c3545a3158108443 560w, https://mintcdn.com/roeai/qeWYCF2quzHQHhsD/images/add-agent.png?w=840\u0026fit=max\u0026auto=format\u0026n=qeWYCF2quzHQHhsD\u0026q=85\u0026s=f2ff846f37b950b226a97adc45767ad2 840w, https://mintcdn.com/roeai/qeWYCF2quzHQHhsD/images/add-agent.png?w=1100\u0026fit=max\u0026auto=format\u0026n=qeWYCF2quzHQHhsD\u0026q=85\u0026s=c0d1f64299041c7646340a58e92985bd 1100w, https://mintcdn.com/roeai/qeWYCF2quzHQHhsD/images/add-agent.png?w=1650\u0026fit=max\u0026auto=format\u0026n=qeWYCF2quzHQHhsD\u0026q=85\u0026s=96b82d48825b3b5426803d1c55f81d92 1650w, https://mintcdn.com/roeai/qeWYCF2quzHQHhsD/images/add-agent.png?w=2500\u0026fit=max\u0026auto=format\u0026n=qeWYCF2quzHQHhsD\u0026q=85\u0026s=d6a02760348b1e8ba6eefd09d2245dc8 2500w`})})]}),_jsxs(Step,{title:`Choose an Engine`,children:[_jsx(_components.p,{children:`Select the Image Extraction Engine.`}),_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/roeai/qeWYCF2quzHQHhsD/images/agent-creation-choose-engine.png?fit=max\u0026auto=format\u0026n=qeWYCF2quzHQHhsD\u0026q=85\u0026s=8333e072e20314d5ec42d5db7594da6e`,\"data-og-width\":`1594`,width:`1594`,\"data-og-height\":`817`,height:`817`,\"data-path\":`images/agent-creation-choose-engine.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/roeai/qeWYCF2quzHQHhsD/images/agent-creation-choose-engine.png?w=280\u0026fit=max\u0026auto=format\u0026n=qeWYCF2quzHQHhsD\u0026q=85\u0026s=44a622a98025716f70e0baf0a919b77e 280w, https://mintcdn.com/roeai/qeWYCF2quzHQHhsD/images/agent-creation-choose-engine.png?w=560\u0026fit=max\u0026auto=format\u0026n=qeWYCF2quzHQHhsD\u0026q=85\u0026s=9cbd17df8ca1e38e15936ec677821d94 560w, https://mintcdn.com/roeai/qeWYCF2quzHQHhsD/images/agent-creation-choose-engine.png?w=840\u0026fit=max\u0026auto=format\u0026n=qeWYCF2quzHQHhsD\u0026q=85\u0026s=34515d2171a5efff062f84d1e4a601c3 840w, https://mintcdn.com/roeai/qeWYCF2quzHQHhsD/images/agent-creation-choose-engine.png?w=1100\u0026fit=max\u0026auto=format\u0026n=qeWYCF2quzHQHhsD\u0026q=85\u0026s=aee6d482050d8dff38925947bb0f2912 1100w, https://mintcdn.com/roeai/qeWYCF2quzHQHhsD/images/agent-creation-choose-engine.png?w=1650\u0026fit=max\u0026auto=format\u0026n=qeWYCF2quzHQHhsD\u0026q=85\u0026s=3dbe615b468111a898aeb7bfaf5f87d2 1650w, https://mintcdn.com/roeai/qeWYCF2quzHQHhsD/images/agent-creation-choose-engine.png?w=2500\u0026fit=max\u0026auto=format\u0026n=qeWYCF2quzHQHhsD\u0026q=85\u0026s=3a4ccfff33d9b591c5af7641442e4c97 2500w`})})]}),_jsxs(Step,{title:`Configurations`,children:[_jsxs(_components.p,{children:[`Configure the `,_jsx(_components.strong,{children:`Agent Inputs`}),` and `,_jsx(_components.strong,{children:`Engine Configurations`}),`.`]}),_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-config-page.png?fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=7d3f8045b04bc2054bde860577783e0f`,\"data-og-width\":`1284`,width:`1284`,\"data-og-height\":`1008`,height:`1008`,\"data-path\":`images/agent-config-page.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-config-page.png?w=280\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=defac2539aa4f4544c4db5b63f7495c1 280w, https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-config-page.png?w=560\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=e6f1e33c8b3d3556bafd8f44a42a33e3 560w, https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-config-page.png?w=840\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=1cb50cc239966b92d378d8df85de5950 840w, https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-config-page.png?w=1100\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=e0e0dca74898c8b567afa7200c4735e6 1100w, https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-config-page.png?w=1650\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=2f429757d4e77c8d823143f785d2e55a 1650w, https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-config-page.png?w=2500\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=1cfe839b605c27696d8af894ea5de998 2500w`})}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Agent Input Definition`}),`: Defines the inputs that your Agent must\naccept when running a job. You can define the input key and its type as well as add or remove inputs. All defined inputs must be passed in a value when running the Agent. Learn more\nabout `,_jsx(_components.a,{href:`/agents/input-definition`,children:`Input Definitions`}),`.`]}),`\n`]}),_jsx(Frame,{caption:`Agent Inputs`,children:_jsx(OptimizedImage,{src:`https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-config-inputs.png?fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=8a777ad73ed7836d5669d110ebdf2e54`,\"data-og-width\":`612`,width:`612`,\"data-og-height\":`453`,height:`453`,\"data-path\":`images/agent-config-inputs.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-config-inputs.png?w=280\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=6d7257e24ff8dde7e18abf3da53c6341 280w, https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-config-inputs.png?w=560\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=d75d7e7dc2b54bcc252bdd2f9dc05256 560w, https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-config-inputs.png?w=840\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=738683373fb05655bd99f194e06c7825 840w, https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-config-inputs.png?w=1100\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=c6eae4eddb6711c6a76d907f453082d8 1100w, https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-config-inputs.png?w=1650\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=6e9580a43306778a7e30d886af009139 1650w, https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-config-inputs.png?w=2500\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=4049484a89e1e42350822cade6182f95 2500w`})}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Engine Configuration`}),`: Configurations specific\nto your selected Engine. This sets things like which AI model or prompt instructions the Agent will use when running jobs. You can also dyanmically define the Engine configurations at runtime by using template strings of the Agent input keys. Learn more about configuring\n`,_jsx(_components.a,{href:`/agents/engines/introduction`,children:`Engines`}),`.`]}),`\n`]}),_jsx(Frame,{caption:`Example of dynamic Engine configurations`,children:_jsx(OptimizedImage,{src:`https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-config-engine-configs.png?fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=38acbe49468f37d603a050308c499e76`,\"data-og-width\":`609`,width:`609`,\"data-og-height\":`862`,height:`862`,\"data-path\":`images/agent-config-engine-configs.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-config-engine-configs.png?w=280\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=7436fd9057a5b8ea0ebe80f824b4b8a4 280w, https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-config-engine-configs.png?w=560\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=c6ad1bbe3c3146c7b4709c722d8431dd 560w, https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-config-engine-configs.png?w=840\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=756333a253c81a0179a033dcae49c2e1 840w, https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-config-engine-configs.png?w=1100\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=afbdba58db11bbfba97834ae64377423 1100w, https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-config-engine-configs.png?w=1650\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=9bcb4bf57f8d971069e31762ba8233f6 1650w, https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-config-engine-configs.png?w=2500\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=3508f42583df1a09d6ca16cb6e65184a 2500w`})})]}),_jsx(Step,{title:`Create the Agent`,children:_jsxs(_components.p,{children:[`Hit the `,_jsx(_components.strong,{children:`Create`}),` button. Woohoo, you just built your first Agent! Now, let’s run it.`]})})]}),`\n`,_jsx(Heading,{level:`2`,id:`run-your-image-extraction-agent`,children:`Run Your Image Extraction Agent`}),`\n`,_jsx(_components.p,{children:`There are three ways to run your Agent:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`UI`}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/api-reference/agents/run`,children:`Agent API`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/database/functions/run-agent.mdx`,children:`Roe SQL`})}),`\n`]}),`\n`,_jsx(_components.p,{children:`We will run the agent through the UI:`}),`\n`,_jsxs(Steps,{children:[_jsx(Step,{title:`Go to the Agent's details page`,children:_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-view.png?fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=21a6c1bb15b90120ba326734a9bad49e`,\"data-og-width\":`1942`,width:`1942`,\"data-og-height\":`200`,height:`200`,\"data-path\":`images/agent-view.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-view.png?w=280\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=cbce4b6f77165a2a4f291d7018d429f8 280w, https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-view.png?w=560\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=c181f71cfc6007fd4053faf60dd18864 560w, https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-view.png?w=840\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=0e7b9883c2dd6df362e8dc1117c06fae 840w, https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-view.png?w=1100\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=063159dedfc45ea4430d443737722708 1100w, https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-view.png?w=1650\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=3f7a6a248a5329f51c93af894617f79c 1650w, https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-view.png?w=2500\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=a988984e8f46c4937213b9088d20dd83 2500w`})})}),_jsx(Step,{title:`Create a new Agent job`,children:_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-new-job.png?fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=3517e85ca469e22edd5d35f7861c8763`,\"data-og-width\":`1942`,width:`1942`,\"data-og-height\":`674`,height:`674`,\"data-path\":`images/agent-new-job.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-new-job.png?w=280\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=c32367630ab366ad6cac21308f7c05cf 280w, https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-new-job.png?w=560\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=5308b0fa029a0f8860ff3ff6fc60ca51 560w, https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-new-job.png?w=840\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=ff9466041e17342d092863cebf532b33 840w, https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-new-job.png?w=1100\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=b34c631268f0b79d835e5cc9a1a55b92 1100w, https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-new-job.png?w=1650\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=9f2dbe5ccbd94c39dfa3fcac892df5a2 1650w, https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-new-job.png?w=2500\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=c55658634add247eb0415cd432261fef 2500w`})})}),_jsxs(Step,{title:`Fill in the Agent inputs`,children:[_jsxs(_components.p,{children:[`Paste in the following text for the `,_jsx(_components.strong,{children:`instruction`}),` input field:`]}),_jsx(CodeBlock,{numberOfLines:`8`,language:`text`,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:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`8`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Describe the image in one sentence.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Output in the following structure:`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\"```\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`{`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"description\": \"\u003cdescription of the image>\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`}`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:\"```\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),_jsxs(_components.p,{children:[`Then pick an image to upload to the `,_jsx(_components.strong,{children:`image`}),` input field. You can use the one below.`]}),_jsx(Frame,{caption:`san-francisco.jpg`,children:_jsx(OptimizedImage,{src:`https://mintcdn.com/roeai/KH5NetBx7zzOcueq/images/san-francisco.jpg?fit=max\u0026auto=format\u0026n=KH5NetBx7zzOcueq\u0026q=85\u0026s=68a5a7e0f6c1f0e5c9ea2bf53211352d`,\"data-og-width\":`612`,width:`612`,\"data-og-height\":`336`,height:`336`,\"data-path\":`images/san-francisco.jpg`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/roeai/KH5NetBx7zzOcueq/images/san-francisco.jpg?w=280\u0026fit=max\u0026auto=format\u0026n=KH5NetBx7zzOcueq\u0026q=85\u0026s=a30efb5cefc7b88d513a1f0a121549c3 280w, https://mintcdn.com/roeai/KH5NetBx7zzOcueq/images/san-francisco.jpg?w=560\u0026fit=max\u0026auto=format\u0026n=KH5NetBx7zzOcueq\u0026q=85\u0026s=1a4936f3267b85b208eba793867dda5a 560w, https://mintcdn.com/roeai/KH5NetBx7zzOcueq/images/san-francisco.jpg?w=840\u0026fit=max\u0026auto=format\u0026n=KH5NetBx7zzOcueq\u0026q=85\u0026s=890655660ea7a69bc5aa991664975774 840w, https://mintcdn.com/roeai/KH5NetBx7zzOcueq/images/san-francisco.jpg?w=1100\u0026fit=max\u0026auto=format\u0026n=KH5NetBx7zzOcueq\u0026q=85\u0026s=01685618001b09f7a59e0a62467cb10a 1100w, https://mintcdn.com/roeai/KH5NetBx7zzOcueq/images/san-francisco.jpg?w=1650\u0026fit=max\u0026auto=format\u0026n=KH5NetBx7zzOcueq\u0026q=85\u0026s=0a2b21ac31b585beec070f38587461b5 1650w, https://mintcdn.com/roeai/KH5NetBx7zzOcueq/images/san-francisco.jpg?w=2500\u0026fit=max\u0026auto=format\u0026n=KH5NetBx7zzOcueq\u0026q=85\u0026s=e920dec2950c24127d4280b4d85458bb 2500w`})}),_jsx(_components.p,{children:`Here is the filled-in Agent inputs:`}),_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-create-job.png?fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=611f776c5fbc0f08b7b40266e3421842`,\"data-og-width\":`1340`,width:`1340`,\"data-og-height\":`952`,height:`952`,\"data-path\":`images/agent-create-job.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-create-job.png?w=280\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=abe7cd4b7bf22347927e41af2dbf01ed 280w, https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-create-job.png?w=560\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=a26d7494ed216848f56e8e2ef4440844 560w, https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-create-job.png?w=840\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=4a43fcf38aa81a7127a4b59ca81cb1f3 840w, https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-create-job.png?w=1100\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=c3aca50012f082ae4c3a3e8b77db01fc 1100w, https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-create-job.png?w=1650\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=e02e316e27d328a7ac2796580cdce67f 1650w, https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-create-job.png?w=2500\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=cff351060b609c5f6598bf81c5e703f9 2500w`})})]}),_jsx(Step,{title:`Run the job`,children:_jsxs(_components.p,{children:[`Hit the `,_jsx(_components.strong,{children:`Create`}),` button at the bottom. Hell yeah, your first Agent job has been kicked off!`]})})]}),`\n`,_jsx(Heading,{level:`2`,id:`view-results`,children:`View Results`}),`\n`,_jsx(_components.p,{children:`You can view the status of your Agent job in its details page.`}),`\n`,_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-jobs-list.png?fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=fb5b948cdb8fb4184aa3f579f192ea5b`,\"data-og-width\":`1930`,width:`1930`,\"data-og-height\":`572`,height:`572`,\"data-path\":`images/agent-jobs-list.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-jobs-list.png?w=280\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=634c49ebd13a814d821a0590c3ccf436 280w, https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-jobs-list.png?w=560\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=6cf2a5ea138f975400894ec1b618748d 560w, https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-jobs-list.png?w=840\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=8bff56b8c7143c48ea1d04c8ca827c25 840w, https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-jobs-list.png?w=1100\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=bc87ba2af23f58550d627f2bb6c8c29b 1100w, https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-jobs-list.png?w=1650\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=e7935b8e34762a99cb573055e478ec57 1650w, https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-jobs-list.png?w=2500\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=97b39feeadc04d458492ce3d03226eb0 2500w`})}),`\n`,_jsxs(_components.p,{children:[`Click `,_jsx(_components.strong,{children:`view`}),` to check the job result.`]}),`\n`,_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-job-detail.png?fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=ce51991d73e918fd05eb79355d58b9db`,\"data-og-width\":`733`,width:`733`,\"data-og-height\":`444`,height:`444`,\"data-path\":`images/agent-job-detail.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-job-detail.png?w=280\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=d80c5f047fd22df33013fdd0f2463568 280w, https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-job-detail.png?w=560\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=4713c83b3478c9068e95f8bc2a9a3575 560w, https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-job-detail.png?w=840\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=e681c3a14e72bf06bb1dc2c681046547 840w, https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-job-detail.png?w=1100\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=77c6c5efafb2db151130975ab706c569 1100w, https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-job-detail.png?w=1650\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=9e7f7bfa7ea97cf00b319bd0555e4971 1650w, https://mintcdn.com/roeai/wyVOyeWPONjXHsrt/images/agent-job-detail.png?w=2500\u0026fit=max\u0026auto=format\u0026n=wyVOyeWPONjXHsrt\u0026q=85\u0026s=a8546f8e3bccee4f57a9861fb27aa186 2500w`})}),`\n`,_jsx(Heading,{level:`2`,id:`improve-your-agents’-results`,children:`Improve Your Agents’ Results`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/agents/prompt-engineering`,children:`Prompt Engineering`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/agents/output-schema-json`,children:`Define Output Schema`})}),`\n`]})]})}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":"Quickstart","description":"Build your first Roe Agent in under 5 minutes","href":"/agents/quickstart"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Build an Image Extraction Agent","slug":"build-an-image-extraction-agent","depth":2,"children":[]},{"title":"Run Your Image Extraction Agent","slug":"run-your-image-extraction-agent","depth":2,"children":[]},{"title":"View Results","slug":"view-results","depth":2,"children":[]},{"title":"Improve Your Agents’ Results","slug":"improve-your-agents’-results","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"roeai","siteName":"Roe Documentation","title":"Quickstart - Roe Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-06-19T00:14:12.048Z","originalFileLocation":"agents/quickstart.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=\"light\"}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=\"Build your first Roe Agent in under 5 minutes\">\u003cmeta data-mint-head name=\"application-name\" content=\"Roe Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/roeai/fPmAFS4J5dj6_hvQ/_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/roeai/fPmAFS4J5dj6_hvQ/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/roeai/fPmAFS4J5dj6_hvQ/_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/roeai/fPmAFS4J5dj6_hvQ/_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/roeai/fPmAFS4J5dj6_hvQ/_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/roeai/fPmAFS4J5dj6_hvQ/_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/roeai/fPmAFS4J5dj6_hvQ/_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/roeai/fPmAFS4J5dj6_hvQ/_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/roeai/fPmAFS4J5dj6_hvQ/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Quickstart - Roe Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Build your first Roe Agent in under 5 minutes\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Roe Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.roe-ai.com/agents/quickstart\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://roeai.mintlify.site/_mintlify/api/og/v2?division=Agents\u0026amp;title=Quickstart\u0026amp;description=Build+your+first+Roe+Agent+in+under+5+minutes\u0026amp;theme=71393da4931c813a27fda74c\u0026amp;signature=77d1c964f16634112d44e4690ed8f3759f2a05094278d0e7274c5997b2e0f205\">\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=\"Quickstart - Roe Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Build your first Roe Agent in under 5 minutes\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://roeai.mintlify.site/_mintlify/api/og/v2?division=Agents\u0026amp;title=Quickstart\u0026amp;description=Build+your+first+Roe+Agent+in+under+5+minutes\u0026amp;theme=71393da4931c813a27fda74c\u0026amp;signature=77d1c964f16634112d44e4690ed8f3759f2a05094278d0e7274c5997b2e0f205\">\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/roeai/fPmAFS4J5dj6_hvQ/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Roe Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF6619\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.roe-ai.com/agents/quickstart\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/agents/quickstart.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.roe-ai.com/#organization\",\"name\":\"Roe Documentation\",\"url\":\"https://docs.roe-ai.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/roeai/fwCD8GI-1nfdsPAX/logo/light.svg?fit=max\u0026auto=format\u0026n=fwCD8GI-1nfdsPAX\u0026q=85\u0026s=d7b4fe21f708298b16c7b5b7af65cdbb\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.roe-ai.com#website\",\"name\":\"Roe Documentation\",\"url\":\"https://docs.roe-ai.com\",\"publisher\":{\"@id\":\"https://docs.roe-ai.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.roe-ai.com/agents/quickstart#webpage\",\"url\":\"https://docs.roe-ai.com/agents/quickstart\",\"name\":\"Quickstart\",\"description\":\"Build your first Roe Agent in under 5 minutes\",\"dateModified\":\"2026-06-19T00:14:12.048Z\",\"isPartOf\":{\"@id\":\"https://docs.roe-ai.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.roe-ai.com/agents/quickstart#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.roe-ai.com/agents/quickstart#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Agents\",\"item\":\"https://docs.roe-ai.com/agents/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Quickstart\",\"item\":\"https://docs.roe-ai.com/agents/quickstart\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.roe-ai.com/agents/quickstart#article\",\"headline\":\"Quickstart\",\"name\":\"Quickstart\",\"description\":\"Build your first Roe Agent in under 5 minutes\",\"url\":\"https://docs.roe-ai.com/agents/quickstart\",\"mainEntityOfPage\":{\"@id\":\"https://docs.roe-ai.com/agents/quickstart#webpage\"},\"dateModified\":\"2026-06-19T00:14:12.048Z\",\"publisher\":{\"@id\":\"https://docs.roe-ai.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.roe-ai.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Roe Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Roe Documentation","nav":{"global":{"anchors":[{"anchor":"Community","icon":"slack","href":"https://join.slack.com/t/roeaiusers/shared_invite/zt-2m0oa9kj4-wltD91LCeJJR~cN1y1R7JQ"},{"anchor":"Blog","icon":"newspaper","href":"https://roeai.substack.com/"}]},"tabs":[{"tab":"Documentation","groups":[{"group":"Get Started","pages":[{"title":"Introduction","href":"/introduction"},{"title":"Quickstart","href":"/quickstart"}]},{"group":"Agents","pages":[{"title":"Introduction","description":"Start building powerful data processing Agents in under 5 minutes","href":"/agents/introduction"},{"title":"Quickstart","href":"/agents/quickstart"},{"title":"Input Definitions","description":"Define the inputs that your Agent will accept","href":"/agents/input-definition"},{"title":"Prompt Engineering Guide","href":"/agents/prompt-engineering"},{"title":"JSON Output Schema","href":"/agents/output-schema-json"},{"group":"Engines","pages":[{"title":"Introduction","href":"/agents/engines/introduction"},{"title":"Document Segmentation","href":"/agents/engines/document-segmentation"},{"title":"Google Maps Insights","href":"/agents/engines/google-maps"},{"title":"Interactive Web Insights","href":"/agents/engines/interactive-web"},{"title":"Marketplace Storefront Analysis","href":"/agents/engines/marketplace-storefront"},{"title":"Merchant Risk Analysis","href":"/agents/engines/merchant-risk"},{"title":"Multimodal Insights","href":"/agents/engines/multimodal-extraction"},{"title":"Document Insights","href":"/agents/engines/pdf-extraction"},{"title":"Research Agent","href":"/agents/engines/research"},{"title":"Social Media Crawler","href":"/agents/engines/social-media-crawler"},{"title":"Web Insights","href":"/agents/engines/url-extraction"},{"title":"URL Finder","href":"/agents/engines/url-finder"}]},{"group":"Agentic Workflows","pages":[{"title":"Introduction","href":"/agents/agentic-workflows/introduction"},{"title":"AML Investigation","href":"/agents/engines/aml-investigation"},{"title":"Data Analysis","href":"/agents/engines/data-analysis"},{"title":"Fraud Investigation","href":"/agents/engines/fraud-investigation"},{"title":"Merchant Underwriting","href":"/agents/engines/merchant-underwriting"},{"title":"Product Policy","href":"/agents/engines/product-policy"}]}]},{"group":"SQL Workspace","pages":[{"title":"Introduction","href":"/database/introduction"},{"title":"Quickstart","href":"/database/quickstart"},{"group":"Functions","pages":[{"title":"Introduction","href":"/database/functions/introduction"},{"title":"run_agent","href":"/database/functions/run-agent"},{"title":"run_agent_sync","href":"/database/functions/run-agent-sync"},{"title":"job_status","href":"/database/functions/job-status"},{"title":"job_result | resolve","href":"/database/functions/job-result"},{"title":"keep_pages","href":"/database/functions/keep-pages"}]},{"group":"Examples","pages":[{"title":"Introduction","href":"/database/examples/introduction"}]}]},{"group":"Data Resources","pages":[{"title":"Introduction","href":"/data-resources/introduction"},{"title":"Context Sources","href":"/data-resources/context-sources"},{"group":"Roe Datasets","pages":[{"title":"Introduction","href":"/data-resources/roe-datasets/introduction"}]},{"group":"Connectors","pages":[{"title":"Introduction","href":"/data-resources/connectors/introduction"},{"title":"Custom API Connector","href":"/data-resources/connectors/custom-api"},{"title":"AWS S3 Connector","href":"/data-resources/connectors/s3"},{"title":"Snowflake Connector","href":"/data-resources/connectors/snowflake"},{"title":"SharePoint Connector","href":"/data-resources/connectors/sharepoint"},{"title":"Zendesk Connector","href":"/data-resources/connectors/zendesk"}]}]},{"group":"Policies","pages":[{"title":"Policies","href":"/policies/introduction"}]},{"group":"Webhooks","pages":[{"title":"Webhooks","href":"/webhooks/introduction"}]},{"group":"MCP Server","pages":[{"title":"Introduction","href":"/mcp/introduction"},{"group":"Skills","pages":[{"title":"Roe MCP Basics","href":"/mcp/skills/roe-mcp-basics"},{"title":"Workflow Builder","href":"/mcp/skills/workflow-builder"}]},{"title":"MCP tools reference","href":"/mcp/tools"}]},{"group":"Enterprise","pages":[{"group":"Single sign-on (SSO)","pages":[{"group":"OIDC","pages":[{"title":"OIDC Single Sign-On (SSO) Integration","href":"/enterprise/sso"},{"title":"Microsoft Entra ID (Azure AD) OIDC SSO Integration","href":"/enterprise/sso-entraid"},{"title":"Okta OIDC SSO Integration Guide","href":"/enterprise/sso-okta"},{"title":"ADFS OIDC SSO Integration Guide","href":"/enterprise/sso-adfs"}]},{"group":"SAML","pages":[{"title":"SAML Single Sign-On (SSO) Integration","href":"/enterprise/sso-saml"},{"title":"Microsoft Entra ID (Azure AD) SAML SSO Integration","href":"/enterprise/sso-saml-entraid"}]}]}]},{"group":"Use Cases","pages":[{"title":"Introduction","href":"/use-cases/finance"}]},{"group":"Release Notes","pages":[{"title":"Release 1.1.4","href":"/release-notes/release-1-1-4"},{"title":"Release 1.1.3","href":"/release-notes/release-1-1-3"},{"title":"Release 1.1.2","href":"/release-notes/release-1-1-2"},{"title":"Release 1.1.1","href":"/release-notes/release-1-1-1"},{"title":"Release 1.1.0","href":"/release-notes/release-1-1-0"},{"title":"Release 1.0.99","href":"/release-notes/release-1-0-99"},{"title":"Release 1.0.98","href":"/release-notes/release-1-0-98"},{"title":"Release 1.0.97","href":"/release-notes/release-1-0-97"},{"title":"Release 1.0.96","href":"/release-notes/release-1-0-96"},{"title":"Release 1.0.95","href":"/release-notes/release-1-0-95"},{"title":"Release 1.0.94","href":"/release-notes/release-1-0-94"},{"title":"Release 1.0.93","href":"/release-notes/release-1-0-93"},{"title":"Release 1.0.92","href":"/release-notes/release-1-0-92"},{"title":"Release 1.0.91","href":"/release-notes/release-1-0-91"},{"title":"Release 1.0.90","href":"/release-notes/release-1-0-90"},{"title":"Release 1.0.89","href":"/release-notes/release-1-0-89"},{"title":"Release 1.0.88","href":"/release-notes/release-1-0-88"},{"title":"Release 1.0.87","href":"/release-notes/release-1-0-87"},{"title":"Release 1.0.86","href":"/release-notes/release-1-0-86"},{"title":"Release 1.0.85","href":"/release-notes/release-1-0-85"},{"title":"Release 1.0.84","href":"/release-notes/release-1-0-84"}]}]},{"tab":"SDK integration","pages":[{"title":"SDK integration","href":"/api-reference/sdk-integration"}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/introduction"}]},{"tab":"SQL Reference","pages":[{"title":"SQL Reference","href":"/sql-reference/introduction"}]}]},"basePath":"","title":"Quickstart - Roe Documentation","buildId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","deploymentId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","dynamics":["07c022d89b","a74be98ba7"],"chunks":["Frame-CXMGc493.js","DynamicMarkdown-D-2HDKEp.js","zoom-image-lightbox-CE4cYsJE.js","lightbox-handle-r17bVUz3.js"]}