Inspect the calling key’s masked value, expiry, monthly spending limit and month-to-date spend. rate_limits is the default text profile; each model’s rate_limit can differ.
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"NoMask","description":"OpenAI-compatible chat and image APIs. Explore NoMask models, SDK guides, coding tools, and an interactive API reference.","colors":{"primary":"#4D6B00","light":"#D8FA5A","dark":"#4D6B00"},"logo":{"light":"https://mintcdn.com/no-mask-ai/CcTFw2G-hooHaeYa/images/light.svg?fit=max\u0026auto=format\u0026n=CcTFw2G-hooHaeYa\u0026q=85\u0026s=fee65ab5fb6c02738ab85237cebca0ba","dark":"https://mintcdn.com/no-mask-ai/7ddCWbUFwfeBZ5mr/images/dark.svg?fit=max\u0026auto=format\u0026n=7ddCWbUFwfeBZ5mr\u0026q=85\u0026s=e610362853cc4a672b3d10596648274f","href":"https://nomask.ai"},"favicon":"https://mintcdn.com/no-mask-ai/CcTFw2G-hooHaeYa/images/favicon.svg?fit=max\u0026auto=format\u0026n=CcTFw2G-hooHaeYa\u0026q=85\u0026s=7705a402426342e550c6b2b5445ecbc7","api":{"openapi":"openapi.json","playground":{"display":"interactive","proxy":true},"examples":{"languages":["curl","python","javascript"],"prefill":true}},"appearance":{"default":"dark"},"navbar":{"links":[{"href":"mailto:support@nomask.ai","label":"Support"}],"primary":{"type":"button","label":"API Dashboard","href":"https://nomask.ai/api/overview"}},"footer":{"socials":{"x":"https://x.com/nomaskai","instagram":"https://instagram.com/nomask.ai"}},"icons":{"library":"tabler"},"styling":{"codeblocks":"system","latex":false},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode","download-spec"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"no-mask-ai","hasAudioNarration":false,"actualSubdomain":"no-mask-ai","customDomains":["docs.nomask.ai"],"gitSource":{"type":"github","owner":"mintlify-community","repo":"docs-no-mask-ai-0f971819","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6ae974a7e98d225f8a4a0a94","collectionId":"6f0df58c-1521-4382-a7c4-0fe3ef9f02eb","liveDeploymentHistoryId":"6ae974a7e98d225f8a4a0a94","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae9762f7e64ded297ae8fb3","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"Docs","count":39},{"language":"default","tag":"Coding Tools","count":8},{"language":"default","tag":"Text \u0026 Chat","count":7},{"language":"default","tag":"Account \u0026 Usage","count":4},{"language":"default","tag":"Getting Started","count":3},{"language":"default","tag":"Chat API","count":2},{"language":"default","tag":"Errors \u0026 Limits","count":2},{"language":"default","tag":"Production","count":2},{"language":"default","tag":"Model API","count":2},{"language":"default","tag":"Image API","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"images/styles.css","content":":root{--sidebar-width:17rem;--content-width:45rem}@media (min-width:1024px){#content-area{max-width:48rem!important}}#sidebar-content a,#sidebar-content a span{white-space:nowrap;overflow-wrap:normal;word-break:normal;hyphens:none}.nomask-start-actions{display:flex;flex-wrap:wrap;gap:12px;margin:28px 0}#content a.nomask-button{display:inline-flex;align-items:center;justify-content:center;gap:12px;padding:13px 22px;border:1px solid;border-radius:10px;font-size:16px;font-weight:600;line-height:1.5;text-decoration:none;box-shadow:0 1px 2px rgb(0 0 0/12%)}#content a.nomask-button-primary{background:#d8fa5a;border-color:#d8fa5a;color:#151709}#content a.nomask-button-primary:hover{background:#c9ee3f;border-color:#c9ee3f}#content a.nomask-button-secondary{background:rgb(128 128 128/10%);border-color:rgb(128 128 128/50%);color:#20251a}.dark #content a.nomask-button-secondary{color:#f4f6ee}#content a.nomask-button-secondary:hover{background:rgb(128 128 128/20%)}#content a.nomask-button:focus-visible{outline:2px solid #8ead26;outline-offset:4px}@media (max-width:480px){.nomask-start-actions{flex-direction:column}#content a.nomask-button{width:100%}}#navbar>.border-b{border-bottom-width:0!important}@media (min-width:1024px){#navbar{padding-top:12px}#sidebar-content{top:calc(3rem + 12px + var(--banner-height, 0px))!important;height:calc(100vh - 3rem - 12px - var(--banner-height, 0px))!important}}:root{--nomask-shell-width:90rem}@media (min-width:1024px){#body-content,#navbar{box-sizing:border-box;width:100%;max-width:var(--nomask-shell-width);margin-inline:auto}#sidebar-content{left:max(0px,calc((100% - var(--nomask-shell-width))/2))!important}#content-area{margin-inline:auto!important}#content-side-layout{top:calc(3rem + 12px + var(--banner-height, 0px))!important;height:calc(100vh - 3rem - 12px - var(--banner-height, 0px))!important}}#navbar a[data-nomask-tab]{position:relative;border-radius:0!important;color:#4b5563!important;background:0 0!important}#navbar a[data-nomask-tab][aria-current=location]{color:#111827!important;background:0 0!important}.dark #navbar a[data-nomask-tab]{color:#9ca3af!important}.dark #navbar a[data-nomask-tab][aria-current=location]{color:#f3f4f6!important;background:0 0!important}#navbar a[data-nomask-tab][aria-current=location]::after{content:\"\";position:absolute;left:8px;right:8px;bottom:-6px;height:2px;background:#4d6b00;pointer-events:none}.dark #navbar a[data-nomask-tab][aria-current=location]::after{background:#d8fa5a}:is(#sidebar-content, #mobile-nav-content) li[data-active=true]>a[aria-current=page]{border-radius:8px;background-color:#edf4d4!important;color:#4d6b00!important}.dark :is(#sidebar-content, #mobile-nav-content) li[data-active=true]>a[aria-current=page]{background-color:#172006!important;color:#d8fa5a!important}html[data-current-path=\"/introduction\"] #page-context-menu{display:none!important}html[data-current-path=\"/introduction\"] #content .nomask-intro-lead{color:inherit;font-size:1.375rem;font-weight:600;line-height:1.5}"}],"page":{"pagePath":"api-reference/me","slug":"/api-reference/me","pageMetadata":{"title":"Get API key details","description":"Inspect the calling key's masked value, expiry, monthly spending limit and month-to-date spend. rate_limits is the default text profile; each model's rate_limit can differ.","deprecated":null,"version":null,"sidebarTitle":"Me","openapi":"/openapi.json get /me","href":"/api-reference/me","autogeneratedByOpenApi":true},"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: \"Inspect the calling key’s masked value, expiry, monthly spending limit and month-to-date spend. rate_limits is the default text profile; each model’s rate_limit can differ.\"\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":{"codeStyling":"system","config":{},"pageMetadata":{"title":"Get API key details","description":"Inspect the calling key's masked value, expiry, monthly spending limit and month-to-date spend. rate_limits is the default text profile; each model's rate_limit can differ.","deprecated":null,"version":null,"sidebarTitle":"Me","openapi":"/openapi.json get /me","href":"/api-reference/me","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/no-mask-ai/f46e19f9d929cec4/images/navigation.js"],"openApiReferenceData":{"operation":{"operationId":"getApiKey","tags":["Account"],"summary":"Get API key details","description":"Inspect the calling key's masked value, expiry, monthly spending limit and month-to-date spend. rate_limits is the default text profile; each model's rate_limit can differ.","responses":{"200":"c896cdc9-d40e-473b-8739-1209bfed5358","401":"e90e7c4d-ed0f-4b92-8694-5e20d157c929","403":"7967652a-75d8-4fb2-af81-25c1a38812ce","429":"235e9244-0319-416d-9704-9fe31ecd180c","500":"6f40fb67-7a45-4d9f-a4fb-ad498eff3489","503":"7d187991-bf12-40f2-a2e0-636134f3ba10"},"x-mint":{"href":"/api-reference/me"},"method":"get","type":"path","servers":["0f103f63-4711-49d9-aedb-1858240c713d"],"security":["9899b00c-2436-47af-af95-5507e1931490"],"path":"/me","baseUrlOptions":["https://api.nomask.ai/v1"],"title":"Get API key details","codeSamples":[],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[]},"dependencies":{"parameters":{},"responses":{"c896cdc9-d40e-473b-8739-1209bfed5358":{"description":"Successful response. Example values are illustrative.","headers":{"X-Request-Id":{"description":"Request identifier for support and diagnostics.","schema":{"type":"string"}},"X-RateLimit-Profile":{"description":"Applied public rate-limit profile.","schema":{"type":"string"}},"X-RateLimit-Limit-Requests":{"description":"Maximum requests in the minute window.","schema":{"type":"string"}},"X-RateLimit-Remaining-Requests":{"description":"Remaining requests in the minute window.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Seconds until the relevant allowance resets.","schema":{"type":"string"}},"X-RateLimit-Limit-Tokens":{"description":"Maximum text tokens in the minute window.","schema":{"type":"string"}},"X-RateLimit-Remaining-Tokens":{"description":"Remaining text tokens in the minute window.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","enum":["api_key"],"isRequired":true,"uniqueKey":"object","typeLabel":"enum\u003cstring>"},"name":{"type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"key":{"type":"string","description":"Masked key, never the full credential.","isRequired":true,"uniqueKey":"key","typeLabel":"string"},"created":{"oneOf":[{"type":"integer","description":"Unix timestamp.","format":"int64","isRequired":true,"uniqueKey":"created.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"Unix timestamp.","format":"int64","isRequired":true,"uniqueKey":"created.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"created","typeLabel":"integer\u003cint64> | null"},"expiration_date":{"oneOf":[{"type":"integer","description":"Unix timestamp, or null if no expiry.","format":"int64","isRequired":true,"uniqueKey":"expiration_date.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"Unix timestamp, or null if no expiry.","format":"int64","isRequired":true,"uniqueKey":"expiration_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"expiration_date","typeLabel":"integer\u003cint64> | null"},"has_monthly_limit":{"type":"boolean","isRequired":true,"uniqueKey":"has_monthly_limit","typeLabel":"boolean"},"monthly_usd_limit":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"monthly_usd_limit.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"monthly_usd_limit.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"monthly_usd_limit","typeLabel":"number | null"},"month_to_date_usd":{"type":"number","isRequired":true,"uniqueKey":"month_to_date_usd","typeLabel":"number"},"rate_limits":{"type":"object","properties":{"name":{"type":"string","description":"Public profile name.","isRequired":true,"uniqueKey":"rate_limits.name","typeLabel":"string"},"requests_per_minute":{"type":"integer","description":"Requests per minute.","isRequired":true,"uniqueKey":"rate_limits.requests_per_minute","typeLabel":"integer"},"tokens_per_minute":{"type":"integer","description":"Tokens per minute.","isRequired":true,"uniqueKey":"rate_limits.tokens_per_minute","typeLabel":"integer"}},"required":["name","requests_per_minute","tokens_per_minute"],"description":"Current text rate-limit profile. Limits are shared per account, and a model may select a different profile.","isRequired":true,"uniqueKey":"rate_limits","typeLabel":"object"},"rate_limit_scope":{"type":"string","enum":["per_account"],"isRequired":true,"uniqueKey":"rate_limit_scope","typeLabel":"enum\u003cstring>"}},"required":["object","name","key","created","expiration_date","has_monthly_limit","monthly_usd_limit","month_to_date_usd","rate_limits","rate_limit_scope"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"object":"api_key","name":"\u003cstring>","key":"\u003cstring>","created":123,"expiration_date":123,"has_monthly_limit":true,"monthly_usd_limit":123,"month_to_date_usd":123,"rate_limits":{"name":"\u003cstring>","requests_per_minute":123,"tokens_per_minute":123},"rate_limit_scope":"per_account"}}},"exampleType":"generated"}},"exampleType":"generated"},"e90e7c4d-ed0f-4b92-8694-5e20d157c929":{"description":"Missing, invalid, expired or revoked API key.","headers":{"X-Request-Id":{"description":"Request identifier for support and diagnostics.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable error.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","description":"Error category.","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable NoMask error code.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"param":{"oneOf":[{"type":"string","description":"The invalid parameter, if applicable.","isRequired":true,"uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"The invalid parameter, if applicable.","isRequired":true,"uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.param","typeLabel":"string | null"}},"required":["message","type","code","param"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"message":"\u003cstring>","type":"\u003cstring>","code":"\u003cstring>","param":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"7967652a-75d8-4fb2-af81-25c1a38812ce":{"description":"Account restricted from API access.","headers":{"X-Request-Id":{"description":"Request identifier for support and diagnostics.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable error.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","description":"Error category.","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable NoMask error code.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"param":{"oneOf":[{"type":"string","description":"The invalid parameter, if applicable.","isRequired":true,"uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"The invalid parameter, if applicable.","isRequired":true,"uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.param","typeLabel":"string | null"}},"required":["message","type","code","param"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"message":"\u003cstring>","type":"\u003cstring>","code":"\u003cstring>","param":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"235e9244-0319-416d-9704-9fe31ecd180c":{"description":"Account rate limit or key monthly spending limit exceeded. Observe Retry-After when supplied.","headers":{"X-Request-Id":{"description":"Request identifier for support and diagnostics.","schema":{"type":"string"}},"X-RateLimit-Profile":{"description":"Applied public rate-limit profile.","schema":{"type":"string"}},"X-RateLimit-Limit-Requests":{"description":"Maximum requests in the minute window.","schema":{"type":"string"}},"X-RateLimit-Remaining-Requests":{"description":"Remaining requests in the minute window.","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Seconds until the relevant allowance resets.","schema":{"type":"string"}},"X-RateLimit-Limit-Tokens":{"description":"Maximum text tokens in the minute window.","schema":{"type":"string"}},"X-RateLimit-Remaining-Tokens":{"description":"Remaining text tokens in the minute window.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying a rate-limited request, when supplied.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable error.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","description":"Error category.","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable NoMask error code.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"param":{"oneOf":[{"type":"string","description":"The invalid parameter, if applicable.","isRequired":true,"uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"The invalid parameter, if applicable.","isRequired":true,"uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.param","typeLabel":"string | null"}},"required":["message","type","code","param"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"message":"\u003cstring>","type":"\u003cstring>","code":"\u003cstring>","param":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"6f40fb67-7a45-4d9f-a4fb-ad498eff3489":{"description":"Internal server error.","headers":{"X-Request-Id":{"description":"Request identifier for support and diagnostics.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable error.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","description":"Error category.","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable NoMask error code.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"param":{"oneOf":[{"type":"string","description":"The invalid parameter, if applicable.","isRequired":true,"uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"The invalid parameter, if applicable.","isRequired":true,"uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.param","typeLabel":"string | null"}},"required":["message","type","code","param"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"message":"\u003cstring>","type":"\u003cstring>","code":"\u003cstring>","param":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"7d187991-bf12-40f2-a2e0-636134f3ba10":{"description":"Service unavailable or model at capacity.","headers":{"X-Request-Id":{"description":"Request identifier for support and diagnostics.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable error.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","description":"Error category.","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable NoMask error code.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"param":{"oneOf":[{"type":"string","description":"The invalid parameter, if applicable.","isRequired":true,"uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"The invalid parameter, if applicable.","isRequired":true,"uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.param","typeLabel":"string | null"}},"required":["message","type","code","param"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"message":"\u003cstring>","type":"\u003cstring>","code":"\u003cstring>","param":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"9899b00c-2436-47af-af95-5507e1931490":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"NoMask API key","description":"Create a NoMask API key at https://nomask.ai/api/keys. Keep it private; enter only your own key when sending a request.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"0f103f63-4711-49d9-aedb-1858240c713d":{"url":"https://api.nomask.ai/v1","description":"NoMask API"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"NoMask API key","description":"Create a NoMask API key at https://nomask.ai/api/keys. Keep it private; enter only your own key when sending a request.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Create a NoMask API key at https://nomask.ai/api/keys. Keep it private; enter only your own key when sending a request.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"no-mask-ai","siteName":"NoMask","title":"Get API key details - NoMask","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-03T05:26:46.165Z","originalFileLocation":"api-reference/me.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=\"dark\"}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=\"Inspect the calling key\u0026#x27;s masked value, expiry, monthly spending limit and month-to-date spend. rate_limits is the default text profile; each model\u0026#x27;s rate_limit can differ.\">\u003cmeta data-mint-head name=\"application-name\" content=\"NoMask\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/no-mask-ai/yCGe-NbM-4ov618a/_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/no-mask-ai/yCGe-NbM-4ov618a/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/no-mask-ai/yCGe-NbM-4ov618a/_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/no-mask-ai/yCGe-NbM-4ov618a/_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/no-mask-ai/yCGe-NbM-4ov618a/_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/no-mask-ai/yCGe-NbM-4ov618a/_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/no-mask-ai/yCGe-NbM-4ov618a/_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/no-mask-ai/yCGe-NbM-4ov618a/_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/no-mask-ai/yCGe-NbM-4ov618a/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get API key details - NoMask\">\u003cmeta data-mint-head property=\"og:description\" content=\"Inspect the calling key\u0026#x27;s masked value, expiry, monthly spending limit and month-to-date spend. rate_limits is the default text profile; each model\u0026#x27;s rate_limit can differ.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"NoMask\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.nomask.ai/api-reference/me\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://no-mask-ai.mintlify.app/_mintlify/api/og/v2?division=Account+%26+Usage\u0026amp;title=Get+API+key+details\u0026amp;description=Inspect+the+calling+key%27s+masked+value%2C+expiry%2C+monthly+spending+limit+and+month-to-date+spend.+rate_limits+is+the+default+text+profile%3B+each+model%27s+rate_limit\u0026amp;theme=052752a1e4d4e861e6dc23eb\u0026amp;signature=75d823d24d30f321aa5b3cee05469562cf3d395d94f322a2260d53219e5ee0bc\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get API key details - NoMask\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Inspect the calling key\u0026#x27;s masked value, expiry, monthly spending limit and month-to-date spend. rate_limits is the default text profile; each model\u0026#x27;s rate_limit can differ.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://no-mask-ai.mintlify.app/_mintlify/api/og/v2?division=Account+%26+Usage\u0026amp;title=Get+API+key+details\u0026amp;description=Inspect+the+calling+key%27s+masked+value%2C+expiry%2C+monthly+spending+limit+and+month-to-date+spend.+rate_limits+is+the+default+text+profile%3B+each+model%27s+rate_limit\u0026amp;theme=052752a1e4d4e861e6dc23eb\u0026amp;signature=75d823d24d30f321aa5b3cee05469562cf3d395d94f322a2260d53219e5ee0bc\">\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/no-mask-ai/yCGe-NbM-4ov618a/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"NoMask\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4D6B00\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.nomask.ai/api-reference/me\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/me.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.nomask.ai/#organization\",\"name\":\"NoMask\",\"url\":\"https://docs.nomask.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/no-mask-ai/CcTFw2G-hooHaeYa/images/light.svg?fit=max\u0026auto=format\u0026n=CcTFw2G-hooHaeYa\u0026q=85\u0026s=fee65ab5fb6c02738ab85237cebca0ba\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.nomask.ai#website\",\"name\":\"NoMask\",\"url\":\"https://docs.nomask.ai\",\"publisher\":{\"@id\":\"https://docs.nomask.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.nomask.ai/api-reference/me#webpage\",\"url\":\"https://docs.nomask.ai/api-reference/me\",\"name\":\"Get API key details\",\"description\":\"Inspect the calling key's masked value, expiry, monthly spending limit and month-to-date spend. rate_limits is the default text profile; each model's rate_limit can differ.\",\"dateModified\":\"2026-11-03T05:26:46.165Z\",\"isPartOf\":{\"@id\":\"https://docs.nomask.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.nomask.ai/api-reference/me#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.nomask.ai/api-reference/me#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Account \u0026 Usage\",\"item\":\"https://docs.nomask.ai/api-reference/balance\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get API key details\",\"item\":\"https://docs.nomask.ai/api-reference/me\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.nomask.ai/api-reference/me#apireference\",\"headline\":\"Get API key details\",\"name\":\"Get API key details\",\"description\":\"Inspect the calling key's masked value, expiry, monthly spending limit and month-to-date spend. rate_limits is the default text profile; each model's rate_limit can differ.\",\"url\":\"https://docs.nomask.ai/api-reference/me\",\"mainEntityOfPage\":{\"@id\":\"https://docs.nomask.ai/api-reference/me#webpage\"},\"dateModified\":\"2026-11-03T05:26:46.165Z\",\"publisher\":{\"@id\":\"https://docs.nomask.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.nomask.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"NoMask\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"NoMask","nav":{"global":null,"tabs":[{"tab":"Docs","icon":"book","groups":[{"group":"Docs","icon":"book","pages":[{"title":"NoMask API","mode":"wide","href":"/introduction"},{"title":"Billing \u0026 Funding","href":"/billing"},{"title":"Privacy","href":"/privacy"}]},{"group":"Getting Started","icon":"rocket","pages":[{"title":"Quickstart","href":"/quickstart"},{"title":"API Keys \u0026 Authentication","href":"/authentication"},{"title":"Migrate from OpenAI","href":"/openai-compatibility"}]},{"group":"Text \u0026 Chat","icon":"message","pages":[{"title":"Streaming","href":"/streaming"},{"title":"Reasoning","href":"/reasoning"},{"title":"Function Calling","href":"/function-calling"},{"title":"Vision","href":"/vision"},{"title":"Video Inputs","href":"/video-inputs"},{"title":"NoMask System Prompt","href":"/system-prompt"},{"title":"Prompt Caching","href":"/prompt-caching"}]},{"group":"Image","icon":"photo","pages":[{"title":"Image Generation","href":"/image-generation"}]},{"group":"Production","icon":"settings","pages":[{"title":"Idempotency","href":"/idempotency"},{"title":"Support","href":"/support"}]},{"group":"Coding Tools","icon":"terminal","pages":[{"title":"Codex","href":"/integration-codex"},{"title":"Claude Code","href":"/integration-claude-code"},{"title":"Roo Code","href":"/integration-roo-code"},{"title":"Command Code","href":"/integration-command-code"},{"title":"Cline","href":"/integration-cline"},{"title":"Kilo Code","href":"/integration-kilo-code"},{"title":"OpenCode","href":"/integration-opencode"},{"title":"Aider","href":"/integration-aider"}]},{"group":"Chat API","icon":"message","pages":[{"title":"Create a chat completion","deprecated":null,"version":null,"sidebarTitle":"Chat completions","openapi":"/openapi.json post /chat/completions","href":"/api-reference/chat-completions"},{"title":"Chat Completions","href":"/chat-completions"}]},{"group":"Image API","icon":"photo","pages":[{"title":"Generate an image","deprecated":null,"version":null,"sidebarTitle":"Image generations","openapi":"/openapi.json post /images/generations","href":"/api-reference/image-generations"},{"title":"Edit an image","deprecated":null,"version":null,"sidebarTitle":"Image edits","openapi":"/openapi.json post /images/edits","href":"/api-reference/image-edits"}]},{"group":"Model API","icon":"box","pages":[{"title":"List models","deprecated":null,"version":null,"sidebarTitle":"List models","openapi":"/openapi.json get /models","href":"/api-reference/list-models"},{"title":"Retrieve a model","deprecated":null,"version":null,"sidebarTitle":"Get model","openapi":"/openapi.json get /models/{model}","href":"/api-reference/get-model"}]},{"group":"Account \u0026 Usage","icon":"wallet","pages":[{"title":"Get balance","deprecated":null,"version":null,"sidebarTitle":"Balance","openapi":"/openapi.json get /balance","href":"/api-reference/balance"},{"title":"List usage","description":"List settled account usage newest first, across all keys. Records contain billing metadata, never prompts or generated content.","deprecated":null,"version":null,"sidebarTitle":"Usage","openapi":"/openapi.json get /usage","href":"/api-reference/usage"},{"title":"Get API key details","deprecated":null,"version":null,"sidebarTitle":"Me","openapi":"/openapi.json get /me","href":"/api-reference/me"},{"title":"Account Endpoints","description":"Read your balance, history and limits programmatically.","href":"/endpoints"}]},{"group":"Errors \u0026 Limits","icon":"alert-circle","pages":[{"title":"Errors","href":"/errors"},{"title":"Rate Limits","href":"/rate-limits"}]}]},{"tab":"Models","icon":"box","href":"https://nomask.ai/models"},{"tab":"API Reference","icon":"code","href":"https://docs.nomask.ai/api-reference/chat-completions"},{"tab":"Coding Tools","icon":"terminal","href":"https://docs.nomask.ai/integration-codex"}]},"basePath":"","title":"Get API key details - NoMask","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-DCDCdBVX.js","utils-ME8dDnLe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-0e84ACsd.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-wgRBj-ia.js","snippetPresets-C11Sgb-o.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-Bevw23-4.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.js","getPastedJson-u6QiPzNZ.js","icon-Bb-CBSxO.js","MethodPill-F7l5AI7V.js","DuplicateIcon-IiAXkdSg.js","createIcon-FliI8EBc.js","DynamicMarkdown-B62XqCSI.js","SectionHeading-Dj31pT03.js","axios-vUo_bRtp.js","Markdown-BOgQCTwD.js","clsx-BIWXJmsZ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DKZWslLH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-UDqbR6xh.js"]}