{"openapi":"3.1.0","info":{"title":"RapidStart Public Product Knowledge API","version":"1.0.0","description":"Read-only public product research and country-level partner lookup. Authentication: none; required OAuth scopes: none. No access to customer records, account operations, registrations, checkout, or deployment. The canonical endpoint is /api/v1/knowledge; breaking changes use a new URL major version. Before removal, supported versions receive at least 90 days of notice with migration instructions and Deprecation (RFC 9745) and Sunset (RFC 8594) headers. No deprecation or shutdown is scheduled. See the guide for request limits and the full compatibility policy."},"servers":[{"url":"https://www.rapidstart.com"}],"security":[],"externalDocs":{"description":"Agent quickstart and MCP connection guide","url":"https://www.rapidstart.com/agent-guide.md"},"paths":{"/api/v1/knowledge":{"post":{"operationId":"queryRapidStartKnowledge","summary":"Research products or find a regional contact","description":"Select catalog, search, or partner using the action field. This POST operation is read-only and requires no authentication or OAuth scopes. Search returns at most three compact facts; follow sourceUrl for complete details. Partner lookup is country-level.","security":[],"externalDocs":{"description":"Authentication and allowed public capabilities","url":"https://www.rapidstart.com/auth.md"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeRequest"},"examples":{"catalog":{"value":{"action":"catalog","locale":"en"}},"search":{"value":{"action":"search","question":"What does RapidStarter require?","pagePath":"/en/products/rapidstarter","locale":"en"}},"partner":{"value":{"action":"partner","countryCode":"DE"}}}}}},"responses":{"200":{"description":"Catalog, compact search results, or country-level partner, according to action.","headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"},"RateLimit":{"$ref":"#/components/headers/RateLimit"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeResponse"}}}},"400":{"description":"Invalid JSON or invalid action parameters. Correct the request using hint and the specification.","headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"},"RateLimit":{"$ref":"#/components/headers/RateLimit"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Instance-local client request limit reached. Wait for Retry-After seconds before retrying.","headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"string","pattern":"^[0-9]+$"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/api/webmcp":{"post":{"operationId":"queryRapidStartKnowledgeCompatibility","summary":"Supported compatibility alias for /api/v1/knowledge","description":"Select catalog, search, or partner using the action field. This POST operation is read-only and requires no authentication or OAuth scopes. Search returns at most three compact facts; follow sourceUrl for complete details. Partner lookup is country-level. Existing website integrations may continue using this alias; new integrations should use /api/v1/knowledge. No removal is scheduled.","security":[],"externalDocs":{"description":"Authentication and allowed public capabilities","url":"https://www.rapidstart.com/auth.md"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeRequest"},"examples":{"catalog":{"value":{"action":"catalog","locale":"en"}},"search":{"value":{"action":"search","question":"What does RapidStarter require?","pagePath":"/en/products/rapidstarter","locale":"en"}},"partner":{"value":{"action":"partner","countryCode":"DE"}}}}}},"responses":{"200":{"description":"Catalog, compact search results, or country-level partner, according to action.","headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"},"RateLimit":{"$ref":"#/components/headers/RateLimit"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeResponse"}}}},"400":{"description":"Invalid JSON or invalid action parameters. Correct the request using hint and the specification.","headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"},"RateLimit":{"$ref":"#/components/headers/RateLimit"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Instance-local client request limit reached. Wait for Retry-After seconds before retrying.","headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimitPolicy"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"string","pattern":"^[0-9]+$"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}}},"components":{"headers":{"RateLimitPolicy":{"description":"Instance-local IP quota, using draft-ietf-httpapi-ratelimit-headers-11 structured-field syntax. Not a distributed account quota.","schema":{"type":"string"},"example":"\"knowledge-instance\";q=120;w=60"},"RateLimit":{"description":"Remaining requests (r) and seconds until window reset (t) for this instance-local quota. Counters may reset on restart or differ across instances.","schema":{"type":"string"},"example":"\"knowledge-instance\";r=119;t=60"}},"schemas":{"KnowledgeRequest":{"$schema":"https://json-schema.org/draft/2020-12/schema","oneOf":[{"type":"object","properties":{"action":{"type":"string","const":"search"},"question":{"type":"string","minLength":2,"maxLength":2000,"description":"Public product question; do not include personal data or secrets."},"pagePath":{"type":"string","maxLength":500,"description":"Product-page context, or an empty string."},"locale":{"type":"string","enum":["en","ar","cs","da","de","fi","fr","hu","it","ja","nl","no","pl","pt","pt-PT","ru","sl","es","sv","tr"],"description":"Language for product/source URLs; curated knowledge facts remain in English."}},"required":["action","question","pagePath","locale"]},{"type":"object","properties":{"action":{"type":"string","const":"catalog"},"locale":{"type":"string","enum":["en","ar","cs","da","de","fi","fr","hu","it","ja","nl","no","pl","pt","pt-PT","ru","sl","es","sv","tr"],"description":"Language for product/source URLs; curated knowledge facts remain in English."}},"required":["action","locale"]},{"type":"object","properties":{"action":{"type":"string","const":"partner"},"countryCode":{"type":"string","pattern":"^[A-Za-z]{2}$","description":"Two-letter ISO country code. Lookup is country-level."}},"required":["action","countryCode"]}]},"KnowledgeResponse":{"$schema":"https://json-schema.org/draft/2020-12/schema","anyOf":[{"type":"object","properties":{"products":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"}},"required":["id","name","url"],"additionalProperties":false}}},"required":["products"],"additionalProperties":false},{"type":"object","properties":{"productIds":{"type":"array","items":{"type":"string"}},"topics":{"type":"array","items":{"type":"string"}},"facts":{"maxItems":3,"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"text":{"type":"string"},"sourceUrl":{"type":"string"}},"required":["id","text","sourceUrl"],"additionalProperties":false}}},"required":["productIds","topics","facts"],"additionalProperties":false},{"type":"object","properties":{"countryCode":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"isFallback":{"type":"boolean"}},"required":["countryCode","name","url","isFallback"],"additionalProperties":false}]},"ApiError":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"code":{"type":"string"},"hint":{"type":"string"},"links":{"type":"object","properties":{"guide":{"type":"string"},"openapi":{"type":"string"},"llms":{"type":"string"},"sitemap":{"type":"string"},"mcp":{"type":"string"}},"required":["guide","openapi","llms","sitemap","mcp"],"additionalProperties":false}},"required":["error","code","hint","links"],"additionalProperties":false}}}}