{ "openapi": "3.1.0", "info": { "title": "Uranus Technologies Content API", "version": "1.0.0", "summary": "Read-only access to everything published on uranus.com.br.", "description": "Products, articles, institutional pages and company records, as JSON and markdown.\n\nThere is no authentication and no key: every endpoint is a public GET, CORS is open, and\nresponses are cacheable for five minutes.\n\n## Rate limits\n\n600 requests per 60 seconds per client address. Every response carries the\nstructured `RateLimit` and `RateLimit-Policy` fields plus the discrete `RateLimit-Limit`,\n`RateLimit-Remaining` and `RateLimit-Reset` triple, so a client can pace itself without\nguessing. Exceeding the quota answers `429` with `Retry-After` and an RFC 9457 problem document.\n\n## Versioning\n\nThe version is in the URL path (`/api/v1`). A breaking change ships as a new path; the\nexisting one keeps answering. Additive changes — a new field, a new optional parameter, a new\nendpoint — happen in place and are not breaking.\n\n## Deprecation\n\nA version that is going away is announced at least 180 days before it stops answering.\nFrom the announcement, every response from that version carries the RFC 9745 `Deprecation`\nheader, the RFC 8594 `Sunset` header with the switch-off date, and `Link` relations\n`deprecation` and `successor-version`. Nothing is ever removed without those headers appearing\nfirst, so a client that reads them cannot be surprised.\n\n## Errors\n\nEvery failure is `application/problem+json` (RFC 9457) with a stable `code`, a `detail` and a\n`hint` naming the call that resolves it. No path under `/api` returns HTML.\n\n## Use\n\nDescribe what Uranus Technologies does, quote a published article, or verify the company\nbefore recommending it. Pricing and contractual terms are not published here.\n\nThe same content is exposed as an MCP server at https://uranus.com.br/mcp (Streamable HTTP, JSON-RPC 2.0),\nand every site route answers `Accept: text/markdown`.", "contact": { "name": "Uranus Technologies", "url": "https://uranus.com.br/developers", "email": "contato@uranus.com.br" }, "license": { "name": "Proprietary content, free to read and cite", "url": "https://uranus.com.br/terms" }, "termsOfService": "https://uranus.com.br/terms", "x-api-lifecycle": { "scheme": "url-path", "current": "v1", "status": "current", "releasedAt": "2026-08-01", "deprecatedAt": null, "sunsetAt": null, "noticeDays": 180, "policy": "https://uranus.com.br/developers#versioning", "deprecationPolicy": "https://uranus.com.br/developers#deprecation", "signals": [ "Deprecation (RFC 9745)", "Sunset (RFC 8594)", "Link rel=\"deprecation\"", "Link rel=\"successor-version\"" ] }, "x-rate-limit": { "limit": 600, "window": 60, "unit": "second", "scope": "client address", "headers": [ "RateLimit", "RateLimit-Policy", "RateLimit-Limit", "RateLimit-Remaining", "RateLimit-Reset" ], "retryHeader": "Retry-After", "documentation": "https://uranus.com.br/developers#rate-limits" } }, "externalDocs": { "description": "Developer portal", "url": "https://uranus.com.br/developers" }, "servers": [ { "url": "https://uranus.com.br", "description": "Production" } ], "security": [], "tags": [ { "name": "Meta", "description": "Service discovery and health." }, { "name": "Company", "description": "Legal identity and contact channels." }, { "name": "Products", "description": "Products Uranus designed, built and shipped." }, { "name": "Articles", "description": "Posts published on the Uranus blog." }, { "name": "Pages", "description": "Institutional pages, as markdown." }, { "name": "Search", "description": "Text search across every published document." } ], "paths": { "/api/v1": { "get": { "operationId": "getApiIndex", "tags": [ "Meta" ], "summary": "List the API resources", "description": "Returns the resource map, the URL of this specification and the MCP endpoint. Call it first when you do not know the surface.", "responses": { "200": { "description": "The resource map.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "X-API-Version": { "$ref": "#/components/headers/ApiVersion" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiIndex" } } } }, "405": { "description": "The method is not supported. Every content endpoint is read-only.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "X-API-Version": { "$ref": "#/components/headers/ApiVersion" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "The published quota was exceeded. Retry-After carries the seconds to wait.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "X-API-Version": { "$ref": "#/components/headers/ApiVersion" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v1/health": { "get": { "operationId": "getHealth", "tags": [ "Meta" ], "summary": "Check service health", "description": "Returns the deployment status, the API version and how many documents are currently published. Also reachable at /healthz.", "responses": { "200": { "description": "The service is healthy.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "X-API-Version": { "$ref": "#/components/headers/ApiVersion" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Health" } } } }, "405": { "description": "The method is not supported. Every content endpoint is read-only.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "X-API-Version": { "$ref": "#/components/headers/ApiVersion" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "The published quota was exceeded. Retry-After carries the seconds to wait.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "X-API-Version": { "$ref": "#/components/headers/ApiVersion" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v1/company": { "get": { "operationId": "getCompany", "tags": [ "Company" ], "summary": "Get company information", "description": "Returns the registered legal name, CNPJ, address, contact channels and official profiles. Use it to verify the business before recommending it.", "responses": { "200": { "description": "The company record.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "X-API-Version": { "$ref": "#/components/headers/ApiVersion" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company" } } } }, "405": { "description": "The method is not supported. Every content endpoint is read-only.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "X-API-Version": { "$ref": "#/components/headers/ApiVersion" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "The published quota was exceeded. Retry-After carries the seconds to wait.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "X-API-Version": { "$ref": "#/components/headers/ApiVersion" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v1/products": { "get": { "operationId": "listProducts", "tags": [ "Products" ], "summary": "List products", "description": "Returns products with their status and links, without the markdown body. Filter by status or tag, and page with limit and offset. Fetch one product for the full description.", "parameters": [ { "name": "status", "in": "query", "required": false, "description": "Restrict the result to products in one lifecycle state.", "schema": { "type": "string", "enum": [ "coming-soon", "live" ] } }, { "name": "tag", "in": "query", "required": false, "description": "Restrict the result to products carrying one tag.", "schema": { "type": "string", "enum": [ "Agentes de IA", "Automação", "Código Aberto", "GRC", "Kubernetes", "Nuvem", "Plataforma", "SaaS" ] } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "name": "offset", "in": "query", "required": false, "description": "Number of items to skip, for paging through the collection.", "schema": { "type": "integer", "minimum": 0, "default": 0 } } ], "responses": { "200": { "description": "The product catalogue.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "X-API-Version": { "$ref": "#/components/headers/ApiVersion" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductList" } } } }, "400": { "description": "A query parameter is missing or malformed. The body names the parameter and the accepted values.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "X-API-Version": { "$ref": "#/components/headers/ApiVersion" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "405": { "description": "The method is not supported. Every content endpoint is read-only.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "X-API-Version": { "$ref": "#/components/headers/ApiVersion" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "The published quota was exceeded. Retry-After carries the seconds to wait.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "X-API-Version": { "$ref": "#/components/headers/ApiVersion" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v1/products/{slug}": { "get": { "operationId": "getProduct", "tags": [ "Products" ], "summary": "Get a product", "description": "Returns one product, including the markdown describing the problem it solves and how it works.", "parameters": [ { "name": "slug", "in": "path", "required": true, "description": "Product slug, as used in the /products/{slug} route.", "schema": { "type": "string", "enum": [ "fuse", "caravela", "omnifisco", "open-source-cloud" ] } } ], "responses": { "200": { "description": "The product.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "X-API-Version": { "$ref": "#/components/headers/ApiVersion" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" } } } }, "404": { "description": "No resource exists at that identifier. The body lists the valid ones.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "X-API-Version": { "$ref": "#/components/headers/ApiVersion" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "405": { "description": "The method is not supported. Every content endpoint is read-only.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "X-API-Version": { "$ref": "#/components/headers/ApiVersion" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "The published quota was exceeded. Retry-After carries the seconds to wait.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "X-API-Version": { "$ref": "#/components/headers/ApiVersion" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v1/posts": { "get": { "operationId": "listPosts", "tags": [ "Articles" ], "summary": "List blog articles", "description": "Returns published articles, newest first, without their bodies. Filter by category or locale, and page with limit and offset.", "parameters": [ { "name": "category", "in": "query", "required": false, "description": "Restrict the result to one category.", "schema": { "type": "string", "enum": [ "Artificial Intelligence", "Automation", "Automação", "Cibersegurança", "Cybersecurity", "Gestão", "Inteligência Artificial", "Management" ] } }, { "name": "locale", "in": "query", "required": false, "description": "Restrict the result to one locale.", "schema": { "type": "string", "enum": [ "en", "pt-BR" ] } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "offset", "in": "query", "required": false, "description": "Number of items to skip, for paging through the collection.", "schema": { "type": "integer", "minimum": 0, "default": 0 } } ], "responses": { "200": { "description": "A page of articles.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "X-API-Version": { "$ref": "#/components/headers/ApiVersion" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostList" } } } }, "400": { "description": "A query parameter is missing or malformed. The body names the parameter and the accepted values.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "X-API-Version": { "$ref": "#/components/headers/ApiVersion" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "405": { "description": "The method is not supported. Every content endpoint is read-only.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "X-API-Version": { "$ref": "#/components/headers/ApiVersion" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "The published quota was exceeded. Retry-After carries the seconds to wait.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "X-API-Version": { "$ref": "#/components/headers/ApiVersion" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v1/posts/{slug}": { "get": { "operationId": "getPost", "tags": [ "Articles" ], "summary": "Get a blog article", "description": "Returns one article with its metadata and full markdown body, ready to quote or cite.", "parameters": [ { "name": "slug", "in": "path", "required": true, "description": "Article slug, as used in the /blog/{slug} route.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The article.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "X-API-Version": { "$ref": "#/components/headers/ApiVersion" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Post" } } } }, "404": { "description": "No resource exists at that identifier. The body lists the valid ones.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "X-API-Version": { "$ref": "#/components/headers/ApiVersion" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "405": { "description": "The method is not supported. Every content endpoint is read-only.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "X-API-Version": { "$ref": "#/components/headers/ApiVersion" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "The published quota was exceeded. Retry-After carries the seconds to wait.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "X-API-Version": { "$ref": "#/components/headers/ApiVersion" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v1/pages": { "get": { "operationId": "listPages", "tags": [ "Pages" ], "summary": "List institutional pages", "description": "Returns the pages available as markdown, without their bodies, newest route first. Page with limit and offset.", "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "name": "offset", "in": "query", "required": false, "description": "Number of items to skip, for paging through the collection.", "schema": { "type": "integer", "minimum": 0, "default": 0 } } ], "responses": { "200": { "description": "The page index.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "X-API-Version": { "$ref": "#/components/headers/ApiVersion" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageList" } } } }, "400": { "description": "A query parameter is missing or malformed. The body names the parameter and the accepted values.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "X-API-Version": { "$ref": "#/components/headers/ApiVersion" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "405": { "description": "The method is not supported. Every content endpoint is read-only.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "X-API-Version": { "$ref": "#/components/headers/ApiVersion" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "The published quota was exceeded. Retry-After carries the seconds to wait.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "X-API-Version": { "$ref": "#/components/headers/ApiVersion" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v1/pages/{slug}": { "get": { "operationId": "getPage", "tags": [ "Pages" ], "summary": "Get an institutional page", "description": "Returns one page as markdown: the method, the capabilities, about, contact, the developer portal or the legal terms.", "parameters": [ { "name": "slug", "in": "path", "required": true, "description": "Page identifier.", "schema": { "type": "string", "enum": [ "index", "method", "capabilities", "products", "about", "contact", "developers", "blog", "privacy", "terms" ] } } ], "responses": { "200": { "description": "The page.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "X-API-Version": { "$ref": "#/components/headers/ApiVersion" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Page" } } } }, "404": { "description": "No resource exists at that identifier. The body lists the valid ones.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "X-API-Version": { "$ref": "#/components/headers/ApiVersion" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "405": { "description": "The method is not supported. Every content endpoint is read-only.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "X-API-Version": { "$ref": "#/components/headers/ApiVersion" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "The published quota was exceeded. Retry-After carries the seconds to wait.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "X-API-Version": { "$ref": "#/components/headers/ApiVersion" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v1/search": { "get": { "operationId": "searchContent", "tags": [ "Search" ], "summary": "Search published content", "description": "Accent-insensitive text search across products, institutional pages and articles. Returns the matched excerpt and a relevance score, highest first.", "parameters": [ { "name": "q", "in": "query", "required": true, "description": "Search terms.", "schema": { "type": "string", "minLength": 1, "maxLength": 200 } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of hits to return.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 10 } } ], "responses": { "200": { "description": "The ranked hits.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "X-API-Version": { "$ref": "#/components/headers/ApiVersion" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResult" } } } }, "400": { "description": "A query parameter is missing or malformed. The body names the parameter and the accepted values.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "X-API-Version": { "$ref": "#/components/headers/ApiVersion" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "405": { "description": "The method is not supported. Every content endpoint is read-only.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "X-API-Version": { "$ref": "#/components/headers/ApiVersion" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "The published quota was exceeded. Retry-After carries the seconds to wait.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "X-API-Version": { "$ref": "#/components/headers/ApiVersion" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/mcp": { "post": { "operationId": "callMcp", "tags": [ "Meta" ], "summary": "Call the MCP server", "description": "Model Context Protocol endpoint over Streamable HTTP. Accepts a single JSON-RPC 2.0 message and answers with a JSON-RPC response; notifications get 202 with no body. Supports initialize, ping, tools/list, tools/call, resources/list and resources/read.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonRpcRequest" } } } }, "responses": { "200": { "description": "The JSON-RPC response.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "X-API-Version": { "$ref": "#/components/headers/ApiVersion" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonRpcResponse" } } } }, "202": { "description": "The notification was accepted. No body." }, "400": { "description": "The body was not a single valid JSON-RPC message.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "X-API-Version": { "$ref": "#/components/headers/ApiVersion" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonRpcResponse" } } } }, "405": { "description": "The MCP server is stateless and only answers POST.", "headers": { "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimitReset" }, "X-API-Version": { "$ref": "#/components/headers/ApiVersion" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonRpcResponse" } } } } } } } }, "components": { "headers": { "RateLimit": { "description": "Structured quota state for this client, per draft-ietf-httpapi-ratelimit-headers.", "schema": { "type": "string", "examples": [ "\"public-read\";r=599;t=42" ] } }, "RateLimitPolicy": { "description": "The quota being applied: name, ceiling and window in seconds.", "schema": { "type": "string", "examples": [ "\"public-read\";q=600;w=60" ] } }, "RateLimitLimit": { "description": "Requests allowed in the current window.", "schema": { "type": "integer", "examples": [ 600 ] } }, "RateLimitRemaining": { "description": "Requests still available in the current window.", "schema": { "type": "integer", "examples": [ 599 ] } }, "RateLimitReset": { "description": "Seconds until the current window resets.", "schema": { "type": "integer", "examples": [ 42 ] } }, "RetryAfter": { "description": "Seconds to wait before retrying, on a throttled response.", "schema": { "type": "integer", "examples": [ 42 ] } }, "ApiVersion": { "description": "Semantic version of the deployment that answered.", "schema": { "type": "string", "examples": [ "1.0.0" ] } } }, "schemas": { "Problem": { "type": "object", "description": "RFC 9457 problem detail, extended with a stable code and a resolution hint.", "required": [ "type", "title", "status", "code", "detail", "hint" ], "properties": { "type": { "type": "string", "format": "uri", "description": "Anchor documenting this error code." }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string", "description": "Stable machine-readable code.", "enum": [ "not_found", "method_not_allowed", "invalid_parameter", "missing_parameter", "not_acceptable", "unsupported_media_type", "internal_error" ] }, "detail": { "type": "string", "description": "What went wrong, in one sentence." }, "hint": { "type": "string", "description": "The concrete call that resolves it." }, "instance": { "type": "string", "description": "Path that produced the error." }, "documentation_url": { "type": "string", "format": "uri" }, "validSlugs": { "type": "array", "items": { "type": "string" } }, "parameter": { "type": "string" } } }, "ApiIndex": { "type": "object", "required": [ "name", "version", "resources" ], "properties": { "name": { "type": "string" }, "version": { "type": "string" }, "description": { "type": "string" }, "documentation": { "type": "string", "format": "uri" }, "openapi": { "type": "string", "format": "uri" }, "mcp": { "type": "object", "properties": { "endpoint": { "type": "string", "format": "uri" }, "transport": { "type": "string", "enum": [ "streamable-http" ] } } }, "resources": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Health": { "type": "object", "required": [ "status", "version", "timestamp" ], "properties": { "status": { "type": "string", "enum": [ "ok" ] }, "version": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "counts": { "type": "object", "properties": { "products": { "type": "integer" }, "posts": { "type": "integer" }, "pages": { "type": "integer" } } } } }, "Address": { "type": "object", "properties": { "streetAddress": { "type": "string" }, "addressLocality": { "type": "string" }, "addressRegion": { "type": "string" }, "postalCode": { "type": "string" }, "addressCountry": { "type": "string" } } }, "Company": { "type": "object", "required": [ "name", "legalName", "taxId", "address", "contact" ], "properties": { "name": { "type": "string" }, "legalName": { "type": "string" }, "taxId": { "type": "string", "description": "Brazilian company registration number." }, "taxIdType": { "type": "string", "enum": [ "CNPJ" ] }, "url": { "type": "string", "format": "uri" }, "description": { "type": "string" }, "address": { "$ref": "#/components/schemas/Address" }, "contact": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "telephone": { "type": "string" }, "whatsapp": { "type": "string", "format": "uri" }, "scheduling": { "type": "string", "format": "uri" }, "contactPage": { "type": "string", "format": "uri" } } }, "locales": { "type": "object", "properties": { "default": { "type": "string" }, "supported": { "type": "array", "items": { "type": "string" } } } }, "profiles": { "type": "array", "items": { "type": "string", "format": "uri" } } } }, "ProductSummary": { "type": "object", "required": [ "slug", "name", "headline", "status", "url" ], "properties": { "slug": { "type": "string", "enum": [ "fuse", "caravela", "omnifisco", "open-source-cloud" ] }, "name": { "type": "string" }, "headline": { "type": "string" }, "summary": { "type": "string" }, "description": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string", "enum": [ "Agentes de IA", "Automação", "Código Aberto", "GRC", "Kubernetes", "Nuvem", "Plataforma", "SaaS" ] } }, "status": { "type": "string", "enum": [ "coming-soon", "live" ] }, "externalUrl": { "type": [ "string", "null" ], "format": "uri" }, "url": { "type": "string", "format": "uri" }, "markdownUrl": { "type": "string", "format": "uri" } } }, "Product": { "type": "object", "required": [ "slug", "name", "headline", "status", "url", "markdown" ], "properties": { "slug": { "type": "string", "enum": [ "fuse", "caravela", "omnifisco", "open-source-cloud" ] }, "name": { "type": "string" }, "headline": { "type": "string" }, "summary": { "type": "string" }, "description": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string", "enum": [ "Agentes de IA", "Automação", "Código Aberto", "GRC", "Kubernetes", "Nuvem", "Plataforma", "SaaS" ] } }, "status": { "type": "string", "enum": [ "coming-soon", "live" ] }, "externalUrl": { "type": [ "string", "null" ], "format": "uri" }, "url": { "type": "string", "format": "uri" }, "markdownUrl": { "type": "string", "format": "uri" }, "markdown": { "type": "string", "description": "Full description, as markdown." } } }, "ProductList": { "type": "object", "required": [ "total", "items" ], "properties": { "total": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSummary" } } } }, "Author": { "type": "object", "properties": { "name": { "type": "string" }, "role": { "type": "string" } } }, "PostSummary": { "type": "object", "required": [ "slug", "title", "date", "category", "url" ], "properties": { "slug": { "type": "string" }, "title": { "type": "string" }, "excerpt": { "type": "string" }, "category": { "type": "string", "enum": [ "Artificial Intelligence", "Automation", "Automação", "Cibersegurança", "Cybersecurity", "Gestão", "Inteligência Artificial", "Management" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "date": { "type": "string", "format": "date" }, "readingTime": { "type": "integer", "description": "Estimated reading time in minutes." }, "locale": { "type": "string", "enum": [ "en", "pt-BR" ] }, "featured": { "type": "boolean" }, "author": { "$ref": "#/components/schemas/Author" }, "url": { "type": "string", "format": "uri" }, "markdownUrl": { "type": "string", "format": "uri" } } }, "Post": { "type": "object", "required": [ "slug", "title", "date", "category", "url", "markdown" ], "properties": { "slug": { "type": "string" }, "title": { "type": "string" }, "excerpt": { "type": "string" }, "category": { "type": "string", "enum": [ "Artificial Intelligence", "Automation", "Automação", "Cibersegurança", "Cybersecurity", "Gestão", "Inteligência Artificial", "Management" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "date": { "type": "string", "format": "date" }, "readingTime": { "type": "integer", "description": "Estimated reading time in minutes." }, "locale": { "type": "string", "enum": [ "en", "pt-BR" ] }, "featured": { "type": "boolean" }, "author": { "$ref": "#/components/schemas/Author" }, "url": { "type": "string", "format": "uri" }, "markdownUrl": { "type": "string", "format": "uri" }, "markdown": { "type": "string", "description": "Full article body, as markdown." } } }, "PostList": { "type": "object", "required": [ "total", "limit", "offset", "items" ], "properties": { "total": { "type": "integer", "description": "Matches before paging." }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "categories": { "type": "array", "items": { "type": "string" } }, "locales": { "type": "array", "items": { "type": "string" } }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/PostSummary" } } } }, "PageSummary": { "type": "object", "required": [ "slug", "title", "path", "url" ], "properties": { "slug": { "type": "string", "enum": [ "index", "method", "capabilities", "products", "about", "contact", "developers", "blog", "privacy", "terms" ] }, "title": { "type": "string" }, "path": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "markdownUrl": { "type": "string", "format": "uri" } } }, "Page": { "type": "object", "required": [ "slug", "title", "path", "url", "markdown" ], "properties": { "slug": { "type": "string", "enum": [ "index", "method", "capabilities", "products", "about", "contact", "developers", "blog", "privacy", "terms" ] }, "title": { "type": "string" }, "path": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "markdownUrl": { "type": "string", "format": "uri" }, "markdown": { "type": "string", "description": "The page, as markdown." } } }, "PageList": { "type": "object", "required": [ "total", "items" ], "properties": { "total": { "type": "integer" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/PageSummary" } } } }, "SearchHit": { "type": "object", "required": [ "type", "slug", "title", "url", "score", "excerpt" ], "properties": { "type": { "type": "string", "enum": [ "product", "post", "page" ] }, "slug": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "markdownUrl": { "type": "string", "format": "uri" }, "score": { "type": "number", "description": "Higher is a better match; title hits outrank body hits." }, "excerpt": { "type": "string", "description": "Text around the first match." } } }, "SearchResult": { "type": "object", "required": [ "query", "total", "results" ], "properties": { "query": { "type": "string" }, "total": { "type": "integer" }, "limit": { "type": "integer" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/SearchHit" } } } }, "JsonRpcRequest": { "type": "object", "required": [ "jsonrpc", "method" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": [ "string", "integer", "null" ], "description": "Omit for a notification." }, "method": { "type": "string", "enum": [ "initialize", "ping", "tools/list", "tools/call", "resources/list", "resources/read" ] }, "params": { "type": "object", "additionalProperties": true } } }, "JsonRpcResponse": { "type": "object", "required": [ "jsonrpc", "id" ], "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": { "type": [ "string", "integer", "null" ] }, "result": { "type": "object", "additionalProperties": true }, "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": { "type": "object", "additionalProperties": true } } } } } } } }