Through our API, you can build white label applications that let users interact with their favorite applications from their AI assistants.API Keys are used to authenticate to your Apigene account.To create an API key.
Click Generate API key to generate your Apigene API key
Ensure to copy and store your API key in a safe location as it can only be viewed from the dashboard once.
HTTP Header: Bearer Authentication
All requests must be authenticated via bearer token in your request HTTP header in the following format:
Authorization: Bearer <YOUR_API_KEY>
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Apigene","colors":{"primary":"#626AE9","light":"#626AE9","dark":"#626AE9"},"logo":{"light":"https://mintcdn.com/apigene/uc-Z_RqMQ0uSxRnH/logo/logo.png?fit=max\u0026auto=format\u0026n=uc-Z_RqMQ0uSxRnH\u0026q=85\u0026s=d3f920afe0cff7053c8f87cd7a3666b7","dark":"https://mintcdn.com/apigene/uc-Z_RqMQ0uSxRnH/logo/logo.png?fit=max\u0026auto=format\u0026n=uc-Z_RqMQ0uSxRnH\u0026q=85\u0026s=d3f920afe0cff7053c8f87cd7a3666b7"},"favicon":"https://mintcdn.com/apigene/uc-Z_RqMQ0uSxRnH/favicon.ico?fit=max\u0026auto=format\u0026n=uc-Z_RqMQ0uSxRnH\u0026q=85\u0026s=ab16204ce88247688a93f6f50a6956d5","navbar":{"links":[{"href":"mailto:support@apigene.ai","label":"Support"}],"primary":{"type":"button","label":"Sign in","href":"https://app.apigene.ai/"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"apigene","hasAudioNarration":false,"actualSubdomain":"apigene","customDomains":["docs.apigene.ai"],"gitSource":{"type":"github","owner":"apigene","repo":"apigene-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6b02c0f307135da59bd49714","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API Reference","count":168},{"language":"default","tag":"API Specs","count":28},{"language":"default","tag":"User Guide","count":26},{"language":"default","tag":"MCP","count":13},{"language":"default","tag":"Workflows","count":12},{"language":"default","tag":"GPT","count":11},{"language":"default","tag":"MCP Server","count":10},{"language":"default","tag":"Organization","count":9},{"language":"default","tag":"Skill","count":9},{"language":"default","tag":"Task","count":8}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api-reference/api-authentication","slug":"/api-reference/api-authentication","pageMetadata":{"title":"API Authentication","description":"Start making requests to the Apigene API","href":"/api-reference/api-authentication"},"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: \"Start making requests to the Apigene API\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,ol:`ol`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Through our API, you can build white label applications that let users interact with their favorite applications from their AI assistants.`}),`\n`,_jsxs(_components.p,{children:[`API Keys are used to authenticate to your `,_jsx(_components.a,{href:`http://app.apigene.ai`,children:`Apigene`}),` account.`]}),`\n`,_jsx(_components.p,{children:`To create an API key.`}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[`Access your `,_jsx(_components.a,{href:`http://app.apigene.ai`,children:`Apigene`}),` dashboard`]}),`\n`,_jsxs(_components.li,{children:[`Navigate to `,_jsx(_components.strong,{children:`Settings`})]}),`\n`,_jsxs(_components.li,{children:[`Select the `,_jsx(_components.strong,{children:`Organization`}),` tab`]}),`\n`,_jsxs(_components.li,{children:[`Click `,_jsx(_components.strong,{children:`Generate API key`}),` to generate your Apigene API key`]}),`\n`]}),`\n`,_jsx(Note,{children:_jsx(_components.p,{children:`Ensure to copy and store your API key in a safe location as it can only be viewed from the dashboard once.`})}),`\n`,_jsx(Heading,{level:`3`,id:`http-header-bearer-authentication`,children:`HTTP Header: Bearer Authentication`}),`\n`,_jsx(_components.p,{children:`All requests must be authenticated via bearer token in your request HTTP header in the following format:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`Authorization:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Bearer`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` \u003c`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`YOUR_API_KE`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`Y`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`>`})]}),`\n`]})})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"API Authentication","description":"Start making requests to the Apigene API","href":"/api-reference/api-authentication"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"HTTP Header: Bearer Authentication","slug":"http-header-bearer-authentication","depth":3,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"apigene","siteName":"Apigene","title":"API Authentication - Apigene","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-12-29T15:26:03.212Z","originalFileLocation":"api-reference/api-authentication.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=\"Start making requests to the Apigene API\">\u003cmeta data-mint-head name=\"application-name\" content=\"Apigene\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/apigene/l_3X4YBf3R8tWBGs/_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/apigene/l_3X4YBf3R8tWBGs/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/apigene/l_3X4YBf3R8tWBGs/_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/apigene/l_3X4YBf3R8tWBGs/_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/apigene/l_3X4YBf3R8tWBGs/_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/apigene/l_3X4YBf3R8tWBGs/_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/apigene/l_3X4YBf3R8tWBGs/_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/apigene/l_3X4YBf3R8tWBGs/_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/apigene/l_3X4YBf3R8tWBGs/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"API Authentication - Apigene\">\u003cmeta data-mint-head property=\"og:description\" content=\"Start making requests to the Apigene API\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Apigene\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.apigene.ai/api-reference/api-authentication\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://apigene.mintlify.site/_mintlify/api/og/v2?division=API+Documentation\u0026amp;title=API+Authentication\u0026amp;description=Start+making+requests+to+the+Apigene+API\u0026amp;theme=02bf718bb6acd60497dc1356\u0026amp;signature=c508b3ea30a5a9bec2791b625d907270f377b4812f7dc71bb0ec36a009654c70\">\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=\"API Authentication - Apigene\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Start making requests to the Apigene API\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://apigene.mintlify.site/_mintlify/api/og/v2?division=API+Documentation\u0026amp;title=API+Authentication\u0026amp;description=Start+making+requests+to+the+Apigene+API\u0026amp;theme=02bf718bb6acd60497dc1356\u0026amp;signature=c508b3ea30a5a9bec2791b625d907270f377b4812f7dc71bb0ec36a009654c70\">\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/apigene/l_3X4YBf3R8tWBGs/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Apigene\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#626AE9\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.apigene.ai/api-reference/api-authentication\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/api-authentication.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.apigene.ai/#organization\",\"name\":\"Apigene\",\"url\":\"https://docs.apigene.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/apigene/uc-Z_RqMQ0uSxRnH/logo/logo.png?fit=max\u0026auto=format\u0026n=uc-Z_RqMQ0uSxRnH\u0026q=85\u0026s=d3f920afe0cff7053c8f87cd7a3666b7\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.apigene.ai#website\",\"name\":\"Apigene\",\"url\":\"https://docs.apigene.ai\",\"publisher\":{\"@id\":\"https://docs.apigene.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.apigene.ai/api-reference/api-authentication#webpage\",\"url\":\"https://docs.apigene.ai/api-reference/api-authentication\",\"name\":\"API Authentication\",\"description\":\"Start making requests to the Apigene API\",\"dateModified\":\"2025-12-29T15:26:03.212Z\",\"isPartOf\":{\"@id\":\"https://docs.apigene.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.apigene.ai/api-reference/api-authentication#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.apigene.ai/api-reference/api-authentication#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Documentation\",\"item\":\"https://docs.apigene.ai/api-reference\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API Authentication\",\"item\":\"https://docs.apigene.ai/api-reference/api-authentication\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.apigene.ai/api-reference/api-authentication#article\",\"headline\":\"API Authentication\",\"name\":\"API Authentication\",\"description\":\"Start making requests to the Apigene API\",\"url\":\"https://docs.apigene.ai/api-reference/api-authentication\",\"mainEntityOfPage\":{\"@id\":\"https://docs.apigene.ai/api-reference/api-authentication#webpage\"},\"dateModified\":\"2025-12-29T15:26:03.212Z\",\"publisher\":{\"@id\":\"https://docs.apigene.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.apigene.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Apigene\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Apigene\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/api-authentication.md","siteName":"Apigene","nav":{"global":null,"tabs":[{"tab":"User Guide","pages":[{"title":"User Guide","href":""}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"API Reference","description":"Apigene REST API reference documentation","href":"/api-reference"},{"title":"API Authentication","href":"/api-reference/api-authentication"}]},{"group":"API Specs","pages":[{"openapi":"get /api/specs","title":"Specs List","description":"List all available specs.\n\nRetrieves a list of all available spec names or detailed information about each spec.\nsecurity_info secret values are never returned on list responses; the\nsecurity_info field is omitted entirely. Use\nGET /spec/{api_name}?include_security=true (org admin) to load credentials.\nsecurity_info_configured and shared_security_info are retained for readiness UIs.\n\nParameters:\n- current_org (AuthOrg): The current org making the request. Retrieved using dependency injection.\n- include_all (bool, optional): Flag to include detailed information about each spec. Defaults to False.\n\nReturns:\n- Union[List[str], List[SpecInfo]]: A list of spec names or detailed information about each spec.\n\nRaises:\n- HTTPException(500): If an error occurs while fetching the specs.","href":"/api-reference/spec/specs-list"},{"openapi":"post /api/spec_from_file/","title":"Spec Create From File","href":"/api-reference/spec/spec-create-from-file"},{"openapi":"post /api/spec_from_url/","title":"Spec Create From Url","href":"/api-reference/spec/spec-create-from-url"},{"openapi":"post /api/spec_from_wsdl/","title":"Spec Create From Wsdl","href":"/api-reference/spec/spec-create-from-wsdl"},{"openapi":"post /api/wsdl_ports/","title":"Wsdl List Ports","href":"/api-reference/spec/spec-wsdl-ports"},{"openapi":"get /api/spec/{api_name}","title":"Spec Get","href":"/api-reference/spec/spec-get"},{"openapi":"delete /api/spec/{api_name}","title":"Spec Delete","href":"/api-reference/spec/spec-delete"},{"openapi":"get /api/spec/{api_name}/agentic_metadata","title":"Spec Get Agentic Metadata","href":"/api-reference/spec/spec-get-agentic-metadata"},{"openapi":"get /api/spec/{api_name}/agentic_metadata_common_parameteres","title":"Spec Get Agentic Metadata Common Parameteres","href":"/api-reference/spec/spec-get-agentic-metadata-common-parameteres"},{"openapi":"get /api/spec/{api_name}/available_scopes","title":"Spec Scopes","href":"/api-reference/spec/spec-scopes"},{"openapi":"post /api/spec/{api_name}/clone","title":"Spec Clone","href":"/api-reference/spec/spec-clone"},{"openapi":"get /api/spec/{api_name}/export","title":"Export provisioned spec","href":"/api-reference/spec/spec-export"},{"openapi":"post /api/spec/import","title":"Import provisioned spec","href":"/api-reference/spec/spec-import"},{"openapi":"post /api/spec/{api_name}/create_agentic_metadata","title":"Spec Create Agentic Metadata","href":"/api-reference/spec/spec-create-agentic-metadata"},{"openapi":"get /api/spec/{api_name}/insigths","title":"Spec Insights","href":"/api-reference/spec/spec-insights"},{"openapi":"post /api/spec/{api_name}/operation_examples","title":"Spec Operation Examples","href":"/api-reference/spec/spec-operation-examples"},{"openapi":"post /api/spec/{api_name}/operation_schema","title":"Spec Operation Schema","href":"/api-reference/spec/spec-operation-schema"},{"openapi":"get /api/spec/{api_name}/operations","title":"Spec Operations","href":"/api-reference/spec/spec-operations"},{"openapi":"post /api/spec/{api_name}/reindex","title":"Spec Reindex","href":"/api-reference/spec/spec-reindex"},{"openapi":"get /api/spec/{api_name}/reindex_status/active","title":"Spec Reindex Status Active","href":"/api-reference/spec/spec-reindex-status-active"},{"openapi":"get /api/spec/{api_name}/schema","title":"Spec Get Schema","href":"/api-reference/spec/spec-get-schema"},{"openapi":"get /api/spec/{api_name}/shared-security","title":"Spec Get Shared Security","href":"/api-reference/spec/spec-get-shared-security"},{"openapi":"put /api/spec/{api_name}/shared-security","title":"Spec Set Shared Security","href":"/api-reference/spec/spec-set-shared-security"},{"openapi":"post /api/spec/{api_name}/summary","title":"Spec Summary","href":"/api-reference/spec/spec-summary"},{"openapi":"post /api/spec/{api_name}/update","title":"Spec Update","href":"/api-reference/spec/spec-update"},{"openapi":"put /api/spec/{api_name}/update_agentic_metadata","title":"Spec Update Agentic Metadata","href":"/api-reference/spec/spec-update-agentic-metadata"},{"openapi":"post /api/spec/{api_name}/use_cases","title":"Spec Use Cases","href":"/api-reference/spec/spec-use-cases"},{"openapi":"get /api/spec/{task_id}/reindex_status","title":"Spec Reindex Status","href":"/api-reference/spec/spec-reindex-status"}]},{"group":"Interaction","pages":[{"openapi":"post /api/interaction/activity-timeline","title":"Get Activity Timeline","href":"/api-reference/interaction/get-activity-timeline"},{"openapi":"post /api/interaction/create","title":"Interaction Create","href":"/api-reference/interaction/interaction-create"},{"openapi":"post /api/interaction/list","title":"List Interactions","href":"/api-reference/interaction/list-interactions"},{"openapi":"post /api/interaction/record-mcp-tool","title":"Record Mcp Tool","href":"/api-reference/interaction/interaction-record-mcp-tool"},{"openapi":"post /api/interaction/summary","title":"Get Summary","href":"/api-reference/interaction/get-summary"},{"openapi":"get /api/interaction/insights/{app_name}","title":"Get App Insights","href":"/api-reference/interaction/get-app-insights"},{"openapi":"get /api/interaction/{interaction_id}","title":"Get Interaction Detail","href":"/api-reference/interaction/get-interaction-detail"}]},{"group":"MCP","pages":[{"openapi":"get /api/mcp/app_get_action_details","title":"App Get Action Details","href":"/api-reference/mcp/mcp-app-get-action-details"},{"openapi":"get /api/mcp/app_get_actions","title":"App Get Actions","href":"/api-reference/mcp/mcp-app-get-actions"},{"openapi":"get /api/mcp/appconfig","title":"Get App Config","href":"/api-reference/mcp/mcp-appconfig"},{"openapi":"get /api/mcp/apps_list","title":"Apps List","href":"/api-reference/mcp/mcp-apps-list"},{"openapi":"get /api/mcp/apps_search_actions","title":"Apps Search Actions","href":"/api-reference/mcp/mcp-apps-search-actions"},{"openapi":"get /api/mcp/get_context","title":"Get Context","href":"/api-reference/mcp/mcp-get-context"},{"openapi":"get /api/mcp/get_instructions","title":"Get Instructions","href":"/api-reference/mcp/mcp-get-instructions"},{"openapi":"get /api/mcp/get_skill","title":"Get Skill","href":"/api-reference/mcp/get-skill"},{"openapi":"get /api/mcp/get_skill_content","title":"Get Skill Content","href":"/api-reference/mcp/get-skill-content"},{"openapi":"get /api/mcp/list_contexts","title":"List Contexts","href":"/api-reference/mcp/mcp-list-contexts"},{"openapi":"get /api/mcp/list_skills","title":"List Skills","href":"/api-reference/mcp/list-skills"},{"openapi":"post /api/mcp/app_execute_action","title":"App Execute Action","href":"/api-reference/mcp/mcp-app-execute-action"},{"openapi":"post /api/mcp/create_skill","title":"Create Skill","href":"/api-reference/mcp/mcp-create-skill"}]},{"group":"MCP Server","pages":[{"openapi":"get /api/mcp-server/list","title":"Mcp Servers List","href":"/api-reference/mcp-server/mcp-servers-list"},{"openapi":"post /api/mcp-server/create","title":"Mcp Server Create","href":"/api-reference/mcp-server/mcp-server-create"},{"openapi":"post /api/mcp-server/create_from_api","title":"Mcp Create From Api","href":"/api-reference/mcp-server/mcp-create-from-api"},{"openapi":"delete /api/mcp-server/delete/{server_id}","title":"Mcp Server Delete","href":"/api-reference/mcp-server/mcp-server-delete"},{"openapi":"get /api/mcp-server/get/{server_id}","title":"Mcp Server Get","href":"/api-reference/mcp-server/mcp-server-get"},{"openapi":"post /api/mcp-server/refresh-tools/{server_id}","title":"Mcp Server Refresh Tools","href":"/api-reference/mcp-server/mcp-server-refresh-tools"},{"openapi":"post /api/mcp-server/login/{server_id}","title":"Mcp Server Login","href":"/api-reference/mcp-server/mcp-server-login"},{"openapi":"post /api/mcp-server/logout/{server_id}","title":"Mcp Server Logout","href":"/api-reference/mcp-server/mcp-server-logout"},{"openapi":"post /api/mcp-server/update-tools-cache/{server_id}","title":"Mcp Server Update Tools Cache","href":"/api-reference/mcp-server/mcp-server-update-tools-cache"},{"openapi":"put /api/mcp-server/update/{server_id}","title":"Mcp Server Update","href":"/api-reference/mcp-server/mcp-server-update"}]},{"group":"Official MCP Server","pages":[{"openapi":"get /api/official-mcp-server","title":"Official Mcp Server List","href":"/api-reference/official-mcp-server/official-mcp-server-list"},{"openapi":"post /api/official-mcp-server","title":"Official Mcp Server Create","href":"/api-reference/official-mcp-server/official-mcp-server-create"},{"openapi":"get /api/official-mcp-server/{server_id}","title":"Official Mcp Server Get","href":"/api-reference/official-mcp-server/official-mcp-server-get"},{"openapi":"put /api/official-mcp-server/{server_id}","title":"Official Mcp Server Update","href":"/api-reference/official-mcp-server/official-mcp-server-update"},{"openapi":"delete /api/official-mcp-server/{server_id}","title":"Official Mcp Server Delete","href":"/api-reference/official-mcp-server/official-mcp-server-delete"}]},{"group":"Agent","pages":[{"openapi":"get /api/agent/get_by_name","title":"Agent Get By Name","href":"/api-reference/agent/agent-get-by-name"},{"openapi":"get /api/agent/list","title":"Agents List","href":"/api-reference/agent/agents-list"},{"openapi":"post /api/agent/create","title":"Agent Create","href":"/api-reference/agent/agent-create"},{"openapi":"delete /api/agent/delete/{agent_id}","title":"Agent Delete","href":"/api-reference/agent/agent-delete"},{"openapi":"get /api/agent/get/{agent_id}","title":"Agent Get","href":"/api-reference/agent/agent-get"},{"openapi":"put /api/agent/update/{agent_id}","title":"Agent Update","href":"/api-reference/agent/agent-update"}]},{"group":"Skill","pages":[{"openapi":"get /api/skill","title":"Skill List","href":"/api-reference/skill/skill-list"},{"openapi":"get /api/skill/search","title":"Skill Search","href":"/api-reference/skill/skill-search"},{"openapi":"post /api/skill","title":"Skill Create","href":"/api-reference/skill/skill-create"},{"openapi":"post /api/skill/upload","title":"Skill Upload","href":"/api-reference/skill/skill-upload"},{"openapi":"post /api/skill/validate","title":"Skill Validate","href":"/api-reference/skill/skill-validate"},{"openapi":"get /api/skill/{skill_id}","title":"Skill Get","href":"/api-reference/skill/skill-get"},{"openapi":"put /api/skill/{skill_id}","title":"Skill Update","href":"/api-reference/skill/skill-update"},{"openapi":"delete /api/skill/{skill_id}","title":"Skill Delete","href":"/api-reference/skill/skill-delete"},{"openapi":"get /api/skill/{skill_id}/file","title":"Skill Get File","href":"/api-reference/skill/skill-get-file"}]},{"group":"Workflows","pages":[{"openapi":"get /api/workflows/{agent_name}","title":"List workflows for an agent","href":"/api-reference/workflow/workflow-list"},{"openapi":"post /api/workflows/{agent_name}","title":"Create a workflow for an agent","href":"/api-reference/workflow/workflow-create"},{"openapi":"post /api/workflows/runs/list","title":"List workflow run history (org-wide, summary projection)","href":"/api-reference/workflow/workflow-runs-history-list"},{"openapi":"get /api/workflows/runs/{run_id}","title":"Get a workflow run by id (full detail, no checkpoint)","href":"/api-reference/workflow/workflow-run-history-get"},{"openapi":"post /api/workflows/runs/activity-timeline","title":"Workflow run activity histogram by status","href":"/api-reference/workflow/workflow-runs-activity-timeline"},{"openapi":"get /api/workflows/{agent_name}/runs/{run_id}","title":"Get a persisted HITL workflow run by id","href":"/api-reference/workflow/workflow-run-get"},{"openapi":"post /api/workflows/{agent_name}/runs/{run_id}/resume","title":"Resume a waiting_human workflow run (starter only)","href":"/api-reference/workflow/workflow-run-resume"},{"openapi":"get /api/workflows/{agent_name}/{workflow_id}","title":"Get a workflow by id","href":"/api-reference/workflow/workflow-get"},{"openapi":"put /api/workflows/{agent_name}/{workflow_id}","title":"Update a workflow","href":"/api-reference/workflow/workflow-update"},{"openapi":"delete /api/workflows/{agent_name}/{workflow_id}","title":"Delete a workflow","href":"/api-reference/workflow/workflow-delete"},{"openapi":"post /api/workflows/{agent_name}/{workflow_id}/run","title":"Run a stored workflow by id","href":"/api-reference/workflow/workflow-run"},{"openapi":"get /api/workflows/{agent_name}/{workflow_id}/runs","title":"List runs for a workflow","href":"/api-reference/workflow/workflow-runs-list"}]},{"group":"Task","pages":[{"openapi":"get /api/task","title":"Task List","href":"/api-reference/task/task-list"},{"openapi":"post /api/task","title":"Task Create","href":"/api-reference/task/task-create"},{"openapi":"post /api/task/generate","title":"Task Generate","href":"/api-reference/task/task-generate"},{"openapi":"get /api/task/{task_id}","title":"Task Get","href":"/api-reference/task/task-get"},{"openapi":"put /api/task/{task_id}","title":"Task Update","href":"/api-reference/task/task-update"},{"openapi":"delete /api/task/{task_id}","title":"Task Delete","href":"/api-reference/task/task-delete"},{"openapi":"post /api/task/{task_id}/background_run","title":"Task Background Run","href":"/api-reference/task/task-background-run"},{"openapi":"get /api/task/{task_id}/scheduled_runs_results","title":"Task Get Scheduled Runs Results","href":"/api-reference/task/task-get-scheduled-runs-results"}]},{"group":"Context","pages":[{"openapi":"get /api/context","title":"Context List","href":"/api-reference/context/context-list"},{"openapi":"get /api/context/search","title":"Context Search","href":"/api-reference/context/context-search"},{"openapi":"post /api/context","title":"Context Create","href":"/api-reference/context/context-create"},{"openapi":"get /api/context/{context_id}","title":"Context Get","href":"/api-reference/context/context-get"},{"openapi":"put /api/context/{context_id}","title":"Context Update","href":"/api-reference/context/context-update"},{"openapi":"delete /api/context/{context_id}","title":"Context Delete","href":"/api-reference/context/context-delete"}]},{"group":"Context Type","pages":[{"openapi":"get /api/context-type","title":"Context Type List","href":"/api-reference/context-type/context-type-list"},{"openapi":"get /api/context-type/defaults","title":"Context Type List Defaults","href":"/api-reference/context-type/context-type-list-defaults"},{"openapi":"post /api/context-type","title":"Context Type Create","href":"/api-reference/context-type/context-type-create"},{"openapi":"get /api/context-type/{context_type_id}","title":"Context Type Get","href":"/api-reference/context-type/context-type-get"},{"openapi":"put /api/context-type/{context_type_id}","title":"Context Type Update","href":"/api-reference/context-type/context-type-update"},{"openapi":"delete /api/context-type/{context_type_id}","title":"Context Type Delete","href":"/api-reference/context-type/context-type-delete"}]},{"group":"GPT","pages":[{"openapi":"get /api/gpts/list","title":"Gpts List","href":"/api-reference/gpt/gpts-list"},{"openapi":"post /api/gpt/create","title":"Gpt Create","href":"/api-reference/gpt/gpt-create"},{"openapi":"post /api/gpt/create_all","title":"Gpt Create All","href":"/api-reference/gpt/gpt-create-all"},{"openapi":"post /api/gpt/create_from_api","title":"Gpt Create From Api","href":"/api-reference/gpt/gpt-create-from-api"},{"openapi":"post /api/gpt/update","title":"Gpt Update","href":"/api-reference/gpt/gpt-update"},{"openapi":"get /api/gpt/redirect/{token}","title":"redirect the shorten url to full authorization url","href":"/api-reference/gpt/gpt-redirect-to-authorization"},{"openapi":"delete /api/gpt/{genai_app}/delete","title":"Gpt Delete","href":"/api-reference/gpt/gpt-delete"},{"openapi":"post /api/gpt/{genai_app}/generate_token","title":"Gpt Generate Token","href":"/api-reference/gpt/gpt-generate-token"},{"openapi":"get /api/gpt/{genai_app}/get","title":"Retrieve Custom GPT Details","href":"/api-reference/gpt/gpt-get"},{"openapi":"get /api/gpt/{genai_app}/read_token","title":"Gpt Read Token","href":"/api-reference/gpt/gpt-read-token-id"},{"openapi":"post /api/gpt/{genai_app}/revoke_token","title":"Gpt Revoke Token","href":"/api-reference/gpt/gpt-revoke-token"}]},{"group":"GPT Public","pages":[{"openapi":"get /api/gpt_public/app_get_actions","title":"App Get Actions","href":"/api-reference/gpt-public/app-get-actions"},{"openapi":"get /api/gpt_public/apps_list","title":"Apps List","href":"/api-reference/gpt-public/apps-list"},{"openapi":"get /api/gpt_public/apps_search_actions","title":"Apps Search Actions","href":"/api-reference/gpt-public/apps-search-actions"},{"openapi":"get /api/openapi","title":"Get Gpt Public Openapi","href":"/api-reference/gpt-public/get-gpt-public-openapi"},{"openapi":"post /api/gpt_public/app_execute_action","title":"App Execute Action","href":"/api-reference/gpt-public/app-execute-action"}]},{"group":"UI Templates","pages":[{"openapi":"get /api/ui-templates","title":"List all APIs with their templates","href":"/api-reference/ui-templates/ui-templates-list-all"},{"openapi":"get /api/ui-templates/{api_name}","title":"List all UI templates for an API","href":"/api-reference/ui-templates/ui-templates-list-by-api"},{"openapi":"get /api/ui-templates/{api_name}/operations/{operation_id}","title":"List UI templates for an operation","href":"/api-reference/ui-templates/ui-templates-list-by-operation"},{"openapi":"get /api/ui-templates/{api_name}/{template_id}","title":"Get a UI template by ID","href":"/api-reference/ui-templates/ui-template-get"},{"openapi":"put /api/ui-templates/{api_name}/{template_id}","title":"Create or update a UI template","href":"/api-reference/ui-templates/ui-template-upsert"},{"openapi":"delete /api/ui-templates/{api_name}/{template_id}","title":"Delete a UI template","href":"/api-reference/ui-templates/ui-template-delete"},{"openapi":"put /api/ui-templates/{api_name}/{template_id}/set-default","title":"Set a UI template as the default for its operation","href":"/api-reference/ui-templates/ui-template-set-default"}]},{"group":"Generative UI Templates","pages":[{"openapi":"get /api/generative-ui-templates/{agent_name}","title":"List generative UI templates for an agent","href":"/api-reference/generative-ui-templates/generative-ui-template-list"},{"openapi":"post /api/generative-ui-templates/{agent_name}","title":"Create a generative UI template for an agent","href":"/api-reference/generative-ui-templates/generative-ui-template-create"},{"openapi":"get /api/generative-ui-templates/{agent_name}/{template_id}","title":"Get a generative UI template by id","href":"/api-reference/generative-ui-templates/generative-ui-template-get"},{"openapi":"put /api/generative-ui-templates/{agent_name}/{template_id}","title":"Update a generative UI template","href":"/api-reference/generative-ui-templates/generative-ui-template-update"},{"openapi":"delete /api/generative-ui-templates/{agent_name}/{template_id}","title":"Delete a generative UI template","href":"/api-reference/generative-ui-templates/generative-ui-template-delete"}]},{"group":"GitHub Sync","pages":[{"openapi":"post /api/ui-templates/github/connect/{api_name}/{template_id}","title":"Connect template to GitHub repository","href":"/api-reference/github-sync/github-sync-connect"},{"openapi":"delete /api/ui-templates/github/disconnect/{api_name}/{template_id}","title":"Disconnect template from GitHub","href":"/api-reference/github-sync/github-sync-disconnect"},{"openapi":"get /api/ui-templates/github/history/{api_name}/{template_id}","title":"Get GitHub sync history","href":"/api-reference/github-sync/github-sync-history"},{"openapi":"get /api/ui-templates/github/status/{api_name}/{template_id}","title":"Get GitHub sync status","href":"/api-reference/github-sync/github-sync-status"},{"openapi":"post /api/ui-templates/github/sync/{api_name}/{template_id}","title":"Sync template with GitHub","href":"/api-reference/github-sync/github-sync"}]},{"group":"Audit","pages":[{"openapi":"get /api/audit/audit-logs","title":"Get Audit Logs","href":"/api-reference/audit/audit-logs"},{"openapi":"get /api/audit/audit-logs/resource/{resource_type}/{resource_id}","title":"Get Resource Audit History","href":"/api-reference/audit/resource-audit-history"}]},{"group":"Organization","pages":[{"openapi":"get /api/org/settings","title":"Retrieve Organization settings","href":"/api-reference/org/retrieve-organization-settings"},{"openapi":"post /api/org/add_user/","title":"Org Add User","href":"/api-reference/org/org-add-user"},{"openapi":"post /api/org/create/","title":"Org Create","href":"/api-reference/org/org-create"},{"openapi":"post /api/org/settings/update","title":"Org Settings Update","href":"/api-reference/org/org-settings-update"},{"openapi":"post /api/org/apply_license","title":"Apply OnPrem License","href":"/api-reference/org/org-apply-license"},{"openapi":"delete /api/org/delete/{org_name}","title":"Org Delete","href":"/api-reference/org/org-delete"},{"openapi":"get /api/org/details/{org_name}","title":"Org Get Details","href":"/api-reference/org/org-get-details"},{"openapi":"delete /api/org/remove_user/{username}","title":"Org Remove User","href":"/api-reference/org/org-remove-user"},{"openapi":"post /api/org/{org_name}/generate_token","title":"Org Generate Token","href":"/api-reference/org/org-generate-token"}]},{"group":"User","pages":[{"openapi":"get /api/user/me","title":"User Me","href":"/api-reference/user/user-me"},{"openapi":"get /api/user/settings","title":"Retrieve User settings","href":"/api-reference/user/retrieve-user-settings"},{"openapi":"post /api/user/settings/update","title":"Settings Update","href":"/api-reference/user/settings-update"},{"openapi":"post /api/user/signup/","title":"User Signup","href":"/api-reference/user/user-signup"},{"openapi":"post /api/user/token","title":"User Token","href":"/api-reference/user/user-token"}]},{"group":"System","pages":[{"openapi":"get /api/health","title":"Health Check","href":"/api-reference/system/health-check"},{"openapi":"get /api/platform/version","title":"Get Platform Version Endpoint","href":"/api-reference/system/get-platform-version-endpoint"},{"openapi":"get /api/version","title":"Get Version","href":"/api-reference/system/get-version"}]},{"group":"Cache","pages":[{"openapi":"get /api/cache/key","title":"Get Cache Key","href":"/api-reference/cache/get-cache-key"},{"openapi":"get /api/cache/keys","title":"Get Tenant Cache Keys","href":"/api-reference/cache/get-tenant-cache-keys"},{"openapi":"post /api/cache_clear","title":"Clear Tenant Cache","href":"/api-reference/cache/clear-tenant-cache"},{"openapi":"delete /api/cache/key","title":"Delete Cache Key","href":"/api-reference/cache/delete-cache-key"}]}]}]},"basePath":"","title":"API Authentication - Apigene","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":[],"chunks":[]}