When a job produces an artifact — result data or a compiled circuit — its ArtifactDescriptor carries a format identifier (e.g. ionq.result.probabilities.json.v2). Use the endpoint above to fetch the JSON Schema document for that identifier and validate or generate types for the artifact payload.
API keys are associated with a user and can be created on the IonQ Quantum Cloud application. To authenticate, prefix your API Key with apiKey and place it in the Authorization request header. Ex: Authorization: apiKey your-api-key
JSON Schema document returned by the schemas endpoint. The exact contents
vary by format identifier (see the Results / Circuit formats catalog
pages for each format's structure).
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"IonQ Quantum Cloud Documentation","colors":{"primary":"#FF5000","light":"#FF5000","dark":"#FF5000"},"logo":{"light":"https://mintcdn.com/ionq/KP8cXNscCAA57Ku7/media/branding/ionq-logo-light.png?fit=max\u0026auto=format\u0026n=KP8cXNscCAA57Ku7\u0026q=85\u0026s=11cad3438352638e3454cd778e5edbd2","dark":"https://mintcdn.com/ionq/KP8cXNscCAA57Ku7/media/branding/ionq-logo-dark.png?fit=max\u0026auto=format\u0026n=KP8cXNscCAA57Ku7\u0026q=85\u0026s=85d5d12a9583104a8d373ede243bb6eb","href":"/"},"favicon":"https://mintcdn.com/ionq/KP8cXNscCAA57Ku7/media/branding/favicon.png?fit=max\u0026auto=format\u0026n=KP8cXNscCAA57Ku7\u0026q=85\u0026s=82c7a4271938c62e2d0face324458e5b","api":{"openapi":["https://api.ionq.co/v0.3/api-docs","https://api.ionq.co/v0.4/api-docs"]},"appearance":{"default":"dark"},"background":{"color":{"dark":"#0F161B"}},"navbar":{"links":[],"primary":{"type":"button","label":"Sign In","href":"https://cloud.ionq.com"}},"footer":{"socials":{"twitter":"https://twitter.com/ionq_inc","github":"https://github.com/ionq","linkedin":"https://www.linkedin.com/company/ionq.co"}},"search":{"prompt":"Search for..."},"seo":{"metatags":{"og:logo":"/media/branding/ionq-logo-light.png"},"indexing":"all"},"integrations":{"ga4":{"measurementId":"G-4MVSY41MTC"}},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Join our Slack","icon":"slack","href":"https://join.slack.com/t/ionqcommunity/shared_invite/zt-2ohj4fkvb-ErVKebhkwaP7S~lt2Gq0_w"},{"anchor":"Example Notebooks","icon":"github","href":"https://github.com/ionq-samples/"},{"anchor":"Other Resources","icon":"book-open-cover","href":"https://ionq.com/resources"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"ionq","hasAudioNarration":false,"actualSubdomain":"ionq","customDomains":["docs.ionq.com"],"gitSource":{"type":"github","owner":"ionq-samples","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adb8b0e2d3c9c6f327a1f19","collectionId":"b88c1530-3396-4270-8569-b4fe17a1adfa","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adb8b0e2d3c9c6f327a1f19"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"DISABLED"},"CONTEXTUAL_FEEDBACK":{"status":"DISABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"DISABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6adb8b0e2d3c9c6f327a1f19","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"default","tag":"API v0.4 (Latest)","count":29},{"language":"default","tag":"Jobs","count":20},{"language":"default","tag":"API v0.3","count":19},{"language":"default","tag":"Home","count":18},{"language":"default","tag":"SDKs","count":11},{"language":"default","tag":"Python SDKs","count":11},{"language":"default","tag":"IonQ v0.3 API","count":7},{"language":"default","tag":"User Manual","count":7},{"language":"default","tag":"Backends","count":5},{"language":"default","tag":"Guides","count":5}]},"assistantConfig":{"deflection":{"enabled":true,"email":"[email protected]"}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"survey-popup.css","content":".ionq-survey-popup{--ionq-survey-bg:#ffffff;--ionq-survey-fg:#0f161b;--ionq-survey-muted:#4b5563;--ionq-survey-border:rgba(15, 22, 27, 0.1);--ionq-survey-shadow:0 12px 32px rgba(15, 22, 27, 0.18);--ionq-survey-accent:#ff5000;--ionq-survey-accent-hover:#e64800;position:fixed;right:1.25rem;bottom:1.25rem;z-index:60;box-sizing:border-box;width:min(22.5rem,calc(100vw - 2.5rem));padding:1.25rem 1.25rem 1.125rem;border:1px solid var(--ionq-survey-border);border-radius:.875rem;background:var(--ionq-survey-bg);color:var(--ionq-survey-fg);box-shadow:var(--ionq-survey-shadow);font-family:inherit;line-height:1.45;opacity:0;transform:translateY(.75rem);transition:opacity .25s ease,transform .25s ease;pointer-events:none}.ionq-survey-popup--visible{opacity:1;transform:translateY(0);pointer-events:auto}html.dark .ionq-survey-popup{--ionq-survey-bg:#161f26;--ionq-survey-fg:#f3f4f6;--ionq-survey-muted:#a8b3bd;--ionq-survey-border:rgba(255, 255, 255, 0.1);--ionq-survey-shadow:0 12px 32px rgba(0, 0, 0, 0.5)}.ionq-survey-popup__close{position:absolute;top:.5rem;right:.5rem;width:1.75rem;height:1.75rem;padding:0;border:0;border-radius:999px;background:0 0;color:var(--ionq-survey-muted);font-size:1.25rem;line-height:1;cursor:pointer}.ionq-survey-popup__close:focus-visible,.ionq-survey-popup__close:hover{background:var(--ionq-survey-border);color:var(--ionq-survey-fg);outline:0}.ionq-survey-popup__badge{display:inline-block;margin-bottom:.625rem;padding:.125rem .5rem;border-radius:999px;background:rgba(255,80,0,.12);color:var(--ionq-survey-accent);font-size:.6875rem;font-weight:600;letter-spacing:.04em;text-transform:uppercase}.ionq-survey-popup__title{margin:0 1.5rem .375rem 0;font-size:1rem;font-weight:600;line-height:1.3}.ionq-survey-popup__body{margin:0 0 1rem;color:var(--ionq-survey-muted);font-size:.875rem}.ionq-survey-popup__actions{display:flex;flex-wrap:wrap;gap:.5rem .75rem;align-items:center}.ionq-survey-popup__cta{display:inline-flex;align-items:center;padding:.5rem .875rem;border-radius:.5rem;background:var(--ionq-survey-accent);color:#fff!important;font-size:.875rem;font-weight:600;text-decoration:none!important;transition:background .15s ease}.ionq-survey-popup__cta:focus-visible,.ionq-survey-popup__cta:hover{background:var(--ionq-survey-accent-hover);outline:0}.ionq-survey-popup__later{padding:.5rem .25rem;border:0;background:0 0;color:var(--ionq-survey-muted);font-size:.875rem;font-weight:500;cursor:pointer}.ionq-survey-popup__later:focus-visible,.ionq-survey-popup__later:hover{color:var(--ionq-survey-fg);text-decoration:underline;outline:0}@media (max-width:640px){.ionq-survey-popup{right:.75rem;left:.75rem;bottom:.75rem;width:auto}}@media (prefers-reduced-motion:reduce){.ionq-survey-popup{transition:none;transform:none}}"}],"page":{"pagePath":"api-reference/v0.4/schemas/get-format-schema","slug":"/api-reference/v0.4/schemas/get-format-schema","pageMetadata":{"openapi":"https://api.ionq.co/v0.4/api-docs GET /schemas/formats/{format}","title":"Get format schema","description":"Get the JSON Schema for an artifact format.","href":"/api-reference/v0.4/schemas/get-format-schema"},"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: \"Get the JSON Schema for an artifact format.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,..._provideComponents(),...props.components},{Card,CardGroup,Heading}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`When a job produces an artifact — result data or a compiled circuit — its `,_jsx(_components.a,{href:`/api-reference/v0.4/jobs/get-job-artifact`,children:_jsx(_components.code,{children:`ArtifactDescriptor`})}),` carries a `,_jsx(_components.code,{children:`format`}),` identifier (e.g. `,_jsx(_components.code,{children:`ionq.result.probabilities.json.v2`}),`). Use the endpoint above to fetch the JSON Schema document for that identifier and validate or generate types for the artifact payload.`]}),`\n`,_jsx(Heading,{level:`2`,id:`format-catalogs`,children:`Format catalogs`}),`\n`,_jsx(_components.p,{children:`Browse all supported format identifiers and their payload structures:`}),`\n`,_jsxs(CardGroup,{cols:2,children:[_jsx(Card,{title:`Results formats`,icon:`chart-line`,href:`/api-reference/v0.4/schemas/results-formats`,children:_jsx(_components.p,{children:`Formats produced when a job completes: probabilities, histograms, shots, and the multi-circuit aggregate.`})}),_jsx(Card,{title:`Circuit formats`,icon:`microchip`,href:`/api-reference/v0.4/schemas/circuit-formats`,children:_jsxs(_components.p,{children:[`Circuit payload formats — used for both submitted circuits (job `,_jsx(_components.code,{children:`input`}),`) and circuits emitted by the compiler.`]})})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"https://api.ionq.co/v0.4/api-docs GET /schemas/formats/{format}","title":"Get format schema","description":"Get the JSON Schema for an artifact format.","href":"/api-reference/v0.4/schemas/get-format-schema"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Format catalogs","slug":"format-catalogs","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/ionq/76975e31ca3d94be/survey-popup.js"],"openApiReferenceData":{"operation":{"operationId":"GetFormatSchema","responses":{"200":"8208d3d4-1254-44a2-a1c9-86e5739c23f3"},"description":"Get the JSON Schema for an artifact format.","tags":["Schemas"],"security":["d0897bb9-fbac-4db7-b577-8bb500cf38cc"],"parameters":["91517c08-9f85-4e27-a360-07fe759ba98d"],"x-codeSamples":[{"lang":"curl","source":"curl \"https://api.ionq.co/v0.4/schemas/formats/ionq.result.probabilities.json.v2\" \\\n -H \"Authorization: apiKey your-api-key\"\n"}],"method":"get","type":"path","servers":["110a05cf-3864-4106-a0c1-ff804f68893c"],"path":"/schemas/formats/{format}","baseUrlOptions":["https://api.ionq.co/v0.4"],"title":"","codeSamples":[{"lang":"curl","source":"curl \"https://api.ionq.co/v0.4/schemas/formats/ionq.result.probabilities.json.v2\" \\\n -H \"Authorization: apiKey your-api-key\"\n"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"91517c08-9f85-4e27-a360-07fe759ba98d":{"in":"path","name":"format","required":true,"schema":{"type":"string","enum":["ionq.result.probabilities.json.v1","ionq.result.probabilities.json.v2","ionq.result.histogram.json.v1","ionq.result.histogram.json.v2","ionq.result.shots.json.v1","ionq.result.shots.json.v2","ionq.result.probabilities-aggregate.json.v1","ionq.native.v1"],"isRequired":true,"uniqueKey":"","typeLabel":"enum\u003cstring>"}}},"responses":{"8208d3d4-1254-44a2-a1c9-86e5739c23f3":{"description":"Ok","content":{"application/json":{"schema":{"description":"JSON Schema document returned by the schemas endpoint. The exact contents\nvary by format identifier (see the Results / Circuit formats catalog\npages for each format's structure).","properties":{"$schema":{"type":"string","description":"JSON Schema draft URI.","isRequired":true,"uniqueKey":"$schema","typeLabel":"string"},"$id":{"type":"string","description":"Format identifier (matches the path parameter).","isRequired":true,"uniqueKey":"$id","typeLabel":"string"},"type":{"type":"string","description":"Top-level JSON type of the format payload.","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"description":{"type":"string","description":"Human-readable description of the format.","uniqueKey":"description","typeLabel":"string"}},"required":["$schema","$id","type"],"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"additionalProperties","typeLabel":"any"},"uniqueKey":"","typeLabel":"object"},"examples":{"ionq.result.probabilities.json.v2":{"title":"ionq.result.probabilities.json.v2","value":{"$schema":"https://json-schema.org/draft-07/schema","$id":"ionq.result.probabilities.json.v2","type":"object","description":"Register-nested probability distribution.","required":["probabilities"],"properties":{"probabilities":{"type":"object","required":["registers"],"properties":{"registers":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"number","minimum":0,"maximum":1}}}}}}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"d0897bb9-fbac-4db7-b577-8bb500cf38cc":{"apiKeyAuth1":{"type":"apiKey","name":"Authorization","in":"header","description":"API keys are associated with a user and can be created on the [IonQ Quantum Cloud](https://cloud.ionq.com) application. To authenticate, prefix your API Key with `apiKey ` and place it in the `Authorization` request header. Ex: `Authorization: apiKey your-api-key`","x-default":"apiKey your-api-key","scopes":[],"schemeName":"apiKeyAuth1"}}},"servers":{"110a05cf-3864-4106-a0c1-ff804f68893c":{"url":"https://api.ionq.co/v0.4"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","name":"Authorization","in":"header","description":"API keys are associated with a user and can be created on the [IonQ Quantum Cloud](https://cloud.ionq.com) application. To authenticate, prefix your API Key with `apiKey ` and place it in the `Authorization` request header. Ex: `Authorization: apiKey your-api-key`","x-default":"apiKey your-api-key","scopes":[],"schemeName":"apiKeyAuth1"},"schema":{"title":"Authorization","type":"string","description":"API keys are associated with a user and can be created on the [IonQ Quantum Cloud](https://cloud.ionq.com) application. To authenticate, prefix your API Key with `apiKey ` and place it in the `Authorization` request header. Ex: `Authorization: apiKey your-api-key`","isRequired":true,"default":"apiKey your-api-key","typeLabel":"string","deprecated":false},"schemeName":"apiKeyAuth1","name":"Authorization"}],"title":"apiKeyAuth1"}]},"originalFileLocation":"https://api.ionq.co/v0.4/api-docs"},"subdomain":"ionq","siteName":"IonQ Quantum Cloud Documentation","title":"Get format schema - IonQ Quantum Cloud Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-06-29T17:05:58.364Z","originalFileLocation":"api-reference/v0.4/schemas/get-format-schema.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=\"Get the JSON Schema for an artifact format.\">\u003cmeta data-mint-head name=\"application-name\" content=\"IonQ Quantum Cloud Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ionq/kNvIbD7sfYoz1On3/_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/ionq/kNvIbD7sfYoz1On3/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ionq/kNvIbD7sfYoz1On3/_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/ionq/kNvIbD7sfYoz1On3/_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/ionq/kNvIbD7sfYoz1On3/_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/ionq/kNvIbD7sfYoz1On3/_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/ionq/kNvIbD7sfYoz1On3/_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/ionq/kNvIbD7sfYoz1On3/_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/ionq/kNvIbD7sfYoz1On3/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get format schema - IonQ Quantum Cloud Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get the JSON Schema for an artifact format.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"IonQ Quantum Cloud Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.ionq.com/api-reference/v0.4/schemas/get-format-schema\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://ionq.mintlify.app/_mintlify/api/og/v2?division=Schemas\u0026amp;title=Get+format+schema\u0026amp;description=Get+the+JSON+Schema+for+an+artifact+format.\u0026amp;theme=f6791b5e02266258dbd08105\u0026amp;signature=9c53faf5459ae6d9047b19d5e85cc0f25a8c33d30d9cd1fd06fe6fd532da6af5\">\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 format schema - IonQ Quantum Cloud Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get the JSON Schema for an artifact format.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ionq.mintlify.app/_mintlify/api/og/v2?division=Schemas\u0026amp;title=Get+format+schema\u0026amp;description=Get+the+JSON+Schema+for+an+artifact+format.\u0026amp;theme=f6791b5e02266258dbd08105\u0026amp;signature=9c53faf5459ae6d9047b19d5e85cc0f25a8c33d30d9cd1fd06fe6fd532da6af5\">\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/ionq/kNvIbD7sfYoz1On3/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"IonQ Quantum Cloud Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF5000\">\u003cmeta data-mint-head name=\"og:logo\" content=\"/media/branding/ionq-logo-light.png\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.ionq.com/api-reference/v0.4/schemas/get-format-schema\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/v0.4/schemas/get-format-schema.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.ionq.com/#organization\",\"name\":\"IonQ Quantum Cloud Documentation\",\"url\":\"https://docs.ionq.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/ionq/KP8cXNscCAA57Ku7/media/branding/ionq-logo-light.png?fit=max\u0026auto=format\u0026n=KP8cXNscCAA57Ku7\u0026q=85\u0026s=11cad3438352638e3454cd778e5edbd2\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.ionq.com#website\",\"name\":\"IonQ Quantum Cloud Documentation\",\"url\":\"https://docs.ionq.com\",\"publisher\":{\"@id\":\"https://docs.ionq.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.ionq.com/api-reference/v0.4/schemas/get-format-schema#webpage\",\"url\":\"https://docs.ionq.com/api-reference/v0.4/schemas/get-format-schema\",\"name\":\"Get format schema\",\"description\":\"Get the JSON Schema for an artifact format.\",\"dateModified\":\"2026-06-29T17:05:58.364Z\",\"isPartOf\":{\"@id\":\"https://docs.ionq.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.ionq.com/api-reference/v0.4/schemas/get-format-schema#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.ionq.com/api-reference/v0.4/schemas/get-format-schema#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"IonQ Quantum Cloud Documentation\",\"item\":\"https://docs.ionq.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get format schema\",\"item\":\"https://docs.ionq.com/api-reference/v0.4/schemas/get-format-schema\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.ionq.com/api-reference/v0.4/schemas/get-format-schema#apireference\",\"headline\":\"Get format schema\",\"name\":\"Get format schema\",\"description\":\"Get the JSON Schema for an artifact format.\",\"url\":\"https://docs.ionq.com/api-reference/v0.4/schemas/get-format-schema\",\"mainEntityOfPage\":{\"@id\":\"https://docs.ionq.com/api-reference/v0.4/schemas/get-format-schema#webpage\"},\"dateModified\":\"2026-06-29T17:05:58.364Z\",\"publisher\":{\"@id\":\"https://docs.ionq.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.ionq.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"IonQ Quantum Cloud Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"IonQ Quantum Cloud Documentation","nav":{"global":{"anchors":[{"anchor":"Join our Slack","icon":"slack","href":"https://join.slack.com/t/ionqcommunity/shared_invite/zt-2ohj4fkvb-ErVKebhkwaP7S~lt2Gq0_w"},{"anchor":"Example Notebooks","icon":"github","href":"https://github.com/ionq-samples/"},{"anchor":"Other Resources","icon":"book-open-cover","href":"https://ionq.com/resources"}]},"tabs":[{"tab":"Home","pages":[{"title":"Home","href":""}]},{"tab":"SDKs","pages":[{"title":"SDKs","href":"/sdks"}]},{"tab":"API v0.4 (Latest)","groups":[{"group":"IonQ v0.4 API","pages":[{"title":"API v0.4 Reference","sidebarTitle":"Introduction","href":"/api-reference/v0.4/introduction"},{"title":"Migrating to API v0.4","href":"/api-reference/v0.4/migration-from-v0.3"},{"title":"v0.4 Error Codes","href":"/api-reference/v0.4/error-codes"},{"title":"OpenQASM 3","href":"/api-reference/v0.4/openqasm3"}]},{"group":"Jobs","pages":[{"openapi":"https://api.ionq.co/v0.4/api-docs POST /jobs","title":null,"href":"/api-reference/v0.4/jobs/create-job"},{"openapi":"https://api.ionq.co/v0.4/api-docs POST /jobs/{UUID}/clone","title":null,"href":"/api-reference/v0.4/jobs/clone-job"},{"openapi":"https://api.ionq.co/v0.4/api-docs POST /jobs/{UUID}/move","title":null,"href":"/api-reference/v0.4/jobs/move-job"},{"openapi":"https://api.ionq.co/v0.4/api-docs GET /jobs/{UUID}","title":null,"href":"/api-reference/v0.4/jobs/get-job"},{"openapi":"https://api.ionq.co/v0.4/api-docs GET /jobs","title":null,"href":"/api-reference/v0.4/jobs/get-jobs"},{"openapi":"https://api.ionq.co/v0.4/api-docs GET /jobs/{UUID}/cost","title":null,"href":"/api-reference/v0.4/jobs/get-job-cost"},{"openapi":"https://api.ionq.co/v0.4/api-docs PUT /jobs/{UUID}/status/cancel","title":"Cancel a job","href":"/api-reference/v0.4/jobs/cancel-job"},{"openapi":"https://api.ionq.co/v0.4/api-docs PUT /jobs/status/cancel","title":null,"href":"/api-reference/v0.4/jobs/cancel-jobs"},{"openapi":"https://api.ionq.co/v0.4/api-docs DELETE /jobs/{UUID}","title":null,"href":"/api-reference/v0.4/jobs/delete-job"},{"openapi":"https://api.ionq.co/v0.4/api-docs DELETE /jobs","title":null,"href":"/api-reference/v0.4/jobs/delete-jobs"},{"openapi":"https://api.ionq.co/v0.4/api-docs GET /jobs/estimate","title":null,"href":"/api-reference/v0.4/jobs/get-job-estimate"},{"openapi":"https://api.ionq.co/v0.4/api-docs GET /jobs/{UUID}/artifacts/{artifactId}","title":"Download a job artifact.","href":"/api-reference/v0.4/jobs/get-job-artifact"}]},{"group":"Sessions","pages":[{"openapi":"https://api.ionq.co/v0.4/api-docs POST /sessions","title":null,"href":"/api-reference/v0.4/sessions/create-session"},{"openapi":"https://api.ionq.co/v0.4/api-docs GET /sessions/{session_id}","title":null,"href":"/api-reference/v0.4/sessions/get-session"},{"openapi":"https://api.ionq.co/v0.4/api-docs GET /sessions","title":null,"href":"/api-reference/v0.4/sessions/get-sessions"},{"openapi":"https://api.ionq.co/v0.4/api-docs POST /sessions/{session_id}/end","title":null,"href":"/api-reference/v0.4/sessions/end-session"}]},{"group":"Backends","pages":[{"openapi":"https://api.ionq.co/v0.4/api-docs GET /backends","title":"Get Backends","href":"/api-reference/v0.4/backends/get-backends"},{"title":"Get a backend","openapi":"https://api.ionq.co/v0.4/api-docs GET /backends/{backend}","href":"/api-reference/v0.4/backends/get-backend-by-name"},{"openapi":"https://api.ionq.co/v0.4/api-docs GET /backends/{backend}/characterizations/{UUID}","title":"Get a Characterization","href":"/api-reference/v0.4/backends/get-a-characterization"},{"title":"Get all backend characterizations","openapi":"https://api.ionq.co/v0.4/api-docs GET /backends/{backend}/characterizations","href":"/api-reference/v0.4/backends/get-characterizations"}]},{"group":"Utilities","pages":[{"title":"Get usage costs","openapi":"https://api.ionq.co/v0.4/api-docs GET /organizations/{organization_id}/usage","href":"/api-reference/v0.4/util/usages"},{"title":"Get current key","openapi":"https://api.ionq.co/v0.4/api-docs GET /whoami","description":"Gets information about the current token.","href":"/api-reference/v0.4/util/whoami"}]},{"group":"Schemas","pages":[{"openapi":"https://api.ionq.co/v0.4/api-docs GET /schemas/formats/{format}","title":"Get format schema","href":"/api-reference/v0.4/schemas/get-format-schema"},{"title":"Results formats","description":"Catalog of result artifact formats.","href":"/api-reference/v0.4/schemas/results-formats"},{"title":"Circuit formats","href":"/api-reference/v0.4/schemas/circuit-formats"}]}]},{"tab":"API v0.3","pages":[{"title":"API v0.3","href":"/api-reference/v0.3/introduction"}]}]},"title":"Get format schema - IonQ Quantum Cloud Documentation","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-26-lDe7V.js","utils-CWQmgYtH.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-4-Aw3rSD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C2zjXYA5.js","snippetPresets-DFmpFA7C.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-FJpQavWq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D_GvPF7k.js","shallow-Bs2ZB0NO.js","getApiPlaygroundDisplay-DCcqJJk-.js","CodeSnippet-DzDxawVe.js","CodeSnippets-aUr7fU-7.js","Page-CT9uE8Ip.js","getPastedJson-Y1fKsj_I.js","icon-DI4zTsDr.js","MethodPill-C0nDlmSQ.js","DuplicateIcon-NUXbx2nQ.js","createIcon-BdTHrPAi.js","DynamicMarkdown-CtpgKJwj.js","SectionHeading-B3x35tOt.js","axios-vUo_bRtp.js","Markdown-3OmurJMP.js","clsx-DMKzROTp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-1ms6tsT-.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ke9xIMFx.js"]}