Returns everything needed to work with the agent through the other endpoints: its channel and direction, its prompt and welcome messages, the variables it expects (fields, to pass as dataBag or variables), the classification tags and extracted values found in results, and what is connected to it (tools, sub-agents, knowledge base chat). The agent must belong to the same company as the API key used for authentication.
GET
/
Agent
/
{agentId}
Get an agent
curl --request GET \ --url https://api.starleads.co/Agent/{agentId} \ --header 'X-Api-Key: <api-key>'
An agent: its identity and channel, its prompt, the variables it expects, how it classifies conversations, and what is connected to it (tools, sub-agents, knowledge base chat)
Channel the agent talks on: Phone, SMS, Web or WhatsApp. Phone and WhatsApp campaigns need a phone number; Web agents are reached through the web widget.
First sentence the agent says when it initiates the conversation (outbound campaign items, callbacks). Placeholders such as {firstName} are replaced by the field values.
First sentence the agent says when a contact reaches it (inbound call, message or web widget). Placeholders such as {firstName} are replaced by the field values.
Variables the prompt expects. Pass their values as dataBag when creating or updating a campaign item or starting a simulation chat, and as variables of a simulation test. System fields are filled by the platform.
Tags the agent can assign to a conversation once it ends. A classification test expects one of these names in tagExpected, and campaign item results carry the assigned tag.
Identifier of the knowledge base chat connected to the agent, if any (see GET /Agent/{agentId}/chat)
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Starleads api docs","colors":{"primary":"#FF5B22","light":"#fe8c74","dark":"#FF5B22"},"favicon":"https://mintcdn.com/locuta/tZlUd6iyAfQwa0YL/logo/favicon.svg?fit=max\u0026auto=format\u0026n=tZlUd6iyAfQwa0YL\u0026q=85\u0026s=967e53c47421a4ed3c5adccac9a32e37","logo":{"light":"https://mintcdn.com/locuta/nbODknSPetkh4479/logo/logo-light.png?fit=max\u0026auto=format\u0026n=nbODknSPetkh4479\u0026q=85\u0026s=0c3dc57cc8eb4727a18bea5b413cfc61","dark":"https://mintcdn.com/locuta/nbODknSPetkh4479/logo/logo-dark.png?fit=max\u0026auto=format\u0026n=nbODknSPetkh4479\u0026q=85\u0026s=b9a5ae7998f0db400ea8722f90609ed5"},"api":{"openapi":"api-reference/openapi.json","mdx":{"server":"https://api.starleads.co","auth":{"method":"key","name":"X-Api-Key"}}},"navbar":{"primary":{"type":"button","label":"Log in","href":"https://app.starleads.co"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/starleads-co","website":"https://starleads.co"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"locuta","hasAudioNarration":false,"actualSubdomain":"locuta","customDomains":["docs.starleads.co"],"gitSource":{"type":"github","owner":"locuta","repo":"starleads-public-gateway","deployBranch":"mintifly","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ab11ae5ebb61b9bf7312a43","collectionId":"4cf50806-03bb-46b2-9027-a2d8bbba048f","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ab11ae5ebb61b9bf7312a43"},"entitlements":{},"buildId":"6ab11ae5ebb61b9bf7312a43","clientVersion":"0.0.3990","searchFilterCounts":[{"language":"default","tag":"API Reference","count":71},{"language":"default","tag":"Agents","count":10},{"language":"default","tag":"Agent Tests","count":8},{"language":"default","tag":"Documentation","count":8},{"language":"default","tag":"Campaign Items","count":7},{"language":"default","tag":"Knowledge Base — Documents","count":7},{"language":"default","tag":"Agent Test Folders","count":5},{"language":"default","tag":"Knowledge Base — Datasets","count":5},{"language":"default","tag":"Knowledge Base — Chats","count":5},{"language":"default","tag":"Knowledge Base — Knowledge Graph","count":5}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/agent/get-an-agent","slug":"/api-reference/agent/get-an-agent","pageMetadata":{"title":"Get an agent","openapi":"GET /Agent/{agentId}","description":"Returns everything needed to work with the agent through the other endpoints: its channel and direction, its prompt and welcome messages, the variables it expects (`fields`, to pass as `dataBag` or `variables`), the classification tags and extracted values found in results, and what is connected to it (tools, sub-agents, knowledge base chat). The agent must belong to the same company as the API key used for authentication.","href":"/api-reference/agent/get-an-agent"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Returns everything needed to work with the agent through the other endpoints: its channel and direction, its prompt and welcome messages, the variables it expects (\", _jsx(_components.code, {\n children: \"fields\"\n }), \", to pass as \", _jsx(_components.code, {\n children: \"dataBag\"\n }), \" or \", _jsx(_components.code, {\n children: \"variables\"\n }), \"), the classification tags and extracted values found in results, and what is connected to it (tools, sub-agents, knowledge base chat). The agent must belong to the same company as the API key used for authentication.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get an agent","openapi":"GET /Agent/{agentId}","description":"Returns everything needed to work with the agent through the other endpoints: its channel and direction, its prompt and welcome messages, the variables it expects (`fields`, to pass as `dataBag` or `variables`), the classification tags and extracted values found in results, and what is connected to it (tools, sub-agents, knowledge base chat). The agent must belong to the same company as the API key used for authentication.","href":"/api-reference/agent/get-an-agent"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Agent"],"summary":"Get an agent","description":"Returns everything needed to work with the agent through the other endpoints: its channel and direction, its prompt and welcome messages, the variables it expects (`fields`, to pass as `dataBag` or `variables`), the classification tags and extracted values found in results, and what is connected to it (tools, sub-agents, knowledge base chat). The agent must belong to the same company as the API key used for authentication.","operationId":"GetAgent","parameters":["20efe464-4fe5-4516-a0e3-4bded6199e4f","9ab0d7d3-d4fd-47da-9f6a-fa53632888a2"],"responses":{"200":"9ac02786-e136-49dd-aacd-42c4972d5bfd","401":"9a49132e-f86a-45cd-aa21-0da9a4d4289e","404":"15ca38ee-bb4d-4759-8762-b7bf6368d0b8"},"method":"get","type":"path","servers":[],"security":[],"path":"/Agent/{agentId}","baseUrlOptions":["https://api.starleads.co"],"title":"Get an agent","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"20efe464-4fe5-4516-a0e3-4bded6199e4f":{"name":"X-Api-Key","in":"header","description":"Api key to pass as a ```X-Api-Key``` request header.","required":true,"schema":{"type":"string","isRequired":true,"description":"Api key to pass as a ```X-Api-Key``` request header.","uniqueKey":"","typeLabel":"string"}},"9ab0d7d3-d4fd-47da-9f6a-fa53632888a2":{"name":"agentId","in":"path","description":"ID of the agent.","required":true,"schema":{"type":"string","isRequired":true,"description":"ID of the agent.","uniqueKey":"","typeLabel":"string"}}},"responses":{"9ac02786-e136-49dd-aacd-42c4972d5bfd":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"agentId":{"oneOf":[{"type":"string","description":"Agent identifier","uniqueKey":"agentId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Agent identifier","uniqueKey":"agentId.oneOf.1","typeLabel":"null"}],"uniqueKey":"agentId","typeLabel":"string | null"},"agentName":{"oneOf":[{"type":"string","description":"Agent name","uniqueKey":"agentName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Agent name","uniqueKey":"agentName.oneOf.1","typeLabel":"null"}],"uniqueKey":"agentName","typeLabel":"string | null"},"channel":{"oneOf":[{"type":"string","description":"Channel the agent talks on: `Phone`, `SMS`, `Web` or `WhatsApp`. Phone and WhatsApp campaigns need a phone number; Web agents are reached through the web widget.","uniqueKey":"channel.oneOf.0","typeLabel":"string"},{"type":"null","description":"Channel the agent talks on: `Phone`, `SMS`, `Web` or `WhatsApp`. Phone and WhatsApp campaigns need a phone number; Web agents are reached through the web widget.","uniqueKey":"channel.oneOf.1","typeLabel":"null"}],"uniqueKey":"channel","typeLabel":"string | null"},"direction":{"oneOf":[{"type":"string","description":"`Inbound`: the agent answers contacts who reach it. `Outbound`: the agent initiates, its campaign items are dialed or messaged.","uniqueKey":"direction.oneOf.0","typeLabel":"string"},{"type":"null","description":"`Inbound`: the agent answers contacts who reach it. `Outbound`: the agent initiates, its campaign items are dialed or messaged.","uniqueKey":"direction.oneOf.1","typeLabel":"null"}],"uniqueKey":"direction","typeLabel":"string | null"},"language":{"oneOf":[{"type":"string","description":"Language of the agent, as an ISO code such as `fr` or `en`","uniqueKey":"language.oneOf.0","typeLabel":"string"},{"type":"null","description":"Language of the agent, as an ISO code such as `fr` or `en`","uniqueKey":"language.oneOf.1","typeLabel":"null"}],"uniqueKey":"language","typeLabel":"string | null"},"tags":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"tags.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Tags set on the agent in the interface, for organisation only. Not related to classification tags.","uniqueKey":"tags.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Tags set on the agent in the interface, for organisation only. Not related to classification tags.","uniqueKey":"tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"tags","typeLabel":"string[] | null"},"createdAt":{"type":"string","description":"Creation date (UTC)","format":"date-time","uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"prompt":{"oneOf":[{"type":"string","description":"Prompt of the agent","uniqueKey":"prompt.oneOf.0","typeLabel":"string"},{"type":"null","description":"Prompt of the agent","uniqueKey":"prompt.oneOf.1","typeLabel":"null"}],"uniqueKey":"prompt","typeLabel":"string | null"},"outboundWelcomeMessage":{"oneOf":[{"type":"string","description":"First sentence the agent says when it initiates the conversation (outbound campaign items, callbacks). Placeholders such as `{firstName}` are replaced by the field values.","uniqueKey":"outboundWelcomeMessage.oneOf.0","typeLabel":"string"},{"type":"null","description":"First sentence the agent says when it initiates the conversation (outbound campaign items, callbacks). Placeholders such as `{firstName}` are replaced by the field values.","uniqueKey":"outboundWelcomeMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"outboundWelcomeMessage","typeLabel":"string | null"},"inboundWelcomeMessage":{"oneOf":[{"type":"string","description":"First sentence the agent says when a contact reaches it (inbound call, message or web widget). Placeholders such as `{firstName}` are replaced by the field values.","uniqueKey":"inboundWelcomeMessage.oneOf.0","typeLabel":"string"},{"type":"null","description":"First sentence the agent says when a contact reaches it (inbound call, message or web widget). Placeholders such as `{firstName}` are replaced by the field values.","uniqueKey":"inboundWelcomeMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"inboundWelcomeMessage","typeLabel":"string | null"},"fields":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"name":{"oneOf":[{"type":"string","description":"Name of the variable, the key to use in `dataBag` and `variables`","uniqueKey":"fields.oneOf.0.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Name of the variable, the key to use in `dataBag` and `variables`","uniqueKey":"fields.oneOf.0.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"fields.oneOf.0.items.[INDEX].name","typeLabel":"string | null"},"isMandatory":{"type":"boolean","description":"Whether a value is required for the agent to run","uniqueKey":"fields.oneOf.0.items.[INDEX].isMandatory","typeLabel":"boolean"},"isSystem":{"type":"boolean","description":"Filled by the platform (for example the phone number); no value needs to be passed","uniqueKey":"fields.oneOf.0.items.[INDEX].isSystem","typeLabel":"boolean"}},"additionalProperties":false,"description":"A variable expected by the agent's prompt","uniqueKey":"fields.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Variables the prompt expects. Pass their values as `dataBag` when creating or updating a campaign item or starting a simulation chat, and as `variables` of a simulation test. System fields are filled by the platform.","uniqueKey":"fields.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"name":{"oneOf":[{"type":"string","description":"Name of the variable, the key to use in `dataBag` and `variables`"},{"type":"null","description":"Name of the variable, the key to use in `dataBag` and `variables`"}]},"isMandatory":{"type":"boolean","description":"Whether a value is required for the agent to run"},"isSystem":{"type":"boolean","description":"Filled by the platform (for example the phone number); no value needs to be passed"}},"additionalProperties":false,"description":"A variable expected by the agent's prompt"},"description":"Variables the prompt expects. Pass their values as `dataBag` when creating or updating a campaign item or starting a simulation chat, and as `variables` of a simulation test. System fields are filled by the platform.","uniqueKey":"fields.oneOf.1","typeLabel":"null"}],"uniqueKey":"fields","typeLabel":"object[] | null"},"classificationTags":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"name":{"oneOf":[{"type":"string","description":"Tag name, as found in campaign item results and expected by classification tests","uniqueKey":"classificationTags.oneOf.0.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Tag name, as found in campaign item results and expected by classification tests","uniqueKey":"classificationTags.oneOf.0.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"classificationTags.oneOf.0.items.[INDEX].name","typeLabel":"string | null"},"definition":{"oneOf":[{"type":"string","description":"When the agent assigns this tag","uniqueKey":"classificationTags.oneOf.0.items.[INDEX].definition.oneOf.0","typeLabel":"string"},{"type":"null","description":"When the agent assigns this tag","uniqueKey":"classificationTags.oneOf.0.items.[INDEX].definition.oneOf.1","typeLabel":"null"}],"uniqueKey":"classificationTags.oneOf.0.items.[INDEX].definition","typeLabel":"string | null"},"isSystem":{"type":"boolean","description":"Provided by the platform (for example voicemail or no answer) rather than defined for this agent","uniqueKey":"classificationTags.oneOf.0.items.[INDEX].isSystem","typeLabel":"boolean"}},"additionalProperties":false,"description":"A tag the agent can assign to a conversation once it ends","uniqueKey":"classificationTags.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Tags the agent can assign to a conversation once it ends. A classification test expects one of these names in `tagExpected`, and campaign item results carry the assigned tag.","uniqueKey":"classificationTags.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"name":{"oneOf":[{"type":"string","description":"Tag name, as found in campaign item results and expected by classification tests"},{"type":"null","description":"Tag name, as found in campaign item results and expected by classification tests"}]},"definition":{"oneOf":[{"type":"string","description":"When the agent assigns this tag"},{"type":"null","description":"When the agent assigns this tag"}]},"isSystem":{"type":"boolean","description":"Provided by the platform (for example voicemail or no answer) rather than defined for this agent"}},"additionalProperties":false,"description":"A tag the agent can assign to a conversation once it ends"},"description":"Tags the agent can assign to a conversation once it ends. A classification test expects one of these names in `tagExpected`, and campaign item results carry the assigned tag.","uniqueKey":"classificationTags.oneOf.1","typeLabel":"null"}],"uniqueKey":"classificationTags","typeLabel":"object[] | null"},"extractedValues":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"name":{"oneOf":[{"type":"string","description":"Name of the value, as found in campaign item results","uniqueKey":"extractedValues.oneOf.0.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Name of the value, as found in campaign item results","uniqueKey":"extractedValues.oneOf.0.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"extractedValues.oneOf.0.items.[INDEX].name","typeLabel":"string | null"},"definition":{"oneOf":[{"type":"string","description":"What the agent extracts","uniqueKey":"extractedValues.oneOf.0.items.[INDEX].definition.oneOf.0","typeLabel":"string"},{"type":"null","description":"What the agent extracts","uniqueKey":"extractedValues.oneOf.0.items.[INDEX].definition.oneOf.1","typeLabel":"null"}],"uniqueKey":"extractedValues.oneOf.0.items.[INDEX].definition","typeLabel":"string | null"},"type":{"oneOf":[{"type":"string","description":"Kind of value: `Text` (free text) or `Nom` (a person name)","uniqueKey":"extractedValues.oneOf.0.items.[INDEX].type.oneOf.0","typeLabel":"string"},{"type":"null","description":"Kind of value: `Text` (free text) or `Nom` (a person name)","uniqueKey":"extractedValues.oneOf.0.items.[INDEX].type.oneOf.1","typeLabel":"null"}],"uniqueKey":"extractedValues.oneOf.0.items.[INDEX].type","typeLabel":"string | null"}},"additionalProperties":false,"description":"A value the agent extracts from a conversation once it ends","uniqueKey":"extractedValues.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Values the agent extracts from a conversation once it ends, returned with the campaign item results","uniqueKey":"extractedValues.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"name":{"oneOf":[{"type":"string","description":"Name of the value, as found in campaign item results"},{"type":"null","description":"Name of the value, as found in campaign item results"}]},"definition":{"oneOf":[{"type":"string","description":"What the agent extracts"},{"type":"null","description":"What the agent extracts"}]},"type":{"oneOf":[{"type":"string","description":"Kind of value: `Text` (free text) or `Nom` (a person name)"},{"type":"null","description":"Kind of value: `Text` (free text) or `Nom` (a person name)"}]}},"additionalProperties":false,"description":"A value the agent extracts from a conversation once it ends"},"description":"Values the agent extracts from a conversation once it ends, returned with the campaign item results","uniqueKey":"extractedValues.oneOf.1","typeLabel":"null"}],"uniqueKey":"extractedValues","typeLabel":"object[] | null"},"isCallTransferEnabled":{"type":"boolean","description":"Whether the agent may transfer the call to a human. When true, `mockCallTransfer` is relevant in simulation tests.","uniqueKey":"isCallTransferEnabled","typeLabel":"boolean"},"tools":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","description":"Tool identifier","uniqueKey":"tools.oneOf.0.items.[INDEX].id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Tool identifier","uniqueKey":"tools.oneOf.0.items.[INDEX].id.oneOf.1","typeLabel":"null"}],"uniqueKey":"tools.oneOf.0.items.[INDEX].id","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","description":"Human-readable tool name","uniqueKey":"tools.oneOf.0.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Human-readable tool name","uniqueKey":"tools.oneOf.0.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"tools.oneOf.0.items.[INDEX].name","typeLabel":"string | null"},"technicalName":{"oneOf":[{"type":"string","description":"Technical name (snake_case) used by the LLM to call the tool","uniqueKey":"tools.oneOf.0.items.[INDEX].technicalName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Technical name (snake_case) used by the LLM to call the tool","uniqueKey":"tools.oneOf.0.items.[INDEX].technicalName.oneOf.1","typeLabel":"null"}],"uniqueKey":"tools.oneOf.0.items.[INDEX].technicalName","typeLabel":"string | null"}},"additionalProperties":false,"description":"A tool connected to an agent","uniqueKey":"tools.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Tools connected to the agent","uniqueKey":"tools.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","description":"Tool identifier"},{"type":"null","description":"Tool identifier"}]},"name":{"oneOf":[{"type":"string","description":"Human-readable tool name"},{"type":"null","description":"Human-readable tool name"}]},"technicalName":{"oneOf":[{"type":"string","description":"Technical name (snake_case) used by the LLM to call the tool"},{"type":"null","description":"Technical name (snake_case) used by the LLM to call the tool"}]}},"additionalProperties":false,"description":"A tool connected to an agent"},"description":"Tools connected to the agent","uniqueKey":"tools.oneOf.1","typeLabel":"null"}],"uniqueKey":"tools","typeLabel":"object[] | null"},"subAgents":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","description":"Sub-agent identifier","uniqueKey":"subAgents.oneOf.0.items.[INDEX].id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Sub-agent identifier","uniqueKey":"subAgents.oneOf.0.items.[INDEX].id.oneOf.1","typeLabel":"null"}],"uniqueKey":"subAgents.oneOf.0.items.[INDEX].id","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","description":"Human-readable sub-agent name","uniqueKey":"subAgents.oneOf.0.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Human-readable sub-agent name","uniqueKey":"subAgents.oneOf.0.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"subAgents.oneOf.0.items.[INDEX].name","typeLabel":"string | null"},"technicalName":{"oneOf":[{"type":"string","description":"Technical name used by the agent to delegate to it","uniqueKey":"subAgents.oneOf.0.items.[INDEX].technicalName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Technical name used by the agent to delegate to it","uniqueKey":"subAgents.oneOf.0.items.[INDEX].technicalName.oneOf.1","typeLabel":"null"}],"uniqueKey":"subAgents.oneOf.0.items.[INDEX].technicalName","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","description":"What the sub-agent does","uniqueKey":"subAgents.oneOf.0.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","description":"What the sub-agent does","uniqueKey":"subAgents.oneOf.0.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"subAgents.oneOf.0.items.[INDEX].description","typeLabel":"string | null"}},"additionalProperties":false,"description":"A sub-agent an agent can delegate to","uniqueKey":"subAgents.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Sub-agents the agent can delegate to. Their ids are the ones accepted by `mockedSubAgents` in simulation tests.","uniqueKey":"subAgents.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","description":"Sub-agent identifier"},{"type":"null","description":"Sub-agent identifier"}]},"name":{"oneOf":[{"type":"string","description":"Human-readable sub-agent name"},{"type":"null","description":"Human-readable sub-agent name"}]},"technicalName":{"oneOf":[{"type":"string","description":"Technical name used by the agent to delegate to it"},{"type":"null","description":"Technical name used by the agent to delegate to it"}]},"description":{"oneOf":[{"type":"string","description":"What the sub-agent does"},{"type":"null","description":"What the sub-agent does"}]}},"additionalProperties":false,"description":"A sub-agent an agent can delegate to"},"description":"Sub-agents the agent can delegate to. Their ids are the ones accepted by `mockedSubAgents` in simulation tests.","uniqueKey":"subAgents.oneOf.1","typeLabel":"null"}],"uniqueKey":"subAgents","typeLabel":"object[] | null"},"knowledgeBaseChatId":{"oneOf":[{"type":"string","description":"Identifier of the knowledge base chat connected to the agent, if any (see `GET /Agent/{agentId}/chat`)","uniqueKey":"knowledgeBaseChatId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Identifier of the knowledge base chat connected to the agent, if any (see `GET /Agent/{agentId}/chat`)","uniqueKey":"knowledgeBaseChatId.oneOf.1","typeLabel":"null"}],"uniqueKey":"knowledgeBaseChatId","typeLabel":"string | null"}},"additionalProperties":false,"description":"An agent: its identity and channel, its prompt, the variables it expects, how it classifies conversations, and what is connected to it (tools, sub-agents, knowledge base chat)","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"agentId":"\u003cstring>","agentName":"\u003cstring>","channel":"\u003cstring>","direction":"\u003cstring>","language":"\u003cstring>","tags":["\u003cstring>"],"createdAt":"2023-11-07T05:31:56Z","prompt":"\u003cstring>","outboundWelcomeMessage":"\u003cstring>","inboundWelcomeMessage":"\u003cstring>","fields":[{"name":"\u003cstring>","isMandatory":true,"isSystem":true}],"classificationTags":[{"name":"\u003cstring>","definition":"\u003cstring>","isSystem":true}],"extractedValues":[{"name":"\u003cstring>","definition":"\u003cstring>","type":"\u003cstring>"}],"isCallTransferEnabled":true,"tools":[{"id":"\u003cstring>","name":"\u003cstring>","technicalName":"\u003cstring>"}],"subAgents":[{"id":"\u003cstring>","name":"\u003cstring>","technicalName":"\u003cstring>","description":"\u003cstring>"}],"knowledgeBaseChatId":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"9a49132e-f86a-45cd-aa21-0da9a4d4289e":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","uniqueKey":"type.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"type.oneOf.1","typeLabel":"null"}],"uniqueKey":"type","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","uniqueKey":"title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"title.oneOf.1","typeLabel":"null"}],"uniqueKey":"title","typeLabel":"string | null"},"status":{"oneOf":[{"type":"integer","format":"int32","uniqueKey":"status.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","uniqueKey":"status.oneOf.1","typeLabel":"null"}],"uniqueKey":"status","typeLabel":"integer\u003cint32> | null"},"detail":{"oneOf":[{"type":"string","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"}},"additionalProperties":{"oneOf":[{}],"uniqueKey":"additionalProperties","typeLabel":"any"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"15ca38ee-bb4d-4759-8762-b7bf6368d0b8":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","uniqueKey":"type.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"type.oneOf.1","typeLabel":"null"}],"uniqueKey":"type","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","uniqueKey":"title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"title.oneOf.1","typeLabel":"null"}],"uniqueKey":"title","typeLabel":"string | null"},"status":{"oneOf":[{"type":"integer","format":"int32","uniqueKey":"status.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","uniqueKey":"status.oneOf.1","typeLabel":"null"}],"uniqueKey":"status","typeLabel":"integer\u003cint32> | null"},"detail":{"oneOf":[{"type":"string","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"}},"additionalProperties":{"oneOf":[{}],"uniqueKey":"additionalProperties","typeLabel":"any"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"5d4f5bf2-e3a9-4b92-b974-2cc177844a16":{"Key":{"name":"X-Api-Key","type":"apiKey","in":"header"}}},"servers":{},"processedSecurityOptions":[{"schemes":[{"scheme":{"name":"X-Api-Key","type":"apiKey","in":"header"},"schema":{"title":"X-Api-Key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"Key","name":"X-Api-Key"}],"title":"Key"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"locuta","siteName":"Starleads api docs","title":"Get an agent - Starleads api docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-21T11:54:21.133Z","originalFileLocation":"api-reference/agent/get-an-agent.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns everything needed to work with the agent through the other endpoints: its channel and direction, its prompt and welcome messages, the variables it expects (fields, to pass as dataBag or variables), the classification tags and extracted values found in results, and what is connected to it (tools, sub-agents, knowledge base chat). The agent must belong to the same company as the API key used for authentication.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Starleads api docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/locuta/ynlCpXqW2nrSkjmQ/_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/locuta/ynlCpXqW2nrSkjmQ/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/locuta/ynlCpXqW2nrSkjmQ/_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/locuta/ynlCpXqW2nrSkjmQ/_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/locuta/ynlCpXqW2nrSkjmQ/_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/locuta/ynlCpXqW2nrSkjmQ/_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/locuta/ynlCpXqW2nrSkjmQ/_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/locuta/ynlCpXqW2nrSkjmQ/_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/locuta/ynlCpXqW2nrSkjmQ/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get an agent - Starleads api docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns everything needed to work with the agent through the other endpoints: its channel and direction, its prompt and welcome messages, the variables it expects (fields, to pass as dataBag or variables), the classification tags and extracted values found in results, and what is connected to it (tools, sub-agents, knowledge base chat). The agent must belong to the same company as the API key used for authentication.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Starleads api docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.starleads.co/api-reference/agent/get-an-agent\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://locuta.mintlify.app/_mintlify/api/og/v2?division=Agents\u0026amp;title=Get+an+agent\u0026amp;description=Returns+everything+needed+to+work+with+the+agent+through+the+other+endpoints%3A+its+channel+and+direction%2C+its+prompt+and+welcome+messages%2C+the+variables+it+expec\u0026amp;theme=5c5c29653f72fde3c80fdcde\u0026amp;signature=6ea28b46f7339848cf50a048aa81e550897c527cb8f95c89f426c8bd9f7eb00f\">\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=\"Get an agent - Starleads api docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns everything needed to work with the agent through the other endpoints: its channel and direction, its prompt and welcome messages, the variables it expects (fields, to pass as dataBag or variables), the classification tags and extracted values found in results, and what is connected to it (tools, sub-agents, knowledge base chat). The agent must belong to the same company as the API key used for authentication.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://locuta.mintlify.app/_mintlify/api/og/v2?division=Agents\u0026amp;title=Get+an+agent\u0026amp;description=Returns+everything+needed+to+work+with+the+agent+through+the+other+endpoints%3A+its+channel+and+direction%2C+its+prompt+and+welcome+messages%2C+the+variables+it+expec\u0026amp;theme=5c5c29653f72fde3c80fdcde\u0026amp;signature=6ea28b46f7339848cf50a048aa81e550897c527cb8f95c89f426c8bd9f7eb00f\">\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/locuta/ynlCpXqW2nrSkjmQ/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Starleads api docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF5B22\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.starleads.co/api-reference/agent/get-an-agent\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/agent/get-an-agent.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.starleads.co/#organization\",\"name\":\"Starleads api docs\",\"url\":\"https://docs.starleads.co\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/locuta/nbODknSPetkh4479/logo/logo-light.png?fit=max\u0026auto=format\u0026n=nbODknSPetkh4479\u0026q=85\u0026s=0c3dc57cc8eb4727a18bea5b413cfc61\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.starleads.co#website\",\"name\":\"Starleads api docs\",\"url\":\"https://docs.starleads.co\",\"publisher\":{\"@id\":\"https://docs.starleads.co/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.starleads.co/api-reference/agent/get-an-agent#webpage\",\"url\":\"https://docs.starleads.co/api-reference/agent/get-an-agent\",\"name\":\"Get an agent\",\"description\":\"Returns everything needed to work with the agent through the other endpoints: its channel and direction, its prompt and welcome messages, the variables it expects (fields, to pass as dataBag or variables), the classification tags and extracted values found in results, and what is connected to it (tools, sub-agents, knowledge base chat). The agent must belong to the same company as the API key used for authentication.\",\"dateModified\":\"2026-09-21T11:54:21.133Z\",\"isPartOf\":{\"@id\":\"https://docs.starleads.co#website\"},\"breadcrumb\":{\"@id\":\"https://docs.starleads.co/api-reference/agent/get-an-agent#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.starleads.co/api-reference/agent/get-an-agent#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Agents\",\"item\":\"https://docs.starleads.co/api-reference/agent/get-the-prompt-of-an-agent\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get an agent\",\"item\":\"https://docs.starleads.co/api-reference/agent/get-an-agent\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.starleads.co/api-reference/agent/get-an-agent#apireference\",\"headline\":\"Get an agent\",\"name\":\"Get an agent\",\"description\":\"Returns everything needed to work with the agent through the other endpoints: its channel and direction, its prompt and welcome messages, the variables it expects (fields, to pass as dataBag or variables), the classification tags and extracted values found in results, and what is connected to it (tools, sub-agents, knowledge base chat). The agent must belong to the same company as the API key used for authentication.\",\"url\":\"https://docs.starleads.co/api-reference/agent/get-an-agent\",\"mainEntityOfPage\":{\"@id\":\"https://docs.starleads.co/api-reference/agent/get-an-agent#webpage\"},\"dateModified\":\"2026-09-21T11:54:21.133Z\",\"publisher\":{\"@id\":\"https://docs.starleads.co/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.starleads.co#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Starleads api docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Starleads api docs","nav":{"global":null,"anchors":[{"anchor":"Documentation","icon":{"name":"book-open","style":"duotone"},"pages":[{"title":"Documentation","href":"/documentation/get-started"}]},{"anchor":"API Reference","icon":{"name":"square-terminal","style":"duotone"},"groups":[{"group":"API Reference","pages":[{"title":"API Reference","mode":"wide","href":"/api-reference/introduction"}]},{"group":"Consumption","pages":[{"title":"Get the current consumption","openapi":"GET /Consumption","href":"/api-reference/consumption/get-current-consumption"},{"title":"Get the consumption breakdown","openapi":"GET /Consumption/breakdown","href":"/api-reference/consumption/get-consumption-breakdown"},{"title":"List consumption transactions","openapi":"GET /Consumption/transactions","href":"/api-reference/consumption/get-consumption-transactions"}]},{"group":"Subscription","pages":[{"title":"Get the subscription contract","openapi":"GET /Subscription","href":"/api-reference/subscription/get-subscription-contract"}]},{"group":"Campaigns","pages":[{"title":"Get all campaigns","openapi":"GET /Campaign","href":"/api-reference/campaign/get-all-campaigns"},{"title":"Create a campaign","openapi":"POST /Campaign","href":"/api-reference/campaign/create-a-campaign"}]},{"group":"Campaign Items","pages":[{"title":"Get campaign items with filters","openapi":"GET /CampaignItem/{campaignId}/items","href":"/api-reference/campaignitem/get-campaign-items-with-filters"},{"title":"Get all items by phone number","openapi":"GET /CampaignItem/{campaignId}/{phoneNumber}","href":"/api-reference/campaignitem/get-all-items-by-phone-number"},{"title":"Add a new campaign item to a campaign","openapi":"POST /CampaignItem/{campaignId}","href":"/api-reference/campaignitem/add-a-new-campaign-item-to-a-campaign"},{"title":"Add multiple items to a campaign","openapi":"POST /CampaignItem/{campaignId}/bulk-add-items","href":"/api-reference/campaignitem/add-multiple-items-to-a-campaign"},{"title":"Delete an item from a campaign","openapi":"DELETE /CampaignItem/{campaignId}/{itemId}","href":"/api-reference/campaignitem/delete-an-item-from-a-campaign"},{"title":"Get item audio recording","openapi":"GET /CampaignItem/{itemId}/audio","href":"/api-reference/campaignitem/get-item-audio-recording"},{"title":"Delete item audio recording","openapi":"DELETE /CampaignItem/{itemId}/audio","href":"/api-reference/campaignitem/delete-item-audio-recording"}]},{"group":"Campaign Fields","pages":[{"title":"Get campaign's fields","openapi":"GET /CampaignField/{campaignId}","href":"/api-reference/campaignfield/get-campaigns-fields"}]},{"group":"Agents","pages":[{"title":"Get the prompt of an agent","openapi":"GET /Agent/{agentId}/prompt","href":"/api-reference/agent/get-the-prompt-of-an-agent"},{"title":"Update the prompt of an agent","openapi":"PUT /Agent/{agentId}/prompt","href":"/api-reference/agent/update-the-prompt-of-an-agent"},{"title":"Connect a knowledge base chat to an agent","openapi":"PUT /Agent/{agentId}/chat","href":"/api-reference/agent/connect-a-knowledge-base-chat-to-an-agent"},{"title":"Get the chat connected to an agent","openapi":"GET /Agent/{agentId}/chat","href":"/api-reference/agent/get-the-chat-connected-to-an-agent"},{"title":"Detach the chat from an agent","openapi":"DELETE /Agent/{agentId}/chat","description":null,"href":"/api-reference/agent/detach-the-chat-from-an-agent"},{"title":"Get an agent","openapi":"GET /Agent/{agentId}","href":"/api-reference/agent/get-an-agent"},{"title":"List the tools connected to an agent","openapi":"GET /Agent/{agentId}/tools","description":"Returns the tools currently connected to the agent (id, name and technical name).","href":"/api-reference/agent/list-the-tools-connected-to-an-agent"},{"title":"Connect a tool to an agent","openapi":"PUT /Agent/{agentId}/tools/{toolId}","href":"/api-reference/agent/connect-a-tool-to-an-agent"},{"title":"Disconnect a tool from an agent","openapi":"DELETE /Agent/{agentId}/tools/{toolId}","href":"/api-reference/agent/disconnect-a-tool-from-an-agent"},{"title":"Get the history of an agent","openapi":"GET /Agent/{agentId}/history","href":"/api-reference/agent/get-the-history-of-an-agent"}]},{"group":"Simulation Chat","pages":[{"title":"Start a simulation chat with an agent","openapi":"POST /SimulationChat/start","href":"/api-reference/simulationchat/start-a-simulation-chat-with-an-agent"},{"title":"Get a simulation chat","openapi":"GET /SimulationChat/{simulationChatId}","href":"/api-reference/simulationchat/get-a-simulation-chat"},{"title":"Send a message to a simulation chat","openapi":"POST /SimulationChat/send-message","href":"/api-reference/simulationchat/send-a-message-to-a-simulation-chat"}]},{"group":"Agent Tests","pages":[{"title":"List the tests of an agent","openapi":"GET /AgentTest","href":"/api-reference/agenttest/list-the-tests-of-an-agent"},{"title":"Get a test","openapi":"GET /AgentTest/{testId}","href":"/api-reference/agenttest/get-a-test"},{"title":"Delete a test","openapi":"DELETE /AgentTest/{testId}","href":"/api-reference/agenttest/delete-a-test"},{"title":"Create a simulation test","openapi":"POST /AgentTest/simulation","href":"/api-reference/agenttest/create-a-simulation-test"},{"title":"Update a simulation test","openapi":"PUT /AgentTest/simulation/{testId}","href":"/api-reference/agenttest/update-a-simulation-test"},{"title":"Create a classification test","openapi":"POST /AgentTest/classification","href":"/api-reference/agenttest/create-a-classification-test"},{"title":"Update a classification test","openapi":"PUT /AgentTest/classification/{testId}","href":"/api-reference/agenttest/update-a-classification-test"},{"title":"Move tests into a folder","openapi":"POST /AgentTest/move","href":"/api-reference/agenttest/move-tests-into-a-folder"}]},{"group":"Agent Test Folders","pages":[{"title":"List the folders of an agent","openapi":"GET /AgentTestFolder","href":"/api-reference/agenttestfolder/list-the-folders-of-an-agent"},{"title":"Get a folder","openapi":"GET /AgentTestFolder/{folderId}","href":"/api-reference/agenttestfolder/get-a-folder"},{"title":"Create a folder","openapi":"POST /AgentTestFolder","href":"/api-reference/agenttestfolder/create-a-folder"},{"title":"Update a folder","openapi":"PUT /AgentTestFolder/{folderId}","href":"/api-reference/agenttestfolder/update-a-folder"},{"title":"Delete a folder","openapi":"DELETE /AgentTestFolder/{folderId}","href":"/api-reference/agenttestfolder/delete-a-folder"}]},{"group":"Agent Test Executions","pages":[{"title":"Launch tests","openapi":"POST /AgentTestExecution","href":"/api-reference/agenttestexecution/launch-tests"},{"title":"Get an execution","openapi":"GET /AgentTestExecution/{executionId}","href":"/api-reference/agenttestexecution/get-an-execution"},{"title":"List the executions of an agent","openapi":"GET /AgentTestExecution","href":"/api-reference/agenttestexecution/list-the-executions-of-an-agent"},{"title":"Cancel an execution","openapi":"POST /AgentTestExecution/{executionId}/cancel","href":"/api-reference/agenttestexecution/cancel-an-execution"}]},{"group":"Agent Test Runs","pages":[{"title":"Get a run","openapi":"GET /AgentTestRun/{runId}","href":"/api-reference/agenttestrun/get-a-run"},{"title":"List runs","openapi":"GET /AgentTestRun","href":"/api-reference/agenttestrun/list-runs"},{"title":"Cancel runs","openapi":"POST /AgentTestRun/cancel","href":"/api-reference/agenttestrun/cancel-runs"}]},{"group":"Knowledge Base — Datasets","pages":[{"title":"List datasets","openapi":"GET /Dataset","href":"/api-reference/dataset/list-datasets"},{"title":"Create a dataset","openapi":"POST /Dataset","href":"/api-reference/dataset/create-a-dataset"},{"title":"Get a dataset","openapi":"GET /Dataset/{datasetId}","href":"/api-reference/dataset/get-a-dataset"},{"title":"Update a dataset","openapi":"PATCH /Dataset/{datasetId}","href":"/api-reference/dataset/update-a-dataset"},{"title":"Delete a dataset","openapi":"DELETE /Dataset/{datasetId}","href":"/api-reference/dataset/delete-a-dataset"}]},{"group":"Knowledge Base — Documents","pages":[{"title":"List documents in a dataset","openapi":"GET /Dataset/{datasetId}/document","href":"/api-reference/document/list-documents-in-a-dataset"},{"title":"Upload documents to a dataset","openapi":"POST /Dataset/{datasetId}/document","href":"/api-reference/document/upload-documents-to-a-dataset"},{"title":"Download a document file","openapi":"GET /Dataset/{datasetId}/document/{documentId}/download","href":"/api-reference/document/download-a-document-file"},{"title":"Update a document","openapi":"PUT /Dataset/{datasetId}/document/{documentId}","href":"/api-reference/document/update-a-document"},{"title":"Delete a document","openapi":"DELETE /Dataset/{datasetId}/document/{documentId}","href":"/api-reference/document/delete-a-document"},{"title":"Trigger document parsing","openapi":"POST /Dataset/{datasetId}/document/parse","href":"/api-reference/document/trigger-document-parsing"},{"title":"Stop document parsing","openapi":"DELETE /Dataset/{datasetId}/document/parse","href":"/api-reference/document/stop-document-parsing"}]},{"group":"Knowledge Base — Chats","pages":[{"title":"List knowledge base chats","openapi":"GET /KnowledgeBaseChat","href":"/api-reference/knowledgebasechat/list-knowledge-base-chats"},{"title":"Create a knowledge base chat","openapi":"POST /KnowledgeBaseChat","href":"/api-reference/knowledgebasechat/create-a-knowledge-base-chat"},{"title":"Get a knowledge base chat","openapi":"GET /KnowledgeBaseChat/{chatId}","href":"/api-reference/knowledgebasechat/get-a-knowledge-base-chat"},{"title":"Update a knowledge base chat","openapi":"PATCH /KnowledgeBaseChat/{chatId}","href":"/api-reference/knowledgebasechat/update-a-knowledge-base-chat"},{"title":"Delete a knowledge base chat","openapi":"DELETE /KnowledgeBaseChat/{chatId}","href":"/api-reference/knowledgebasechat/delete-a-knowledge-base-chat"}]},{"group":"Knowledge Base — Knowledge Graph","pages":[{"title":"Enable knowledge graph on a dataset","openapi":"POST /Dataset/{datasetId}/knowledge-graph/enable","href":"/api-reference/knowledgegraph/enable-knowledge-graph-on-a-dataset"},{"title":"Trigger knowledge graph construction","openapi":"POST /Dataset/{datasetId}/knowledge-graph/build","href":"/api-reference/knowledgegraph/trigger-knowledge-graph-construction"},{"title":"Get knowledge graph build status","openapi":"GET /Dataset/{datasetId}/knowledge-graph/status","href":"/api-reference/knowledgegraph/get-knowledge-graph-build-status"},{"title":"Get the knowledge graph","openapi":"GET /Dataset/{datasetId}/knowledge-graph","href":"/api-reference/knowledgegraph/get-the-knowledge-graph"},{"title":"Delete the knowledge graph","openapi":"DELETE /Dataset/{datasetId}/knowledge-graph","href":"/api-reference/knowledgegraph/delete-the-knowledge-graph"}]}]}]},"title":"Get an agent - Starleads api docs","buildId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","deploymentId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-WRhTSUDL.js","utils-ChMov4Kr.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-_REmC2bI.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp6nVRCu.js","snippetPresets-DZadmXoU.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CY2WdoTl.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DwYG-Q4l.js","shallow-BXQIGwv4.js","getApiPlaygroundDisplay-CK5nK5B9.js","CodeSnippet-TH4a2aGW.js","CodeSnippets-DwsQiOFS.js","Page-R3M_BF4L.js","getPastedJson-DD7kUzi_.js","icon-holE3QoJ.js","MethodPill-DUW0T8us.js","DuplicateIcon-CI_p4be-.js","createIcon-BdbRvavb.js","DynamicMarkdown-DN96a4Ur.js","SectionHeading-SCu36A9d.js","axios-vUo_bRtp.js","Markdown-CCeGv-zI.js","clsx-BGBGWFTt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Cv_O2fky.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-2C5OB2eV.js"]}