Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
docs: hide User tag and CLI realtime endpoints from API reference
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Sushmitha Mallesh committed
Feb 23, 2026 at 23:30 UTC
e1c7a413932522dba00a9f878e2df97bbbb8302d
3 files changed
+3
-366
docs/content/reference/api-reference/user/index.mdx
deleted
-15
@@ -1,15 +0,0 @@
1
----
2
-title: User
3
-description: "User API key management"
4
----
5
-
6
-{/* Auto-generated from OpenAPI spec. Do not edit directly. */}
7
-
8
-User API key management
9
-
10
-## Endpoints
11
-
12
-| Endpoint | Quick Link |
13
-|----------|------------|
14
-| `GET /api/v3/user/api_keys` | [List active user API keys](/reference/api-reference/user/getUserApiKeys) |
15
-| `DELETE /api/v3/user/api_keys/{key_id}` | [Revoke a user API key](/reference/api-reference/user/deleteUserApiKeysByKeyId) |
docs/public/openapi.json
-351
@@ -100,10 +100,6 @@
100
{
101
"name": "Tool Router",
102
"description": "(Labs) Tool router endpoints"
103
- },
104
- {
105
- "name": "User",
106
- "description": "User API key management"
103
}
104
],
105
"components": {
@@ -2387,161 +2383,6 @@
2383
}
2384
}
2385
},
2390
- "/api/v3/cli/realtime/credentials": {
2391
- "get": {
2392
- "summary": "Get credentials for CLI realtime events",
2393
- "description": "Get the Pusher key and project nanoId for the CLI realtime trigger channel. The CLI subscribes to private-cli-{project_id}.",
2394
- "tags": [
2395
- "Triggers"
2396
- ],
2397
- "operationId": "getCliRealtimeCredentials",
2398
- "security": [
2399
- {
2400
- "ApiKeyAuth": []
2401
- },
2402
- {
2403
- "UserApiKeyAuth": []
2404
- }
2405
- ],
2406
- "responses": {
2407
- "200": {
2408
- "description": "Credentials for CLI realtime events retrieved successfully",
2409
- "content": {
2410
- "application/json": {
2411
- "schema": {
2412
- "type": "object",
2413
- "properties": {
2414
- "pusher_key": {
2415
- "type": "string",
2416
- "description": "The Pusher client key for subscribing to the trigger"
2417
- },
2418
- "pusher_cluster": {
2419
- "type": "string",
2420
- "description": "The Pusher cluster for subscribing to the trigger"
2421
- },
2422
- "project_id": {
2423
- "type": "string",
2424
- "description": "The project nanoId associated with the API Key provided. Used as part of the CLI channel name: private-cli-{project_id}"
2425
- }
2426
- },
2427
- "required": [
2428
- "pusher_key",
2429
- "pusher_cluster",
2430
- "project_id"
2431
- ]
2432
- }
2433
- }
2434
- }
2435
- },
2436
- "401": {
2437
- "description": "Unauthorized. Authentication is required or the provided credentials are invalid.",
2438
- "content": {
2439
- "application/json": {
2440
- "schema": {
2441
- "$ref": "#/components/schemas/Error"
2442
- }
2443
- }
2444
- }
2445
- }
2446
- }
2447
- }
2448
- },
2449
- "/api/v3/cli/realtime/auth": {
2450
- "post": {
2451
- "summary": "Authenticate CLI Pusher channel access",
2452
- "description": "Authenticate CLI client access to a private-cli-{nanoId} Pusher channel",
2453
- "tags": [
2454
- "Triggers"
2455
- ],
2456
- "operationId": "postCliRealtimeAuth",
2457
- "security": [
2458
- {
2459
- "ApiKeyAuth": []
2460
- },
2461
- {
2462
- "UserApiKeyAuth": []
2463
- }
2464
- ],
2465
- "requestBody": {
2466
- "content": {
2467
- "application/json": {
2468
- "schema": {
2469
- "type": "object",
2470
- "properties": {
2471
- "channel_name": {
2472
- "type": "string",
2473
- "description": "The channel name to authenticate for"
2474
- },
2475
- "socket_id": {
2476
- "type": "string",
2477
- "description": "The socket ID for Pusher authentication"
2478
- }
2479
- },
2480
- "required": [
2481
- "channel_name",
2482
- "socket_id"
2483
- ]
2484
- }
2485
- }
2486
- }
2487
- },
2488
- "responses": {
2489
- "200": {
2490
- "description": "Pusher authentication successful",
2491
- "content": {
2492
- "application/json": {
2493
- "schema": {
2494
- "type": "object",
2495
- "properties": {
2496
- "auth": {
2497
- "type": "string",
2498
- "description": "The authentication string for Pusher"
2499
- },
2500
- "channel_data": {
2501
- "type": "string",
2502
- "description": "Channel data for presence channels"
2503
- }
2504
- },
2505
- "required": [
2506
- "auth"
2507
- ]
2508
- }
2509
- }
2510
- }
2511
- },
2512
- "400": {
2513
- "description": "Invalid channel name",
2514
- "content": {
2515
- "application/json": {
2516
- "schema": {
2517
- "$ref": "#/components/schemas/Error"
2518
- }
2519
- }
2520
- }
2521
- },
2522
- "401": {
2523
- "description": "Unauthorized. Authentication is required or the provided credentials are invalid.",
2524
- "content": {
2525
- "application/json": {
2526
- "schema": {
2527
- "$ref": "#/components/schemas/Error"
2528
- }
2529
- }
2530
- }
2531
- },
2532
- "500": {
2533
- "description": "Internal server error occurred during authentication.",
2534
- "content": {
2535
- "application/json": {
2536
- "schema": {
2537
- "$ref": "#/components/schemas/Error"
2538
- }
2539
- }
2540
- }
2541
- }
2542
- }
2543
- }
2544
- },
2386
"/api/v3/connected_accounts": {
2387
"get": {
2388
"summary": "List connected accounts with optional filters",
@@ -6705,198 +6546,6 @@
6546
}
6547
}
6548
},
6708
- "/api/v3/user/api_keys": {
6709
- "get": {
6710
- "summary": "List active user API keys",
6711
- "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.",
6712
- "tags": [
6713
- "User"
6714
- ],
6715
- "operationId": "getUserApiKeys",
6716
- "responses": {
6717
- "200": {
6718
- "description": "List of active user API keys retrieved successfully.",
6719
- "content": {
6720
- "application/json": {
6721
- "schema": {
6722
- "type": "object",
6723
- "properties": {
6724
- "items": {
6725
- "type": "array",
6726
- "items": {
6727
- "type": "object",
6728
- "properties": {
6729
- "id": {
6730
- "type": "string",
6731
- "description": "Unique identifier for the user API key."
6732
- },
6733
- "name": {
6734
- "type": "string",
6735
- "nullable": true,
6736
- "description": "Display name of the API key."
6737
- },
6738
- "source": {
6739
- "type": "string",
6740
- "nullable": true,
6741
- "description": "Source string describing where the key was created from."
6742
- },
6743
- "created_at": {
6744
- "type": "string",
6745
- "description": "ISO timestamp when the key was created."
6746
- },
6747
- "revoked_at": {
6748
- "type": "string",
6749
- "nullable": true,
6750
- "description": "ISO timestamp when the key was revoked, or null if active."
6751
- },
6752
- "expires_at": {
6753
- "type": "string",
6754
- "nullable": true,
6755
- "description": "ISO timestamp when the key expires, or null if indefinite."
6756
- },
6757
- "cli_session_id": {
6758
- "type": "string",
6759
- "nullable": true,
6760
- "description": "CLI session ID associated with this key, if any."
6761
- }
6762
- },
6763
- "required": [
6764
- "id",
6765
- "name",
6766
- "source",
6767
- "created_at",
6768
- "revoked_at",
6769
- "expires_at",
6770
- "cli_session_id"
6771
- ]
6772
- },
6773
- "description": "List of active user API keys."
6774
- }
6775
- },
6776
- "required": [
6777
- "items"
6778
- ]
6779
- }
6780
- }
6781
- }
6782
- },
6783
- "401": {
6784
- "description": "Unauthorized. Authentication is required.",
6785
- "content": {
6786
- "application/json": {
6787
- "schema": {
6788
- "$ref": "#/components/schemas/Error"
6789
- }
6790
- }
6791
- }
6792
- },
6793
- "500": {
6794
- "description": "Internal server error.",
6795
- "content": {
6796
- "application/json": {
6797
- "schema": {
6798
- "$ref": "#/components/schemas/Error"
6799
- }
6800
- }
6801
- }
6802
- }
6803
- }
6804
- }
6805
- },
6806
- "/api/v3/user/api_keys/{key_id}": {
6807
- "delete": {
6808
- "summary": "Revoke a user API key",
6809
- "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.",
6810
- "tags": [
6811
- "User"
6812
- ],
6813
- "operationId": "deleteUserApiKeysByKeyId",
6814
- "parameters": [
6815
- {
6816
- "schema": {
6817
- "type": "string",
6818
- "description": "The ID of the user API key to revoke."
6819
- },
6820
- "required": true,
6821
- "description": "The ID of the user API key to revoke.",
6822
- "name": "key_id",
6823
- "in": "path"
6824
- }
6825
- ],
6826
- "responses": {
6827
- "200": {
6828
- "description": "User API key revoked successfully.",
6829
- "content": {
6830
- "application/json": {
6831
- "schema": {
6832
- "type": "object",
6833
- "properties": {
6834
- "id": {
6835
- "type": "string",
6836
- "description": "Unique identifier of the revoked API key."
6837
- },
6838
- "revoked_at": {
6839
- "type": "string",
6840
- "description": "ISO timestamp when the key was revoked."
6841
- },
6842
- "expires_at": {
6843
- "type": "string",
6844
- "nullable": true,
6845
- "description": "ISO timestamp when the key expires, or null if indefinite."
6846
- }
6847
- },
6848
- "required": [
6849
- "id",
6850
- "revoked_at",
6851
- "expires_at"
6852
- ]
6853
- }
6854
- }
6855
- }
6856
- },
6857
- "400": {
6858
- "description": "Bad request. Key may already be revoked.",
6859
- "content": {
6860
- "application/json": {
6861
- "schema": {
6862
- "$ref": "#/components/schemas/Error"
6863
- }
6864
- }
6865
- }
6866
- },
6867
- "401": {
6868
- "description": "Unauthorized. Authentication is required.",
6869
- "content": {
6870
- "application/json": {
6871
- "schema": {
6872
- "$ref": "#/components/schemas/Error"
6873
- }
6874
- }
6875
- }
6876
- },
6877
- "404": {
6878
- "description": "User API key not found or does not belong to the authenticated user.",
6879
- "content": {
6880
- "application/json": {
6881
- "schema": {
6882
- "$ref": "#/components/schemas/Error"
6883
- }
6884
- }
6885
- }
6886
- },
6887
- "500": {
6888
- "description": "Internal server error.",
6889
- "content": {
6890
- "application/json": {
6891
- "schema": {
6892
- "$ref": "#/components/schemas/Error"
6893
- }
6894
- }
6895
- }
6896
- }
6897
- }
6898
- }
6899
- },
6549
"/api/v3/webhook_subscriptions": {
6550
"post": {
6551
"summary": "Create webhook subscription",
docs/scripts/fetch-openapi.mjs
+3
@@ -18,6 +18,8 @@ const IGNORED_PATHS = [
18
'/api/v3/cli/get-session',
19
'/api/v3/cli/create-session',
20
'/api/v3/auth/session/logout',
21
+ '/api/v3/cli/realtime/credentials',
22
+ '/api/v3/cli/realtime/auth',
23
];
24
25
// Tags to ignore (internal/admin)
@@ -25,6 +27,7 @@ const IGNORED_TAGS = [
27
'CLI',
28
'Admin',
29
'Profiling',
30
+ 'User',
31
];
32
33
async function fetchAndFilterSpec() {