Beta Notice: This project is in rapid development and may not be stable for production use.
AI Agents in IO Intelligence are specialized assistants designed to handle a variety of tasks, from reasoning and summarization to sentiment analysis and translation. These agents leverage advanced AI capabilities to automate complex workflows, enhance decision-making, and streamline information processing.Each AI Agent is tailored for a specific function — whether it is extracting key information, classifying data, moderating content, or translating languages. By integrating these agents into your applications, you can harness powerful AI-driven automation with ease.
Each model within IO Intelligence has its own value and credit consumption rate based on its complexity, capability, and computational cost.For plan subscribers (Basic, Professional, or higher tiers), all model interactions draw from a shared usage pool. This means you can use any model available under your plan, and your total usage will count toward a single shared credit allowance — rather than having separate limits for each model.This shared system provides maximum flexibility, allowing you to switch between models seamlessly while staying within your daily or hourly quota.This limit is designed to ensure fair and balanced usage for all users. If you anticipate needing a higher request limit, please consider optimizing your implementation or reach out to us for assistance.For further details on usage limits, full breakdown of rates, and how IO Credits are billed, refer to the IO Intelligence Payments page.
You can interact with the API using HTTP requests from any programming language or by using the official Python.To install the official Python library, run the following command:
The following is an example of how you can use the iointel Python library to interact with the IO Intelligence APIs:
from iointel import ( Agent, Workflow)import osimport asyncioapi_key = os.environ["OPENAI_API_KEY"] # Replace with your actual io.net API keytext = """In the rapidly evolving landscape of artificial intelligence, the ability to condense vast amounts of information into concise and meaningful summaries is crucial. From research papers and business reports to legal documents and news articles, professionals across industries rely on summarization to extract key insights efficiently. Traditional summarization techniques often struggle with maintaining coherence and contextual relevance. However, advanced AI models now leverage natural language understanding to identify core ideas, eliminate redundancy, and generate human-like summaries. As organizations continue to deal with an ever-growing influx of data, the demand for intelligent summarization tools will only increase. Whether enhancing productivity, improving decision-making, or streamlining workflows, AI-powered summarization is set to become an indispensable asset in the digital age."""agent = Agent( name="Summarize Agent", instructions="You are an assistant specialized in summarization.", model="meta-llama/Llama-3.3-70B-Instruct", api_key=api_key, base_url="https://api.intelligence.io.solutions/api/v1")workflow = Workflow(objective=text, client_mode=False)async def run_workflow(): results = (await workflow.summarize_text(max_words=50,agents=[agent]).run_tasks())["results"] return resultsresults = asyncio.run(run_workflow())print(results)
This snippet demonstrates how to configure the client, send a chat completion request using the Llama-3.3-70B-Instruct agent, and retrieve a response.
run_tasks() is now asynchronous. All usage must be wrapped inside an async function. Use asyncio.run() to execute it.
IO Intelligence APIs authenticate requests using API keys. You can generate API keys from the API Keys tab under IO Intelligence.
Always treat your API key as a secret. Do not share it or expose it in client-side code (e.g., browsers or mobile apps). Instead, store it securely in an environment variable or a key management service on your backend server.
Include the API key in an Authorization HTTP header for all API requests:
{ "agents": { "reasoning_agent": { "name": "Reasoning Agent", "description": "A logic-driven problem solver that breaks down complex scenarios into clear, step-by-step conclusions. Whether evaluating arguments, making inferences, or troubleshooting issues, this agent excels at structured thinking and insightful analysis.", "persona": null, "metadata": { "image_url": null, "tags": [ "text" ] } }, "summary_agent": { ... }, "sentiment_analysis_agent": { ... }, ... }}
With these steps, you have successfully made your first request to the IO Intelligence Agents API.For further details on Agents, Workflows, and API Endpoints, check out the IO Intelligence Agent Framework.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"io.net","colors":{"primary":"#6b6b6b","light":"#6b6b6b","dark":"#6b6b6b"},"logo":{"light":"https://mintcdn.com/ionet-cca8037f/b19dlbPlCUid06dF/logo/light.svg?fit=max\u0026auto=format\u0026n=b19dlbPlCUid06dF\u0026q=85\u0026s=debc44eff771f4f2f76b8b8a86faf828","dark":"https://mintcdn.com/ionet-cca8037f/b19dlbPlCUid06dF/logo/dark.svg?fit=max\u0026auto=format\u0026n=b19dlbPlCUid06dF\u0026q=85\u0026s=ea1ddf5bcdb6dab50a40fe0c7b30589f"},"favicon":"https://mintcdn.com/ionet-cca8037f/UVfyCRC1Po30yGvw/logo-small-favicon.png?fit=max\u0026auto=format\u0026n=UVfyCRC1Po30yGvw\u0026q=85\u0026s=7f6d17a7f949fb2e0ddaf85f9da85629","appearance":{"default":"light","strict":true},"fonts":{"heading":{"family":"Geist","source":"https://cdn.jsdelivr.net/fontsource/fonts/geist@latest/latin-400-normal.woff2","format":"woff2"},"body":{"family":"Geist","source":"https://cdn.jsdelivr.net/fontsource/fonts/geist@latest/latin-400-normal.woff2","format":"woff2"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"ionet-cca8037f","hasAudioNarration":false,"actualSubdomain":"ionet-cca8037f","customDomains":["io.net"],"gitSource":{"type":"github","owner":"ionet-official","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aec56ed754501e0c6b58691","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"default","tag":"Community","count":59},{"language":"default","tag":"API References","count":51},{"language":"default","tag":"IO Worker","count":35},{"language":"default","tag":"IO Cloud","count":25},{"language":"default","tag":"Cloud","count":23},{"language":"default","tag":"IO Intelligence","count":21},{"language":"default","tag":"Core Concepts","count":17},{"language":"default","tag":"Intelligence","count":16},{"language":"default","tag":"IO Explorer","count":13},{"language":"default","tag":"IO Staking","count":13}]},"assistantConfig":{},"basePath":"/docs","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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}],"googleFontsInlined":false},"customCss":[{"filePath":"styles.css","content":"@font-face{font-family:\"Geist\";font-style:normal;font-weight:400;font-display:swap;src:url(\"https://cdn.jsdelivr.net/fontsource/fonts/geist@latest/latin-400-normal.woff2\") format(\"woff2\")}:root{--gray-700: 10, 10, 10;--primary: 10, 10, 10}body,#sidebar,#content-area,#content-container{font-family:\"Geist\", ui-sans-serif, system-ui, sans-serif}#search-bar-entry{border-radius:9999px!important}@media (min-width: 1024px){:has(>#content-container){background:#f9f9f9}}#content-area{position:relative}#content-area::before{content:\"\";display:none}@media (min-width: 1024px){#content-area::before{display:block;position:absolute;top:-2.5rem;left:-2.5rem;width:calc(100% + 5rem);height:calc(100% + 2.5rem);background:#fff}#content-area{}}#sidebar{background:#f9f9f9}.nav-logo{height:20px}#table-of-contents-content,#table-of-contents-layout{display:block!important;min-width:12rem}.toc-track-wrapper{position:relative;padding-left:0rem}.toc{padding-left:0.75rem}.toc-track{position:absolute;left:0;top:0;bottom:0;width:1px;background:#f5f5f5;border-radius:1px;pointer-events:none}.toc-thumb{position:absolute;left:0;width:1px;background:#0a0a0a;border-radius:1px;pointer-events:none;transition:top 0.2s ease-out, height 0.2s ease-out}"}],"page":{"pagePath":"reference/ai-agents/getting-started-with-api-agents","slug":"/reference/ai-agents/getting-started-with-api-agents","pageMetadata":{"sidebarTitle":"Overview","title":"Getting Started with AI Agents API","description":null,"href":"/reference/ai-agents/getting-started-with-api-agents"},"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`,em:`em`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,..._provideComponents(),...props.components},{CodeBlock,CodeGroup,Frame,Heading,OptimizedImage,Warning}=_components;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(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Warning,{children:_jsx(_components.p,{children:`Beta Notice: This project is in rapid development and may not be stable for production use.`})}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.em,{children:_jsx(_components.strong,{children:`AI Agents`})}),` in `,_jsx(_components.strong,{children:`IO Intelligence`}),` are specialized assistants designed to handle a variety of tasks, from reasoning and summarization to sentiment analysis and translation. These agents leverage advanced AI capabilities to automate complex workflows, enhance decision-making, and streamline information processing.`]}),`\n`,_jsxs(_components.p,{children:[`Each `,_jsx(_components.em,{children:_jsx(_components.strong,{children:`AI Agent`})}),` is tailored for a specific function — whether it is extracting key information, classifying data, moderating content, or translating languages. By integrating these agents into your applications, you can harness powerful AI-driven automation with ease.`]}),`\n`,_jsx(Heading,{level:`3`,id:`important-note-on-usage-limits`,children:`Important Note on Usage Limits`}),`\n`,_jsxs(_components.p,{children:[`Each model within `,_jsx(_components.strong,{children:`IO Intelligence`}),` has its own value and credit consumption rate based on its complexity, capability, and computational cost.`]}),`\n`,_jsxs(_components.p,{children:[`For `,_jsx(_components.strong,{children:`plan subscribers`}),` (`,_jsx(_components.em,{children:`Basic`}),`, `,_jsx(_components.em,{children:`Professional`}),`, or higher tiers), all model interactions draw from a `,_jsx(_components.strong,{children:`shared usage pool`}),`. This means you can use any model available under your plan, and your total usage will count toward a single shared credit allowance — rather than having separate limits for each model.`]}),`\n`,_jsx(_components.p,{children:`This shared system provides maximum flexibility, allowing you to switch between models seamlessly while staying within your daily or hourly quota.`}),`\n`,_jsx(_components.p,{children:`This limit is designed to ensure fair and balanced usage for all users. If you anticipate needing a higher request limit, please consider optimizing your implementation or reach out to us for assistance.`}),`\n`,_jsxs(_components.p,{children:[`For further details on `,_jsx(_components.strong,{children:`usage limits, full breakdown of rates, and how IO Credits are billed`}),`, refer to the `,_jsx(_components.a,{href:`/guides/payment/io-intelligence-payments`,children:_jsx(_components.strong,{children:`IO Intelligence Payments`})}),` page.`]}),`\n`,_jsx(Heading,{level:`2`,id:`introduction`,children:`Introduction`}),`\n`,_jsx(_components.p,{children:`You can interact with the API using HTTP requests from any programming language or by using the official Python.`}),`\n`,_jsx(_components.p,{children:`To install the official Python library, run the following command:`}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,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:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`pip install iointel`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(Heading,{level:`3`,id:`example-using-the-ai-agents-api-in-python`,children:`Example: Using the AI Agents API in Python`}),`\n`,_jsxs(_components.p,{children:[`The following is an example of how you can use the `,_jsx(_components.code,{children:`iointel Python`}),` library to interact with the `,_jsx(_components.em,{children:`IO Intelligence APIs`}),`:`]}),`\n`,_jsx(CodeGroup,{children:_jsx(CodeBlock,{filename:`Python`,numberOfLines:`28`,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:`28`,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:` iointel `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` (`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` Agent,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` Workflow`})}),`\n`,_jsx(_components.span,{className:`line`,children:_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\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` os`})]}),`\n`,_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:` asyncio`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`api_key `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` os.environ[`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"OPENAI_API_KEY\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`] `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Replace with your actual io.net API key`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`text `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"\"\"In the rapidly evolving landscape of artificial intelligence, the ability to condense vast amounts of information into concise and meaningful summaries is crucial. From research papers and business reports to legal documents and news articles, professionals across industries rely on summarization to extract key insights efficiently. Traditional summarization techniques often struggle with maintaining coherence and contextual relevance. However, advanced AI models now leverage natural language understanding to identify core ideas, eliminate redundancy, and generate human-like summaries. As organizations continue to deal with an ever-growing influx of data, the demand for intelligent summarization tools will only increase. Whether enhancing productivity, improving decision-making, or streamlining workflows, AI-powered summarization is set to become an indispensable asset in the digital age.\"\"\"`})]}),`\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:` Agent(`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` name`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Summarize Agent\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` instructions`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"You are an assistant specialized in summarization.\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` model`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"meta-llama/Llama-3.3-70B-Instruct\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,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:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`api_key,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_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:`\"https://api.intelligence.io.solutions/api/v1\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_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:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`workflow `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` Workflow(`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`objective`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`text, `}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`client_mode`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`False`}),_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:`async`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` def`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` run_workflow`}),_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\":`#D4D4D4`},children:` results `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_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\":`#D4D4D4`},children:` workflow.summarize_text(`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`max_words`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`50`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`agents`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`[agent]).run_tasks())[`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"results\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`]`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` return`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` results`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`results `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` asyncio.run(run_workflow())`})]}),`\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:`(results)`})]}),`\n`]})})})}),`\n`,_jsxs(_components.p,{children:[`This snippet demonstrates how to configure the client, send a chat completion request using the `,_jsx(_components.code,{children:`Llama-3.3-70B-Instruct`}),` agent, and retrieve a response.`]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`run_tasks()`}),` is now asynchronous. All usage must be wrapped inside an async function. Use asyncio.run() to execute it.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`authentication`,children:`Authentication`}),`\n`,_jsx(Heading,{level:`3`,id:`api-keys`,children:`API Keys`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.em,{children:`IO Intelligence APIs`}),` authenticate requests using `,_jsx(_components.strong,{children:`API keys`}),`. You can generate API keys from the `,_jsx(_components.a,{href:`https://ai.io.net/ai/api-keys`,children:`API Keys tab`}),` under `,_jsx(_components.strong,{children:`IO Intelligence`}),`.`]}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`Always treat your API key as a secret. Do not share it or expose it in client-side code (e.g., browsers or mobile apps). Instead, store it securely in an environment variable or a key management service on your backend server.`})}),`\n`,_jsxs(_components.p,{children:[`Include the API key in an `,_jsx(_components.code,{children:`Authorization`}),` HTTP header for all API requests:`]}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,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:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Authorization: Bearer \\\\$IOINTELLIGENCE_API_KEY`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(Heading,{level:`3`,id:`example-list-available-agents`,children:`Example: List Available Agents`}),`\n`,_jsxs(_components.p,{children:[`The following is an example `,_jsx(_components.code,{children:`curl`}),` command to list all agents available in `,_jsx(_components.strong,{children:`IO Intelligence`}),`:`]}),`\n`,_jsx(CodeGroup,{children:_jsx(CodeBlock,{filename:`curl`,numberOfLines:`3`,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:`3`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`curl https://api.intelligence.io.solutions/api/v1/agents /`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` -H \"Authorization: Bearer \\\\$IOINTELLIGENCE_API_KEY\" `})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})}),`\n`,_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/ionet-cca8037f/s2w54-m8LpJVz2ID/images/reference/d662245a9a9e42e605edab5851966cd24a7c8ec6bea32ef23aac82f57ea300cc-agents.jpg?fit=max\u0026auto=format\u0026n=s2w54-m8LpJVz2ID\u0026q=85\u0026s=f2cd3b065a7c838f02ebfc848c7ea347`,alt:``,\"data-og-width\":`1870`,width:`1870`,\"data-og-height\":`1100`,height:`1100`,\"data-path\":`images/reference/d662245a9a9e42e605edab5851966cd24a7c8ec6bea32ef23aac82f57ea300cc-agents.jpg`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/ionet-cca8037f/s2w54-m8LpJVz2ID/images/reference/d662245a9a9e42e605edab5851966cd24a7c8ec6bea32ef23aac82f57ea300cc-agents.jpg?w=280\u0026fit=max\u0026auto=format\u0026n=s2w54-m8LpJVz2ID\u0026q=85\u0026s=63bb29b051e60852fdf38a76402e2892 280w, https://mintcdn.com/ionet-cca8037f/s2w54-m8LpJVz2ID/images/reference/d662245a9a9e42e605edab5851966cd24a7c8ec6bea32ef23aac82f57ea300cc-agents.jpg?w=560\u0026fit=max\u0026auto=format\u0026n=s2w54-m8LpJVz2ID\u0026q=85\u0026s=a10e8750fa8afcc7c94782ebd85aadcb 560w, https://mintcdn.com/ionet-cca8037f/s2w54-m8LpJVz2ID/images/reference/d662245a9a9e42e605edab5851966cd24a7c8ec6bea32ef23aac82f57ea300cc-agents.jpg?w=840\u0026fit=max\u0026auto=format\u0026n=s2w54-m8LpJVz2ID\u0026q=85\u0026s=2c42af0af2f1c910873c1ee50cd1cd93 840w, https://mintcdn.com/ionet-cca8037f/s2w54-m8LpJVz2ID/images/reference/d662245a9a9e42e605edab5851966cd24a7c8ec6bea32ef23aac82f57ea300cc-agents.jpg?w=1100\u0026fit=max\u0026auto=format\u0026n=s2w54-m8LpJVz2ID\u0026q=85\u0026s=869e553e7d4a1e1b4ee80f74778960bd 1100w, https://mintcdn.com/ionet-cca8037f/s2w54-m8LpJVz2ID/images/reference/d662245a9a9e42e605edab5851966cd24a7c8ec6bea32ef23aac82f57ea300cc-agents.jpg?w=1650\u0026fit=max\u0026auto=format\u0026n=s2w54-m8LpJVz2ID\u0026q=85\u0026s=f564e510394c741b1b67340f577c3f92 1650w, https://mintcdn.com/ionet-cca8037f/s2w54-m8LpJVz2ID/images/reference/d662245a9a9e42e605edab5851966cd24a7c8ec6bea32ef23aac82f57ea300cc-agents.jpg?w=2500\u0026fit=max\u0026auto=format\u0026n=s2w54-m8LpJVz2ID\u0026q=85\u0026s=5c1001d77cca04e1aa2def7154e0250c 2500w`})}),`\n`,_jsx(_components.p,{children:`This request should return a response as follows:`}),`\n`,_jsx(CodeGroup,{children:_jsx(CodeBlock,{filename:`json`,numberOfLines:`22`,language:`json`,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:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`22`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"agents\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"reasoning_agent\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Reasoning Agent\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"description\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"A logic-driven problem solver that breaks down complex scenarios into clear, step-by-step conclusions. Whether evaluating arguments, making inferences, or troubleshooting issues, this agent excels at structured thinking and insightful analysis.\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"persona\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"metadata\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"image_url\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"tags\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"text\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"summary_agent\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:` ...`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"sentiment_analysis_agent\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:` ...`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:` ...`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})}),`\n`,_jsxs(_components.p,{children:[`With these steps, you have successfully made your first request to the `,_jsx(_components.em,{children:_jsx(_components.strong,{children:`IO Intelligence Agents API`})}),`.`]}),`\n`,_jsxs(_components.p,{children:[`For further details on `,_jsx(_components.strong,{children:`Agents, Workflows, and API Endpoints`}),`, check out the `,_jsx(_components.a,{href:`/guides/intelligence/agent-framework`,children:`IO Intelligence Agent Framework`}),`.`]})]})}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":{"sidebarTitle":"Overview","title":"Getting Started with AI Agents API","description":null,"href":"/reference/ai-agents/getting-started-with-api-agents"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Important Note on Usage Limits","slug":"important-note-on-usage-limits","depth":3,"children":[]},{"title":"Introduction","slug":"introduction","depth":2,"children":[{"title":"Example: Using the AI Agents API in Python","slug":"example-using-the-ai-agents-api-in-python","depth":3,"children":[]}]},{"title":"Authentication","slug":"authentication","depth":2,"children":[{"title":"API Keys","slug":"api-keys","depth":3,"children":[]},{"title":"Example: List Available Agents","slug":"example-list-available-agents","depth":3,"children":[]}]}],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/ionet-cca8037f/536253863eb63726/scripts/toc-track.js"],"subdomain":"ionet-cca8037f","siteName":"io.net","title":"Getting Started with AI Agents API - io.net","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-05T10:15:35.038Z","originalFileLocation":"reference/ai-agents/getting-started-with-api-agents.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";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=\"application-name\" content=\"io.net\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/ionet-cca8037f/45_PhHvAsXqoDTU6/_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=\"/docs/mintlify-assets/_mintlify/favicons/ionet-cca8037f/45_PhHvAsXqoDTU6/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/ionet-cca8037f/45_PhHvAsXqoDTU6/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/ionet-cca8037f/45_PhHvAsXqoDTU6/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/ionet-cca8037f/45_PhHvAsXqoDTU6/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/ionet-cca8037f/45_PhHvAsXqoDTU6/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/ionet-cca8037f/45_PhHvAsXqoDTU6/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/ionet-cca8037f/45_PhHvAsXqoDTU6/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/ionet-cca8037f/45_PhHvAsXqoDTU6/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Getting Started with AI Agents API - io.net\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"io.net\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://io.net/docs/reference/ai-agents/getting-started-with-api-agents\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://ionet-cca8037f.mintlify.site/docs/_mintlify/api/og/v2?division=Getting+Started+with+AI+Agents+API\u0026amp;title=Getting+Started+with+AI+Agents+API\u0026amp;theme=c216b07be2cce0f8115c5458\u0026amp;signature=b4a16d287bf31140bb20f329a8f2c76737468ea65a233de81903af198f8a3ca6\">\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=\"Getting Started with AI Agents API - io.net\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ionet-cca8037f.mintlify.site/docs/_mintlify/api/og/v2?division=Getting+Started+with+AI+Agents+API\u0026amp;title=Getting+Started+with+AI+Agents+API\u0026amp;theme=c216b07be2cce0f8115c5458\u0026amp;signature=b4a16d287bf31140bb20f329a8f2c76737468ea65a233de81903af198f8a3ca6\">\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=\"/docs/mintlify-assets/_mintlify/favicons/ionet-cca8037f/45_PhHvAsXqoDTU6/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"io.net\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6b6b6b\">\u003clink data-mint-head rel=\"canonical\" href=\"https://io.net/docs/reference/ai-agents/getting-started-with-api-agents\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/reference/ai-agents/getting-started-with-api-agents.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://io.net/#organization\",\"name\":\"io.net\",\"url\":\"https://io.net\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/ionet-cca8037f/b19dlbPlCUid06dF/logo/light.svg?fit=max\u0026auto=format\u0026n=b19dlbPlCUid06dF\u0026q=85\u0026s=debc44eff771f4f2f76b8b8a86faf828\"}},{\"@type\":\"WebSite\",\"@id\":\"https://io.net/docs#website\",\"name\":\"io.net\",\"url\":\"https://io.net/docs\",\"publisher\":{\"@id\":\"https://io.net/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://io.net/docs/reference/ai-agents/getting-started-with-api-agents#webpage\",\"url\":\"https://io.net/docs/reference/ai-agents/getting-started-with-api-agents\",\"name\":\"Getting Started with AI Agents API\",\"dateModified\":\"2026-11-05T10:15:35.038Z\",\"isPartOf\":{\"@id\":\"https://io.net/docs#website\"},\"breadcrumb\":{\"@id\":\"https://io.net/docs/reference/ai-agents/getting-started-with-api-agents#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://io.net/docs/reference/ai-agents/getting-started-with-api-agents#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"IO Intelligence\",\"item\":\"https://io.net/docs/reference/ai-models/get-started-with-io-intelligence-api\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Getting Started with AI Agents API\",\"item\":\"https://io.net/docs/reference/ai-agents/getting-started-with-api-agents\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://io.net/docs/reference/ai-agents/getting-started-with-api-agents#article\",\"headline\":\"Getting Started with AI Agents API\",\"name\":\"Getting Started with AI Agents API\",\"url\":\"https://io.net/docs/reference/ai-agents/getting-started-with-api-agents\",\"mainEntityOfPage\":{\"@id\":\"https://io.net/docs/reference/ai-agents/getting-started-with-api-agents#webpage\"},\"dateModified\":\"2026-11-05T10:15:35.038Z\",\"publisher\":{\"@id\":\"https://io.net/#organization\"},\"isPartOf\":{\"@id\":\"https://io.net/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"io.net\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"io.net\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/docs/reference/ai-agents/getting-started-with-api-agents.md","siteName":"io.net","nav":{"global":null,"tabs":[{"tab":"Core Concepts","pages":[{"title":"Core Concepts","href":"/guides/inception"}]},{"tab":"Cloud","pages":[{"title":"Cloud","href":"/guides/clouds/io-cloud"}]},{"tab":"Intelligence","pages":[{"title":"Intelligence","href":"/guides/intelligence/unified-chat"}]},{"tab":"Community","pages":[{"title":"Community","href":"/guides/workers/io-worker"}]},{"tab":"API References","groups":[{"group":"IO Explorer","pages":[{"group":"Getting Started With IO Explorer API","pages":[{"title":"Getting Started with IO Explorer API","sidebarTitle":"Overview","href":"/reference/io-explorer/getting-started-with-your-api"},{"title":"Device Object Reference","href":"/reference/io-explorer/objects"},{"openapi":"openapi/io-explorer/get-device-details.json GET /v1/io-explorer/devices/{device_id}/details","title":"Device Details","href":"/reference/io-explorer/get-device-details"},{"openapi":"openapi/io-explorer/device-summary.json GET /v1/io-explorer/devices/{device_id}/summary","title":"Device Summary","href":"/reference/io-explorer/device-summary"},{"openapi":"openapi/io-explorer/pow-summary.json GET /v1/io-explorer/devices/{device_id}/pow-summary","title":"PoW Summary","href":"/reference/io-explorer/pow-summary"}]}]},{"group":"IO Intelligence","pages":[{"group":"Getting Started with AI Models API","pages":[{"sidebarTitle":"Overview","title":"Getting Started with AI Models API","href":"/reference/ai-models/get-started-with-io-intelligence-api"},{"title":"Uploading Images","href":"/reference/ai-models/uploading-images"},{"openapi":"openapi/ai-models/get-models-list.json GET /api/v1/models","title":"Models List","sidebarTitle":"Models List","href":"/reference/ai-models/get-models-list"},{"openapi":"openapi/ai-models/create-chat-completion.json POST /api/v1/chat/completions","title":"Create Chat Completion","sidebarTitle":"Chat Completion","href":"/reference/ai-models/create-chat-completion"},{"openapi":"openapi/ai-models/create-response.json POST /api/v1/responses","title":"Create Response","sidebarTitle":"Responses","href":"/reference/ai-models/create-response"}]},{"group":"Sub-API Keys","pages":[{"openapi":"openapi/sub-keys/create-sub-key.json POST /v1/api-keys/sub-keys","title":"Create Sub-API Key","sidebarTitle":"Create Sub-Key","href":"/reference/sub-keys/create-sub-key"},{"openapi":"openapi/sub-keys/list-sub-keys.json GET /v1/api-keys/sub-keys","title":"List Sub-API Keys","sidebarTitle":"List Sub-Keys","href":"/reference/sub-keys/list-sub-keys"},{"openapi":"openapi/sub-keys/update-sub-key.json PATCH /v1/api-keys/sub-keys/{key_id}","title":"Update Sub-API Key","sidebarTitle":"Update Sub-Key","href":"/reference/sub-keys/update-sub-key"},{"openapi":"openapi/sub-keys/revoke-sub-key.json DELETE /v1/api-keys/sub-keys/{key_id}","title":"Revoke Sub-API Key","sidebarTitle":"Revoke Sub-Key","href":"/reference/sub-keys/revoke-sub-key"},{"openapi":"openapi/sub-keys/get-all-keys-usage.json GET /v1/api-keys/sub-keys/usage","title":"Get All Sub-Keys Usage","sidebarTitle":"All Keys Usage","href":"/reference/sub-keys/get-all-keys-usage"},{"openapi":"openapi/sub-keys/get-key-usage.json GET /v1/api-keys/sub-keys/{key_id}/usage","title":"Get Sub-Key Usage","sidebarTitle":"Single Key Usage","href":"/reference/sub-keys/get-key-usage"},{"openapi":"openapi/sub-keys/get-own-usage.json GET /v1/api-keys/sub-keys/me/usage","title":"Get Own Usage (Sub-Key Self-Service)","description":"Allows a sub-key to check its own credit status without exposing the admin key to the sub-key holder.","sidebarTitle":"Self Usage Check","href":"/reference/sub-keys/get-own-usage"}]},{"group":"Getting Started with AI Agents API","pages":[{"sidebarTitle":"Overview","title":"Getting Started with AI Agents API","href":"/reference/ai-agents/getting-started-with-api-agents"},{"openapi":"openapi/ai-agents/get-agents-list.json GET /api/v1/agents","title":"Agents List","description":"Get a list of all the available agents.","href":"/reference/ai-agents/get-agents-list"},{"openapi":"openapi/ai-agents/workflows-schema.json GET /api/v1/workflows/schema","title":"Workflows Schema","href":"/reference/ai-agents/workflows-schema"},{"openapi":"openapi/ai-agents/workflows-run.json POST /api/v1/workflows/run","title":"Workflows Run","href":"/reference/ai-agents/workflows-run"},{"group":"Secret Management","hidden":false,"pages":[{"openapi":"openapi/ai-agents/secret-management-list.json GET /v1/secrets/","title":"Secrets List","href":"/reference/ai-agents/secret-management-list"},{"openapi":"openapi/ai-agents/secret-management-get.json GET /v1/secrets/{secret_id}","title":"Get Secret Details","href":"/reference/ai-agents/secret-management-get"},{"openapi":"openapi/ai-agents/secret-management-post.json POST /v1/secrets/","title":"Create a Secret","href":"/reference/ai-agents/secret-management-post"},{"openapi":"openapi/ai-agents/secret-management-patch.json PATCH /v1/secrets/{secret_id}","title":"Update Secret Details","href":"/reference/ai-agents/secret-management-patch"},{"openapi":"openapi/ai-agents/secret-management-delete.json DELETE /v1/secrets/{secret_id}","title":"Delete a Secret","href":"/reference/ai-agents/secret-management-delete"}]}]}]},{"group":"IO Cloud","pages":[{"group":"Getting Started With CaaS API","pages":[{"sidebarTitle":"Overview","title":"Getting Started with CaaS API","href":"/reference/caas/get-started-with-caas-api"},{"openapi":"openapi/caas/get-all-deployments.json GET /enterprise/v1/io-cloud/caas/deployments","title":"Get All Deployments","href":"/reference/caas/get-all-deployments"},{"openapi":"openapi/caas/get-deployment-details.json GET /enterprise/v1/io-cloud/caas/deployment/{deployment_id}","title":"Get Deployment Details","href":"/reference/caas/get-deployment-details"},{"openapi":"openapi/caas/deploy-a-container.json POST /enterprise/v1/io-cloud/caas/deploy","title":"Deploy a Container","href":"/reference/caas/deploy-a-container"},{"openapi":"openapi/caas/list-deployment-containers.json GET /enterprise/v1/io-cloud/caas/deployment/{deployment_id}/containers","title":"List Deployment Containers","href":"/reference/caas/list-deployment-containers"},{"openapi":"openapi/caas/get-hardware-list.json GET /enterprise/v1/io-cloud/caas/hardware","title":"Get Hardware List","href":"/reference/caas/get-hardware-list"},{"openapi":"openapi/caas/get-node-pools.json GET /enterprise/v1/io-cloud/caas/node-pools","title":"Get Private Node Pools","href":"/reference/caas/get-node-pools"},{"openapi":"openapi/caas/price-estimation.json GET /enterprise/v1/io-cloud/caas/price","title":"Deployment Price Check","href":"/reference/caas/price-estimation"},{"openapi":"openapi/caas/container-job-details.json GET /enterprise/v1/io-cloud/caas/deployment/{deployment_id}/containers-jobs/{container_id}","title":"Container Job Details","href":"/reference/caas/container-job-details"},{"openapi":"openapi/caas/container-logs.json GET /enterprise/v1/io-cloud/caas/deployment/{deployment_id}/log/{container_id}","title":"Container Logs","href":"/reference/caas/container-logs"},{"openapi":"openapi/caas/update-deployment-configuration.json PATCH /enterprise/v1/io-cloud/caas/deployment/{deployment_id}","title":"Update Deployment Configuration","href":"/reference/caas/update-deployment-configuration"},{"openapi":"openapi/caas/extend-deployment-duration.json POST /enterprise/v1/io-cloud/caas/deployment/{deployment_id}/extend","title":"Extend Deployment Duration","href":"/reference/caas/extend-deployment-duration"},{"openapi":"openapi/caas/destroy-container.json DELETE /enterprise/v1/io-cloud/caas/deployment/{deployment_id}","title":"Destroy Container","href":"/reference/caas/destroy-container"}]},{"group":"Getting Started With VMaaS API","pages":[{"title":"Getting Started with VMaaS API","sidebarTitle":"Overview","href":"/reference/vmaas/get-started-with-vmaas-api"},{"title":"Cluster Deployment using APIs","href":"/reference/vmaas/example-deploying-using-APIs"},{"openapi":"openapi/vmaas/get-hardware-list.json GET /enterprise/v1/io-cloud/vmaas/hardware","title":"Get Hardware List","sidebarTitle":"Hardware List","href":"/reference/vmaas/get-hardware-list"},{"openapi":"openapi/vmaas/get-all-deployments.json GET /enterprise/v1/io-cloud/vmaas/deployments","title":"Get All Deployments","sidebarTitle":"Deployments List","href":"/reference/vmaas/get-all-deployments"},{"openapi":"openapi/vmaas/get-deployment-details.json GET /enterprise/v1/io-cloud/vmaas/deployment/{deployment_id}","title":"Get Deployment Details","sidebarTitle":"Deployment Details","href":"/reference/vmaas/get-deployment-details"},{"openapi":"openapi/vmaas/get-deployment-vms.json GET /enterprise/v1/io-cloud/vmaas/deployment/{deployment_id}/vms","title":"Get Deployment VMs","sidebarTitle":"Deployment VMs","href":"/reference/vmaas/get-deployment-vms"},{"openapi":"openapi/vmaas/get-vms-jobs-history.json GET /enterprise/v1/io-cloud/vmaas/deployment/{deployment_id}/vms-jobs/{container_id}","title":"Get a VM's Jobs History","sidebarTitle":"VM Jobs History","href":"/reference/vmaas/get-vms-jobs-history"},{"openapi":"openapi/vmaas/get-deployment-price.json GET /enterprise/v1/io-cloud/vmaas/price","title":"Get Deployment Price","sidebarTitle":"Deployment Price","href":"/reference/vmaas/get-deployment-price"},{"openapi":"openapi/vmaas/deploy-vms.json POST /enterprise/v1/io-cloud/vmaas/deploy","title":"Deploy a VM","href":"/reference/vmaas/deploy-vms"},{"openapi":"openapi/vmaas/extend-cluster.json POST /enterprise/v1/io-cloud/vmaas/deployment/{deployment_id}/extend","title":"Extend Cluster","href":"/reference/vmaas/extend-cluster"},{"openapi":"openapi/vmaas/destroy-deployment.json DELETE /enterprise/v1/io-cloud/vmaas/deployment/{deployment_id}","title":"Destroy Deployment","href":"/reference/vmaas/destroy-deployment"}]},{"group":"Billing","pages":[{"openapi":"openapi/io-cloud/get-burn-rate.json GET /enterprise/v1/io-cloud/users/burn-rate","title":"Get Burn Rate","href":"/reference/io-cloud/get-burn-rate"}]}]}]}]},"basePath":"","title":"Getting Started with AI Agents API - io.net","buildId":"dpl_2AK98Hxhwu4fUXpx9atbv41cC328","deploymentId":"dpl_2AK98Hxhwu4fUXpx9atbv41cC328","dynamics":["07c022d89b","a74be98ba7"],"chunks":["Frame-Buk2KjK6.js","DynamicMarkdown-DYYZTGpa.js","zoom-image-lightbox-T84NdC3b.js","lightbox-handle-r17bVUz3.js"]}