Semantic validation status of a config's most recently saved definition (e.g. whether every
fixed export schema column is actually produced by a command). Serialized as its underlying
int, not a string - see Sequentum.Enterprise.ControlCenter.Swagger.EnumDescriptionsSchemaFilter
for how these values get documented in the public OpenAPI spec. (1 = Unknown - Validation status was not computed for this response (e.g. a historical config version, which does not retain its own stored status); 2 = Invalid - The config has one or more semantic validation errors (e.g. a required export column with no producing command); 3 = Valid - The config has no semantic validation errors)
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Sequentum Developer Documentation","description":"Build, run, and operate web data agents at enterprise scale.","colors":{"primary":"#5248f9","light":"#7c74fb","dark":"#14163b"},"logo":{"light":"https://mintcdn.com/sequentum/fcE1x9eYvxrlj_sO/logo/wordmark-light.svg?fit=max\u0026auto=format\u0026n=fcE1x9eYvxrlj_sO\u0026q=85\u0026s=0a67e1bcfec589a284d603f793833f43","dark":"https://mintcdn.com/sequentum/fcE1x9eYvxrlj_sO/logo/wordmark-dark.svg?fit=max\u0026auto=format\u0026n=fcE1x9eYvxrlj_sO\u0026q=85\u0026s=2c2373b40cd1969f989d11624005229b","href":"https://docs.sequentum.com"},"favicon":{"light":"https://mintcdn.com/sequentum/fcE1x9eYvxrlj_sO/favicon-light.svg?fit=max\u0026auto=format\u0026n=fcE1x9eYvxrlj_sO\u0026q=85\u0026s=7b586086bac293498d14050730848a18","dark":"https://mintcdn.com/sequentum/fcE1x9eYvxrlj_sO/favicon-dark.svg?fit=max\u0026auto=format\u0026n=fcE1x9eYvxrlj_sO\u0026q=85\u0026s=93ab6db44ff5945729856e1209d0bc5c"},"navbar":{"links":[{"href":"https://www.sequentum.com/contact-us","label":"Support"}],"primary":{"type":"button","label":"Get API Key","href":"https://dashboard.sequentum.com/user/api-keys"}},"footer":{"socials":{"x":"https://x.com/sequentum","linkedin":"https://www.linkedin.com/company/sequentum","github":"https://github.com/sequentum"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"sequentum","hasAudioNarration":false,"actualSubdomain":"sequentum","customDomains":["docs.sequentum.com"],"gitSource":{"type":"github","owner":"sequentum","repo":"sequentum-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae566d14f6cee598f7bd105","collectionId":"1284149c-11bf-4d11-8aa2-609e19837aea","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae566d14f6cee598f7bd105"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae566d14f6cee598f7bd105","clientVersion":"0.0.4064","searchFilterCounts":[{"language":"default","tag":"Agents","count":64},{"language":"default","tag":"Documentation","count":60},{"language":"default","tag":"API reference","count":48},{"language":"default","tag":"Commands","count":43},{"language":"default","tag":"Export","count":11},{"language":"default","tag":"Extract","count":9},{"language":"default","tag":"Schedules","count":7},{"language":"default","tag":"Get started","count":7},{"language":"default","tag":"Agent Builder","count":6},{"language":"default","tag":"Billing","count":6}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","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":"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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/agents/get","slug":"/api-reference/agents/get","pageMetadata":{"title":"Get an agent","openapi":"GET /api/v1/agent/{agentId}","mode":"wide","description":"Returns a specific agent accessible to the authenticated user within their organization.","href":"/api-reference/agents/get"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Returns a specific agent accessible to the authenticated user within their organization.\"\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 /api/v1/agent/{agentId}","mode":"wide","description":"Returns a specific agent accessible to the authenticated user within their organization.","href":"/api-reference/agents/get"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["ApiAgent"],"summary":"Get a single agent","description":"Returns a specific agent accessible to the authenticated user within their organization.","parameters":["8a8d6236-52f6-4c63-8a1b-0d910bb00806"],"responses":{"200":"a983968e-99fc-40c1-865d-4a34a068f9db","400":"a0dc9b45-0867-416a-bd68-3f9631d45727","401":"c5304695-1927-4d40-8e75-0c94fb0d6375","404":"5964b280-3d68-44d4-a114-fb16752a60cd","429":"107a6756-8e73-4f25-9eeb-d089470b9050"},"method":"get","type":"path","servers":[],"security":["c8641e7d-99f9-44e8-a2b7-2b249e4b5896"],"path":"/api/v1/agent/{agentId}","baseUrlOptions":[],"title":"Get a single agent","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"8a8d6236-52f6-4c63-8a1b-0d910bb00806":{"name":"agentId","in":"path","description":"The ID of the agent to retrieve","required":true,"schema":{"type":"integer","format":"int32","isRequired":true,"description":"The ID of the agent to retrieve","uniqueKey":"","typeLabel":"integer\u003cint32>"}}},"responses":{"a983968e-99fc-40c1-865d-4a34a068f9db":{"description":"Returns the requested agent","content":{"application/json":{"schema":{"type":"object","properties":{"agentTemplates":{"oneOf":[{"type":"string","uniqueKey":"agentTemplates.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"agentTemplates.oneOf.1","typeLabel":"null"}],"uniqueKey":"agentTemplates","typeLabel":"string | null"},"configType":{"enum":[1,2,3,4],"type":"integer","description":"`1` = `Agent`; `2` = `SharedFile`; `3` = `Template`; `4` = `Command`","format":"int32","uniqueKey":"configType","typeLabel":"enum\u003cinteger>"},"description":{"oneOf":[{"type":"string","uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"documentation":{"oneOf":[{"type":"string","uniqueKey":"documentation.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"documentation.oneOf.1","typeLabel":"null"}],"uniqueKey":"documentation","typeLabel":"string | null"},"icon":{"oneOf":[{"type":"string","uniqueKey":"icon.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"icon.oneOf.1","typeLabel":"null"}],"uniqueKey":"icon","typeLabel":"string | null"},"image":{"oneOf":[{"type":"string","format":"byte","uniqueKey":"image.oneOf.0","typeLabel":"string\u003cbyte>"},{"type":"null","format":"byte","uniqueKey":"image.oneOf.1","typeLabel":"null"}],"uniqueKey":"image","typeLabel":"string\u003cbyte> | null"},"inputParameters":{"oneOf":[{"type":"object","additionalProperties":{"type":"string","uniqueKey":"inputParameters.oneOf.0.additionalProperties","typeLabel":"string"},"uniqueKey":"inputParameters.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"string","uniqueKey":"inputParameters.oneOf.1.additionalProperties","typeLabel":"string"},"uniqueKey":"inputParameters.oneOf.1","typeLabel":"null"}],"uniqueKey":"inputParameters","typeLabel":"object | null"},"id":{"oneOf":[{"type":"integer","format":"int32","uniqueKey":"id.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","uniqueKey":"id.oneOf.1","typeLabel":"null"}],"uniqueKey":"id","typeLabel":"integer\u003cint32> | null"},"isActive":{"type":"boolean","readOnly":true,"uniqueKey":"isActive","typeLabel":"boolean"},"lastActivity":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"lastActivity.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"lastActivity.oneOf.1","typeLabel":"null"}],"uniqueKey":"lastActivity","typeLabel":"string\u003cdate-time> | null"},"name":{"oneOf":[{"type":"string","uniqueKey":"name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"name.oneOf.1","typeLabel":"null"}],"uniqueKey":"name","typeLabel":"string | null"},"proxyPoolId":{"oneOf":[{"type":"integer","format":"int32","uniqueKey":"proxyPoolId.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","uniqueKey":"proxyPoolId.oneOf.1","typeLabel":"null"}],"uniqueKey":"proxyPoolId","typeLabel":"integer\u003cint32> | null"},"spaceId":{"oneOf":[{"type":"integer","format":"int32","uniqueKey":"spaceId.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","uniqueKey":"spaceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"spaceId","typeLabel":"integer\u003cint32> | null"},"startUrl":{"oneOf":[{"type":"string","uniqueKey":"startUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"startUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"startUrl","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"},"userId":{"oneOf":[{"type":"integer","format":"int32","uniqueKey":"userId.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","uniqueKey":"userId.oneOf.1","typeLabel":"null"}],"uniqueKey":"userId","typeLabel":"integer\u003cint32> | null"},"validationStatus":{"enum":[1,2,3],"type":"integer","description":"Semantic validation status of a config's most recently saved definition (e.g. whether every\r\nfixed export schema column is actually produced by a command). Serialized as its underlying\r\nint, not a string - see Sequentum.Enterprise.ControlCenter.Swagger.EnumDescriptionsSchemaFilter\r\nfor how these values get documented in the public OpenAPI spec. (`1` = `Unknown` - Validation status was not computed for this response (e.g. a historical config version, which does not retain its own stored status); `2` = `Invalid` - The config has one or more semantic validation errors (e.g. a required export column with no producing command); `3` = `Valid` - The config has no semantic validation errors)","format":"int32","uniqueKey":"validationStatus","typeLabel":"enum\u003cinteger>"},"version":{"type":"integer","format":"int32","uniqueKey":"version","typeLabel":"integer\u003cint32>"},"created":{"type":"string","format":"date-time","uniqueKey":"created","typeLabel":"string\u003cdate-time>"},"updated":{"type":"string","format":"date-time","uniqueKey":"updated","typeLabel":"string\u003cdate-time>"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"agentTemplates":"\u003cstring>","configType":1,"description":"\u003cstring>","documentation":"\u003cstring>","icon":"\u003cstring>","image":"aSDinaTvuI8gbWludGxpZnk=","inputParameters":{},"id":123,"isActive":true,"lastActivity":"2023-11-07T05:31:56Z","name":"\u003cstring>","proxyPoolId":123,"spaceId":123,"startUrl":"\u003cstring>","status":123,"userId":123,"validationStatus":1,"version":123,"created":"2023-11-07T05:31:56Z","updated":"2023-11-07T05:31:56Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"a0dc9b45-0867-416a-bd68-3f9631d45727":{"description":"If the request is invalid","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","format":"int32","uniqueKey":"statusCode","typeLabel":"integer\u003cint32>"},"statusDescription":{"oneOf":[{"type":"string","uniqueKey":"statusDescription.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"statusDescription.oneOf.1","typeLabel":"null"}],"uniqueKey":"statusDescription","typeLabel":"string | null"},"message":{"oneOf":[{"type":"string","readOnly":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"uniqueKey":"message.oneOf.1","typeLabel":"null"}],"uniqueKey":"message","typeLabel":"string | null"},"severity":{"enum":[0,1,2,3,4],"type":"integer","description":"`0` = `Error`; `1` = `Unexpected`; `2` = `Fatal`; `3` = `Warning`; `4` = `Info`","format":"int32","uniqueKey":"severity","typeLabel":"enum\u003cinteger>"},"errorCode":{"oneOf":[{"type":"string","description":"Optional machine-readable error code. When present, clients should switch on this\r\nvalue rather than parsing Sequentum.Enterprise.Core.ControllerError.Message. Omitted from the response when null.","uniqueKey":"errorCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional machine-readable error code. When present, clients should switch on this\r\nvalue rather than parsing Sequentum.Enterprise.Core.ControllerError.Message. Omitted from the response when null.","uniqueKey":"errorCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"errorCode","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":123,"statusDescription":"\u003cstring>","message":"\u003cstring>","severity":0,"errorCode":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"c5304695-1927-4d40-8e75-0c94fb0d6375":{"description":"If the API key is missing or invalid","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"},"5964b280-3d68-44d4-a114-fb16752a60cd":{"description":"If the agent is not found or user doesn't have access","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"},"107a6756-8e73-4f25-9eeb-d089470b9050":{"description":"Too Many Requests","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":{"c8641e7d-99f9-44e8-a2b7-2b249e4b5896":{"ApiKey":{"type":"apiKey","description":"API Key authorization header. Example: \"Authorization: ApiKey {your-api-key}\"","name":"Authorization","in":"header","scopes":[]},"Bearer":{"type":"http","description":"OAuth 2.0 Bearer token. Example: \"Authorization: Bearer {access-token}\"","scheme":"bearer","bearerFormat":"JWT","scopes":[]}}},"servers":{},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","description":"API Key authorization header. Example: \"Authorization: ApiKey {your-api-key}\"","name":"Authorization","in":"header","scopes":[]},"schema":{"title":"Authorization","type":"string","description":"API Key authorization header. Example: \"Authorization: ApiKey {your-api-key}\"","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKey","name":"Authorization"},{"scheme":{"type":"http","description":"OAuth 2.0 Bearer token. Example: \"Authorization: Bearer {access-token}\"","scheme":"bearer","bearerFormat":"JWT","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"OAuth 2.0 Bearer token. Example: \"Authorization: Bearer {access-token}\"","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"Bearer","name":"Authorization"}],"title":"ApiKey \u0026 Bearer"}]},"originalFileLocation":"swagger.json"},"subdomain":"sequentum","siteName":"Sequentum Developer Documentation","title":"Get an agent - Sequentum Developer Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-05T22:38:33.740Z","originalFileLocation":"api-reference/agents/get.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 a specific agent accessible to the authenticated user within their organization.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Sequentum Developer Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/sequentum/VkZlqfknQ1prTgmm/_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/sequentum/VkZlqfknQ1prTgmm/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/sequentum/VkZlqfknQ1prTgmm/_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/sequentum/VkZlqfknQ1prTgmm/_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/sequentum/VkZlqfknQ1prTgmm/_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/sequentum/VkZlqfknQ1prTgmm/_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/sequentum/VkZlqfknQ1prTgmm/_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/sequentum/VkZlqfknQ1prTgmm/_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/sequentum/VkZlqfknQ1prTgmm/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get an agent - Sequentum Developer Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns a specific agent accessible to the authenticated user within their organization.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Sequentum Developer Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.sequentum.com/api-reference/agents/get\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://sequentum.mintlify.app/_mintlify/api/og/v2?division=Agents\u0026amp;title=Get+an+agent\u0026amp;description=Returns+a+specific+agent+accessible+to+the+authenticated+user+within+their+organization.\u0026amp;theme=79ab2d552dc11d5e80ec210a\u0026amp;signature=6be8869d4b71a835e74c8b2b25754e657fd91cc6f86e30408bdc53fb64c82044\">\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 - Sequentum Developer Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns a specific agent accessible to the authenticated user within their organization.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://sequentum.mintlify.app/_mintlify/api/og/v2?division=Agents\u0026amp;title=Get+an+agent\u0026amp;description=Returns+a+specific+agent+accessible+to+the+authenticated+user+within+their+organization.\u0026amp;theme=79ab2d552dc11d5e80ec210a\u0026amp;signature=6be8869d4b71a835e74c8b2b25754e657fd91cc6f86e30408bdc53fb64c82044\">\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/sequentum/VkZlqfknQ1prTgmm/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Sequentum Developer Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#5248f9\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.sequentum.com/api-reference/agents/get\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/agents/get.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.sequentum.com/#organization\",\"name\":\"Sequentum Developer Documentation\",\"url\":\"https://docs.sequentum.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/sequentum/fcE1x9eYvxrlj_sO/logo/wordmark-light.svg?fit=max\u0026auto=format\u0026n=fcE1x9eYvxrlj_sO\u0026q=85\u0026s=0a67e1bcfec589a284d603f793833f43\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.sequentum.com#website\",\"name\":\"Sequentum Developer Documentation\",\"url\":\"https://docs.sequentum.com\",\"publisher\":{\"@id\":\"https://docs.sequentum.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.sequentum.com/api-reference/agents/get#webpage\",\"url\":\"https://docs.sequentum.com/api-reference/agents/get\",\"name\":\"Get an agent\",\"description\":\"Returns a specific agent accessible to the authenticated user within their organization.\",\"dateModified\":\"2026-08-05T22:38:33.740Z\",\"isPartOf\":{\"@id\":\"https://docs.sequentum.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.sequentum.com/api-reference/agents/get#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.sequentum.com/api-reference/agents/get#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Agents\",\"item\":\"https://docs.sequentum.com/api-reference/agents/list\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get an agent\",\"item\":\"https://docs.sequentum.com/api-reference/agents/get\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.sequentum.com/api-reference/agents/get#apireference\",\"headline\":\"Get an agent\",\"name\":\"Get an agent\",\"description\":\"Returns a specific agent accessible to the authenticated user within their organization.\",\"url\":\"https://docs.sequentum.com/api-reference/agents/get\",\"mainEntityOfPage\":{\"@id\":\"https://docs.sequentum.com/api-reference/agents/get#webpage\"},\"dateModified\":\"2026-08-05T22:38:33.740Z\",\"publisher\":{\"@id\":\"https://docs.sequentum.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.sequentum.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Sequentum Developer Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Sequentum Developer Documentation","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API reference","groups":[{"group":"Overview","pages":[{"title":"API reference","href":"/api-reference/introduction"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Errors","href":"/api-reference/errors"}]},{"group":"Agent Builder","pages":[{"title":"Start an Agent Builder session","openapi":"POST /api/v1/agent-builder/start","mode":"wide","href":"/api-reference/agent-builder/start-session"},{"title":"Get session status","openapi":"GET /api/v1/agent-builder/{sessionId}/status","mode":"wide","href":"/api-reference/agent-builder/session-status"},{"title":"Stop a session","openapi":"POST /api/v1/agent-builder/{sessionId}/stop","mode":"wide","href":"/api-reference/agent-builder/session-stop"}]},{"group":"Agents","pages":[{"title":"List agents","openapi":"GET /api/v1/agent/all","mode":"wide","href":"/api-reference/agents/list"},{"title":"Search agents","openapi":"GET /api/v1/agent/search","mode":"wide","description":"Searches for agents by matching the query term against agent names and descriptions (case-insensitive).\n\nReturns agents accessible to the authenticated user within their organization. Results are\nlimited to prevent performance issues — use `maxRecords` to control the limit.","href":"/api-reference/agents/search"},{"title":"Get an agent","openapi":"GET /api/v1/agent/{agentId}","mode":"wide","href":"/api-reference/agents/get"},{"title":"Get agent content","openapi":"GET /api/v1/agent/{agentId}/content","mode":"wide","description":"Returns the latest version of an agent's content. Edit it and upload it via\n`POST {agentId}/content` to create a new version.\n\n`format` controls the shape of the returned `content`:\n- `json` (default) - the canonical config as a JSON object. This is the only format\n `POST {agentId}/content` accepts.\n- `yaml` - the plain-text NestedText format used by the agent editor, returned as a string.\n\nSecret values in the content (for example static input values, or FTP/Snowflake\npasswords and API keys) are returned as encrypted ciphertext, not plaintext.\n\nRequires read access to the agent.","href":"/api-reference/agents/get-content"},{"title":"Upload agent content","openapi":"POST /api/v1/agent/{agentId}/content","mode":"wide","href":"/api-reference/agents/upload-content"},{"title":"Get agent input parameters","openapi":"GET /api/v1/agent/{agentId}/input-parameters","mode":"wide","href":"/api-reference/agents/input-parameters"},{"title":"Start a run","openapi":"POST /api/v1/agent/{agentId}/start","mode":"wide","href":"/api-reference/agents/start-run"},{"title":"List runs for an agent","openapi":"GET /api/v1/agent/{agentId}/runs","mode":"wide","href":"/api-reference/agents/list-runs"},{"title":"Get run status","openapi":"GET /api/v1/agent/{agentId}/run/{runId}/status","mode":"wide","href":"/api-reference/agents/run-status"},{"title":"Stop a run","openapi":"POST /api/v1/agent/{agentId}/run/{runId}/stop","mode":"wide","href":"/api-reference/agents/stop-run"},{"title":"Kill a run","openapi":"POST /api/v1/agent/{agentId}/run/{runId}/kill","mode":"wide","href":"/api-reference/agents/kill-run"},{"title":"Delete a run","openapi":"DELETE /api/v1/agent/{agentId}/run/{runId}","mode":"wide","href":"/api-reference/agents/delete-run"},{"title":"List run output files","openapi":"GET /api/v1/agent/{agentId}/run/{runId}/files","mode":"wide","href":"/api-reference/agents/run-files"},{"title":"Download a run output file","openapi":"GET /api/v1/agent/{agentId}/run/{runId}/file/{fileId}/download","mode":"wide","href":"/api-reference/agents/run-file-download"},{"title":"List agent versions","openapi":"GET /api/v1/agent/{agentId}/versions","mode":"wide","href":"/api-reference/agents/versions"},{"title":"Get version content","openapi":"GET /api/v1/agent/{agentId}/version/{versionNumber}/content","mode":"wide","href":"/api-reference/agents/version-content"},{"title":"Restore an agent version","openapi":"POST /api/v1/agent/{agentId}/version/{versionNumber}/restore","mode":"wide","href":"/api-reference/agents/restore-version"},{"title":"Archive an agent","openapi":"POST /api/v1/agent/{agentId}/archive","mode":"wide","href":"/api-reference/agents/archive"},{"title":"Unarchive an agent","openapi":"POST /api/v1/agent/{agentId}/unarchive","mode":"wide","href":"/api-reference/agents/unarchive"}]},{"group":"Schedules","pages":[{"title":"List schedules for an agent","openapi":"GET /api/v1/agent/{agentId}/schedules","mode":"wide","href":"/api-reference/schedules/list"},{"title":"Create a schedule","openapi":"POST /api/v1/agent/{agentId}/schedules","mode":"wide","href":"/api-reference/schedules/create"},{"title":"Get a schedule","openapi":"GET /api/v1/agent/{agentId}/schedules/{scheduleId}","mode":"wide","href":"/api-reference/schedules/get"},{"title":"Update a schedule","openapi":"PUT /api/v1/agent/{agentId}/schedules/{scheduleId}","mode":"wide","href":"/api-reference/schedules/update"},{"title":"Delete a schedule","openapi":"DELETE /api/v1/agent/{agentId}/schedules/{scheduleId}","mode":"wide","href":"/api-reference/schedules/delete"},{"title":"Enable a schedule","openapi":"POST /api/v1/agent/{agentId}/schedules/{scheduleId}/enable","mode":"wide","href":"/api-reference/schedules/enable"},{"title":"Disable a schedule","openapi":"POST /api/v1/agent/{agentId}/schedules/{scheduleId}/disable","mode":"wide","href":"/api-reference/schedules/disable"}]},{"group":"Analytics","pages":[{"title":"Runs summary","openapi":"GET /api/v1/analytics/runs/summary","mode":"wide","href":"/api-reference/analytics/runs-summary"},{"title":"Records summary","openapi":"GET /api/v1/analytics/records/summary","mode":"wide","href":"/api-reference/analytics/records-summary"},{"title":"Upcoming schedules","openapi":"GET /api/v1/analytics/schedules/upcoming","mode":"wide","href":"/api-reference/analytics/schedules-upcoming"},{"title":"Run diagnostics","openapi":"GET /api/v1/analytics/agents/{agentId}/runs/{runId}/diagnostics","mode":"wide","href":"/api-reference/analytics/run-diagnostics"},{"title":"Latest failure for an agent","openapi":"GET /api/v1/analytics/agents/{agentId}/latest-failure","mode":"wide","href":"/api-reference/analytics/latest-failure"}]},{"group":"Billing","pages":[{"title":"Get credits balance","openapi":"GET /api/v1/billing/credits","mode":"wide","href":"/api-reference/billing/credits"},{"title":"Get spending","openapi":"GET /api/v1/billing/spending","mode":"wide","href":"/api-reference/billing/spending"},{"title":"Billing history","openapi":"GET /api/v1/billing/history","mode":"wide","href":"/api-reference/billing/history"},{"title":"Per-agent billing summary","openapi":"GET /api/v1/billing/agents","mode":"wide","href":"/api-reference/billing/agents"},{"title":"Agent billing detail","openapi":"GET /api/v1/billing/agents/{agentId}","mode":"wide","href":"/api-reference/billing/agent"},{"title":"Agent run-level billing","openapi":"GET /api/v1/billing/agents/{agentId}/runs","mode":"wide","href":"/api-reference/billing/agent-runs"}]},{"group":"Spaces","pages":[{"title":"List spaces","openapi":"GET /api/v1/spaces","mode":"wide","href":"/api-reference/spaces/list"},{"title":"Get a space","openapi":"GET /api/v1/spaces/{spaceId}","mode":"wide","href":"/api-reference/spaces/get"},{"title":"List agents in a space","openapi":"GET /api/v1/spaces/{spaceId}/agents","mode":"wide","href":"/api-reference/spaces/agents"},{"title":"Run all agents in a space","openapi":"POST /api/v1/spaces/{spaceId}/run-all","mode":"wide","href":"/api-reference/spaces/run-all"},{"title":"Search spaces","openapi":"GET /api/v1/spaces/search","mode":"wide","href":"/api-reference/spaces/search"}]}]}]},"basePath":"","title":"Get an agent - Sequentum Developer Documentation","buildId":"dpl_2gSLkbMoF5kkLsBqYzq9KWtDyJRo","deploymentId":"dpl_2gSLkbMoF5kkLsBqYzq9KWtDyJRo","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-hfTk6MZX.js","utils-Bfp7HcY4.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-D8dSW7yV.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CFgQXcZO.js","snippetPresets-dMW1-pV3.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-BsZAA8xk.js","ApiExamples-DyrCOido.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Bwwdcyh3.js","shallow-drVXTg79.js","getApiPlaygroundDisplay-GMPxUzWV.js","CodeSnippet-wTmV0wP6.js","CodeSnippets-D_QxCJEq.js","getPastedJson-Dev-X0Xy.js","icon-7L2WL0jD.js","MethodPill-Ble59Dl_.js","DuplicateIcon-r-98uLGh.js","createIcon-DaFzipjW.js","DynamicMarkdown-Jk8YAWGN.js","SectionHeading-nLgrCDOg.js","axios-vUo_bRtp.js","Markdown-_QGow1Wo.js","clsx-v8ssfMzu.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CjboTi0T.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DkAyo-p5.js"]}