OpenAPI Specification & Swagger UI

Corexar provides complete interactive specifications for all system API endpoints:

  • /api-docs/swagger — Interactive Swagger UI interface with live in-browser request execution
  • /api-docs/swagger.json — Machine-readable OpenAPI 3.1.0 schema for code generation, client SDKs and contracts

Personal API Keys

API keys enable external scripts, CI/CD pipelines, and AI assistants to securely interact with collections on your behalf while respecting role boundaries:

cURL
# Example: Fetching collections via API key
curl -s -H "Authorization: Bearer cxk_live_a89f2e71..." \
  https://corexar.example.com/api/projects

Model Context Protocol (MCP)

The built-in MCP server allows LLM agents (Claude Desktop, Cursor, Google Antigravity, Cline) to discover collections, find cards, inspect fields, and apply changes:

claude_desktop_config.json
{
  "mcpServers": {
    "corexar": {
      "command": "node",
      "args": ["/path/to/corexar/mcp-server/index.mjs"],
      "env": {
        "COREXAR_URL": "https://corexar.example.com",
        "COREXAR_API_KEY": "cxk_your_key_here"
      }
    }
  }
}

Available MCP Tools

  • corexar_get_profile — Identity check, accessible workspaces and key permissions
  • corexar_list_projects — List workspace collections with field schema metadata
  • corexar_get_collection_schema — Detailed collection schema, workflow states and view layouts
  • corexar_search_items — Full-text and faceted search across collections and items
  • corexar_create_item — Create a new item with field validation and access enforcement
  • corexar_update_item_fields — Batch or selective patching of item field values