> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ionq.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get format schema

> Get the JSON Schema for an artifact format.

When a job produces an artifact — result data or a compiled circuit — its [`ArtifactDescriptor`](/api-reference/v0.4/jobs/get-job-artifact) 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:

<CardGroup cols={2}>
  <Card title="Results formats" icon="chart-line" href="/api-reference/v0.4/schemas/results-formats">
    Formats produced when a job completes: probabilities, histograms, shots, and the multi-circuit aggregate.
  </Card>

  <Card title="Circuit formats" icon="microchip" href="/api-reference/v0.4/schemas/circuit-formats">
    Circuit payload formats — used for both submitted circuits (job `input`) and circuits emitted by the compiler.
  </Card>
</CardGroup>


## OpenAPI

````yaml https://api.ionq.co/v0.4/api-docs GET /schemas/formats/{format}
openapi: 3.0.3
info:
  contact:
    email: support@ionq.co
    name: IonQ
    url: https://ionq.com/
  description: |
    *Last updated: June 29, 2026*
    IonQ's API for accessing the IonQ Quantum Cloud platform

    Please subscribe for automated updates when we perform maintenance or
    experience an outage.

    In addition, you may use the [status endpoint](#tag/status) to check the
    current status of our API.

    ## Authentication

    <SecurityDefinitions />
  title: IonQ Cloud Platform API
  version: v0.4
servers:
  - url: https://api.ionq.co/v0.4
security: []
paths:
  /schemas/formats/{format}:
    get:
      tags:
        - Schemas
      description: >-
        Returns the JSON Schema document for the requested artifact format.

        See the Results formats and Circuit formats catalog pages for the full
        list of identifiers and their payload schemas.
      operationId: GetFormatSchema
      parameters:
        - in: path
          name: format
          required: true
          schema:
            $ref: '#/components/schemas/Formats'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FormatSchemaDocument'
              examples:
                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
      security:
        - apiKeyAuth: []
components:
  schemas:
    Formats:
      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
    FormatSchemaDocument:
      description: >-
        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).
      properties:
        $schema:
          type: string
          description: JSON Schema draft URI.
        $id:
          type: string
          description: Format identifier (matches the path parameter).
        type:
          type: string
          description: Top-level JSON type of the format payload.
        description:
          type: string
          description: Human-readable description of the format.
      required:
        - $schema
        - $id
        - type
      type: object
      additionalProperties: {}
  securitySchemes:
    apiKeyAuth:
      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`
      in: header
      name: Authorization
      type: apiKey

````