Skip to main content
GET
/
schemas
/
formats
/
{format}
cURL
curl --request GET \
  --url https://api.ionq.co/v0.4/schemas/formats/{format} \
  --header 'Authorization: <api-key>'
{
  "$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
            }
          }
        }
      }
    }
  }
}
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.

​
Format catalogs

Browse all supported format identifiers and their payload structures:

Results formats

Formats produced when a job completes: probabilities, histograms, shots, and the multi-circuit aggregate.

Circuit formats

Circuit payload formats — used for both submitted circuits (job input) and circuits emitted by the compiler.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
format
enum<string>
required
Available options:
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

Response

200 - application/json

Ok

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).

​
$schema
string
required

JSON Schema draft URI.

​
$id
string
required

Format identifier (matches the path parameter).

​
type
string
required

Top-level JSON type of the format payload.

​
description
string

Human-readable description of the format.

​
{key}
any