RideDesk Developer Docs

{'type': 'object', 'required': ['topic'], 'properties': {'host': {'type': 'string', 'description': "The operator's RideDesk domain (e.g. their-workspace.ridedesk.app or a custom domain). Optional — examples use a placeholder without it."}, 'topic': {'enum': ['overview', 'quote-and-book', 'checkout', 'endpoints', 'widgets', 'attribution', 'live-chat', 'customer-portal', 'mcp-connector'], 'type': 'string', 'description': 'A topic from list_docs'}}, 'additionalProperties': False}

{'type': 'object', 'properties': {'host': {'type': 'string', 'description': "The operator's RideDesk domain (e.g. their-workspace.ridedesk.app or a custom domain). Optional — examples use a placeholder without it."}}, 'additionalProperties': False}

{'type': 'object', 'properties': {'host': {'type': 'string', 'description': "The operator's RideDesk domain (e.g. their-workspace.ridedesk.app or a custom domain). Optional — examples use a placeholder without it."}}, 'additionalProperties': False}

{'type': 'object', 'properties': {}, 'additionalProperties': False}

{'type': 'object', 'required': ['docs', 'note'], 'properties': {'docs': {'type': 'array', 'items': {'type': 'object', 'required': ['topic', 'title', 'summary'], 'properties': {'title': {'type': 'string'}, 'topic': {'enum': ['overview', 'quote-and-book', 'checkout', 'endpoints', 'widgets', 'attribution', 'live-chat', 'customer-portal', 'mcp-connector'], 'type': 'string', 'description': 'Pass this to get_doc'}, 'summary': {'type': 'string'}}, 'additionalProperties': False}, 'description': 'Every documentation topic this server can serve.'}, 'note': {'type': 'string'}}, 'additionalProperties': False}

{'type': 'object', 'required': ['query'], 'properties': {'host': {'type': 'string', 'description': "The operator's RideDesk domain (e.g. their-workspace.ridedesk.app or a custom domain). Optional — examples use a placeholder without it."}, 'query': {'type': 'string', 'description': 'Keywords, an endpoint path, or a field name (e.g. "quote_ref", "apple pay", "/api/enquiries")'}}, 'additionalProperties': False}

{'type': 'object', 'required': ['results'], 'properties': {'note': {'type': 'string', 'description': 'Present only when there were no matches.'}, 'results': {'type': 'array', 'items': {'type': 'object', 'required': ['topic', 'heading', 'excerpt'], 'properties': {'topic': {'enum': ['overview', 'quote-and-book', 'checkout', 'endpoints', 'widgets', 'attribution', 'live-chat', 'customer-portal', 'mcp-connector'], 'type': 'string', 'description': 'Pass this to get_doc for the full topic'}, 'excerpt': {'type': 'string', 'description': 'Up to 600 characters of the matching section'}, 'heading': {'type': 'string', 'description': 'The section heading the match sits under'}}, 'additionalProperties': False}, 'description': 'Matching sections, best first. Empty when nothing matched.'}}, 'additionalProperties': False}