{ "openapi": "3.1.0", "info": { "title": "MeByte Public API", "version": "1.0.0", "summary": "Free GEO/AI-visibility tools plus the authenticated partner data API.", "description": "Two families of endpoints live under `/api/public`:\n\n1. **Free tools** (`/api/public/v1/tools/*`) — keyless, CORS-open. Without an API key you receive a shareable result URL and a headline summary (`X-RateLimit-Mode: share-link`). Send `x-api-key: mbk_live_...` from a paid plan to receive the full machine-readable payload and a multiplied quota.\n2. **Partner API** (`/api/public/v1/articles`, `/geo`, `/events`) — requires a partner client key and scope; returns brand-scoped data.\n\n**Rate limits.** Every tools response carries `X-RateLimit-*` headers describing the hourly and daily windows for that endpoint and tier. When a window is exhausted you get `429` with `Retry-After` in seconds plus a `quota` object. Wait `Retry-After` seconds, then retry with exponential backoff and jitter. Cache responses for at least 5 minutes.", "contact": { "name": "MeByte", "url": "https://mebyte.ai/developers" }, "license": { "name": "Fair use — attribution required", "url": "https://mebyte.ai/terms" } }, "servers": [ { "url": "https://mebyte.ai", "description": "Production" } ], "tags": [ { "name": "Free tools", "description": "Keyless GEO utilities. Tiered quotas via API key." }, { "name": "Catalog", "description": "Machine-readable index of the tool API." }, { "name": "Partner API", "description": "Brand-scoped data for authenticated partner clients." } ], "externalDocs": { "description": "Developer platform", "url": "https://mebyte.ai/developers" }, "paths": { "/api/public/v1/openapi.json": { "get": { "operationId": "getOpenApiSpec", "summary": "This OpenAPI document", "tags": [ "Catalog" ], "responses": { "200": { "description": "OpenAPI 3.1 document.", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "options": { "summary": "CORS preflight", "description": "Returns 204 with permissive CORS headers. All rate limit headers are exposed.", "responses": { "204": { "description": "No content." } } } }, "/api/public/v1/tools": { "get": { "operationId": "getToolCatalog", "summary": "Tool catalog", "description": "Machine-readable index of every free tool endpoint, quota and tier.", "tags": [ "Catalog" ], "security": [ {}, { "ApiKeyHeader": [] } ], "responses": { "200": { "description": "Catalog document.", "headers": { "X-RateLimit-Tier": { "description": "Quota tier applied to this call: anonymous, solo, growth or partner.", "schema": { "type": "string", "enum": [ "anonymous", "solo", "growth", "partner" ] } }, "X-RateLimit-Mode": { "description": "`share-link` for keyless calls (shareable result URL + headline summary only) or `full` when a valid API key unlocked the machine-readable payload.", "schema": { "type": "string", "enum": [ "share-link", "full" ] } }, "X-RateLimit-Scope": { "description": "Endpoint bucket the quota was counted against, e.g. `tools:crawler-check`.", "schema": { "type": "string" } }, "X-RateLimit-Subject": { "description": "What the quota was counted per: `key` when an API key was sent, else `brand` when you passed brand_id, else `ip`.", "schema": { "type": "string", "enum": [ "key", "brand", "ip" ] } }, "X-RateLimit-Limit": { "description": "Requests allowed in the current hourly window for this scope and tier.", "schema": { "type": "integer", "example": 20 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current hourly window. Slow down as this approaches 0.", "schema": { "type": "integer", "example": 17 } }, "X-RateLimit-Reset": { "description": "ISO 8601 timestamp when the hourly window resets.", "schema": { "type": "string", "format": "date-time" } }, "X-RateLimit-Daily-Limit": { "description": "Requests allowed in the current daily window.", "schema": { "type": "integer", "example": 100 } }, "X-RateLimit-Daily-Remaining": { "description": "Requests left in the current daily window.", "schema": { "type": "integer", "example": 84 } }, "X-RateLimit-Daily-Reset": { "description": "ISO 8601 timestamp when the daily window resets.", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "type": "object" } } } }, "429": { "description": "Rate limited. The quota object says which window (hourly or daily) is exhausted and when it resets.", "headers": { "X-RateLimit-Tier": { "description": "Quota tier applied to this call: anonymous, solo, growth or partner.", "schema": { "type": "string", "enum": [ "anonymous", "solo", "growth", "partner" ] } }, "X-RateLimit-Mode": { "description": "`share-link` for keyless calls (shareable result URL + headline summary only) or `full` when a valid API key unlocked the machine-readable payload.", "schema": { "type": "string", "enum": [ "share-link", "full" ] } }, "X-RateLimit-Scope": { "description": "Endpoint bucket the quota was counted against, e.g. `tools:crawler-check`.", "schema": { "type": "string" } }, "X-RateLimit-Subject": { "description": "What the quota was counted per: `key` when an API key was sent, else `brand` when you passed brand_id, else `ip`.", "schema": { "type": "string", "enum": [ "key", "brand", "ip" ] } }, "X-RateLimit-Limit": { "description": "Requests allowed in the current hourly window for this scope and tier.", "schema": { "type": "integer", "example": 20 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current hourly window. Slow down as this approaches 0.", "schema": { "type": "integer", "example": 17 } }, "X-RateLimit-Reset": { "description": "ISO 8601 timestamp when the hourly window resets.", "schema": { "type": "string", "format": "date-time" } }, "X-RateLimit-Daily-Limit": { "description": "Requests allowed in the current daily window.", "schema": { "type": "integer", "example": 100 } }, "X-RateLimit-Daily-Remaining": { "description": "Requests left in the current daily window.", "schema": { "type": "integer", "example": 84 } }, "X-RateLimit-Daily-Reset": { "description": "ISO 8601 timestamp when the daily window resets.", "schema": { "type": "string", "format": "date-time" } }, "Retry-After": { "description": "Seconds to wait before retrying. Only present on 429. Honour it first, then add exponential backoff with jitter.", "schema": { "type": "integer", "example": 42 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" }, "example": { "error": "rate_limited", "message": "You reached the hourly quota for tools:crawler-check on the anonymous tier (20/hour, 100/day per ip). Retry in 42s, or cache results for at least 5 minutes. Add an API key header (x-api-key) from a paid plan for a higher limit.", "tier": "anonymous", "quota": { "per": "ip", "tier": "anonymous", "hour_limit": 20, "hour_remaining": 0, "hour_reset": "2026-08-01T09:00:00.000Z", "day_limit": 100, "day_remaining": 63, "day_reset": "2026-08-02T00:00:00.000Z", "retry_after_seconds": 42 }, "upgrade": "https://mebyte.ai/pricing", "docs": "https://mebyte.ai/developers" } } } } } }, "options": { "summary": "CORS preflight", "description": "Returns 204 with permissive CORS headers. All rate limit headers are exposed.", "responses": { "204": { "description": "No content." } } } }, "/api/public/v1/tools/crawler-check": { "get": { "operationId": "crawlerCheckGet", "summary": "AI crawler access check", "description": "Fetches the site's robots.txt and llms.txt live and reports whether each major AI crawler is allowed. Base quota 20/hour, 100/day.", "tags": [ "Free tools" ], "security": [ {}, { "ApiKeyHeader": [] }, { "BearerApiKey": [] } ], "parameters": [ { "name": "url", "in": "query", "required": true, "description": "Website address, with or without protocol.", "schema": { "type": "string", "example": "example.com" } } ], "responses": { "200": { "description": "Success. With an API key you get the full payload; keyless callers get the ShareLink shape instead.", "headers": { "X-RateLimit-Tier": { "description": "Quota tier applied to this call: anonymous, solo, growth or partner.", "schema": { "type": "string", "enum": [ "anonymous", "solo", "growth", "partner" ] } }, "X-RateLimit-Mode": { "description": "`share-link` for keyless calls (shareable result URL + headline summary only) or `full` when a valid API key unlocked the machine-readable payload.", "schema": { "type": "string", "enum": [ "share-link", "full" ] } }, "X-RateLimit-Scope": { "description": "Endpoint bucket the quota was counted against, e.g. `tools:crawler-check`.", "schema": { "type": "string" } }, "X-RateLimit-Subject": { "description": "What the quota was counted per: `key` when an API key was sent, else `brand` when you passed brand_id, else `ip`.", "schema": { "type": "string", "enum": [ "key", "brand", "ip" ] } }, "X-RateLimit-Limit": { "description": "Requests allowed in the current hourly window for this scope and tier.", "schema": { "type": "integer", "example": 20 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current hourly window. Slow down as this approaches 0.", "schema": { "type": "integer", "example": 17 } }, "X-RateLimit-Reset": { "description": "ISO 8601 timestamp when the hourly window resets.", "schema": { "type": "string", "format": "date-time" } }, "X-RateLimit-Daily-Limit": { "description": "Requests allowed in the current daily window.", "schema": { "type": "integer", "example": 100 } }, "X-RateLimit-Daily-Remaining": { "description": "Requests left in the current daily window.", "schema": { "type": "integer", "example": 84 } }, "X-RateLimit-Daily-Reset": { "description": "ISO 8601 timestamp when the daily window resets.", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CrawlerCheckResult" }, { "$ref": "#/components/schemas/ShareLinkResponse" } ] } } } }, "400": { "description": "Invalid input. `details` maps each failing field to its validation messages.", "headers": { "X-RateLimit-Tier": { "description": "Quota tier applied to this call: anonymous, solo, growth or partner.", "schema": { "type": "string", "enum": [ "anonymous", "solo", "growth", "partner" ] } }, "X-RateLimit-Mode": { "description": "`share-link` for keyless calls (shareable result URL + headline summary only) or `full` when a valid API key unlocked the machine-readable payload.", "schema": { "type": "string", "enum": [ "share-link", "full" ] } }, "X-RateLimit-Scope": { "description": "Endpoint bucket the quota was counted against, e.g. `tools:crawler-check`.", "schema": { "type": "string" } }, "X-RateLimit-Subject": { "description": "What the quota was counted per: `key` when an API key was sent, else `brand` when you passed brand_id, else `ip`.", "schema": { "type": "string", "enum": [ "key", "brand", "ip" ] } }, "X-RateLimit-Limit": { "description": "Requests allowed in the current hourly window for this scope and tier.", "schema": { "type": "integer", "example": 20 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current hourly window. Slow down as this approaches 0.", "schema": { "type": "integer", "example": 17 } }, "X-RateLimit-Reset": { "description": "ISO 8601 timestamp when the hourly window resets.", "schema": { "type": "string", "format": "date-time" } }, "X-RateLimit-Daily-Limit": { "description": "Requests allowed in the current daily window.", "schema": { "type": "integer", "example": 100 } }, "X-RateLimit-Daily-Remaining": { "description": "Requests left in the current daily window.", "schema": { "type": "integer", "example": 84 } }, "X-RateLimit-Daily-Reset": { "description": "ISO 8601 timestamp when the daily window resets.", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidInputError" }, "example": { "error": "invalid_input", "details": { "url": [ "Enter a valid website address" ] } } } } }, "429": { "description": "Rate limited. The quota object says which window (hourly or daily) is exhausted and when it resets.", "headers": { "X-RateLimit-Tier": { "description": "Quota tier applied to this call: anonymous, solo, growth or partner.", "schema": { "type": "string", "enum": [ "anonymous", "solo", "growth", "partner" ] } }, "X-RateLimit-Mode": { "description": "`share-link` for keyless calls (shareable result URL + headline summary only) or `full` when a valid API key unlocked the machine-readable payload.", "schema": { "type": "string", "enum": [ "share-link", "full" ] } }, "X-RateLimit-Scope": { "description": "Endpoint bucket the quota was counted against, e.g. `tools:crawler-check`.", "schema": { "type": "string" } }, "X-RateLimit-Subject": { "description": "What the quota was counted per: `key` when an API key was sent, else `brand` when you passed brand_id, else `ip`.", "schema": { "type": "string", "enum": [ "key", "brand", "ip" ] } }, "X-RateLimit-Limit": { "description": "Requests allowed in the current hourly window for this scope and tier.", "schema": { "type": "integer", "example": 20 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current hourly window. Slow down as this approaches 0.", "schema": { "type": "integer", "example": 17 } }, "X-RateLimit-Reset": { "description": "ISO 8601 timestamp when the hourly window resets.", "schema": { "type": "string", "format": "date-time" } }, "X-RateLimit-Daily-Limit": { "description": "Requests allowed in the current daily window.", "schema": { "type": "integer", "example": 100 } }, "X-RateLimit-Daily-Remaining": { "description": "Requests left in the current daily window.", "schema": { "type": "integer", "example": 84 } }, "X-RateLimit-Daily-Reset": { "description": "ISO 8601 timestamp when the daily window resets.", "schema": { "type": "string", "format": "date-time" } }, "Retry-After": { "description": "Seconds to wait before retrying. Only present on 429. Honour it first, then add exponential backoff with jitter.", "schema": { "type": "integer", "example": 42 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" }, "example": { "error": "rate_limited", "message": "You reached the hourly quota for tools:crawler-check on the anonymous tier (20/hour, 100/day per ip). Retry in 42s, or cache results for at least 5 minutes. Add an API key header (x-api-key) from a paid plan for a higher limit.", "tier": "anonymous", "quota": { "per": "ip", "tier": "anonymous", "hour_limit": 20, "hour_remaining": 0, "hour_reset": "2026-08-01T09:00:00.000Z", "day_limit": 100, "day_remaining": 63, "day_reset": "2026-08-02T00:00:00.000Z", "retry_after_seconds": 42 }, "upgrade": "https://mebyte.ai/pricing", "docs": "https://mebyte.ai/developers" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericError" } } } } } }, "post": { "operationId": "crawlerCheckPost", "summary": "AI crawler access check", "description": "Same as GET, with a JSON body.", "tags": [ "Free tools" ], "security": [ {}, { "ApiKeyHeader": [] }, { "BearerApiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UrlInput" } } } }, "responses": { "200": { "description": "Success. With an API key you get the full payload; keyless callers get the ShareLink shape instead.", "headers": { "X-RateLimit-Tier": { "description": "Quota tier applied to this call: anonymous, solo, growth or partner.", "schema": { "type": "string", "enum": [ "anonymous", "solo", "growth", "partner" ] } }, "X-RateLimit-Mode": { "description": "`share-link` for keyless calls (shareable result URL + headline summary only) or `full` when a valid API key unlocked the machine-readable payload.", "schema": { "type": "string", "enum": [ "share-link", "full" ] } }, "X-RateLimit-Scope": { "description": "Endpoint bucket the quota was counted against, e.g. `tools:crawler-check`.", "schema": { "type": "string" } }, "X-RateLimit-Subject": { "description": "What the quota was counted per: `key` when an API key was sent, else `brand` when you passed brand_id, else `ip`.", "schema": { "type": "string", "enum": [ "key", "brand", "ip" ] } }, "X-RateLimit-Limit": { "description": "Requests allowed in the current hourly window for this scope and tier.", "schema": { "type": "integer", "example": 20 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current hourly window. Slow down as this approaches 0.", "schema": { "type": "integer", "example": 17 } }, "X-RateLimit-Reset": { "description": "ISO 8601 timestamp when the hourly window resets.", "schema": { "type": "string", "format": "date-time" } }, "X-RateLimit-Daily-Limit": { "description": "Requests allowed in the current daily window.", "schema": { "type": "integer", "example": 100 } }, "X-RateLimit-Daily-Remaining": { "description": "Requests left in the current daily window.", "schema": { "type": "integer", "example": 84 } }, "X-RateLimit-Daily-Reset": { "description": "ISO 8601 timestamp when the daily window resets.", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CrawlerCheckResult" }, { "$ref": "#/components/schemas/ShareLinkResponse" } ] } } } }, "400": { "description": "Invalid input. `details` maps each failing field to its validation messages.", "headers": { "X-RateLimit-Tier": { "description": "Quota tier applied to this call: anonymous, solo, growth or partner.", "schema": { "type": "string", "enum": [ "anonymous", "solo", "growth", "partner" ] } }, "X-RateLimit-Mode": { "description": "`share-link` for keyless calls (shareable result URL + headline summary only) or `full` when a valid API key unlocked the machine-readable payload.", "schema": { "type": "string", "enum": [ "share-link", "full" ] } }, "X-RateLimit-Scope": { "description": "Endpoint bucket the quota was counted against, e.g. `tools:crawler-check`.", "schema": { "type": "string" } }, "X-RateLimit-Subject": { "description": "What the quota was counted per: `key` when an API key was sent, else `brand` when you passed brand_id, else `ip`.", "schema": { "type": "string", "enum": [ "key", "brand", "ip" ] } }, "X-RateLimit-Limit": { "description": "Requests allowed in the current hourly window for this scope and tier.", "schema": { "type": "integer", "example": 20 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current hourly window. Slow down as this approaches 0.", "schema": { "type": "integer", "example": 17 } }, "X-RateLimit-Reset": { "description": "ISO 8601 timestamp when the hourly window resets.", "schema": { "type": "string", "format": "date-time" } }, "X-RateLimit-Daily-Limit": { "description": "Requests allowed in the current daily window.", "schema": { "type": "integer", "example": 100 } }, "X-RateLimit-Daily-Remaining": { "description": "Requests left in the current daily window.", "schema": { "type": "integer", "example": 84 } }, "X-RateLimit-Daily-Reset": { "description": "ISO 8601 timestamp when the daily window resets.", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidInputError" }, "example": { "error": "invalid_input", "details": { "url": [ "Enter a valid website address" ] } } } } }, "429": { "description": "Rate limited. The quota object says which window (hourly or daily) is exhausted and when it resets.", "headers": { "X-RateLimit-Tier": { "description": "Quota tier applied to this call: anonymous, solo, growth or partner.", "schema": { "type": "string", "enum": [ "anonymous", "solo", "growth", "partner" ] } }, "X-RateLimit-Mode": { "description": "`share-link` for keyless calls (shareable result URL + headline summary only) or `full` when a valid API key unlocked the machine-readable payload.", "schema": { "type": "string", "enum": [ "share-link", "full" ] } }, "X-RateLimit-Scope": { "description": "Endpoint bucket the quota was counted against, e.g. `tools:crawler-check`.", "schema": { "type": "string" } }, "X-RateLimit-Subject": { "description": "What the quota was counted per: `key` when an API key was sent, else `brand` when you passed brand_id, else `ip`.", "schema": { "type": "string", "enum": [ "key", "brand", "ip" ] } }, "X-RateLimit-Limit": { "description": "Requests allowed in the current hourly window for this scope and tier.", "schema": { "type": "integer", "example": 20 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current hourly window. Slow down as this approaches 0.", "schema": { "type": "integer", "example": 17 } }, "X-RateLimit-Reset": { "description": "ISO 8601 timestamp when the hourly window resets.", "schema": { "type": "string", "format": "date-time" } }, "X-RateLimit-Daily-Limit": { "description": "Requests allowed in the current daily window.", "schema": { "type": "integer", "example": 100 } }, "X-RateLimit-Daily-Remaining": { "description": "Requests left in the current daily window.", "schema": { "type": "integer", "example": 84 } }, "X-RateLimit-Daily-Reset": { "description": "ISO 8601 timestamp when the daily window resets.", "schema": { "type": "string", "format": "date-time" } }, "Retry-After": { "description": "Seconds to wait before retrying. Only present on 429. Honour it first, then add exponential backoff with jitter.", "schema": { "type": "integer", "example": 42 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" }, "example": { "error": "rate_limited", "message": "You reached the hourly quota for tools:crawler-check on the anonymous tier (20/hour, 100/day per ip). Retry in 42s, or cache results for at least 5 minutes. Add an API key header (x-api-key) from a paid plan for a higher limit.", "tier": "anonymous", "quota": { "per": "ip", "tier": "anonymous", "hour_limit": 20, "hour_remaining": 0, "hour_reset": "2026-08-01T09:00:00.000Z", "day_limit": 100, "day_remaining": 63, "day_reset": "2026-08-02T00:00:00.000Z", "retry_after_seconds": 42 }, "upgrade": "https://mebyte.ai/pricing", "docs": "https://mebyte.ai/developers" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericError" } } } } } }, "options": { "summary": "CORS preflight", "description": "Returns 204 with permissive CORS headers. All rate limit headers are exposed.", "responses": { "204": { "description": "No content." } } } }, "/api/public/v1/tools/llms-txt": { "get": { "operationId": "llmsTxtGet", "summary": "llms.txt generator", "description": "Builds the llms.txt file AI crawlers read first. Base quota 60/hour, 400/day. Use `format=text` to get the raw file.", "tags": [ "Free tools" ], "security": [ {}, { "ApiKeyHeader": [] }, { "BearerApiKey": [] } ], "parameters": [ { "name": "brand", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "summary", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "products", "in": "query", "description": "Pipe-separated list, e.g. `Widgets|Gadgets`.", "schema": { "type": "string" } }, { "name": "differentiators", "in": "query", "description": "Pipe-separated list.", "schema": { "type": "string" } }, { "name": "audience", "in": "query", "schema": { "type": "string" } }, { "name": "contact", "in": "query", "schema": { "type": "string" } }, { "name": "format", "in": "query", "description": "`json` (default) or `text` for the raw llms.txt body.", "schema": { "type": "string", "enum": [ "json", "text" ] } } ], "responses": { "200": { "description": "Success. With an API key you get the full payload; keyless callers get the ShareLink shape instead.", "headers": { "X-RateLimit-Tier": { "description": "Quota tier applied to this call: anonymous, solo, growth or partner.", "schema": { "type": "string", "enum": [ "anonymous", "solo", "growth", "partner" ] } }, "X-RateLimit-Mode": { "description": "`share-link` for keyless calls (shareable result URL + headline summary only) or `full` when a valid API key unlocked the machine-readable payload.", "schema": { "type": "string", "enum": [ "share-link", "full" ] } }, "X-RateLimit-Scope": { "description": "Endpoint bucket the quota was counted against, e.g. `tools:crawler-check`.", "schema": { "type": "string" } }, "X-RateLimit-Subject": { "description": "What the quota was counted per: `key` when an API key was sent, else `brand` when you passed brand_id, else `ip`.", "schema": { "type": "string", "enum": [ "key", "brand", "ip" ] } }, "X-RateLimit-Limit": { "description": "Requests allowed in the current hourly window for this scope and tier.", "schema": { "type": "integer", "example": 20 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current hourly window. Slow down as this approaches 0.", "schema": { "type": "integer", "example": 17 } }, "X-RateLimit-Reset": { "description": "ISO 8601 timestamp when the hourly window resets.", "schema": { "type": "string", "format": "date-time" } }, "X-RateLimit-Daily-Limit": { "description": "Requests allowed in the current daily window.", "schema": { "type": "integer", "example": 100 } }, "X-RateLimit-Daily-Remaining": { "description": "Requests left in the current daily window.", "schema": { "type": "integer", "example": 84 } }, "X-RateLimit-Daily-Reset": { "description": "ISO 8601 timestamp when the daily window resets.", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/LlmsTxtResult" }, { "$ref": "#/components/schemas/ShareLinkResponse" } ] } } } }, "400": { "description": "Invalid input. `details` maps each failing field to its validation messages.", "headers": { "X-RateLimit-Tier": { "description": "Quota tier applied to this call: anonymous, solo, growth or partner.", "schema": { "type": "string", "enum": [ "anonymous", "solo", "growth", "partner" ] } }, "X-RateLimit-Mode": { "description": "`share-link` for keyless calls (shareable result URL + headline summary only) or `full` when a valid API key unlocked the machine-readable payload.", "schema": { "type": "string", "enum": [ "share-link", "full" ] } }, "X-RateLimit-Scope": { "description": "Endpoint bucket the quota was counted against, e.g. `tools:crawler-check`.", "schema": { "type": "string" } }, "X-RateLimit-Subject": { "description": "What the quota was counted per: `key` when an API key was sent, else `brand` when you passed brand_id, else `ip`.", "schema": { "type": "string", "enum": [ "key", "brand", "ip" ] } }, "X-RateLimit-Limit": { "description": "Requests allowed in the current hourly window for this scope and tier.", "schema": { "type": "integer", "example": 20 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current hourly window. Slow down as this approaches 0.", "schema": { "type": "integer", "example": 17 } }, "X-RateLimit-Reset": { "description": "ISO 8601 timestamp when the hourly window resets.", "schema": { "type": "string", "format": "date-time" } }, "X-RateLimit-Daily-Limit": { "description": "Requests allowed in the current daily window.", "schema": { "type": "integer", "example": 100 } }, "X-RateLimit-Daily-Remaining": { "description": "Requests left in the current daily window.", "schema": { "type": "integer", "example": 84 } }, "X-RateLimit-Daily-Reset": { "description": "ISO 8601 timestamp when the daily window resets.", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidInputError" }, "example": { "error": "invalid_input", "details": { "url": [ "Enter a valid website address" ] } } } } }, "429": { "description": "Rate limited. The quota object says which window (hourly or daily) is exhausted and when it resets.", "headers": { "X-RateLimit-Tier": { "description": "Quota tier applied to this call: anonymous, solo, growth or partner.", "schema": { "type": "string", "enum": [ "anonymous", "solo", "growth", "partner" ] } }, "X-RateLimit-Mode": { "description": "`share-link` for keyless calls (shareable result URL + headline summary only) or `full` when a valid API key unlocked the machine-readable payload.", "schema": { "type": "string", "enum": [ "share-link", "full" ] } }, "X-RateLimit-Scope": { "description": "Endpoint bucket the quota was counted against, e.g. `tools:crawler-check`.", "schema": { "type": "string" } }, "X-RateLimit-Subject": { "description": "What the quota was counted per: `key` when an API key was sent, else `brand` when you passed brand_id, else `ip`.", "schema": { "type": "string", "enum": [ "key", "brand", "ip" ] } }, "X-RateLimit-Limit": { "description": "Requests allowed in the current hourly window for this scope and tier.", "schema": { "type": "integer", "example": 20 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current hourly window. Slow down as this approaches 0.", "schema": { "type": "integer", "example": 17 } }, "X-RateLimit-Reset": { "description": "ISO 8601 timestamp when the hourly window resets.", "schema": { "type": "string", "format": "date-time" } }, "X-RateLimit-Daily-Limit": { "description": "Requests allowed in the current daily window.", "schema": { "type": "integer", "example": 100 } }, "X-RateLimit-Daily-Remaining": { "description": "Requests left in the current daily window.", "schema": { "type": "integer", "example": 84 } }, "X-RateLimit-Daily-Reset": { "description": "ISO 8601 timestamp when the daily window resets.", "schema": { "type": "string", "format": "date-time" } }, "Retry-After": { "description": "Seconds to wait before retrying. Only present on 429. Honour it first, then add exponential backoff with jitter.", "schema": { "type": "integer", "example": 42 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" }, "example": { "error": "rate_limited", "message": "You reached the hourly quota for tools:crawler-check on the anonymous tier (20/hour, 100/day per ip). Retry in 42s, or cache results for at least 5 minutes. Add an API key header (x-api-key) from a paid plan for a higher limit.", "tier": "anonymous", "quota": { "per": "ip", "tier": "anonymous", "hour_limit": 20, "hour_remaining": 0, "hour_reset": "2026-08-01T09:00:00.000Z", "day_limit": 100, "day_remaining": 63, "day_reset": "2026-08-02T00:00:00.000Z", "retry_after_seconds": 42 }, "upgrade": "https://mebyte.ai/pricing", "docs": "https://mebyte.ai/developers" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericError" } } } } } }, "post": { "operationId": "llmsTxtPost", "summary": "llms.txt generator", "description": "Same as GET, with a JSON body (arrays allowed for products/differentiators).", "tags": [ "Free tools" ], "security": [ {}, { "ApiKeyHeader": [] }, { "BearerApiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LlmsTxtInput" } } } }, "responses": { "200": { "description": "Success. With an API key you get the full payload; keyless callers get the ShareLink shape instead.", "headers": { "X-RateLimit-Tier": { "description": "Quota tier applied to this call: anonymous, solo, growth or partner.", "schema": { "type": "string", "enum": [ "anonymous", "solo", "growth", "partner" ] } }, "X-RateLimit-Mode": { "description": "`share-link` for keyless calls (shareable result URL + headline summary only) or `full` when a valid API key unlocked the machine-readable payload.", "schema": { "type": "string", "enum": [ "share-link", "full" ] } }, "X-RateLimit-Scope": { "description": "Endpoint bucket the quota was counted against, e.g. `tools:crawler-check`.", "schema": { "type": "string" } }, "X-RateLimit-Subject": { "description": "What the quota was counted per: `key` when an API key was sent, else `brand` when you passed brand_id, else `ip`.", "schema": { "type": "string", "enum": [ "key", "brand", "ip" ] } }, "X-RateLimit-Limit": { "description": "Requests allowed in the current hourly window for this scope and tier.", "schema": { "type": "integer", "example": 20 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current hourly window. Slow down as this approaches 0.", "schema": { "type": "integer", "example": 17 } }, "X-RateLimit-Reset": { "description": "ISO 8601 timestamp when the hourly window resets.", "schema": { "type": "string", "format": "date-time" } }, "X-RateLimit-Daily-Limit": { "description": "Requests allowed in the current daily window.", "schema": { "type": "integer", "example": 100 } }, "X-RateLimit-Daily-Remaining": { "description": "Requests left in the current daily window.", "schema": { "type": "integer", "example": 84 } }, "X-RateLimit-Daily-Reset": { "description": "ISO 8601 timestamp when the daily window resets.", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/LlmsTxtResult" }, { "$ref": "#/components/schemas/ShareLinkResponse" } ] } } } }, "400": { "description": "Invalid input. `details` maps each failing field to its validation messages.", "headers": { "X-RateLimit-Tier": { "description": "Quota tier applied to this call: anonymous, solo, growth or partner.", "schema": { "type": "string", "enum": [ "anonymous", "solo", "growth", "partner" ] } }, "X-RateLimit-Mode": { "description": "`share-link` for keyless calls (shareable result URL + headline summary only) or `full` when a valid API key unlocked the machine-readable payload.", "schema": { "type": "string", "enum": [ "share-link", "full" ] } }, "X-RateLimit-Scope": { "description": "Endpoint bucket the quota was counted against, e.g. `tools:crawler-check`.", "schema": { "type": "string" } }, "X-RateLimit-Subject": { "description": "What the quota was counted per: `key` when an API key was sent, else `brand` when you passed brand_id, else `ip`.", "schema": { "type": "string", "enum": [ "key", "brand", "ip" ] } }, "X-RateLimit-Limit": { "description": "Requests allowed in the current hourly window for this scope and tier.", "schema": { "type": "integer", "example": 20 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current hourly window. Slow down as this approaches 0.", "schema": { "type": "integer", "example": 17 } }, "X-RateLimit-Reset": { "description": "ISO 8601 timestamp when the hourly window resets.", "schema": { "type": "string", "format": "date-time" } }, "X-RateLimit-Daily-Limit": { "description": "Requests allowed in the current daily window.", "schema": { "type": "integer", "example": 100 } }, "X-RateLimit-Daily-Remaining": { "description": "Requests left in the current daily window.", "schema": { "type": "integer", "example": 84 } }, "X-RateLimit-Daily-Reset": { "description": "ISO 8601 timestamp when the daily window resets.", "schema": { "type": "string", "format": "date-time" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidInputError" }, "example": { "error": "invalid_input", "details": { "url": [ "Enter a valid website address" ] } } } } }, "429": { "description": "Rate limited. The quota object says which window (hourly or daily) is exhausted and when it resets.", "headers": { "X-RateLimit-Tier": { "description": "Quota tier applied to this call: anonymous, solo, growth or partner.", "schema": { "type": "string", "enum": [ "anonymous", "solo", "growth", "partner" ] } }, "X-RateLimit-Mode": { "description": "`share-link` for keyless calls (shareable result URL + headline summary only) or `full` when a valid API key unlocked the machine-readable payload.", "schema": { "type": "string", "enum": [ "share-link", "full" ] } }, "X-RateLimit-Scope": { "description": "Endpoint bucket the quota was counted against, e.g. `tools:crawler-check`.", "schema": { "type": "string" } }, "X-RateLimit-Subject": { "description": "What the quota was counted per: `key` when an API key was sent, else `brand` when you passed brand_id, else `ip`.", "schema": { "type": "string", "enum": [ "key", "brand", "ip" ] } }, "X-RateLimit-Limit": { "description": "Requests allowed in the current hourly window for this scope and tier.", "schema": { "type": "integer", "example": 20 } }, "X-RateLimit-Remaining": { "description": "Requests left in the current hourly window. Slow down as this approaches 0.", "schema": { "type": "integer", "example": 17 } }, "X-RateLimit-Reset": { "description": "ISO 8601 timestamp when the hourly window resets.", "schema": { "type": "string", "format": "date-time" } }, "X-RateLimit-Daily-Limit": { "description": "Requests allowed in the current daily window.", "schema": { "type": "integer", "example": 100 } }, "X-RateLimit-Daily-Remaining": { "description": "Requests left in the current daily window.", "schema": { "type": "integer", "example": 84 } }, "X-RateLimit-Daily-Reset": { "description": "ISO 8601 timestamp when the daily window resets.", "schema": { "type": "string", "format": "date-time" } }, "Retry-After": { "description": "Seconds to wait before retrying. Only present on 429. Honour it first, then add exponential backoff with jitter.", "schema": { "type": "integer", "example": 42 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitError" }, "example": { "error": "rate_limited", "message": "You reached the hourly quota for tools:crawler-check on the anonymous tier (20/hour, 100/day per ip). Retry in 42s, or cache results for at least 5 minutes. Add an API key header (x-api-key) from a paid plan for a higher limit.", "tier": "anonymous", "quota": { "per": "ip", "tier": "anonymous", "hour_limit": 20, "hour_remaining": 0, "hour_reset": "2026-08-01T09:00:00.000Z", "day_limit": 100, "day_remaining": 63, "day_reset": "2026-08-02T00:00:00.000Z", "retry_after_seconds": 42 }, "upgrade": "https://mebyte.ai/pricing", "docs": "https://mebyte.ai/developers" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericError" } } } } } }, "options": { "summary": "CORS preflight", "description": "Returns 204 with permissive CORS headers. All rate limit headers are exposed.", "responses": { "204": { "description": "No content." } } } }, "/api/public/v1/tools/schema": { "get": { "operationId": "schemaGenGet", "summary": "JSON-LD schema generator", "description": "Builds Organization, Product or FAQPage JSON-LD. Base quota 60/hour, 400/day. Use `format=script` for a ready-to-paste