CometChat Docs

{'type': 'object', 'required': ['path'], 'properties': {'path': {'type': 'string', 'description': "Documentation path or full URL. Relative paths like '/sdk/javascript/overview' and full URLs both work."}}, 'additionalProperties': False}

{'type': 'object', 'required': ['title', 'url', 'section', 'content', 'contentLength'], 'properties': {'url': {'type': 'string', 'description': 'Canonical page URL.'}, 'title': {'type': 'string', 'description': 'Page title.'}, 'content': {'type': 'string', 'description': 'Full page content as markdown (truncated if very large).'}, 'section': {'type': 'string', 'description': 'Documentation section the page belongs to.'}, 'contentLength': {'type': 'number', 'description': 'Content length in bytes after truncation.'}, 'redirectedFrom': {'type': 'string', 'description': 'Path originally requested, present only when that page has moved. url and section describe the page it moved to.'}}, 'additionalProperties': False}

{'type': 'object', 'required': ['bundle'], 'properties': {'bundle': {'type': 'string', 'description': "Bundle name in lowercase kebab-case, e.g. 'react-uikit-quickstart'."}}, 'additionalProperties': False}

{'type': 'object', 'required': ['bundle', 'title', 'framework', 'prerequisites', 'last_verified', 'content'], 'properties': {'title': {'type': 'string', 'description': 'Human-readable bundle title.'}, 'bundle': {'type': 'string', 'description': 'Bundle identifier.'}, 'content': {'type': 'string', 'description': 'The full implementation recipe as markdown.'}, 'framework': {'type': 'string', 'description': 'Target framework/platform.'}, 'last_verified': {'type': 'string', 'description': 'Date the bundle was last verified against live SDK versions.'}, 'prerequisites': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Prerequisites before applying the bundle.'}}, 'additionalProperties': False}

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

{'type': 'object', 'required': ['bundles', 'total'], 'properties': {'total': {'type': 'number', 'description': 'Number of bundles available.'}, 'bundles': {'type': 'array', 'items': {'type': 'object', 'required': ['bundle', 'title', 'framework', 'last_verified'], 'properties': {'title': {'type': 'string', 'description': 'Human-readable bundle title.'}, 'bundle': {'type': 'string', 'description': 'Bundle identifier to pass to get_cometchat_implementation_bundle.'}, 'framework': {'type': 'string', 'description': 'Target framework/platform.'}, 'last_verified': {'type': 'string', 'description': 'Date the bundle was last verified against live SDK versions.'}}, 'additionalProperties': False}, 'description': 'All available implementation bundles.'}}, 'additionalProperties': False}

{'type': 'object', 'required': ['query'], 'properties': {'limit': {'type': 'number', 'maximum': 25, 'minimum': 1, 'description': 'Maximum number of results to return. Default 10, maximum 25.'}, 'query': {'type': 'string', 'description': 'Search query. 1â\x80\x93500 characters.'}, 'version': {'type': 'string', 'description': "Optional version label from the docs version picker, e.g. 'v7' or 'v5'. Each SDK and UI Kit numbers its versions independently, so a label matches every product that uses it. Omit to search all versions, with current versions preferred."}}, 'additionalProperties': False}

{'type': 'object', 'required': ['results', 'totalAvailable'], 'properties': {'results': {'type': 'array', 'items': {'type': 'object', 'required': ['title', 'url', 'snippet', 'section', 'isCurrent'], 'properties': {'url': {'type': 'string', 'description': 'Direct link to the source page.'}, 'title': {'type': 'string', 'description': 'Page title.'}, 'section': {'type': 'string', 'description': 'Documentation section the page belongs to.'}, 'snippet': {'type': 'string', 'description': 'Matched excerpt with context.'}, 'version': {'type': 'string', 'description': "Version label of the page's SDK or UI Kit, e.g. 'v7'. Omitted for pages that are not versioned."}, 'isCurrent': {'type': 'boolean', 'description': 'False when the page documents an older version of its SDK or UI Kit.'}}, 'additionalProperties': False}, 'description': 'Ranked search results.'}, 'totalAvailable': {'type': 'number', 'description': 'Total matching pages available (may exceed the returned count).'}}, 'additionalProperties': False}