HomeDocumentation

API Documentation

Everything you need to integrate with Spec Workbench

OpenAPI Spec

Multi-Format Support

OpenAPI 3.x, AsyncAPI 2.x, JSON Schema, and MCP specs

Instant Validation

Real-time validation with detailed error messages and suggestions

Auto-Repair

Automatically fix common spec issues like missing required fields

MCP Generation

Generate production-ready MCP servers with PlatPhorm identity

Quick Start

Get started with the Spec Workbench API in seconds

# Validate a spec
curl -X POST https://spec.platphormnews.com/api/v1/specs/validate \
  -H "Content-Type: application/json" \
  -d '{"content": "{\"openapi\": \"3.1.0\", ...}"}'

API Endpoints

All available REST API endpoints

GET

/api/health

Health check endpoint

{ status, version, latency_ms }

GET

/api/docs

OpenAPI 3.1 specification

OpenAPI JSON document

GET

/api/v1/specs

List saved specs

{ specs: [], total }

POST

/api/v1/specs

Create and parse a spec

{ id, name, type, is_valid }

POST

/api/v1/specs/validate

Validate a spec inline

{ isValid, errors, warnings }

POST

/api/v1/specs/repair

Auto-repair common issues

{ wasRepaired, changes, repairedContent }

POST

/api/v1/generate/mcp

Generate MCP server scaffold

{ files: [], summary }

POST

/api/v1/generate/client

Generate typed client code

{ files: [], summary }

GET

/api/v1/network/spec-sources

List discovered network spec source URLs

{ sources: [], status, updatedAt }

POST

/api/v1/import/probe

Probe trusted URLs and return importable specs

{ results: [], firstImportable }

GET

/api/mcp

MCP server metadata, tools, resources, and prompts

{ endpoint, methods, tools, resources, prompts }

POST

/api/mcp

JSON-RPC MCP endpoint for tools/resources/prompts

{ jsonrpc, id, result | error }

MCP Tooling

Model Context Protocol tools available at /api/mcp

validate_specrepair_specdiff_specslist_network_spec_sourcesprobe_trusted_spec_urlsimport_trusted_spec_urldiff_trusted_spec_urls

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "probe_trusted_spec_urls",
    "arguments": {
      "urls": ["https://spec.platphormnews.com/openapi.yaml"]
    }
  }
}

Discovery Endpoints

Machine-readable service discovery files

/llms.txt

LLM-friendly service description

/llms-full.txt

Complete API documentation for LLMs

/llms-index.json

Structured LLM index

/sitemap.xml

XML sitemap for crawlers

/feed.xml

RSS feed for updates

/robots.txt

Crawler instructions

Part of the PlatPhorm News Network

Status Changelog GitHub