Interface description: Use X-Api-Key to retrieve call counts grouped by quota group for the API Key associated with the current credential. If period is omitted, the current UTC calendar month is returned. Pass YYYY-MM to query one specific previous month per request.
This endpoint returns quota usage, not successful publication counts, AI tokens, or detailed credit consumption. If no usage was recorded for a month, used is 0 for every group. Only the current API Key can be queried; arbitrary keys cannot be selected through request parameters.
GET
/
api
/
api-key
/
current
/
usage
API Key usage
curl --request GET \ --url https://aitoearn.cn/api/api-key/current/usage \ --header 'X-Api-Key: <api-key>'
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"AiToEarn Open Platform","description":"AiToEarn 开放平台文档","colors":{"primary":"#A989FF","light":"#B8A1FF","dark":"#8B63F7"},"logo":{"light":"https://mintcdn.com/aitoearn/kGrHrvymy8zxbAqE/assets/logo/logo-light.png?fit=max\u0026auto=format\u0026n=kGrHrvymy8zxbAqE\u0026q=85\u0026s=9328b13457837280719d93e4b04a2065","dark":"https://mintcdn.com/aitoearn/kGrHrvymy8zxbAqE/assets/logo/logo-dark.png?fit=max\u0026auto=format\u0026n=kGrHrvymy8zxbAqE\u0026q=85\u0026s=f1f0a9eeaa59400547ba354f99441d91","href":"/en/home"},"favicon":"https://mintcdn.com/aitoearn/kccGWRJU0qczBwCa/favicon.svg?fit=max\u0026auto=format\u0026n=kccGWRJU0qczBwCa\u0026q=85\u0026s=d3bd4ea8af9d51e155c170481f8c3e9a","api":{"params":{"expanded":"all"},"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","python","javascript","go"],"prefill":true,"autogenerate":true},"url":"full"},"appearance":{"default":"system","strict":false},"footer":{"socials":{"github":"https://github.com/yikart/AiToEarn"}},"icons":{"library":"lucide"},"errors":{"404":{"redirect":false,"title":"页面未找到","description":"没有找到对应文档。你可以返回[首页](/zh/home),或查看[API Key 获取教程](/zh/use/api-key)。"}},"contextual":{"options":["copy","view","download-spec"],"display":"header"},"interaction":{"drilldown":false},"metadata":{"timestamp":true},"styling":{"latex":false},"navigation":{"languages":[{"language":"zh","default":true,"navbar":{"links":[{"href":"https://github.com/yikart/AiToEarn","label":"GitHub","type":"github"}],"primary":{"type":"button","label":"前往 AiToEarn","href":"https://aitoearn.cn/"}},"href":"zh/use/introduction"},{"language":"en","navbar":{"links":[{"href":"https://github.com/yikart/AiToEarn","label":"GitHub","type":"github"}],"primary":{"type":"button","label":"Go to AiToEarn","href":"https://aitoearn.ai/"}},"href":"en/use"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"aitoearn","hasAudioNarration":false,"actualSubdomain":"aitoearn","customDomains":["docs.aitoearn.ai"],"gitSource":{"type":"github","owner":"yikart","repo":"aitoearn-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6afbf7b86f7f9a87fc093816","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"en","tag":"API Docs","count":80},{"language":"en","tag":"Endpoint Groups","count":80},{"language":"zh","tag":"API 文档","count":80},{"language":"zh","tag":"接口分组","count":80},{"language":"en","tag":"Help Docs","count":31},{"language":"zh","tag":"帮助文档","count":31},{"language":"en","tag":"AI Services/Video Generation","count":18},{"language":"zh","tag":"AI 服务/视频生成","count":18},{"language":"en","tag":"Social Platforms","count":16},{"language":"zh","tag":"社交平台","count":16},{"language":"en","tag":"Channel Management/Publishing","count":14},{"language":"zh","tag":"渠道管理/内容发布","count":14},{"language":"en","tag":"Use","count":13},{"language":"zh","tag":"使用","count":13},{"language":"en","tag":"Virtual portrait assets","count":10},{"language":"zh","tag":"虚拟人像素材","count":10},{"language":"en","tag":"AI Services/Agent","count":9},{"language":"en","tag":"AI Services/Image Generation","count":9},{"language":"zh","tag":"AI 服务/Agent","count":9},{"language":"zh","tag":"AI 服务/图像生成","count":9}]},"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":"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":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"mintlify-overrides/home-nav-state.css","content":"html[data-current-path=\"/home\"] nav[aria-label=\"Main\"] a,html[data-current-path=\"/zh/home\"] nav[aria-label=\"Main\"] a,html[data-current-path=\"/en/home\"] nav[aria-label=\"Main\"] a{color:rgb(var(--gray-600))!important;background:transparent none!important;box-shadow:none!important}html.dark[data-current-path=\"/home\"] nav[aria-label=\"Main\"] a,html.dark[data-current-path=\"/zh/home\"] nav[aria-label=\"Main\"] a,html.dark[data-current-path=\"/en/home\"] nav[aria-label=\"Main\"] a{color:rgb(var(--gray-400))!important;background:transparent none!important;box-shadow:none!important}html[data-current-path=\"/home\"] nav[aria-label=\"Main\"] a:hover,html[data-current-path=\"/zh/home\"] nav[aria-label=\"Main\"] a:hover,html[data-current-path=\"/en/home\"] nav[aria-label=\"Main\"] a:hover{color:rgb(var(--gray-900))!important;background:rgb(var(--gray-950) / 0.03)!important}html.dark[data-current-path=\"/home\"] nav[aria-label=\"Main\"] a:hover,html.dark[data-current-path=\"/zh/home\"] nav[aria-label=\"Main\"] a:hover,html.dark[data-current-path=\"/en/home\"] nav[aria-label=\"Main\"] a:hover{color:rgb(var(--gray-200))!important;background:rgb(255 255 255 / 0.03)!important}"},{"filePath":"mintlify-overrides/sidebar-width.css","content":"@media (min-width: 1024px){#sidebar-content{width:17rem}html:not([data-page-mode=\"custom\"]):has(#sidebar-content) #body-content{padding-left:17rem}html:not([data-page-mode=\"custom\"]):has(#sidebar-content) #content-area{margin-left:max(0px, calc(50vw - 348px - 17rem))}html:not([data-page-mode=\"custom\"]):has(#sidebar-content) #navigation-items{padding-left:0.75rem;padding-right:0.75rem}}"}],"page":{"pagePath":"en/api-reference/get-api-api-key-current-usage","slug":"/en/api-reference/get-api-api-key-current-usage","pageMetadata":{"title":"API Key usage","description":"Interface description: Use `X-Api-Key` to retrieve call counts grouped by quota group for the API Key associated with the current credential. If `period` is omitted, the current UTC calendar month is returned. Pass `YYYY-MM` to query one specific previous month per request.\n\nThis endpoint returns quota usage, not successful publication counts, AI tokens, or detailed credit consumption. If no usage was recorded for a month, `used` is 0 for every group. Only the current API Key can be queried; arbitrary keys cannot be selected through request parameters.","deprecated":null,"version":null,"sidebarTitle":"API Key usage","openapi":"/openapi/en/aitoearn.openapi.json get /api/api-key/current/usage","href":"/en/api-reference/get-api-api-key-current-usage","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Interface description: Use \", _jsx(_components.code, {\n children: \"X-Api-Key\"\n }), \" to retrieve call counts grouped by quota group for the API Key associated with the current credential. If \", _jsx(_components.code, {\n children: \"period\"\n }), \" is omitted, the current UTC calendar month is returned. Pass \", _jsx(_components.code, {\n children: \"YYYY-MM\"\n }), \" to query one specific previous month per request.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"This endpoint returns quota usage, not successful publication counts, AI tokens, or detailed credit consumption. If no usage was recorded for a month, \", _jsx(_components.code, {\n children: \"used\"\n }), \" is 0 for every group. Only the current API Key can be queried; arbitrary keys cannot be selected through request parameters.\"]\n })]\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":"API Key usage","description":"Interface description: Use `X-Api-Key` to retrieve call counts grouped by quota group for the API Key associated with the current credential. If `period` is omitted, the current UTC calendar month is returned. Pass `YYYY-MM` to query one specific previous month per request.\n\nThis endpoint returns quota usage, not successful publication counts, AI tokens, or detailed credit consumption. If no usage was recorded for a month, `used` is 0 for every group. Only the current API Key can be queried; arbitrary keys cannot be selected through request parameters.","deprecated":null,"version":null,"sidebarTitle":"API Key usage","openapi":"/openapi/en/aitoearn.openapi.json get /api/api-key/current/usage","href":"/en/api-reference/get-api-api-key-current-usage","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/aitoearn/839abaa7c36feed1/mintlify-overrides/home-nav-state.js","/_mintlify/custom/aitoearn/a22913f768343522/mintlify-overrides/hide-auth-request-headers.js"],"openApiReferenceData":{"operation":{"tags":["Account \u0026 Keys/API Key"],"summary":"API Key usage","description":"Interface description: Use `X-Api-Key` to retrieve call counts grouped by quota group for the API Key associated with the current credential. If `period` is omitted, the current UTC calendar month is returned. Pass `YYYY-MM` to query one specific previous month per request.\n\nThis endpoint returns quota usage, not successful publication counts, AI tokens, or detailed credit consumption. If no usage was recorded for a month, `used` is 0 for every group. Only the current API Key can be queried; arbitrary keys cannot be selected through request parameters.","operationId":"ApiKeyController_getCurrentUsage","parameters":["5333de3c-3217-4086-b454-898cdf8e1c03"],"responses":{"200":"9ff7986a-9ebb-4486-b726-784f7cb4482d"},"x-mint":{"href":"/en/api-reference/get-api-api-key-current-usage","metadata":{"title":"API Key usage","sidebarTitle":"API Key usage"}},"security":["8606ae1d-944e-441b-9462-d010f5f8411c"],"x-aitoearn-backend":{"controller":"D:/project/yika/aitoearn-monorepo/apps/aitoearn-server/src/core/api-key/api-key.controller.ts","controllerMethod":"getCurrentUsage","services":[{"property":"apiKeyService","type":"ApiKeyService","file":"D:/project/yika/aitoearn-monorepo/apps/aitoearn-server/src/core/api-key/api-key.service.ts","method":"getUsageByIdAndUserId"}],"responseCodes":[{"name":"ApiKeyInvalid","code":19000,"message":"Invalid API Key"}],"rawResponse":false},"method":"get","type":"path","servers":["57ad866f-30c3-4af4-80f2-039608641992","562e7ea2-2e59-4270-bd1a-d35df0de6fce"],"path":"/api/api-key/current/usage","baseUrlOptions":["https://aitoearn.cn","https://aitoearn.ai"],"title":"API Key usage","codeSamples":[],"requestExampleLanguages":["bash","python","javascript","go"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[],"urlDisplay":"full"},"dependencies":{"parameters":{"5333de3c-3217-4086-b454-898cdf8e1c03":{"name":"period","in":"query","required":false,"description":"Usage period in YYYY-MM format. Optional; defaults to the current UTC calendar month. Example: 2026-09.","schema":{"type":"string","pattern":"^\\d{4}-\\d{2}$","example":"2026-09","description":"Usage period in YYYY-MM format. Optional; defaults to the current UTC calendar month. Example: 2026-09.","isRequired":false,"uniqueKey":"","typeLabel":"string"},"example":"2026-09"}},"responses":{"9ff7986a-9ebb-4486-b726-784f7cb4482d":{"description":"The request has been processed by the service. Business success is determined by whether the response body has code === 0.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Business status code. 0 means success; non-zero means a business error.","isRequired":true,"uniqueKey":"code","typeLabel":"integer"},"message":{"type":"string","description":"Response message.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"data":{"type":"object","properties":{"period":{"type":"string","description":"Usage period in YYYY-MM format.","example":"2026-09","isRequired":true,"uniqueKey":"data.period","typeLabel":"string"},"apiKeyId":{"type":"string","description":"API Key ID。","isRequired":true,"uniqueKey":"data.apiKeyId","typeLabel":"string"},"userId":{"type":"string","description":"ID of the user who owns this API key.","isRequired":true,"uniqueKey":"data.userId","typeLabel":"string"},"groups":{"type":"array","description":"Usage grouped by quota group.","items":{"type":"object","properties":{"groupId":{"type":"string","description":"Quota group ID.","isRequired":true,"uniqueKey":"data.groups.items.[INDEX].groupId","typeLabel":"string"},"name":{"type":"string","description":"Quota group name.","isRequired":true,"uniqueKey":"data.groups.items.[INDEX].name","typeLabel":"string"},"used":{"type":"number","description":"Number of calls made in this period.","isRequired":true,"uniqueKey":"data.groups.items.[INDEX].used","typeLabel":"number"}},"required":["groupId","name","used"],"additionalProperties":false,"uniqueKey":"data.groups.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.groups","typeLabel":"object[]"}},"required":["period","apiKeyId","userId","groups"],"additionalProperties":false,"uniqueKey":"data","typeLabel":"object"},"requestId":{"type":"string","description":"Request ID.","uniqueKey":"requestId","typeLabel":"string"},"timestamp":{"type":"integer","description":"Error response timestamp in Unix milliseconds.","uniqueKey":"timestamp","typeLabel":"integer"}},"required":["code","message"],"uniqueKey":"","typeLabel":"object"},"examples":{"success":{"title":"success","summary":"Success","value":{"code":0,"message":"Request succeeded","data":{"period":"2026-09","apiKeyId":"key-id-1","userId":"user-id-1","groups":[{"groupId":"publish-api","name":"Publish API","used":17}]},"requestId":"request-id-1"}},"unauthorized401":{"title":"unauthorized401","summary":"Unauthenticated or invalid API Key","value":{"code":401,"message":"Unauthorized","data":{},"timestamp":1772099056662}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"8606ae1d-944e-441b-9462-d010f5f8411c":{"apikey-header-X-Api-Key":{"type":"apiKey","in":"header","name":"X-Api-Key","description":"Need to get API Key from AiToEarn. Click to go to [\"API Key Obtaining Tutorial\"](/en/use/api-key).","scopes":[],"schemeName":"apikey-header-X-Api-Key"}}},"servers":{"57ad866f-30c3-4af4-80f2-039608641992":{"url":"https://aitoearn.cn","description":"China site"},"562e7ea2-2e59-4270-bd1a-d35df0de6fce":{"url":"https://aitoearn.ai","description":"International site"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-Api-Key","description":"Need to get API Key from AiToEarn. Click to go to [\"API Key Obtaining Tutorial\"](/en/use/api-key).","scopes":[],"schemeName":"apikey-header-X-Api-Key"},"schema":{"title":"X-Api-Key","type":"string","description":"Need to get API Key from AiToEarn. Click to go to [\"API Key Obtaining Tutorial\"](/en/use/api-key).","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apikey-header-X-Api-Key","name":"X-Api-Key"}],"title":"apikey-header-X-Api-Key"}]},"originalFileLocation":"openapi/en/aitoearn.openapi.json"},"subdomain":"aitoearn","siteName":"AiToEarn Open Platform","title":"API Key usage - AiToEarn Open Platform","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"zh":{"href":"/api-reference/get-api-api-key-current-usage","matchLevel":1},"en":{"href":"/en/api-reference/get-api-api-key-current-usage","matchLevel":0}}},"originalFileLocation":"en/api-reference/get-api-api-key-current-usage.mdx","locale":"en"},"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=\"Interface description: Use X-Api-Key to retrieve call counts grouped by quota group for the API Key associated with the current credential. If period is omitted, the current UTC calendar month is returned. Pass YYYY-MM to query one specific previous month per request. This endpoint returns quota usage, not successful publication counts, AI tokens, or detailed credit consumption. If no usage was recorded for a month, used is 0 for every group. Only the current API Key can be queried; arbitrary keys cannot be selected through request parameters.\">\u003cmeta data-mint-head name=\"application-name\" content=\"AiToEarn Open Platform\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/aitoearn/fC9w3JuXYc3Wbg6o/_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/aitoearn/fC9w3JuXYc3Wbg6o/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/aitoearn/fC9w3JuXYc3Wbg6o/_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/aitoearn/fC9w3JuXYc3Wbg6o/_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/aitoearn/fC9w3JuXYc3Wbg6o/_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/aitoearn/fC9w3JuXYc3Wbg6o/_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/aitoearn/fC9w3JuXYc3Wbg6o/_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/aitoearn/fC9w3JuXYc3Wbg6o/_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/aitoearn/fC9w3JuXYc3Wbg6o/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"API Key usage - AiToEarn Open Platform\">\u003cmeta data-mint-head property=\"og:description\" content=\"Interface description: Use X-Api-Key to retrieve call counts grouped by quota group for the API Key associated with the current credential. If period is omitted, the current UTC calendar month is returned. Pass YYYY-MM to query one specific previous month per request. This endpoint returns quota usage, not successful publication counts, AI tokens, or detailed credit consumption. If no usage was recorded for a month, used is 0 for every group. Only the current API Key can be queried; arbitrary keys cannot be selected through request parameters.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"AiToEarn Open Platform\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.aitoearn.ai/en/api-reference/get-api-api-key-current-usage\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://aitoearn.mintlify.site/_mintlify/api/og/v2?division=Account+%26+Keys%2FAPI+Key\u0026amp;title=API+Key+usage\u0026amp;description=Interface+description%3A+Use+%60X-Api-Key%60+to+retrieve+call+counts+grouped+by+quota+group+for+the+API+Key+associated+with+the+current+credential.+If+%60period%60+is+omi\u0026amp;theme=b262227f5673722e38438a70\u0026amp;signature=8bee6606db8cecb95a49446abaae6f4347dab97b27bae3243ad5535ce08a7a1a\">\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 Key usage - AiToEarn Open Platform\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Interface description: Use X-Api-Key to retrieve call counts grouped by quota group for the API Key associated with the current credential. If period is omitted, the current UTC calendar month is returned. Pass YYYY-MM to query one specific previous month per request. This endpoint returns quota usage, not successful publication counts, AI tokens, or detailed credit consumption. If no usage was recorded for a month, used is 0 for every group. Only the current API Key can be queried; arbitrary keys cannot be selected through request parameters.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://aitoearn.mintlify.site/_mintlify/api/og/v2?division=Account+%26+Keys%2FAPI+Key\u0026amp;title=API+Key+usage\u0026amp;description=Interface+description%3A+Use+%60X-Api-Key%60+to+retrieve+call+counts+grouped+by+quota+group+for+the+API+Key+associated+with+the+current+credential.+If+%60period%60+is+omi\u0026amp;theme=b262227f5673722e38438a70\u0026amp;signature=8bee6606db8cecb95a49446abaae6f4347dab97b27bae3243ad5535ce08a7a1a\">\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/aitoearn/fC9w3JuXYc3Wbg6o/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"AiToEarn Open Platform\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#A989FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.aitoearn.ai/en/api-reference/get-api-api-key-current-usage\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/en/api-reference/get-api-api-key-current-usage.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.aitoearn.ai/en/api-reference/get-api-api-key-current-usage\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"zh\" href=\"https://docs.aitoearn.ai/api-reference/get-api-api-key-current-usage\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.aitoearn.ai/api-reference/get-api-api-key-current-usage\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.aitoearn.ai/#organization\",\"name\":\"AiToEarn Open Platform\",\"url\":\"https://docs.aitoearn.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/aitoearn/kGrHrvymy8zxbAqE/assets/logo/logo-light.png?fit=max\u0026auto=format\u0026n=kGrHrvymy8zxbAqE\u0026q=85\u0026s=9328b13457837280719d93e4b04a2065\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.aitoearn.ai#website\",\"name\":\"AiToEarn Open Platform\",\"url\":\"https://docs.aitoearn.ai\",\"publisher\":{\"@id\":\"https://docs.aitoearn.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.aitoearn.ai/en/api-reference/get-api-api-key-current-usage#webpage\",\"url\":\"https://docs.aitoearn.ai/en/api-reference/get-api-api-key-current-usage\",\"name\":\"API Key usage\",\"description\":\"Interface description: Use X-Api-Key to retrieve call counts grouped by quota group for the API Key associated with the current credential. If period is omitted, the current UTC calendar month is returned. Pass YYYY-MM to query one specific previous month per request. This endpoint returns quota usage, not successful publication counts, AI tokens, or detailed credit consumption. If no usage was recorded for a month, used is 0 for every group. Only the current API Key can be queried; arbitrary keys cannot be selected through request parameters.\",\"isPartOf\":{\"@id\":\"https://docs.aitoearn.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.aitoearn.ai/en/api-reference/get-api-api-key-current-usage#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.aitoearn.ai/en/api-reference/get-api-api-key-current-usage#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoint Groups\",\"item\":\"https://docs.aitoearn.ai/en/api\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API Key usage\",\"item\":\"https://docs.aitoearn.ai/en/api-reference/get-api-api-key-current-usage\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.aitoearn.ai/en/api-reference/get-api-api-key-current-usage#apireference\",\"headline\":\"API Key usage\",\"name\":\"API Key usage\",\"description\":\"Interface description: Use X-Api-Key to retrieve call counts grouped by quota group for the API Key associated with the current credential. If period is omitted, the current UTC calendar month is returned. Pass YYYY-MM to query one specific previous month per request. This endpoint returns quota usage, not successful publication counts, AI tokens, or detailed credit consumption. If no usage was recorded for a month, used is 0 for every group. Only the current API Key can be queried; arbitrary keys cannot be selected through request parameters.\",\"url\":\"https://docs.aitoearn.ai/en/api-reference/get-api-api-key-current-usage\",\"mainEntityOfPage\":{\"@id\":\"https://docs.aitoearn.ai/en/api-reference/get-api-api-key-current-usage#webpage\"},\"publisher\":{\"@id\":\"https://docs.aitoearn.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.aitoearn.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"AiToEarn Open Platform\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"AiToEarn Open Platform\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/en/api-reference/get-api-api-key-current-usage.md","siteName":"AiToEarn Open Platform","nav":{"global":null,"languages":[{"language":"zh","default":true,"navbar":{"links":[{"href":"https://github.com/yikart/AiToEarn","label":"GitHub","type":"github"}],"primary":{"type":"button","label":"前往 AiToEarn","href":"https://aitoearn.cn/"}},"pages":[{"title":"zh","href":"/api-reference/get-api-api-key-current-usage"}]},{"language":"en","navbar":{"links":[{"href":"https://github.com/yikart/AiToEarn","label":"GitHub","type":"github"}],"primary":{"type":"button","label":"Go to AiToEarn","href":"https://aitoearn.ai/"}},"tabs":[{"tab":"Home","hidden":true,"pages":[{"title":"Home","href":"/en/home","hidden":true}]},{"tab":"Use","icon":"book-open","pages":[{"title":"Use","href":"/en/use"}]},{"tab":"API Docs","icon":"code","groups":[{"group":"Endpoint Groups","pages":[{"group":"Overview","expanded":false,"pages":[{"title":"API Docs","href":"/en/api"}]},{"group":"AI Services/Video Generation","expanded":false,"pages":[{"title":"Video Generation Models","deprecated":false,"version":null,"sidebarTitle":"Video Generation Models","openapi":"/openapi/en/aitoearn.openapi.json get /api/ai/models/video/generation","href":"/en/api-reference/get-api-ai-models-video-generation"},{"title":"Generate Video","deprecated":false,"version":null,"sidebarTitle":"Generate Video","openapi":"/openapi/en/aitoearn.openapi.json post /api/ai/video/generations","href":"/en/api-reference/post-api-ai-video-generations"},{"title":"Video Task List","deprecated":false,"version":null,"sidebarTitle":"Video Task List","openapi":"/openapi/en/aitoearn.openapi.json get /api/ai/video/generations","href":"/en/api-reference/get-api-ai-video-generations"},{"title":"Video Task Status","deprecated":false,"version":null,"sidebarTitle":"Video Task Status","openapi":"/openapi/en/aitoearn.openapi.json get /api/ai/video/generations/{taskId}","href":"/en/api-reference/get-api-ai-video-generations-task-id"},{"title":"Create Volcengine-format video generation task","deprecated":null,"version":null,"sidebarTitle":"Create Volcengine-format video generation task","openapi":"/openapi/en/aitoearn.openapi.json post /api/ai/v3/contents/generations/tasks","href":"/en/api-reference/post-api-ai-v3-contents-generations-tasks"},{"title":"Query Volcengine-format video task","deprecated":null,"version":null,"sidebarTitle":"Query Volcengine-format video task","openapi":"/openapi/en/aitoearn.openapi.json get /api/ai/v3/contents/generations/tasks/{taskId}","href":"/en/api-reference/get-api-ai-v3-contents-generations-tasks-task-id"},{"group":"Real-person verification","expanded":false,"pages":[{"title":"Create real-person verification session","deprecated":null,"version":null,"sidebarTitle":"Create real-person verification session","openapi":"/openapi/en/aitoearn.openapi.json post /api/ai/volcengine/assets/visual-validation-sessions","href":"/en/api-reference/post-api-ai-volcengine-assets-visual-validation-sessions"},{"title":"Complete real-person verification","deprecated":null,"version":null,"sidebarTitle":"Complete real-person verification","openapi":"/openapi/en/aitoearn.openapi.json post /api/ai/volcengine/assets/visual-validation-sessions/{bytedToken}/complete","href":"/en/api-reference/post-api-ai-volcengine-assets-visual-validation-sessions-byted-token-complete"}]},{"group":"Virtual portrait assets","expanded":false,"pages":[{"title":"Create virtual portrait group","deprecated":null,"version":null,"sidebarTitle":"Create virtual portrait group","openapi":"/openapi/en/aitoearn.openapi.json post /api/ai/volcengine/assets/groups","href":"/en/api-reference/post-api-ai-volcengine-assets-groups"},{"title":"Asset group list","deprecated":null,"version":null,"sidebarTitle":"Asset group list","openapi":"/openapi/en/aitoearn.openapi.json get /api/ai/volcengine/assets/groups","href":"/en/api-reference/get-api-ai-volcengine-assets-groups"},{"title":"Asset group details","deprecated":null,"version":null,"sidebarTitle":"Asset group details","openapi":"/openapi/en/aitoearn.openapi.json get /api/ai/volcengine/assets/groups/{groupId}","href":"/en/api-reference/get-api-ai-volcengine-assets-groups-group-id"},{"title":"Update asset group","deprecated":null,"version":null,"sidebarTitle":"Update asset group","openapi":"/openapi/en/aitoearn.openapi.json patch /api/ai/volcengine/assets/groups/{groupId}","href":"/en/api-reference/patch-api-ai-volcengine-assets-groups-group-id"},{"title":"Delete asset group","deprecated":null,"version":null,"sidebarTitle":"Delete asset group","openapi":"/openapi/en/aitoearn.openapi.json delete /api/ai/volcengine/assets/groups/{groupId}","href":"/en/api-reference/delete-api-ai-volcengine-assets-groups-group-id"},{"title":"Create asset","deprecated":null,"version":null,"sidebarTitle":"Create asset","openapi":"/openapi/en/aitoearn.openapi.json post /api/ai/volcengine/assets/items","href":"/en/api-reference/post-api-ai-volcengine-assets-items"},{"title":"Asset list","deprecated":null,"version":null,"sidebarTitle":"Asset list","openapi":"/openapi/en/aitoearn.openapi.json get /api/ai/volcengine/assets/items","href":"/en/api-reference/get-api-ai-volcengine-assets-items"},{"title":"Asset details","deprecated":null,"version":null,"sidebarTitle":"Asset details","openapi":"/openapi/en/aitoearn.openapi.json get /api/ai/volcengine/assets/items/{assetId}","href":"/en/api-reference/get-api-ai-volcengine-assets-items-asset-id"},{"title":"Update asset","deprecated":null,"version":null,"sidebarTitle":"Update asset","openapi":"/openapi/en/aitoearn.openapi.json patch /api/ai/volcengine/assets/items/{assetId}","href":"/en/api-reference/patch-api-ai-volcengine-assets-items-asset-id"},{"title":"Delete asset","deprecated":null,"version":null,"sidebarTitle":"Delete asset","openapi":"/openapi/en/aitoearn.openapi.json delete /api/ai/volcengine/assets/items/{assetId}","href":"/en/api-reference/delete-api-ai-volcengine-assets-items-asset-id"}]}]},{"group":"AI Services/Image Generation","expanded":false,"pages":[{"title":"Image Generation Models","deprecated":false,"version":null,"sidebarTitle":"Image Generation Models","openapi":"/openapi/en/aitoearn.openapi.json get /api/ai/models/image/generation","href":"/en/api-reference/get-api-ai-models-image-generation"},{"title":"Image Editing Models","deprecated":false,"version":null,"sidebarTitle":"Image Editing Models","openapi":"/openapi/en/aitoearn.openapi.json get /api/ai/models/image/edit","href":"/en/api-reference/get-api-ai-models-image-edit"},{"title":"Generate Image","deprecated":false,"version":null,"sidebarTitle":"Generate Image","openapi":"/openapi/en/aitoearn.openapi.json post /api/ai/image/generate","href":"/en/api-reference/post-api-ai-image-generate"},{"title":"Edit Image","deprecated":false,"version":null,"sidebarTitle":"Edit Image","openapi":"/openapi/en/aitoearn.openapi.json post /api/ai/image/edit","href":"/en/api-reference/post-api-ai-image-edit"},{"title":"Generate Image Async","deprecated":false,"version":null,"sidebarTitle":"Generate Image Async","openapi":"/openapi/en/aitoearn.openapi.json post /api/ai/image/generate/async","href":"/en/api-reference/post-api-ai-image-generate-async"},{"title":"Edit Image Async","deprecated":false,"version":null,"sidebarTitle":"Edit Image Async","openapi":"/openapi/en/aitoearn.openapi.json post /api/ai/image/edit/async","href":"/en/api-reference/post-api-ai-image-edit-async"},{"title":"Image Task Status","deprecated":false,"version":null,"sidebarTitle":"Image Task Status","openapi":"/openapi/en/aitoearn.openapi.json get /api/ai/image/task/{logId}","href":"/en/api-reference/get-api-ai-image-task-log-id"},{"title":"OpenAI Image Generation","deprecated":false,"version":null,"sidebarTitle":"OpenAI Image Generation","openapi":"/openapi/en/aitoearn.openapi.json post /api/ai/images/generations","href":"/en/api-reference/post-api-ai-images-generations"},{"title":"OpenAI Image Editing","deprecated":false,"version":null,"sidebarTitle":"OpenAI Image Editing","openapi":"/openapi/en/aitoearn.openapi.json post /api/ai/images/edits","href":"/en/api-reference/post-api-ai-images-edits"}]},{"group":"AI Services/Large Language Models","expanded":false,"pages":[{"title":"Chat Model List","deprecated":false,"version":null,"sidebarTitle":"Chat Model List","openapi":"/openapi/en/aitoearn.openapi.json get /api/ai/models/chat","href":"/en/api-reference/get-api-ai-models-chat"},{"title":"OpenAI Chat","deprecated":false,"version":null,"sidebarTitle":"OpenAI Chat","openapi":"/openapi/en/aitoearn.openapi.json post /api/ai/chat/completions","href":"/en/api-reference/post-api-ai-chat-completions"},{"title":"Anthropic Chat","deprecated":false,"version":null,"sidebarTitle":"Anthropic Chat","openapi":"/openapi/en/aitoearn.openapi.json post /api/ai/v1/messages","href":"/en/api-reference/post-api-ai-v1-messages"},{"title":"Gemini Chat","deprecated":false,"version":null,"sidebarTitle":"Gemini Chat","openapi":"/openapi/en/aitoearn.openapi.json post /api/ai/v1beta/models/{model}:generateContent","href":"/en/api-reference/post-api-ai-v1beta-models-model-generate-content"},{"title":"Gemini Streaming Chat","deprecated":false,"version":null,"sidebarTitle":"Gemini Streaming Chat","openapi":"/openapi/en/aitoearn.openapi.json post /api/ai/v1beta/models/{model}:streamGenerateContent","href":"/en/api-reference/post-api-ai-v1beta-models-model-stream-generate-content"}]},{"group":"AI Services/Agent","expanded":false,"pages":[{"title":"Start Chat","deprecated":null,"version":null,"sidebarTitle":"Start Chat","openapi":"/openapi/en/aitoearn.openapi.json post /api/ai/agent/chat","href":"/en/api-reference/post-api-ai-agent-chat"},{"title":"Session List","deprecated":null,"version":null,"sidebarTitle":"Session List","openapi":"/openapi/en/aitoearn.openapi.json get /api/ai/agent/sessions","href":"/en/api-reference/get-api-ai-agent-sessions"},{"title":"Session Details","deprecated":null,"version":null,"sidebarTitle":"Session Details","openapi":"/openapi/en/aitoearn.openapi.json get /api/ai/agent/sessions/{sessionId}","href":"/en/api-reference/get-api-ai-agent-sessions-session-id"},{"title":"Update Session","deprecated":null,"version":null,"sidebarTitle":"Update Session","openapi":"/openapi/en/aitoearn.openapi.json patch /api/ai/agent/sessions/{sessionId}","href":"/en/api-reference/patch-api-ai-agent-sessions-session-id"},{"title":"Delete Session","deprecated":null,"version":null,"sidebarTitle":"Delete Session","openapi":"/openapi/en/aitoearn.openapi.json delete /api/ai/agent/sessions/{sessionId}","href":"/en/api-reference/delete-api-ai-agent-sessions-session-id"},{"title":"Message list","deprecated":null,"version":null,"sidebarTitle":"Message list","openapi":"/openapi/en/aitoearn.openapi.json get /api/ai/agent/sessions/{sessionId}/messages","href":"/en/api-reference/get-api-ai-agent-sessions-session-id-messages"},{"title":"Resume Stream","deprecated":null,"version":null,"sidebarTitle":"Resume Stream","openapi":"/openapi/en/aitoearn.openapi.json get /api/ai/agent/sessions/{sessionId}/resume","href":"/en/api-reference/get-api-ai-agent-sessions-session-id-resume"},{"title":"Abort Session","deprecated":null,"version":null,"sidebarTitle":"Abort Session","openapi":"/openapi/en/aitoearn.openapi.json post /api/ai/agent/sessions/{sessionId}/abort","href":"/en/api-reference/post-api-ai-agent-sessions-session-id-abort"},{"title":"Call MCP","deprecated":null,"version":null,"sidebarTitle":"Call MCP","openapi":"/openapi/en/aitoearn.openapi.json post /api/ai/agent/mcp","href":"/en/api-reference/post-api-ai-agent-mcp"}]},{"group":"Channel Management/Accounts","expanded":false,"pages":[{"title":"Account List","deprecated":false,"version":null,"sidebarTitle":"Account List","openapi":"/openapi/en/aitoearn.openapi.json get /api/v2/channels/accounts","href":"/en/api-reference/get-api-v2-channels-accounts"},{"title":"Batch Delete Accounts","deprecated":false,"version":null,"sidebarTitle":"Batch Delete Accounts","openapi":"/openapi/en/aitoearn.openapi.json delete /api/v2/channels/accounts","href":"/en/api-reference/delete-api-v2-channels-accounts"},{"title":"Account Details","deprecated":false,"version":null,"sidebarTitle":"Account Details","openapi":"/openapi/en/aitoearn.openapi.json get /api/v2/channels/accounts/{accountId}","href":"/en/api-reference/get-api-v2-channels-accounts-account-id"},{"title":"Delete Account","deprecated":false,"version":null,"sidebarTitle":"Delete Account","openapi":"/openapi/en/aitoearn.openapi.json delete /api/v2/channels/accounts/{accountId}","href":"/en/api-reference/delete-api-v2-channels-accounts-account-id"},{"title":"Account Authorization Status","deprecated":false,"version":null,"sidebarTitle":"Account Authorization Status","openapi":"/openapi/en/aitoearn.openapi.json get /api/v2/channels/accounts/{accountId}/auth-status","href":"/en/api-reference/get-api-v2-channels-accounts-account-id-auth-status"},{"title":"Publish Option Values","deprecated":false,"version":null,"sidebarTitle":"Publish Option Values","openapi":"/openapi/en/aitoearn.openapi.json get /api/v2/channels/accounts/{accountId}/publish-options/{field}/values","href":"/en/api-reference/get-api-v2-channels-accounts-account-id-publish-options-field-values"},{"title":"Create Publish Option Value","deprecated":false,"version":null,"sidebarTitle":"Create Publish Option Value","openapi":"/openapi/en/aitoearn.openapi.json post /api/v2/channels/accounts/{accountId}/publish-options/{field}/values","href":"/en/api-reference/post-api-v2-channels-accounts-account-id-publish-options-field-values"}]},{"group":"Channel Management/Publishing","expanded":false,"pages":[{"title":"Create Publish Flow","deprecated":false,"version":null,"sidebarTitle":"Create Publish Flow","openapi":"/openapi/en/aitoearn.openapi.json post /api/v2/channels/publish/flows","href":"/en/api-reference/post-api-v2-channels-publish-flows"},{"title":"Publish Flow Details","deprecated":false,"version":null,"sidebarTitle":"Publish Flow Details","openapi":"/openapi/en/aitoearn.openapi.json get /api/v2/channels/publish/flows/{flowId}","href":"/en/api-reference/get-api-v2-channels-publish-flows-flow-id"},{"title":"Publish Now","deprecated":false,"version":null,"sidebarTitle":"Publish Now","openapi":"/openapi/en/aitoearn.openapi.json post /api/v2/channels/publish/tasks/{taskId}/publish-now","href":"/en/api-reference/post-api-v2-channels-publish-tasks-task-id-publish-now"},{"title":"Retry Publish Task","deprecated":false,"version":null,"sidebarTitle":"Retry Publish Task","openapi":"/openapi/en/aitoearn.openapi.json post /api/v2/channels/publish/tasks/{taskId}/retry","href":"/en/api-reference/post-api-v2-channels-publish-tasks-task-id-retry"},{"title":"Cancel Publish Task","deprecated":false,"version":null,"sidebarTitle":"Cancel Publish Task","openapi":"/openapi/en/aitoearn.openapi.json delete /api/v2/channels/publish/tasks/{taskId}","href":"/en/api-reference/delete-api-v2-channels-publish-tasks-task-id"},{"title":"Update Publish Time","deprecated":false,"version":null,"sidebarTitle":"Update Publish Time","openapi":"/openapi/en/aitoearn.openapi.json patch /api/v2/channels/publish/tasks/{taskId}/publish-at","href":"/en/api-reference/patch-api-v2-channels-publish-tasks-task-id-publish-at"},{"title":"Publish Record List","deprecated":false,"version":null,"sidebarTitle":"Publish Record List","openapi":"/openapi/en/aitoearn.openapi.json get /api/v2/channels/publish/records","href":"/en/api-reference/get-api-v2-channels-publish-records"},{"title":"Queued Publish List","deprecated":false,"version":null,"sidebarTitle":"Queued Publish List","openapi":"/openapi/en/aitoearn.openapi.json get /api/v2/channels/publish/records/queued","href":"/en/api-reference/get-api-v2-channels-publish-records-queued"},{"title":"Published List","deprecated":false,"version":null,"sidebarTitle":"Published List","openapi":"/openapi/en/aitoearn.openapi.json get /api/v2/channels/publish/records/published","href":"/en/api-reference/get-api-v2-channels-publish-records-published"},{"title":"Delete Publish Record","deprecated":false,"version":null,"sidebarTitle":"Delete Publish Record","openapi":"/openapi/en/aitoearn.openapi.json delete /api/v2/channels/publish/records/{recordId}","href":"/en/api-reference/delete-api-v2-channels-publish-records-record-id"},{"title":"Publish Record Details","deprecated":false,"version":null,"sidebarTitle":"Publish Record Details","openapi":"/openapi/en/aitoearn.openapi.json get /api/v2/channels/publish/records/{recordId}","href":"/en/api-reference/get-api-v2-channels-publish-records-record-id"},{"title":"App Deep Link","deprecated":false,"version":null,"sidebarTitle":"App Deep Link","openapi":"/openapi/en/aitoearn.openapi.json get /api/v2/channels/publish/records/{recordId}/user-action","href":"/en/api-reference/get-api-v2-channels-publish-records-record-id-user-action"},{"title":"Create Douyin Check-in","deprecated":null,"version":null,"sidebarTitle":"Create Douyin Check-in","openapi":"/openapi/en/aitoearn.openapi.json post /api/v2/channels/douyin/open/offline-qr","href":"/en/api-reference/post-api-v2-channels-douyin-open-offline-qr"},{"title":"Get REDnote Signature","deprecated":null,"version":null,"sidebarTitle":"Get REDnote Signature","openapi":"/openapi/en/aitoearn.openapi.json post /api/v2/channels/rednote/open/offline-qr/share-config","href":"/en/api-reference/post-api-v2-channels-rednote-open-offline-qr-share-config"}]},{"group":"Channel Management/Platforms","expanded":false,"pages":[{"title":"Platform List","deprecated":false,"version":null,"sidebarTitle":"Platform List","openapi":"/openapi/en/aitoearn.openapi.json get /api/v2/channels/platforms","href":"/en/api-reference/get-api-v2-channels-platforms"},{"title":"Platform Publish Options","deprecated":false,"version":null,"sidebarTitle":"Platform Publish Options","openapi":"/openapi/en/aitoearn.openapi.json get /api/v2/channels/platforms/{platform}/publish-options","href":"/en/api-reference/get-api-v2-channels-platforms-platform-publish-options"}]},{"group":"Channel Management/Works","expanded":false,"pages":[{"title":"Parse Work Link","deprecated":false,"version":null,"sidebarTitle":"Parse Work Link","openapi":"/openapi/en/aitoearn.openapi.json get /api/v2/channels/works/link-info","href":"/en/api-reference/get-api-v2-channels-works-link-info"},{"title":"Work List","deprecated":false,"version":null,"sidebarTitle":"Work List","openapi":"/openapi/en/aitoearn.openapi.json get /api/v2/channels/works/{platform}","href":"/en/api-reference/get-api-v2-channels-works-platform"},{"title":"Work Details","deprecated":false,"version":null,"sidebarTitle":"Work Details","openapi":"/openapi/en/aitoearn.openapi.json get /api/v2/channels/works/{platform}/{platformWorkId}","href":"/en/api-reference/get-api-v2-channels-works-platform-platform-work-id"},{"title":"Work Analytics","deprecated":false,"version":null,"sidebarTitle":"Work Analytics","openapi":"/openapi/en/aitoearn.openapi.json get /api/v2/channels/works/{platform}/{platformWorkId}/analytics","href":"/en/api-reference/get-api-v2-channels-works-platform-platform-work-id-analytics"},{"title":"Verify Work Ownership","deprecated":false,"version":null,"sidebarTitle":"Verify Work Ownership","openapi":"/openapi/en/aitoearn.openapi.json post /api/v2/channels/works/{platform}/{platformWorkId}/ownership/verify","href":"/en/api-reference/post-api-v2-channels-works-platform-platform-work-id-ownership-verify"}]},{"group":"Channel Management/Account Groups","expanded":false,"pages":[{"title":"Group List","deprecated":false,"version":null,"sidebarTitle":"Group List","openapi":"/openapi/en/aitoearn.openapi.json get /api/v2/channels/account-groups","href":"/en/api-reference/get-api-v2-channels-account-groups"},{"title":"Create Group","deprecated":false,"version":null,"sidebarTitle":"Create Group","openapi":"/openapi/en/aitoearn.openapi.json post /api/v2/channels/account-groups","href":"/en/api-reference/post-api-v2-channels-account-groups"},{"title":"Batch Delete Groups","deprecated":false,"version":null,"sidebarTitle":"Batch Delete Groups","openapi":"/openapi/en/aitoearn.openapi.json delete /api/v2/channels/account-groups","href":"/en/api-reference/delete-api-v2-channels-account-groups"},{"title":"Update Group","deprecated":false,"version":null,"sidebarTitle":"Update Group","openapi":"/openapi/en/aitoearn.openapi.json patch /api/v2/channels/account-groups/{groupId}","href":"/en/api-reference/patch-api-v2-channels-account-groups-group-id"},{"title":"Update Account Order","deprecated":false,"version":null,"sidebarTitle":"Update Account Order","openapi":"/openapi/en/aitoearn.openapi.json patch /api/v2/channels/account-groups/{groupId}/accounts/rank","href":"/en/api-reference/patch-api-v2-channels-account-groups-group-id-accounts-rank"}]},{"group":"Channel Management/Authorization","expanded":false,"pages":[{"title":"Start Platform Authorization","deprecated":false,"version":null,"sidebarTitle":"Start Platform Authorization","openapi":"/openapi/en/aitoearn.openapi.json get /api/v2/channels/accounts/auth/{platform}","href":"/en/api-reference/get-api-v2-channels-accounts-auth-platform"},{"title":"Get Authorization Status","deprecated":false,"version":null,"sidebarTitle":"Get Authorization Status","openapi":"/openapi/en/aitoearn.openapi.json get /api/v2/channels/accounts/auth/{platform}/status/{sessionId}","href":"/en/api-reference/get-api-v2-channels-accounts-auth-platform-status-session-id"}]},{"group":"Asset Management","expanded":false,"pages":[{"title":"Generate Upload Signature","deprecated":false,"version":null,"sidebarTitle":"Generate Upload Signature","openapi":"/openapi/en/aitoearn.openapi.json post /api/assets/uploadSign","href":"/en/api-reference/post-api-assets-upload-sign"},{"title":"Confirm Asset Upload","description":"Interface description: After the client directly transfers the object storage, callback confirmation is completed, and the final status and access path of the resource are recorded.","deprecated":false,"version":null,"sidebarTitle":"Confirm Asset Upload","openapi":"/openapi/en/aitoearn.openapi.json post /api/assets/{id}/confirm","href":"/en/api-reference/post-api-assets-id-confirm"}]},{"group":"Account \u0026 Keys/API Key","expanded":false,"pages":[{"title":"API Key usage","deprecated":null,"version":null,"sidebarTitle":"API Key usage","openapi":"/openapi/en/aitoearn.openapi.json get /api/api-key/current/usage","href":"/en/api-reference/get-api-api-key-current-usage"}]}]}]},{"tab":"Help Docs","icon":"book-open","pages":[{"title":"Help Docs","href":"/en/help"}]},{"tab":"Contributing","icon":"heart-handshake","pages":[{"title":"Contributing","href":"/en/use/contributing"}]}]}]},"basePath":"","title":"API Key usage - AiToEarn Open Platform","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-jJHA3WSo.js","utils-DbZn3Mjn.js","cloneDeep-CnBnaSyy.js","_Uint8Array-CMQtTgBR.js","isObject-FP1Yky1u.js","utils-Bl2DvzOJ.js","addUniqueKeysToSchema-BwOLo9p1.js","snippetPresets-BBiPpKa-.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-DRLI_2Ue.js","ApiExamples-C0px4Tml.js","isEqual-zAyttAAO.js","usePlaygroundInputsStore-Dell6dGw.js","shallow-0VKqkSqN.js","getApiPlaygroundDisplay-CP_ctPEB.js","CodeSnippet-5L35ic0s.js","CodeSnippets-DOXbNhJw.js","getPastedJson-VhzT9m2P.js","icon-CD8_AtCO.js","MethodPill-DGgOMftG.js","DuplicateIcon-DZ6A_EtN.js","createIcon-DUl4oM5f.js","DynamicMarkdown-BGHukeRM.js","SectionHeading-ChrEUs8u.js","axios-vUo_bRtp.js","Markdown-Dj-na-_-.js","dist-C5gjFYHe.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-DEBW87tT.js"]}