Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
TypeScript agentic-aiagentsaiai-agentsaiagentsdeveloper-toolsfunction-callinggpt-4javascriptjsllmllmopsmcppythonremote-mcp-serverssetypescript
docs: hide User tag and CLI realtime endpoints from API reference
Sushmitha Malleshe1c7a4139325
diff --git a/docs/content/reference/api-reference/user/index.mdx b/docs/content/reference/api-reference/user/index.mdxdeleted file mode 100644index 83b96d4b4..000000000--- a/docs/content/reference/api-reference/user/index.mdx+++ /dev/null@@ -1,15 +0,0 @@-----title: User-description: "User API key management"------{/* Auto-generated from OpenAPI spec. Do not edit directly. */}--User API key management--## Endpoints--| Endpoint | Quick Link |-|----------|------------|-| `GET /api/v3/user/api_keys` | [List active user API keys](/reference/api-reference/user/getUserApiKeys) |-| `DELETE /api/v3/user/api_keys/{key_id}` | [Revoke a user API key](/reference/api-reference/user/deleteUserApiKeysByKeyId) |diff --git a/docs/public/openapi.json b/docs/public/openapi.jsonindex a650762ce..7b3d514a7 100644--- a/docs/public/openapi.json+++ b/docs/public/openapi.json@@ -100,10 +100,6 @@{"name": "Tool Router","description": "(Labs) Tool router endpoints"- },- {- "name": "User",- "description": "User API key management"}],"components": {@@ -2387,161 +2383,6 @@}}},- "/api/v3/cli/realtime/credentials": {- "get": {- "summary": "Get credentials for CLI realtime events",- "description": "Get the Pusher key and project nanoId for the CLI realtime trigger channel. The CLI subscribes to private-cli-{project_id}.",- "tags": [- "Triggers"- ],- "operationId": "getCliRealtimeCredentials",- "security": [- {- "ApiKeyAuth": []- },- {- "UserApiKeyAuth": []- }- ],- "responses": {- "200": {- "description": "Credentials for CLI realtime events retrieved successfully",- "content": {- "application/json": {- "schema": {- "type": "object",- "properties": {- "pusher_key": {- "type": "string",- "description": "The Pusher client key for subscribing to the trigger"- },- "pusher_cluster": {- "type": "string",- "description": "The Pusher cluster for subscribing to the trigger"- },- "project_id": {- "type": "string",- "description": "The project nanoId associated with the API Key provided. Used as part of the CLI channel name: private-cli-{project_id}"- }- },- "required": [- "pusher_key",- "pusher_cluster",- "project_id"- ]- }- }- }- },- "401": {- "description": "Unauthorized. Authentication is required or the provided credentials are invalid.",- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/Error"- }- }- }- }- }- }- },- "/api/v3/cli/realtime/auth": {- "post": {- "summary": "Authenticate CLI Pusher channel access",- "description": "Authenticate CLI client access to a private-cli-{nanoId} Pusher channel",- "tags": [- "Triggers"- ],- "operationId": "postCliRealtimeAuth",- "security": [- {- "ApiKeyAuth": []- },- {- "UserApiKeyAuth": []- }- ],- "requestBody": {- "content": {- "application/json": {- "schema": {- "type": "object",- "properties": {- "channel_name": {- "type": "string",- "description": "The channel name to authenticate for"- },- "socket_id": {- "type": "string",- "description": "The socket ID for Pusher authentication"- }- },- "required": [- "channel_name",- "socket_id"- ]- }- }- }- },- "responses": {- "200": {- "description": "Pusher authentication successful",- "content": {- "application/json": {- "schema": {- "type": "object",- "properties": {- "auth": {- "type": "string",- "description": "The authentication string for Pusher"- },- "channel_data": {- "type": "string",- "description": "Channel data for presence channels"- }- },- "required": [- "auth"- ]- }- }- }- },- "400": {- "description": "Invalid channel name",- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/Error"- }- }- }- },- "401": {- "description": "Unauthorized. Authentication is required or the provided credentials are invalid.",- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/Error"- }- }- }- },- "500": {- "description": "Internal server error occurred during authentication.",- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/Error"- }- }- }- }- }- }- },"/api/v3/connected_accounts": {"get": {"summary": "List connected accounts with optional filters",@@ -6705,198 +6546,6 @@}}},- "/api/v3/user/api_keys": {- "get": {- "summary": "List active user API keys",- "description": "Returns all active (non-revoked) user API keys for the authenticated user. User API keys (uak_ prefix) are user-scoped keys that authenticate across projects, typically created during CLI login with scope=user.",- "tags": [- "User"- ],- "operationId": "getUserApiKeys",- "responses": {- "200": {- "description": "List of active user API keys retrieved successfully.",- "content": {- "application/json": {- "schema": {- "type": "object",- "properties": {- "items": {- "type": "array",- "items": {- "type": "object",- "properties": {- "id": {- "type": "string",- "description": "Unique identifier for the user API key."- },- "name": {- "type": "string",- "nullable": true,- "description": "Display name of the API key."- },- "source": {- "type": "string",- "nullable": true,- "description": "Source string describing where the key was created from."- },- "created_at": {- "type": "string",- "description": "ISO timestamp when the key was created."- },- "revoked_at": {- "type": "string",- "nullable": true,- "description": "ISO timestamp when the key was revoked, or null if active."- },- "expires_at": {- "type": "string",- "nullable": true,- "description": "ISO timestamp when the key expires, or null if indefinite."- },- "cli_session_id": {- "type": "string",- "nullable": true,- "description": "CLI session ID associated with this key, if any."- }- },- "required": [- "id",- "name",- "source",- "created_at",- "revoked_at",- "expires_at",- "cli_session_id"- ]- },- "description": "List of active user API keys."- }- },- "required": [- "items"- ]- }- }- }- },- "401": {- "description": "Unauthorized. Authentication is required.",- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/Error"- }- }- }- },- "500": {- "description": "Internal server error.",- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/Error"- }- }- }- }- }- }- },- "/api/v3/user/api_keys/{key_id}": {- "delete": {- "summary": "Revoke a user API key",- "description": "Revokes a specific user API key by ID. Once revoked, the key can no longer be used for authentication. The revocation takes effect immediately (cache is cleared). The authenticated user must own the key.",- "tags": [- "User"- ],- "operationId": "deleteUserApiKeysByKeyId",- "parameters": [- {- "schema": {- "type": "string",- "description": "The ID of the user API key to revoke."- },- "required": true,- "description": "The ID of the user API key to revoke.",- "name": "key_id",- "in": "path"- }- ],- "responses": {- "200": {- "description": "User API key revoked successfully.",- "content": {- "application/json": {- "schema": {- "type": "object",- "properties": {- "id": {- "type": "string",- "description": "Unique identifier of the revoked API key."- },- "revoked_at": {- "type": "string",- "description": "ISO timestamp when the key was revoked."- },- "expires_at": {- "type": "string",- "nullable": true,- "description": "ISO timestamp when the key expires, or null if indefinite."- }- },- "required": [- "id",- "revoked_at",- "expires_at"- ]- }- }- }- },- "400": {- "description": "Bad request. Key may already be revoked.",- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/Error"- }- }- }- },- "401": {- "description": "Unauthorized. Authentication is required.",- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/Error"- }- }- }- },- "404": {- "description": "User API key not found or does not belong to the authenticated user.",- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/Error"- }- }- }- },- "500": {- "description": "Internal server error.",- "content": {- "application/json": {- "schema": {- "$ref": "#/components/schemas/Error"- }- }- }- }- }- }- },"/api/v3/webhook_subscriptions": {"post": {"summary": "Create webhook subscription",diff --git a/docs/scripts/fetch-openapi.mjs b/docs/scripts/fetch-openapi.mjsindex 05bd3ed61..c170b22b1 100644--- a/docs/scripts/fetch-openapi.mjs+++ b/docs/scripts/fetch-openapi.mjs@@ -18,6 +18,8 @@ const IGNORED_PATHS = ['/api/v3/cli/get-session','/api/v3/cli/create-session','/api/v3/auth/session/logout',+ '/api/v3/cli/realtime/credentials',+ '/api/v3/cli/realtime/auth',];// Tags to ignore (internal/admin)@@ -25,6 +27,7 @@ const IGNORED_TAGS = ['CLI','Admin','Profiling',+ 'User',];async function fetchAndFilterSpec() {