All of the API endpoints are protected by an API Key. You can purcahse one from our patreon page.
The API Key should be passed as a header with the key Authorization and the value <API_KEY>.
Authorization: <API_KEY>
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Miona Docs","colors":{"primary":"#a855f7","light":"#c084fc","dark":"#a855f7"},"logo":{"light":"https://mintcdn.com/miona/T-Ii_MvXcsOpaOcQ/images/logo/light.svg?fit=max\u0026auto=format\u0026n=T-Ii_MvXcsOpaOcQ\u0026q=85\u0026s=ec34a52afc1449e90e351ca5604a7dbe","dark":"https://mintcdn.com/miona/T-Ii_MvXcsOpaOcQ/images/logo/dark.svg?fit=max\u0026auto=format\u0026n=T-Ii_MvXcsOpaOcQ\u0026q=85\u0026s=d784e4e03be12cbb0916abc9a8c05948"},"favicon":"https://mintcdn.com/miona/T-Ii_MvXcsOpaOcQ/images/logo.png?fit=max\u0026auto=format\u0026n=T-Ii_MvXcsOpaOcQ\u0026q=85\u0026s=cf414c3c9e3b04770c92a97c6d6026ca","navbar":{"links":[{"href":"https://discord.gg/52nsdaGpDx","label":"Support"}],"primary":{"type":"button","label":"Website","href":"https://miona.bot"}},"footer":{"socials":{"discord":"https://discord.gg/52nsdaGpDx","github":"https://github.com/miona-cc"}},"errors":{"404":{"redirect":false,"title":"Oops! Page Not Found","description":"Looks like this page vanished faster than a deleted message. Try using the navigation menu or head back home."}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Support","icon":"discord","href":"https://discord.gg/52nsdaGpDx"},{"anchor":"Embed Builder","icon":"newspaper","href":"https://messages.miona.bot"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"miona","hasAudioNarration":false,"actualSubdomain":"miona","customDomains":["docs.miona.bot"],"gitSource":{"type":"github","owner":"miona-cc","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae922f1d4316d4cae576b3c:success","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"Documentation","count":21},{"language":"default","tag":"API Reference","count":5},{"language":"default","tag":"Greeting","count":5},{"language":"default","tag":"Endpoint","count":4},{"language":"default","tag":"Roles","count":4},{"language":"default","tag":"AutoPost","count":3},{"language":"default","tag":"Get Started","count":3},{"language":"default","tag":"More Features","count":3},{"language":"default","tag":"Tickets","count":3},{"language":"default","tag":"API Documentation","count":1}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/introduction","slug":"/api-reference/introduction","pageMetadata":{"title":"Introduction","description":"An overview of the Miona API","href":"/api-reference/introduction"},"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: \"An overview of the Miona 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`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock,Heading}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`authorization`,children:`Authorization`}),`\n`,_jsxs(_components.p,{children:[`All of the API endpoints are protected by an API Key. You can purcahse one from our `,_jsx(_components.a,{href:`https://miona.bot/patreon`,children:`patreon page.`}),`\nThe API Key should be passed as a header with the key `,_jsx(_components.code,{children:`Authorization`}),` and the value `,_jsx(_components.code,{children:`\u003cAPI_KEY>`}),`.`]}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Authorization: \u003cAPI_KEY>`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})]})}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":"Introduction","description":"An overview of the Miona API","href":"/api-reference/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Authorization","slug":"authorization","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"miona","siteName":"Miona Docs","title":"Introduction - Miona Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-11-21T21:20:17.769Z","originalFileLocation":"api-reference/introduction.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=\"An overview of the Miona API\">\u003cmeta data-mint-head name=\"application-name\" content=\"Miona 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/miona/pH53CNvwwfZDhGtN/_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/miona/pH53CNvwwfZDhGtN/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/miona/pH53CNvwwfZDhGtN/_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/miona/pH53CNvwwfZDhGtN/_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/miona/pH53CNvwwfZDhGtN/_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/miona/pH53CNvwwfZDhGtN/_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/miona/pH53CNvwwfZDhGtN/_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/miona/pH53CNvwwfZDhGtN/_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/miona/pH53CNvwwfZDhGtN/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Introduction - Miona Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"An overview of the Miona API\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Miona Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.miona.bot/api-reference/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://miona.mintlify.site/_mintlify/api/og/v2?division=API+Documentation\u0026amp;title=Introduction\u0026amp;description=An+overview+of+the+Miona+API\u0026amp;theme=95525a09ad3a11982f5e08d0\u0026amp;signature=628a9f94c85a43f6282dbb522a8f283329314b598ce62401cc9fcf37aea7d54d\">\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=\"Introduction - Miona Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"An overview of the Miona API\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://miona.mintlify.site/_mintlify/api/og/v2?division=API+Documentation\u0026amp;title=Introduction\u0026amp;description=An+overview+of+the+Miona+API\u0026amp;theme=95525a09ad3a11982f5e08d0\u0026amp;signature=628a9f94c85a43f6282dbb522a8f283329314b598ce62401cc9fcf37aea7d54d\">\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/miona/pH53CNvwwfZDhGtN/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Miona Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#a855f7\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.miona.bot/api-reference/introduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/introduction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.miona.bot/#organization\",\"name\":\"Miona Docs\",\"url\":\"https://docs.miona.bot\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/miona/T-Ii_MvXcsOpaOcQ/images/logo/light.svg?fit=max\u0026auto=format\u0026n=T-Ii_MvXcsOpaOcQ\u0026q=85\u0026s=ec34a52afc1449e90e351ca5604a7dbe\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.miona.bot#website\",\"name\":\"Miona Docs\",\"url\":\"https://docs.miona.bot\",\"publisher\":{\"@id\":\"https://docs.miona.bot/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.miona.bot/api-reference/introduction#webpage\",\"url\":\"https://docs.miona.bot/api-reference/introduction\",\"name\":\"Introduction\",\"description\":\"An overview of the Miona API\",\"dateModified\":\"2025-11-21T21:20:17.769Z\",\"isPartOf\":{\"@id\":\"https://docs.miona.bot#website\"},\"breadcrumb\":{\"@id\":\"https://docs.miona.bot/api-reference/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.miona.bot/api-reference/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Miona Docs\",\"item\":\"https://docs.miona.bot\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Introduction\",\"item\":\"https://docs.miona.bot/api-reference/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.miona.bot/api-reference/introduction#article\",\"headline\":\"Introduction\",\"name\":\"Introduction\",\"description\":\"An overview of the Miona API\",\"url\":\"https://docs.miona.bot/api-reference/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://docs.miona.bot/api-reference/introduction#webpage\"},\"dateModified\":\"2025-11-21T21:20:17.769Z\",\"publisher\":{\"@id\":\"https://docs.miona.bot/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.miona.bot#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Miona Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Miona Docs","nav":{"global":{"anchors":[{"anchor":"Support","icon":"discord","href":"https://discord.gg/52nsdaGpDx"},{"anchor":"Embed Builder","icon":"newspaper","href":"https://messages.miona.bot"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"}]},{"group":"Endpoint","pages":[{"title":"Get Image Counts","openapi":"GET /count","description":null,"href":"/api-reference/endpoint/count"},{"title":"Get PFP","openapi":"GET /image/{id}","href":"/api-reference/endpoint/image"},{"title":"Get Random PFP","openapi":"GET /random/{type}","href":"/api-reference/endpoint/random"},{"title":"Get Matching PFPs","openapi":"GET /match/{type}","href":"/api-reference/endpoint/match"}]}]}]},"basePath":"","title":"Introduction - Miona Docs","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":[],"chunks":[]}