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

# Schema Inventory

> Return the data-derived schema inventory for an authorized dataset.

Summarizes the knowledge graph by semantic type: per-type instance
counts, representative sample names, and the per-pair relationship
distribution. Wraps the ``get_schema_inventory`` SDK function so it
is accessible over HTTP with an OpenAPI response schema.

Query parameters:
    dataset_id: dataset UUID to scope the graph databases.
    samples_per_type: max sample instance names per type (default 5).
    sort: ``"count"`` (default) orders types by descending count;
        ``"none"`` preserves discovery order.



## OpenAPI

````yaml /cognee_openapi_spec.json get /api/v1/schema/inventory
openapi: 3.1.0
info:
  title: Cognee API
  description: Cognee API with Bearer token and Cookie auth
  version: 1.0.0
servers:
  - url: https://api.cognee.ai
    description: Production server (full functionality)
  - url: http://localhost:8000
    description: Local development server (requires local setup)
security:
  - BearerAuth: []
  - ApiKeyAuth: []
tags:
  - name: activity
    description: ''
  - name: add
    description: Data ingestion endpoints for adding text, files, and structured data.
  - name: agent connections
    description: ''
  - name: agent management
    description: ''
  - name: auth
    description: >-
      Authentication endpoints for user registration, login, and token
      management.
  - name: checks
    description: ''
  - name: cognify
    description: >-
      Knowledge processing endpoints to transform raw data into knowledge
      graphs.
  - name: configuration
    description: ''
  - name: datasets
    description: Dataset management endpoints for listing, creating, and deleting datasets.
  - name: delete
    description: Data deletion endpoints (deprecated — use datasets endpoints instead).
  - name: forget
    description: ''
  - name: health
    description: ''
  - name: improve
    description: ''
  - name: llm
    description: ''
  - name: memify
    description: ''
  - name: ontologies
    description: ''
  - name: permissions
    description: Permission management for multi-user access control.
  - name: recall
    description: ''
  - name: remember
    description: ''
  - name: responses
    description: Response generation endpoints using the knowledge graph.
  - name: schema
    description: ''
  - name: search
    description: Search endpoints for querying the knowledge graph.
  - name: sessions
    description: ''
  - name: settings
    description: Configuration endpoints for managing Cognee settings.
  - name: skills
    description: ''
  - name: sync
    description: ''
  - name: update
    description: ''
  - name: users
    description: User management endpoints.
  - name: visualize
    description: Graph visualization endpoints.
paths:
  /api/v1/schema/inventory:
    get:
      tags:
        - schema
      summary: Schema Inventory
      description: |-
        Return the data-derived schema inventory for an authorized dataset.

        Summarizes the knowledge graph by semantic type: per-type instance
        counts, representative sample names, and the per-pair relationship
        distribution. Wraps the ``get_schema_inventory`` SDK function so it
        is accessible over HTTP with an OpenAPI response schema.

        Query parameters:
            dataset_id: dataset UUID to scope the graph databases.
            samples_per_type: max sample instance names per type (default 5).
            sort: ``"count"`` (default) orders types by descending count;
                ``"none"`` preserves discovery order.
      operationId: schema_inventory_api_v1_schema_inventory_get
      parameters:
        - name: dataset_id
          in: query
          required: true
          schema:
            type: string
            format: uuid
            description: >-
              Dataset UUID to scope the graph databases. List your datasets via
              GET /api/v1/datasets to find it.
            examples:
              - 3fa85f64-5717-4562-b3fc-2c963f66afa6
            title: Dataset Id
          description: >-
            Dataset UUID to scope the graph databases. List your datasets via
            GET /api/v1/datasets to find it.
        - name: samples_per_type
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
            default: 5
            title: Samples Per Type
        - name: sort
          in: query
          required: false
          schema:
            type: string
            description: >-
              Sort order: 'count' (default) orders types by descending instance
              count; 'none' preserves discovery order. Other values are
              rejected.
            examples:
              - count
            default: count
            title: Sort
          description: >-
            Sort order: 'count' (default) orders types by descending instance
            count; 'none' preserves discovery order. Other values are rejected.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SchemaInventoryItem'
                title: Response Schema Inventory Api V1 Schema Inventory Get
        '403':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/cognee__api__v1__visualize__routers__get_schema_router__ErrorResponse
          description: Forbidden
        '409':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/cognee__api__v1__visualize__routers__get_schema_router__ErrorResponse
          description: Conflict
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - BearerAuth: []
        - ApiKeyAuth: []
components:
  schemas:
    SchemaInventoryItem:
      properties:
        type:
          anyOf:
            - type: string
            - type: 'null'
          title: Type
          description: Semantic type name.
        count:
          type: integer
          minimum: 0
          title: Count
          description: Total number of instances of this type.
        samples:
          items:
            anyOf:
              - type: string
              - type: 'null'
          type: array
          title: Samples
          description: Representative instance names.
        sample_size:
          type: integer
          minimum: 0
          title: Sample Size
          description: Number of returned samples.
        relationships:
          items:
            $ref: '#/components/schemas/SchemaInventoryRelationship'
          type: array
          title: Relationships
          description: Relationship aggregates involving this semantic type.
      type: object
      required:
        - count
        - sample_size
      title: SchemaInventoryItem
      description: Per-semantic-type inventory row returned by /schema/inventory.
    cognee__api__v1__visualize__routers__get_schema_router__ErrorResponse:
      properties:
        error:
          type: string
          title: Error
      type: object
      required:
        - error
      title: ErrorResponse
      description: Generic API error response.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    SchemaInventoryRelationship:
      properties:
        to_type:
          anyOf:
            - type: string
            - type: 'null'
          title: To Type
          description: Target semantic type for this relationship aggregate.
        relation:
          type: string
          title: Relation
          description: Relationship name.
        count:
          type: integer
          minimum: 0
          title: Count
          description: Number of matching relationships.
      type: object
      required:
        - relation
        - count
      title: SchemaInventoryRelationship
      description: Relationship aggregate from one semantic type to another.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key

````