CometChat Docs

Searches CometChat documentation including SDK guides (JavaScript, React, iOS, Android, Flutter, React Native), UI Kit references, REST API documentation, integration tutorials, and OpenAPI specs. Returns ranked snippets with titles and direct links to source pages. Pages for the current version of each SDK and UI Kit are preferred over older versions, and each result reports its version label and whether it is current. To reach older docs, pass the `version` filter with that version's label.

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "description": "Search query. 1–500 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."
    },
    "limit": {
      "type": "number",
      "description": "Maximum number of results to return. Default 10, maximum 25.",
      "minimum": 1,
      "maximum": 25
    }
  },
  "required": [
    "query"
  ],
  "additionalProperties": false
}

{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "description": "Ranked search results.",
      "items": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string",
            "description": "Page title."
          },
          "url": {
            "type": "string",
            "description": "Direct link to the source page."
          },
          "snippet": {
            "type": "string",
            "description": "Matched excerpt with context."
          },
          "section": {
            "type": "string",
            "description": "Documentation section the page belongs to."
          },
          "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."
          }
        },
        "required": [
          "title",
          "url",
          "snippet",
          "section",
          "isCurrent"
        ],
        "additionalProperties": false
      }
    },
    "totalAvailable": {
      "type": "number",
      "description": "Total matching pages available (may exceed the returned count)."
    }
  },
  "required": [
    "results",
    "totalAvailable"
  ],
  "additionalProperties": false
}

Fetches the full content of a single CometChat documentation page by URL or path. Returns the page content as markdown along with title and section metadata. Path can be passed as a full https://www.cometchat.com/docs URL or as a relative path such as '/sdk/javascript/overview'.

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

{
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "description": "Page title."
    },
    "url": {
      "type": "string",
      "description": "Canonical page URL."
    },
    "section": {
      "type": "string",
      "description": "Documentation section the page belongs to."
    },
    "content": {
      "type": "string",
      "description": "Full page content as markdown (truncated if very large)."
    },
    "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."
    }
  },
  "required": [
    "title",
    "url",
    "section",
    "content",
    "contentLength"
  ],
  "additionalProperties": false
}

Returns a curated implementation bundle for a named CometChat integration scenario. Each bundle includes prerequisites, install commands, configuration, working code examples, and common pitfalls. Available bundles cover common integration patterns across React, Flutter, iOS, Android, React Native, and the JavaScript SDK.

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

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

Lists every available CometChat implementation bundle with its identifier, title, target framework, and last-verified date.

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

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