Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
62 commits
Select commit Hold shift + click to select a range
c087032
doc updates
pranavkamble-cometchat Feb 9, 2026
737a793
Fixed webhooks redirect URLs.
siva-cometchat Feb 10, 2026
c54d59a
cac changes
pranavkamble-cometchat Feb 10, 2026
05471dc
cac updates
pranavkamble-cometchat Feb 10, 2026
0c10663
Updated font size of API description.
siva-cometchat Feb 10, 2026
e274416
cac updates
pranavkamble-cometchat Feb 10, 2026
fe4e3f9
cac updates
pranavkamble-cometchat Feb 11, 2026
faefe5a
Restructured the REST API endpoints.
siva-cometchat Feb 11, 2026
63d6646
Merge branch 'main' into docs/restapi-chatapi-ENG-30061
siva-cometchat Feb 11, 2026
6cffa63
Updated the structure of Platform APIs.
siva-cometchat Feb 12, 2026
58da443
cac changes
pranavkamble-cometchat Feb 12, 2026
8b0b3d5
Updated the moderation section.
siva-cometchat Feb 12, 2026
7b26277
Corrected openAI docs.
siva-cometchat Feb 12, 2026
91262a6
Renamed providers to Integrations.
siva-cometchat Feb 13, 2026
b29e8e6
Updated the constraints on each file.
siva-cometchat Feb 17, 2026
c4b39f2
Merge branch 'main' into docs/restapi-chatapi-ENG-30061
siva-cometchat Feb 17, 2026
b65256d
Corrected the constraints.
siva-cometchat Feb 17, 2026
284e3ba
cac changes
pranavkamble-cometchat Feb 17, 2026
6c73e32
cac changes
pranavkamble-cometchat Feb 18, 2026
1765036
Added the greedy regex info in moderation.
siva-cometchat Feb 18, 2026
a4906b0
Merge branch 'main' into docs/restapi-chatapi-ENG-30061
siva-cometchat Feb 26, 2026
782cde1
fix: REST API docs review — broken links, contradictions, enriched Re…
ketanyekale Mar 23, 2026
9e16bac
Merge branch 'main' into docs/restapi-chatapi-ENG-30061-ketan
ketanyekale Mar 23, 2026
aa6ce89
fix: rewrite remaining overview pages to enriched format, add descrip…
ketanyekale Mar 23, 2026
7bb6ff8
Added links to properties and constraints
ketanyekale Mar 23, 2026
7c87582
Updated sample users and groups
ketanyekale Mar 23, 2026
c17ff83
Merge branch 'main' into docs/restapi-chatapi-ENG-30061-ketan
ketanyekale Mar 25, 2026
12fffe3
Resolve merge conflicts and apply REST API docs audit fixes
ketanyekale Mar 25, 2026
c5c31f7
corrected sample data in examples
ketanyekale Mar 26, 2026
a64e5bc
added rbac and sbac
ketanyekale Mar 27, 2026
917e58c
Added AI Agents API docs
ketanyekale Mar 27, 2026
1eb0a86
fixed medium and low issues from audit
ketanyekale Mar 27, 2026
f6e042f
Added missing moderation docs
ketanyekale Mar 27, 2026
ec1264e
Fixed consistency issues
ketanyekale Mar 27, 2026
0bd5d84
Fixed consistency issues
ketanyekale Mar 27, 2026
efceb57
Moved all the rest api docs under rest-api
ketanyekale Mar 27, 2026
b155fb1
deleted origional of api docs moved to reast-api
ketanyekale Mar 27, 2026
1a98cc5
Added separate troubleshooting docs for each Product's rest APIs
ketanyekale Mar 28, 2026
7d86897
Audit fixes after consistency changes across products
ketanyekale Mar 28, 2026
8c0b947
Audit fixes
ketanyekale Mar 28, 2026
0f19592
Removed duplicate resources table
ketanyekale Mar 28, 2026
2e3ca22
Minor audit fixes
ketanyekale Mar 28, 2026
3bfdc28
Added separate authentication page
ketanyekale Mar 28, 2026
af55a77
Removed interactive message
ketanyekale Mar 30, 2026
581faf3
Added cross product links
ketanyekale Mar 30, 2026
4fe4fbd
Removed orphans from REST API docs
ketanyekale Mar 31, 2026
456a19d
Removed orphans from REST API docs
ketanyekale Mar 31, 2026
c2cb6f6
fixed broken links
ketanyekale Mar 31, 2026
6924b7f
Added page descriptions for AEO friendliness
ketanyekale Mar 31, 2026
46efa0b
fixed conversations overview table and removed CHECK THIS.
ketanyekale Mar 31, 2026
f5a019a
Fixed p1 issues from audit
ketanyekale Mar 31, 2026
90c4c8a
Fixed P2s from audit.
ketanyekale Mar 31, 2026
22dd3ed
Added undocumented APIs from AI Agents.
ketanyekale Mar 31, 2026
7330fe7
fixed low priority issues from the audit report.
ketanyekale Mar 31, 2026
2258f04
Fixed schemas
ketanyekale Mar 31, 2026
0ec3f5d
Merge branch 'main' into docs/restapi-chatapi-ENG-30061-ketan
ketanyekale Mar 31, 2026
ed6ba01
Fixed all the p1s
ketanyekale Mar 31, 2026
554f0ca
Fixed all the p2s
ketanyekale Mar 31, 2026
bc20c21
Fixed all the p3s
ketanyekale Apr 1, 2026
32e04ed
Fixes for AEO
ketanyekale Apr 1, 2026
78fd34e
Fixed link hygiene to 10/10
ketanyekale Apr 1, 2026
d3702cb
updated code blocks for AEO
ketanyekale Apr 1, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
21 changes: 21 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
root = true

[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.json]
indent_style = space
indent_size = 2

[*.mdx]
indent_style = space
indent_size = 2
trim_trailing_whitespace = false

[*.md]
trim_trailing_whitespace = false
3 changes: 2 additions & 1 deletion .mintlifyignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
.github
.github/**
.claude/**
7 changes: 7 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"tabWidth": 2,
"useTabs": false,
"endOfLine": "lf",
"singleQuote": false,
"trailingComma": "none"
}
Empty file added Warning
Empty file.
39 changes: 21 additions & 18 deletions ai-agent-service.json
Original file line number Diff line number Diff line change
Expand Up @@ -114,12 +114,12 @@
"description": "Internal document ID"
},
"createdAt": {
"type": "string",
"type": "integer",
"format": "date-time",
"description": "Creation timestamp"
},
"updatedAt": {
"type": "string",
"type": "integer",
"format": "date-time",
"description": "Last update timestamp"
}
Expand Down Expand Up @@ -294,11 +294,11 @@
}
},
"createdAt": {
"type": "string",
"type": "integer",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"type": "integer",
"format": "date-time"
}
}
Expand Down Expand Up @@ -419,11 +419,11 @@
}
},
"createdAt": {
"type": "string",
"type": "integer",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"type": "integer",
"format": "date-time"
}
}
Expand Down Expand Up @@ -542,11 +542,11 @@
}
},
"createdAt": {
"type": "string",
"type": "integer",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"type": "integer",
"format": "date-time"
}
}
Expand Down Expand Up @@ -670,11 +670,11 @@
}
},
"createdAt": {
"type": "string",
"type": "integer",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"type": "integer",
"format": "date-time"
}
}
Expand Down Expand Up @@ -1416,7 +1416,7 @@
},
"constantValue": {
"type": "string",
"example": ""
"example": "premium"
},
"defaultValue": {
"type": "string",
Expand Down Expand Up @@ -1517,7 +1517,7 @@
},
"constantValue": {
"type": "string",
"example": ""
"example": "premium"
},
"defaultValue": {
"type": "string",
Expand Down Expand Up @@ -1629,7 +1629,7 @@
},
"constantValue": {
"type": "string",
"example": ""
"example": "premium"
},
"defaultValue": {
"type": "string",
Expand Down Expand Up @@ -4387,7 +4387,7 @@
"example": 1
},
"createdAt": {
"type": "string",
"type": "integer",
"example": "2026-03-12T12:52:28.063000"
}
}
Expand Down Expand Up @@ -7481,6 +7481,7 @@
}
],
"summary": "Enable actions for a tool",
"description": "Adds actions to a specific tool attached to an agent.",
"tags": [
"Agent Builder"
]
Expand Down Expand Up @@ -7540,6 +7541,7 @@
}
],
"summary": "Remove actions for a tool",
"description": "Removes actions from a specific tool attached to an agent.",
"tags": [
"Agent Builder"
]
Expand Down Expand Up @@ -7612,6 +7614,7 @@
}
],
"summary": "Get actions available within a tool for agent",
"description": "Lists all actions available for a specific tool attached to an agent.",
"tags": [
"Agent Builder Ready to Use Tools"
]
Expand Down Expand Up @@ -8188,9 +8191,9 @@
],
"servers": [
{
"url": "https://{appid}.api-{region}.cometchat.io/v3",
"url": "https://{appId}.api-{region}.cometchat.io/v3",
"variables": {
"appid": {
"appId": {
"default": "appId",
"description": "(Required) App ID"
},
Expand Down Expand Up @@ -9190,12 +9193,12 @@
"description": "Internal document ID"
},
"createdAt": {
"type": "string",
"type": "integer",
"format": "date-time",
"description": "Creation timestamp"
},
"updatedAt": {
"type": "string",
"type": "integer",
"format": "date-time",
"description": "Last update timestamp"
}
Expand Down
2 changes: 1 addition & 1 deletion ai-agents/ag2-knowledge-agent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ curl -N -X POST http://localhost:8000/agent \
<Step title="Enable">Save then confirm the toggle shows <b>Enabled</b>.</Step>
</Steps>

> For more on CometChat AI Agents, see: [Overview](/ai-agents/overview) · [Instructions](/ai-agents/instructions) · [Custom agents](/ai-agents/custom-agents)
> For more on CometChat AI Agents, see: [Overview](/ai-agents/agent-builder/overview) · [Instructions](/ai-agents/agent-builder/instructions) · [Custom agents](/ai-agents/agent-builder/tools/overview)

***

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ Or if content should be redacted:
```

**Agent Instructions:**
```
```python
After retrieving information from the knowledge base, call
validateKnowledgeResponse with the retrieved content.

Expand Down
3 changes: 0 additions & 3 deletions ai-agents/apis/add-api-tools-to-agent.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions ai-agents/apis/add-frontend-actions-to-agent.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions ai-agents/apis/add-knowledge-base-files.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions ai-agents/apis/add-mcp-servers-to-agent.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions ai-agents/apis/add-tools-to-agent.mdx

This file was deleted.

1 change: 1 addition & 0 deletions ai-agents/apis/authenticate-composio-tool.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: post /ai-agents/agent-builder/agents/{uid}/tools/{slug}/authenticate
description: "POST /ai-agents/agent-builder/agents/{uid}/tools/{slug}/authenticate — CometChat API endpoint."
---
3 changes: 0 additions & 3 deletions ai-agents/apis/create-agent.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions ai-agents/apis/create-api-tool.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions ai-agents/apis/create-byo-agent.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions ai-agents/apis/create-custom-variable.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions ai-agents/apis/create-frontend-action.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions ai-agents/apis/create-mcp-server.mdx

This file was deleted.

1 change: 1 addition & 0 deletions ai-agents/apis/create-tag.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: post /ai-agents/tags
description: "POST /ai-agents/tags — CometChat API endpoint."
---
3 changes: 0 additions & 3 deletions ai-agents/apis/create-text-detail.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions ai-agents/apis/create-tool.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions ai-agents/apis/delete-agent.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions ai-agents/apis/delete-api-tool.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions ai-agents/apis/delete-byo-agent.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions ai-agents/apis/delete-custom-variable.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions ai-agents/apis/delete-frontend-action.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions ai-agents/apis/delete-mcp-server.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions ai-agents/apis/delete-text-detail.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions ai-agents/apis/delete-tool.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions ai-agents/apis/delete-uploaded-file.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions ai-agents/apis/delete-website.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions ai-agents/apis/enable-tool-actions.mdx

This file was deleted.

1 change: 1 addition & 0 deletions ai-agents/apis/get-action-edit-form.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: get /ai-agents/forms/action-edit/{name}
description: "GET /ai-agents/forms/action-edit/{name} — CometChat API endpoint."
---
1 change: 1 addition & 0 deletions ai-agents/apis/get-actions-creation-form.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: get /ai-agents/forms/actions-creation
description: "GET /ai-agents/forms/actions-creation — CometChat API endpoint."
---
1 change: 1 addition & 0 deletions ai-agents/apis/get-actions-form.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: get /ai-agents/forms/actions
description: "GET /ai-agents/forms/actions — CometChat API endpoint."
---
1 change: 1 addition & 0 deletions ai-agents/apis/get-agent-creation-form.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: get /ai-agents/forms/agent-creation
description: "GET /ai-agents/forms/agent-creation — CometChat API endpoint."
---
1 change: 1 addition & 0 deletions ai-agents/apis/get-agent-edit-form.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: get /ai-agents/forms/agent-edit/{id}
description: "GET /ai-agents/forms/agent-edit/{id} — CometChat API endpoint."
---
3 changes: 0 additions & 3 deletions ai-agents/apis/get-agent.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions ai-agents/apis/get-all-available-variables.mdx

This file was deleted.

1 change: 1 addition & 0 deletions ai-agents/apis/get-all-tools-for-agent.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: get /ai-agents/agent-builder/agents/{uid}/all-tools
description: "GET /ai-agents/agent-builder/agents/{uid}/all-tools — CometChat API endpoint."
---
1 change: 1 addition & 0 deletions ai-agents/apis/get-all-variables.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: get /ai-agents/agent-builder/agents/variables
description: "GET /ai-agents/agent-builder/agents/variables — CometChat API endpoint."
---
1 change: 1 addition & 0 deletions ai-agents/apis/get-api-tool.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: get /ai-agents/agent-builder/api-tools/{slug}
description: "Retrieves a specific API tool by its slug. Use this endpoint to inspect an API tool's configuration, parameters, and connected agents."
---
1 change: 1 addition & 0 deletions ai-agents/apis/get-available-models.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: get /ai-agents/agent-builder/agents/available-models
description: "Retrieves the list of AI models available for agents. Use this endpoint to discover supported models before creating or updating an agent. **Model details:** Each model includes its provider, configu"
---
1 change: 1 addition & 0 deletions ai-agents/apis/get-composio-tools.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: get /ai-agents/agent-builder/tools/agent/{uid}
description: "GET /ai-agents/agent-builder/tools/agent/{uid} — CometChat API endpoint."
---
1 change: 1 addition & 0 deletions ai-agents/apis/get-custom-variables.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: get /ai-agents/agent-builder/agents/variables/custom
description: "Retrieves all custom variables defined for the application. Use this endpoint to view and manage dynamic variables used in agent instructions. **Variable types:** Custom variables can source values f"
---
3 changes: 0 additions & 3 deletions ai-agents/apis/get-discovered-urls.mdx

This file was deleted.

1 change: 1 addition & 0 deletions ai-agents/apis/get-form-fields.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: get /ai-agents/agents/form-fields
description: "GET /ai-agents/agents/form-fields — CometChat API endpoint."
---
1 change: 1 addition & 0 deletions ai-agents/apis/get-frontend-action.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: get /ai-agents/agent-builder/frontend-actions/{id}
description: "Retrieves a specific frontend action by its unique ID. Use this endpoint to inspect a frontend action's configuration, parameters, and trigger function."
---
1 change: 1 addition & 0 deletions ai-agents/apis/get-mcp-server.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: get /ai-agents/agent-builder/mcp-servers/{slug}
description: "Retrieves a specific MCP server by its slug. Use this endpoint to inspect an MCP server's configuration and connected agents."
---
Loading