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

> ## Agent Instructions
> To act on Atlan objects, use the Atlan MCP server at https://api.atlan.com/mcp or the SDK. To install or publish skills from a terminal, use the `aireg` CLI; `aireg --map json` prints its command map. The `atlanai` CLI is deprecated. Run a read-only identity check before any write.
> The docs MCP server at /mcp searches these docs only. It cannot read or change Atlan objects.
> SDK packages: Python `atlanai` (PyPI) and TypeScript `@atlanai/sdk` (npm). Show Python first, then TypeScript.
> These docs cover Atlan AI Registry, Atlan's hosted product. The AI registry specification and aireg CLI are maintained separately. /open-source lists publicly reachable signed installers and explains that the source repository and hosted CLI reference currently require GitHub access. Do not claim the repository or its reference docs are publicly accessible. Use these docs for Atlan-specific setup such as the adapter, sign-in and workspaces.

# Query governed knowledge records as of a business-valid instant



## OpenAPI

````yaml /public-openapi.json post /ontology/v1/record-queries
openapi: 3.1.0
info:
  title: Atlan public API
  version: current
  description: >-
    Public HTTP API reference for Registry, Skills, Agents, outputs, files, MCP
    servers and tools, and OTLP telemetry ingestion.
servers:
  - url: https://api.atlan.com
    description: Atlan API base URL
security:
  - bearer: []
tags:
  - name: Core
  - name: Skill
  - name: Agent
  - name: Files
  - name: Knowledge
  - name: MCP
  - name: Observability
  - name: API proxy
  - name: Credentials
  - name: Store
  - name: Apps
  - name: Evals
  - name: Ontologies
  - name: Ontology bindings
  - name: Slack
  - name: GitHub
  - name: Objectives
  - name: Repositories
paths:
  /ontology/v1/record-queries:
    post:
      tags:
        - Ontologies
      summary: Query governed knowledge records as of a business-valid instant
      operationId: ontology.queryKnowledgeRecords
      parameters:
        - name: Content-Encoding
          in: header
          required: false
          schema:
            type: string
            enum:
              - base64
              - gzip, base64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ontology-RecordQuery'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ontology-RecordQueryResult'
          description: HTTP 200 response.
        '400':
          content:
            application/problem+json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ontology-ProblemDetails'
                  - type: object
                    required:
                      - code
                    properties:
                      code:
                        type: string
                        enum:
                          - invalid_base64
                          - invalid_gzip
                          - invalid_json
          description: HTTP 400 response.
        '401':
          content:
            application/problem+json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ontology-ProblemDetails'
                  - type: object
                    required:
                      - code
                    properties:
                      code:
                        type: string
                        enum:
                          - alg_mismatch
                          - alg_not_allowed
                          - audience_mismatch
                          - invalid_api_key
                          - missing_identity
                          - missing_org
                          - missing_user
                          - signature_invalid
                          - token_expired
                          - token_malformed
                          - token_missing
                          - token_not_yet_valid
                          - token_rejected
                          - token_service_account_unbound
                          - unauthorized
                          - unknown_account
                          - unknown_key
                          - untrusted_issuer
          description: HTTP 401 response.
        '403':
          content:
            application/problem+json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ontology-ProblemDetails'
                  - type: object
                    required:
                      - code
                    properties:
                      code:
                        type: string
                        enum:
                          - access_denied
                          - account_suspended
                          - forbidden
                          - platform_principal_refused
          description: HTTP 403 response.
        '413':
          content:
            application/problem+json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ontology-ProblemDetails'
                  - type: object
                    required:
                      - code
                    properties:
                      code:
                        type: string
                        enum:
                          - compressed_payload_too_large
                          - decompressed_payload_too_large
                          - payload_too_large
          description: HTTP 413 response.
        '415':
          content:
            application/problem+json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ontology-ProblemDetails'
                  - type: object
                    required:
                      - code
                    properties:
                      code:
                        type: string
                        enum:
                          - unsupported_content_encoding
                          - unsupported_content_type
          description: HTTP 415 response.
        '422':
          content:
            application/problem+json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ontology-ProblemDetails'
                  - type: object
                    required:
                      - code
                    properties:
                      code:
                        type: string
                        enum:
                          - unprocessable
                          - validation_failed
          description: HTTP 422 response.
        '500':
          content:
            application/problem+json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ontology-ProblemDetails'
                  - type: object
                    required:
                      - code
                    properties:
                      code:
                        type: string
                        enum:
                          - internal_error
          description: HTTP 500 response.
        '503':
          content:
            application/problem+json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ontology-ProblemDetails'
                  - type: object
                    required:
                      - code
                    properties:
                      code:
                        type: string
                        enum:
                          - auth_unavailable
                          - service_overloaded
                          - service_unavailable
          description: HTTP 503 response.
        '504':
          content:
            application/problem+json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ontology-ProblemDetails'
                  - type: object
                    required:
                      - code
                    properties:
                      code:
                        type: string
                        enum:
                          - request_timeout
          description: HTTP 504 response.
components:
  schemas:
    ontology-RecordQuery:
      type: object
      required:
        - ontology_id
      properties:
        as_of:
          type:
            - string
            - 'null'
          format: date-time
        include_knowledge_references:
          type: boolean
        include_relationships:
          type: boolean
        lifecycle_states:
          type: array
          items:
            $ref: '#/components/schemas/ontology-RecordStatus'
        limit:
          type:
            - integer
            - 'null'
          minimum: 0
        offset:
          type:
            - integer
            - 'null'
          minimum: 0
        ontology_id:
          type: string
        query:
          type:
            - string
            - 'null'
        record_set_id:
          type:
            - string
            - 'null'
        record_set_release_id:
          type:
            - string
            - 'null'
        record_type_artifact_id:
          type:
            - string
            - 'null'
      additionalProperties: false
    ontology-RecordQueryResult:
      type: object
      required:
        - ontology_id
        - as_of
        - records
        - limit
        - offset
        - scanned_count
        - has_more
        - scan_truncated
      properties:
        as_of:
          type: string
          format: date-time
        has_more:
          type: boolean
        limit:
          type: integer
          minimum: 0
        offset:
          type: integer
          minimum: 0
        ontology_id:
          type: string
        records:
          type: array
          items:
            $ref: '#/components/schemas/ontology-GovernedRecord'
        scan_truncated:
          type: boolean
        scanned_count:
          type: integer
          minimum: 0
    ontology-ProblemDetails:
      type: object
      required:
        - title
        - status
        - detail
        - code
      properties:
        code:
          type: string
        detail:
          type: string
        status:
          type: integer
          format: int32
          minimum: 0
        title:
          type: string
        trace_id:
          type:
            - string
            - 'null'
    ontology-RecordStatus:
      type: string
      enum:
        - draft
        - active
        - superseded
        - retired
    ontology-GovernedRecord:
      type: object
      required:
        - artifact_id
        - name
        - display_name
        - artifact_version
        - content_hash
        - record
      properties:
        artifact_id:
          type: string
        artifact_version:
          type: integer
          format: int64
        content_hash:
          type: string
        display_name:
          type: string
        name:
          type: string
        record:
          $ref: '#/components/schemas/ontology-RecordMeta'
    ontology-RecordMeta:
      type: object
      required:
        - ontology_id
        - api_name
        - ontology_release
        - record_type_artifact_id
        - record_type
        - values
        - effective_from
        - lifecycle_state
      properties:
        api_name:
          type: string
        effective_from:
          type: string
          format: date-time
        effective_to:
          type:
            - string
            - 'null'
          format: date-time
        knowledge_references:
          type: array
          items:
            $ref: '#/components/schemas/ontology-KnowledgeReference'
        lifecycle_state:
          $ref: '#/components/schemas/ontology-RecordStatus'
        ontology_id:
          type: string
        ontology_release:
          $ref: '#/components/schemas/ontology-OntologyReleaseRef'
        record_type:
          $ref: '#/components/schemas/ontology-ArtifactVersionRef'
        record_type_artifact_id:
          type: string
        relationships:
          type: array
          items:
            $ref: '#/components/schemas/ontology-RecordRelationship'
        supersedes:
          type: array
          items:
            type: string
        values:
          type: object
          additionalProperties: {}
          propertyNames:
            type: string
      additionalProperties: false
    ontology-KnowledgeReference:
      type: object
      required:
        - concept
      properties:
        concept:
          $ref: '#/components/schemas/ontology-ArtifactVersionRef'
      additionalProperties: false
    ontology-OntologyReleaseRef:
      type: object
      required:
        - ontology_id
        - release_id
        - version_label
        - manifest_digest
      properties:
        manifest_digest:
          type: string
        ontology_id:
          type: string
        release_id:
          type: string
        version_label:
          type: string
      additionalProperties: false
    ontology-ArtifactVersionRef:
      type: object
      required:
        - kind
        - artifact_id
        - version_ordinal
        - content_hash
      properties:
        artifact_id:
          type: string
        content_hash:
          type: string
        kind:
          type: string
        version_ordinal:
          type: integer
          format: int64
      additionalProperties: false
    ontology-RecordRelationship:
      type: object
      required:
        - relationship_type
        - target_record_id
      properties:
        relationship_type:
          $ref: '#/components/schemas/ontology-ArtifactVersionRef'
        target_record_id:
          type: string
        valid_time:
          oneOf:
            - $ref: '#/components/schemas/ontology-ValidTime'
            - type: 'null'
      additionalProperties: false
    ontology-ValidTime:
      type: object
      required:
        - effective_from
      properties:
        effective_from:
          type: string
        effective_to:
          type:
            - string
            - 'null'
      additionalProperties: false
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.