{ "openapi": "3.1.0", "info": { "title": "MyOrbitHealth site API", "version": "1.0.0", "summary": "Public agent API over myorbithealth.com content, plus consent-gated contact actions over MCP.", "description": "Unauthenticated endpoints for AI agents and integrators: natural-language site search, paginated article and comparison indexes, a health check, and an MCP server. The REST endpoints are read-only; the only write actions (request_demo, request_callback) are exposed as MCP tools on POST /mcp and must only be called after the user explicitly consents. There are no REST equivalents for actions. All content is sourced from myorbithealth.com. Developer portal: https://myorbithealth.com/developers. Errors use RFC 9457 problem details. Best-effort rate limit: 120 requests per minute per client.", "contact": { "name": "MyOrbitHealth developers", "email": "tech@myorbithealth.com", "url": "https://myorbithealth.com/contact" } }, "servers": [ { "url": "https://myorbithealth.com" } ], "externalDocs": { "description": "llms.txt", "url": "https://myorbithealth.com/llms.txt" }, "paths": { "/mcp": { "post": { "operationId": "mcp", "summary": "MCP server (JSON-RPC 2.0, streamable HTTP, stateless)", "description": "Model Context Protocol 2025-06-18. Supports initialize, notifications/initialized, ping, tools/list, and tools/call. Responses are application/json; notifications return 202. 15 tools: 13 read-only, plus the consent-gated action tools request_demo and request_callback (limited to 5 calls per 10 minutes per client; spam or injection-like input is refused with a JSON-RPC error whose data carries a hint).", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonRpcRequest" } } } }, "responses": { "200": { "description": "JSON-RPC response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonRpcResponse" } } } }, "202": { "description": "Notification accepted" }, "400": { "description": "Malformed JSON-RPC message", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonRpcResponse" } } } }, "413": { "description": "Body too large", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limited", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } }, "get": { "operationId": "mcpGet", "summary": "Not supported — use POST", "responses": { "405": { "description": "Method not allowed; POST JSON-RPC messages instead", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/ask": { "get": { "operationId": "ask", "summary": "Natural-language site search", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "minLength": 2, "maxLength": 200 } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 10, "default": 8 } } ], "responses": { "200": { "description": "Ranked results", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AskResponse" } } } }, "400": { "description": "Missing or invalid query", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limited", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/articles": { "get": { "operationId": "listArticles", "summary": "Blog articles, newest first", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 50, "default": 20 } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "category", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "Launch", "Compliance", "Growth", "Verticals" ] } } ], "responses": { "200": { "description": "A page of articles", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArticlePage" } } } }, "400": { "description": "Invalid pagination or category", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limited", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/comparisons": { "get": { "operationId": "listComparisons", "summary": "MyOrbitHealth-vs-competitor comparison pages", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 50, "default": 20 } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0 } } ], "responses": { "200": { "description": "A page of comparisons", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComparisonPage" } } } }, "400": { "description": "Invalid pagination", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limited", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/health": { "get": { "operationId": "health", "summary": "Health check", "responses": { "200": { "description": "Service is up", "content": { "application/health+json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "pass" ] } }, "required": [ "status" ] } } } } } } }, "/blog/{slug}.md": { "get": { "operationId": "getArticleMarkdown", "summary": "Raw markdown mirror of a blog article", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Article markdown", "content": { "text/markdown": { "schema": { "type": "string" } } } }, "404": { "description": "Unknown slug", "content": { "text/plain": { "schema": { "type": "string" } } } } } } }, "/.well-known/api-catalog": { "get": { "operationId": "apiCatalog", "summary": "RFC 9727 API catalog", "responses": { "200": { "description": "Linkset", "content": { "application/linkset+json": { "schema": { "type": "object" } } } } } } } }, "components": { "schemas": { "Problem": { "type": "object", "description": "RFC 9457 problem details", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "instance": { "type": "string" } }, "required": [ "type", "title", "status", "detail" ] }, "SearchResult": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "name": { "type": "string" }, "description": { "type": "string" }, "kind": { "type": "string", "enum": [ "page", "tool", "solution", "comparison", "article" ] }, "score": { "type": "number", "minimum": 0, "maximum": 1, "description": "Relevance relative to the top result" } }, "required": [ "url", "name", "description", "score" ] }, "AskResponse": { "type": "object", "properties": { "query": { "type": "string" }, "count": { "type": "integer" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/SearchResult" } } }, "required": [ "query", "count", "results" ] }, "Pagination": { "type": "object", "properties": { "total": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "next_offset": { "type": [ "integer", "null" ] } }, "required": [ "total", "limit", "offset", "next_offset" ] }, "Links": { "type": "object", "properties": { "self": { "type": "string" }, "next": { "type": [ "string", "null" ] } } }, "Article": { "type": "object", "properties": { "slug": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "date": { "type": "string", "format": "date" }, "author": { "type": "string" }, "category": { "type": "string" }, "reading_time_minutes": { "type": "integer" }, "url": { "type": "string", "format": "uri" }, "markdown_url": { "type": "string", "format": "uri" } }, "required": [ "slug", "title", "url" ] }, "ArticlePage": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Article" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "links": { "$ref": "#/components/schemas/Links" } }, "required": [ "data", "pagination" ] }, "Comparison": { "type": "object", "properties": { "slug": { "type": "string" }, "competitor": { "type": "string" }, "title": { "type": "string" }, "summary": { "type": "string" }, "as_of": { "type": [ "string", "null" ] }, "url": { "type": "string", "format": "uri" } }, "required": [ "slug", "competitor", "url" ] }, "ComparisonPage": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Comparison" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "links": { "$ref": "#/components/schemas/Links" } }, "required": [ "data", "pagination" ] }, "JsonRpcRequest": { "type": "object", "properties": { "jsonrpc": { "const": "2.0" }, "id": { "type": [ "string", "integer" ] }, "method": { "type": "string", "examples": [ "initialize", "tools/list", "tools/call" ] }, "params": { "type": "object" } }, "required": [ "jsonrpc", "method" ] }, "JsonRpcResponse": { "type": "object", "properties": { "jsonrpc": { "const": "2.0" }, "id": { "type": [ "string", "integer", "null" ] }, "result": { "type": "object" }, "error": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": {} }, "required": [ "code", "message" ] } }, "required": [ "jsonrpc", "id" ] } } } }