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

# Get collection metadata



## OpenAPI

````yaml /api-reference/ai-collection/swagger.yml get /v1/collections/{collection_id}
openapi: 3.0.3
info:
  version: 1.0.0
  title: Collections API
  description: |
    Public REST API for the Prisme.ai Collections workspace: named collections
    of structured records with typed schemas, MongoDB-style querying,
    aggregations, and an MCP (JSON-RPC 2.0) endpoint for AI agents.

    Records are isolated per owner (user or agent); a collection can be shared
    with additional agents through its `agent_ids` list. Every write emits an
    audit event.
  contact:
    name: Prisme.ai
    url: https://prisme.ai
servers:
  - url: https://{host}/v2/workspaces/slug:ai-collection-v3/webhooks
    description: Prisme.ai workspace webhooks
    variables:
      host:
        default: api.studio.prisme.ai
        description: API host (override for self-hosted or sandbox)
security:
  - BearerAuth: []
  - OrgApiKeyAuth: []
tags:
  - name: Collections
    description: Create, list, read, update, and delete collections (metadata and schema).
  - name: Records
    description: Insert, query, read, update, upsert, and delete records in a collection.
  - name: Analytics
    description: Count, distinct values, and aggregations (sum, avg, count with grouping).
  - name: MCP
    description: >-
      JSON-RPC 2.0 endpoint exposing the `data_*` tools to AI agents and MCP
      clients.
paths:
  /v1/collections/{collection_id}:
    parameters:
      - $ref: '#/components/parameters/CollectionId'
    get:
      tags:
        - Collections
      summary: Get collection metadata
      operationId: getCollection
      responses:
        '200':
          description: Collection metadata.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Collection'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    CollectionId:
      name: collection_id
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: Collection identifier returned at creation.
  schemas:
    Collection:
      type: object
      properties:
        collection_id:
          type: string
          format: uuid
        name:
          type: string
          example: products
        description:
          type: string
        owner_id:
          type: string
          description: User ID or agent ID owning the collection.
        owner_type:
          type: string
          enum:
            - user
            - agent
        agent_ids:
          type: array
          description: Agents granted access (sharing list).
          items:
            type: string
        settings:
          $ref: '#/components/schemas/CollectionSettings'
        schema:
          $ref: '#/components/schemas/SchemaProperties'
        row_count:
          type: integer
        status:
          type: string
          example: ready
    CollectionSettings:
      type: object
      properties:
        ttl_days:
          type: integer
          minimum: 0
          description: Default record expiration in days (0 = never).
        max_records:
          type: integer
          description: Collection size limit (default 10,000).
    SchemaProperties:
      type: object
      description: 'Column definitions: field name → type descriptor.'
      additionalProperties:
        type: object
        required:
          - type
        properties:
          type:
            type: string
            enum:
              - text
              - integer
              - double
              - boolean
              - date
              - datetime
              - json
              - array
          nullable:
            type: boolean
      example:
        product_name:
          type: text
        price:
          type: double
        stock:
          type: integer
          nullable: true
        active:
          type: boolean
        released_at:
          type: date
        specs:
          type: json
    Error:
      type: object
      properties:
        error:
          type: string
          example: InvalidArguments
        message:
          type: string
  responses:
    NotFound:
      description: Collection or record not found, or the caller has no access to it.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'User session JWT. Send as `Authorization: Bearer <token>`.'
    OrgApiKeyAuth:
      type: apiKey
      in: header
      name: x-prismeai-api-key
      description: Organization-scoped API key.

````