Returns the entity the credential belongs to and the permissions it holds. Use it to confirm an API key works. A public link is reported with the id ANONYMOUS and no entity or permissions.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Synthetic API","colors":{"primary":"#4f7658"},"logo":{"light":"https://mintcdn.com/synthetic-intelligences-inc/fQrygfnnSQo6sqbf/logo/light.svg?fit=max\u0026auto=format\u0026n=fQrygfnnSQo6sqbf\u0026q=85\u0026s=2dda80021fb41535557588dfc2db8171","dark":"https://mintcdn.com/synthetic-intelligences-inc/fQrygfnnSQo6sqbf/logo/dark.svg?fit=max\u0026auto=format\u0026n=fQrygfnnSQo6sqbf\u0026q=85\u0026s=5c52f16fb166ac48b3d84c1a873ee2f6","href":"https://synthetic.ai"},"favicon":"https://mintcdn.com/synthetic-intelligences-inc/fQrygfnnSQo6sqbf/favicon.svg?fit=max\u0026auto=format\u0026n=fQrygfnnSQo6sqbf\u0026q=85\u0026s=99c5d1fd4b2b7623472231c876aa54f9","navbar":{"links":[{"href":"https://app.synthetic.ai","label":"Open Synthetic"}]},"footer":{"links":[{"header":"Synthetic","items":[{"label":"Website","href":"https://synthetic.ai"},{"label":"Sign in","href":"https://app.synthetic.ai"}]}]},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"synthetic-intelligences-inc","hasAudioNarration":false,"actualSubdomain":"synthetic-intelligences-inc","customDomains":["docs.synthetic.ai"],"gitSource":{"type":"github","owner":"synthetic-intelligences","repo":"synthetic-monorepo","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6ae502b2240fd66bc490d4ad","collectionId":"4cb46970-d7ab-4e23-99d0-135b97fe157c","liveDeploymentHistoryId":"6ae502b2240fd66bc490d4ad","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae502b2240fd66bc490d4ad","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"API Reference","count":16},{"language":"default","tag":"Contracts","count":7},{"language":"default","tag":"Guides","count":4},{"language":"default","tag":"Invoices","count":3},{"language":"default","tag":"Customers","count":2},{"language":"default","tag":"Payments","count":2},{"language":"default","tag":"System","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":[],"page":{"pagePath":"api-reference/system/identify-the-caller","slug":"/api-reference/system/identify-the-caller","pageMetadata":{"title":"Identify the caller","description":"Returns the entity the credential belongs to and the permissions it holds. Use it to confirm an API key works. A public link is reported with the id ANONYMOUS and no entity or permissions.","deprecated":null,"version":null,"openapi":"https://app.synthetic.ai/api/v1/openapi.json get /me","href":"/api-reference/system/identify-the-caller","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: \"Returns the entity the credential belongs to and the permissions it holds. Use it to confirm an API key works. A public link is reported with the id ANONYMOUS and no entity or permissions.\"\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":"Identify the caller","description":"Returns the entity the credential belongs to and the permissions it holds. Use it to confirm an API key works. A public link is reported with the id ANONYMOUS and no entity or permissions.","deprecated":null,"version":null,"openapi":"https://app.synthetic.ai/api/v1/openapi.json get /me","href":"/api-reference/system/identify-the-caller","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"me-get","summary":"Identify the caller","description":"Returns the entity the credential belongs to and the permissions it holds. Use it to confirm an API key works. A public link is reported with the id ANONYMOUS and no entity or permissions.","tags":["System"],"security":["2ec801b5-ad20-4f3d-87ff-28d5fa0631bf"],"responses":{"200":"f80a31b0-0097-4a8f-b537-b423087c9e12","401":"e48543e9-dc41-4534-9e1b-ea4a6e3bb606","500":"93e9765f-700a-4458-aa56-840322553d4d"},"method":"get","type":"path","servers":["cf001fbc-6f44-475c-a4d8-19bb294765d5"],"path":"/me","baseUrlOptions":["https://app.synthetic.ai/api/v1"],"title":"Identify the caller","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"responses":{"f80a31b0-0097-4a8f-b537-b423087c9e12":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"principal":{"type":"object","properties":{"type":{"type":"string","enum":["USER","API_KEY","PUBLIC_LINK"],"isRequired":true,"uniqueKey":"principal.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","uniqueKey":"principal.id","typeLabel":"string"}},"required":["type"],"additionalProperties":false,"isRequired":true,"uniqueKey":"principal","typeLabel":"object"},"entity":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","isRequired":true,"uniqueKey":"entity.id","typeLabel":"string\u003cuuid>"},"workosOrgId":{"type":"string","isRequired":true,"uniqueKey":"entity.workosOrgId","typeLabel":"string"},"name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"entity.name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"entity.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"entity.name","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"entity.description.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"entity.description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"entity.description","typeLabel":"string | null"},"startDate":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"entity.startDate.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"entity.startDate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"entity.startDate","typeLabel":"string | null"},"incorporationType":{"oneOf":[{"type":"string","enum":["LLC","S_CORP","C_CORP","SOLE_PROPRIETOR","PARTNERSHIP","NON_PROFIT"],"isRequired":true,"uniqueKey":"entity.incorporationType.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"entity.incorporationType.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"entity.incorporationType","typeLabel":"enum\u003cstring> | null"},"streetAddress1":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"entity.streetAddress1.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"entity.streetAddress1.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"entity.streetAddress1","typeLabel":"string | null"},"streetAddress2":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"entity.streetAddress2.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"entity.streetAddress2.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"entity.streetAddress2","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"entity.city.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"entity.city.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"entity.city","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"entity.state.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"entity.state.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"entity.state","typeLabel":"string | null"},"postalCode":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"entity.postalCode.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"entity.postalCode.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"entity.postalCode","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"entity.country.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"entity.country.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"entity.country","typeLabel":"string | null"},"primaryEmail":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"entity.primaryEmail.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"entity.primaryEmail.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"entity.primaryEmail","typeLabel":"string | null"},"primaryPhone":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"entity.primaryPhone.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"entity.primaryPhone.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"entity.primaryPhone","typeLabel":"string | null"},"billingMode":{"type":"string","enum":["SETUP","ACTIVE"],"isRequired":true,"uniqueKey":"entity.billingMode","typeLabel":"enum\u003cstring>"},"billingActivatedAt":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"entity.billingActivatedAt.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"entity.billingActivatedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"entity.billingActivatedAt","typeLabel":"string | null"},"timezone":{"type":"string","isRequired":true,"uniqueKey":"entity.timezone","typeLabel":"string"},"createdAt":{"type":"string","isRequired":true,"uniqueKey":"entity.createdAt","typeLabel":"string"}},"required":["id","workosOrgId","name","description","startDate","incorporationType","streetAddress1","streetAddress2","city","state","postalCode","country","primaryEmail","primaryPhone","billingMode","billingActivatedAt","timezone","createdAt"],"additionalProperties":false,"uniqueKey":"entity","typeLabel":"object"},"authorizationClaims":{"type":"array","items":{"type":"string","enum":["contracts:read","customers:read","invoices:read","payments:read","public_link:read","unpaid_invoices:read","payment_bank_accounts:read","payment_bank_accounts:write","customer_autopay_config:read","customer_autopay_config:write","checkouts:read","checkouts:write","users:read","users:write","api_keys:read","api_keys:write","billing_settings:read","billing_settings:write","legal_acknowledgments:write"],"uniqueKey":"authorizationClaims.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"authorizationClaims","typeLabel":"enum\u003cstring>[]"}},"required":["principal"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"principal":{"type":"USER","id":"\u003cstring>"},"entity":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","workosOrgId":"\u003cstring>","name":"\u003cstring>","description":"\u003cstring>","startDate":"\u003cstring>","incorporationType":"LLC","streetAddress1":"\u003cstring>","streetAddress2":"\u003cstring>","city":"\u003cstring>","state":"\u003cstring>","postalCode":"\u003cstring>","country":"\u003cstring>","primaryEmail":"\u003cstring>","primaryPhone":"\u003cstring>","billingMode":"SETUP","billingActivatedAt":"\u003cstring>","timezone":"\u003cstring>","createdAt":"\u003cstring>"},"authorizationClaims":["contracts:read"]}}},"exampleType":"generated"}},"exampleType":"generated"},"e48543e9-dc41-4534-9e1b-ea4a6e3bb606":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The error message","example":"Unauthorized","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"The error code","example":"UNAUTHORIZED","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"issues":{"description":"An array of issues that were responsible for the error","example":[],"type":"array","items":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"issues.items.[INDEX].message","typeLabel":"string"}},"required":["message"],"additionalProperties":false,"uniqueKey":"issues.items.[INDEX]","typeLabel":"object"},"uniqueKey":"issues","typeLabel":"object[]"}},"required":["message","code"],"additionalProperties":false,"title":"Unauthorized error (401)","description":"The error information","example":{"code":"UNAUTHORIZED","message":"Unauthorized","issues":[]},"uniqueKey":"","typeLabel":"Unauthorized error (401) · object"},"examples":{"Example":{"title":"Example","value":{"code":"UNAUTHORIZED","message":"Unauthorized","issues":[]}}},"exampleType":"generated"}},"exampleType":"generated"},"93e9765f-700a-4458-aa56-840322553d4d":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The error message","example":"An unexpected error occurred.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"The error code","example":"INTERNAL_SERVER_ERROR","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"issues":{"description":"An array of issues that were responsible for the error","example":[],"type":"array","items":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"issues.items.[INDEX].message","typeLabel":"string"}},"required":["message"],"additionalProperties":false,"uniqueKey":"issues.items.[INDEX]","typeLabel":"object"},"uniqueKey":"issues","typeLabel":"object[]"}},"required":["message","code"],"additionalProperties":false,"title":"An unexpected error occurred. error (500)","description":"The error information","example":{"code":"INTERNAL_SERVER_ERROR","message":"An unexpected error occurred.","issues":[]},"uniqueKey":"","typeLabel":"An unexpected error occurred. error (500) · object"},"examples":{"Example":{"title":"Example","value":{"code":"INTERNAL_SERVER_ERROR","message":"An unexpected error occurred.","issues":[]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"2ec801b5-ad20-4f3d-87ff-28d5fa0631bf":{"BearerAuth":{"type":"http","scheme":"bearer","description":"An API key created in Settings, sent as `Authorization: Bearer \u003ckey>`.","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"cf001fbc-6f44-475c-a4d8-19bb294765d5":{"url":"https://app.synthetic.ai/api/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"An API key created in Settings, sent as `Authorization: Bearer \u003ckey>`.","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"An API key created in Settings, sent as `Authorization: Bearer \u003ckey>`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"https://app.synthetic.ai/api/v1/openapi.json"},"subdomain":"synthetic-intelligences-inc","siteName":"Synthetic API","title":"Identify the caller - Synthetic API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-30T20:48:55.270Z","originalFileLocation":"api-reference/system/identify-the-caller.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns the entity the credential belongs to and the permissions it holds. Use it to confirm an API key works. A public link is reported with the id ANONYMOUS and no entity or permissions.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Synthetic API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/synthetic-intelligences-inc/Mg1HiyJW6ibf7wLe/_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/synthetic-intelligences-inc/Mg1HiyJW6ibf7wLe/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/synthetic-intelligences-inc/Mg1HiyJW6ibf7wLe/_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/synthetic-intelligences-inc/Mg1HiyJW6ibf7wLe/_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/synthetic-intelligences-inc/Mg1HiyJW6ibf7wLe/_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/synthetic-intelligences-inc/Mg1HiyJW6ibf7wLe/_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/synthetic-intelligences-inc/Mg1HiyJW6ibf7wLe/_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/synthetic-intelligences-inc/Mg1HiyJW6ibf7wLe/_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/synthetic-intelligences-inc/Mg1HiyJW6ibf7wLe/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Identify the caller - Synthetic API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns the entity the credential belongs to and the permissions it holds. Use it to confirm an API key works. A public link is reported with the id ANONYMOUS and no entity or permissions.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Synthetic API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.synthetic.ai/api-reference/system/identify-the-caller\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://synthetic-intelligences-inc.mintlify.app/_mintlify/api/og/v2?division=System\u0026amp;title=Identify+the+caller\u0026amp;description=Returns+the+entity+the+credential+belongs+to+and+the+permissions+it+holds.+Use+it+to+confirm+an+API+key+works.+A+public+link+is+reported+with+the+id+ANONYMOUS+a\u0026amp;theme=a479a14ec030af800e1f5c00\u0026amp;signature=45abd72a742970ce59f4716f198fe85155eeddc807039d29b8ee3f7ec3dedf48\">\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=\"Identify the caller - Synthetic API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns the entity the credential belongs to and the permissions it holds. Use it to confirm an API key works. A public link is reported with the id ANONYMOUS and no entity or permissions.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://synthetic-intelligences-inc.mintlify.app/_mintlify/api/og/v2?division=System\u0026amp;title=Identify+the+caller\u0026amp;description=Returns+the+entity+the+credential+belongs+to+and+the+permissions+it+holds.+Use+it+to+confirm+an+API+key+works.+A+public+link+is+reported+with+the+id+ANONYMOUS+a\u0026amp;theme=a479a14ec030af800e1f5c00\u0026amp;signature=45abd72a742970ce59f4716f198fe85155eeddc807039d29b8ee3f7ec3dedf48\">\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/synthetic-intelligences-inc/Mg1HiyJW6ibf7wLe/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Synthetic API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4f7658\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.synthetic.ai/api-reference/system/identify-the-caller\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/system/identify-the-caller.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.synthetic.ai/#organization\",\"name\":\"Synthetic API\",\"url\":\"https://docs.synthetic.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/synthetic-intelligences-inc/fQrygfnnSQo6sqbf/logo/light.svg?fit=max\u0026auto=format\u0026n=fQrygfnnSQo6sqbf\u0026q=85\u0026s=2dda80021fb41535557588dfc2db8171\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.synthetic.ai#website\",\"name\":\"Synthetic API\",\"url\":\"https://docs.synthetic.ai\",\"publisher\":{\"@id\":\"https://docs.synthetic.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.synthetic.ai/api-reference/system/identify-the-caller#webpage\",\"url\":\"https://docs.synthetic.ai/api-reference/system/identify-the-caller\",\"name\":\"Identify the caller\",\"description\":\"Returns the entity the credential belongs to and the permissions it holds. Use it to confirm an API key works. A public link is reported with the id ANONYMOUS and no entity or permissions.\",\"dateModified\":\"2026-10-30T20:48:55.270Z\",\"isPartOf\":{\"@id\":\"https://docs.synthetic.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.synthetic.ai/api-reference/system/identify-the-caller#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.synthetic.ai/api-reference/system/identify-the-caller#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Synthetic API\",\"item\":\"https://docs.synthetic.ai\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Identify the caller\",\"item\":\"https://docs.synthetic.ai/api-reference/system/identify-the-caller\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.synthetic.ai/api-reference/system/identify-the-caller#apireference\",\"headline\":\"Identify the caller\",\"name\":\"Identify the caller\",\"description\":\"Returns the entity the credential belongs to and the permissions it holds. Use it to confirm an API key works. A public link is reported with the id ANONYMOUS and no entity or permissions.\",\"url\":\"https://docs.synthetic.ai/api-reference/system/identify-the-caller\",\"mainEntityOfPage\":{\"@id\":\"https://docs.synthetic.ai/api-reference/system/identify-the-caller#webpage\"},\"dateModified\":\"2026-10-30T20:48:55.270Z\",\"publisher\":{\"@id\":\"https://docs.synthetic.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.synthetic.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Synthetic API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Synthetic API","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"Customers","pages":[{"title":"List customers","deprecated":null,"version":null,"openapi":"https://app.synthetic.ai/api/v1/openapi.json get /customers","href":"/api-reference/customers/list-customers"},{"title":"Get a customer","deprecated":null,"version":null,"openapi":"https://app.synthetic.ai/api/v1/openapi.json get /customers/{id}","href":"/api-reference/customers/get-a-customer"}]},{"group":"Contracts","pages":[{"title":"List a contract's amendments","deprecated":null,"version":null,"openapi":"https://app.synthetic.ai/api/v1/openapi.json get /amendments","href":"/api-reference/contracts/list-a-contracts-amendments"},{"title":"Get an amendment","deprecated":null,"version":null,"openapi":"https://app.synthetic.ai/api/v1/openapi.json get /amendments/{id}","href":"/api-reference/contracts/get-an-amendment"},{"title":"List contracts","deprecated":null,"version":null,"openapi":"https://app.synthetic.ai/api/v1/openapi.json get /contracts","href":"/api-reference/contracts/list-contracts"},{"title":"Get a contract","deprecated":null,"version":null,"openapi":"https://app.synthetic.ai/api/v1/openapi.json get /contracts/{id}","href":"/api-reference/contracts/get-a-contract"},{"title":"List a contract's line items","deprecated":null,"version":null,"openapi":"https://app.synthetic.ai/api/v1/openapi.json get /contract-line-items","href":"/api-reference/contracts/list-a-contracts-line-items"},{"title":"List invoice previews","deprecated":null,"version":null,"openapi":"https://app.synthetic.ai/api/v1/openapi.json query /invoice-previews","href":"/api-reference/contracts/list-invoice-previews"},{"title":"Get a link to an invoice preview's PDF","deprecated":null,"version":null,"openapi":"https://app.synthetic.ai/api/v1/openapi.json query /invoice-previews/pdf","href":"/api-reference/contracts/get-a-link-to-an-invoice-previews-pdf"}]},{"group":"Invoices","pages":[{"title":"List invoices","deprecated":null,"version":null,"openapi":"https://app.synthetic.ai/api/v1/openapi.json get /invoices","href":"/api-reference/invoices/list-invoices"},{"title":"Get an invoice","deprecated":null,"version":null,"openapi":"https://app.synthetic.ai/api/v1/openapi.json get /invoices/{id}","href":"/api-reference/invoices/get-an-invoice"},{"title":"Get a link to an invoice's PDF","deprecated":null,"version":null,"openapi":"https://app.synthetic.ai/api/v1/openapi.json get /invoices/{id}/pdf","href":"/api-reference/invoices/get-a-link-to-an-invoices-pdf"}]},{"group":"Payments","pages":[{"title":"List payments","deprecated":null,"version":null,"openapi":"https://app.synthetic.ai/api/v1/openapi.json get /payments","href":"/api-reference/payments/list-payments"},{"title":"Get a payment","description":"One payment of any type by id, including a fee or a voided card payment. A payment of another entity is not found. Needs a key holding `payments:read`.","deprecated":null,"version":null,"openapi":"https://app.synthetic.ai/api/v1/openapi.json get /payments/{id}","href":"/api-reference/payments/get-a-payment"}]},{"group":"System","pages":[{"title":"Identify the caller","deprecated":null,"version":null,"openapi":"https://app.synthetic.ai/api/v1/openapi.json get /me","href":"/api-reference/system/identify-the-caller"},{"title":"Check that the API is reachable","description":"Returns OK when the public API is up. No credentials are needed, so use this to confirm connectivity before calling data routes.","deprecated":null,"version":null,"openapi":"https://app.synthetic.ai/api/v1/openapi.json get /health","href":"/api-reference/system/check-that-the-api-is-reachable"}]}]}]},"basePath":"","title":"Identify the caller - Synthetic API","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}