Skip to content

Contract Intelligence API

HTTP API for discovering manifest schemas, browsing UI primitives, validating manifests, and getting structural guidance.

Base URL

https://public.ikary.co

All endpoints are prefixed with /api/ except the MCP endpoint at /mcp.

Authentication

None. The API is public and requires no authentication.

Quick start

Fetch the manifest schema:

bash
curl https://public.ikary.co/api/schemas/manifest

Validate a manifest:

bash
curl -X POST https://public.ikary.co/api/validate/manifest \
  -H "Content-Type: application/json" \
  -d '{
    "manifest": {
      "apiVersion": "ikary.co/v1alpha1",
      "kind": "Cell",
      "metadata": { "key": "test", "name": "Test", "version": "0.1.0" },
      "spec": {
        "mount": { "mountPath": "/test", "landingPage": "dashboard" },
        "pages": [{ "key": "dashboard", "type": "dashboard", "title": "Dashboard", "path": "/" }]
      }
    }
  }'

Response:

json
{ "valid": true, "errors": [] }

Endpoints

Schema Discovery

MethodPathDescription
GET/api/schemas/manifestCellManifestV1 schema
GET/api/schemas/entityEntityDefinition schema
GET/api/schemas/pagePageDefinition schema
GET/api/schemas/capabilityCapabilityDefinition schema

See Schema Discovery for parameters and response examples.

UI Primitives

MethodPathDescription
GET/api/primitivesList all 30 UI primitives
GET/api/primitives/{key}Get one primitive contract

See UI Primitives for the full catalog.

Example Manifests

MethodPathDescription
GET/api/examplesList available example manifests
GET/api/examples/{key}Get one example manifest

See Example Manifests for available keys.

Guidance

MethodPathDescription
POST/api/guidance/recommendRecommend manifest structure from a business goal
POST/api/guidance/suggest-pagesGenerate pages for a set of entities
POST/api/guidance/suggest-relationsSuggest entity relations
POST/api/guidance/explain-errorsTurn validation errors into fix suggestions

See Guidance for request bodies and examples.

Validation

MethodPathDescription
POST/api/validate/manifestValidate a full CellManifestV1
POST/api/validate/entityValidate a single EntityDefinition
POST/api/validate/pageValidate a single PageDefinition
POST/api/validate/normalizeValidate and normalize a manifest

See Validation for request and response shapes.

MCP

MethodPathDescription
POST/mcpMCP Streamable HTTP transport (JSON-RPC 2.0)

The same capabilities are available as MCP tools for AI agents. See MCP Endpoint for connection setup.

Response format

All responses are JSON. GET endpoints return the resource directly. POST validation endpoints return { valid, errors } or { valid, manifest, errors }. POST guidance endpoints return structured recommendations.

Error responses follow a consistent shape. See Error Handling for the full reference.

Interactive documentation

Swagger UI is available at /api/docs for interactive exploration.