Clarity · Schema

AdminCreateCollectionRequest

Admin request to register a collection and materialize its table (the contour agents use). Deleting a collection is deliberately NOT exposed here — that belongs to the owning client on the user API.

Artificial IntelligenceCustomer ExperienceAI AgentsEnterprise

Properties

Name Type Description
project_id integer Project to create the collection in.
owner_id integer User id of the owning client (may delete it).
slug string Kebab-case slug, unique per project.
title string Human title.
description object Optional human description.
json_schema object JSON Schema of a record: top-level object with typed properties. A property's 'title' becomes its human-readable label in the UI.
indexes array Indexes to create on the dynamic table (btree, scalar fields only).
ticket_link_field object Field whose value is a ticket unique_id (text or integer field); it makes the collection's other fields available as ticket filters. Omit to auto-link a field named 'ticket_id' / 'unique_id' when pres
ticket_link_es_field object ES ticket field the link values are matched against (keyword); omit for unique_id — e.g. 'user_name' to join an author collection by handle.
View JSON Schema on GitHub

JSON Schema

onclarity-com-admin-create-collection-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/onclarity-com/json-schema/onclarity-com-admin-create-collection-request-schema.json",
  "title": "AdminCreateCollectionRequest",
  "description": "Admin request to register a collection and materialize its table (the contour\nagents use). Deleting a collection is deliberately NOT exposed here — that belongs\nto the owning client on the user API.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/onclarity-com-agent-store-admin-api-openapi.yml#/components/schemas/AdminCreateCollectionRequest",
  "properties": {
    "project_id": {
      "type": "integer",
      "title": "Project Id",
      "description": "Project to create the collection in."
    },
    "owner_id": {
      "type": "integer",
      "title": "Owner Id",
      "description": "User id of the owning client (may delete it)."
    },
    "slug": {
      "type": "string",
      "title": "Slug",
      "description": "Kebab-case slug, unique per project."
    },
    "title": {
      "type": "string",
      "title": "Title",
      "description": "Human title."
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Description",
      "description": "Optional human description."
    },
    "json_schema": {
      "additionalProperties": true,
      "type": "object",
      "title": "Json Schema",
      "description": "JSON Schema of a record: top-level object with typed properties. A property's 'title' becomes its human-readable label in the UI."
    },
    "indexes": {
      "items": {
        "$ref": "#/$defs/IndexSpec"
      },
      "type": "array",
      "title": "Indexes",
      "description": "Indexes to create on the dynamic table (btree, scalar fields only)."
    },
    "ticket_link_field": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Ticket Link Field",
      "description": "Field whose value is a ticket unique_id (text or integer field); it makes the collection's other fields available as ticket filters. Omit to auto-link a field named 'ticket_id' / 'unique_id' when present (each joins the same-named ticket field: ticket_id is the source system's id, unique_id the index id); send null to stay unlinked. Indexing it is recommended."
    },
    "ticket_link_es_field": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Ticket Link Es Field",
      "description": "ES ticket field the link values are matched against (keyword); omit for unique_id — e.g. 'user_name' to join an author collection by handle."
    }
  },
  "type": "object",
  "required": [
    "project_id",
    "owner_id",
    "slug",
    "title",
    "json_schema"
  ],
  "$defs": {
    "IndexSpec": {
      "properties": {
        "fields": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "title": "Fields",
          "description": "Schema fields the index covers (1..5)."
        },
        "unique": {
          "type": "boolean",
          "title": "Unique",
          "description": "Create as a UNIQUE index.",
          "default": false
        }
      },
      "type": "object",
      "required": [
        "fields"
      ],
      "title": "IndexSpec",
      "description": "One requested index over the collection's dynamic table (btree, scalar fields)."
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/onclarity-com-admin-create-collection-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.