API Docs
v0.0.277Rapid API
API documentation for Rapid
Admin
26 endpoints
Admin
getList all groups with member counts
/admin/groups
List all groups with member counts
/admin/groups
Returns all groups with their member counts
Responses
postCreate a new group
/admin/groups
Create a new group
/admin/groups
Creates a new group with the given name and optional description
Request body
Responses
getGet group details with members
/admin/groups/{id}
Get group details with members
/admin/groups/{id}
Returns a group with its members
Parameters
The group ID
Responses
putUpdate a group
/admin/groups/{id}
Update a group
/admin/groups/{id}
Updates a group's name and/or description
Parameters
The group ID
Request body
Responses
deleteDelete a group
/admin/groups/{id}
Delete a group
/admin/groups/{id}
Deletes a group and all its memberships
Parameters
The group ID
Responses
getGet group members
/admin/groups/{id}/members
Get group members
/admin/groups/{id}/members
Returns all members of a group
Parameters
The group ID
Responses
postAdd a member to a group
/admin/groups/{id}/members
Add a member to a group
/admin/groups/{id}/members
Adds a user to a group
Parameters
The group ID
Request body
Responses
deleteRemove a member from a group
/admin/groups/{id}/members/{userId}
Remove a member from a group
/admin/groups/{id}/members/{userId}
Removes a user from a group
Parameters
The group ID
The user ID
Responses
getList organizations
/admin/organizations
List organizations
/admin/organizations
Returns all organizations for admin management.
Responses
postCreate a new organization
/admin/organizations
Create a new organization
/admin/organizations
Creates an organization with the given name and optional description.
Responses
getGet an organization by ID
/admin/organizations/{id}
Get an organization by ID
/admin/organizations/{id}
Returns a single organization for admin management.
Responses
putUpdate an organization
/admin/organizations/{id}
Update an organization
/admin/organizations/{id}
Updates an organization's name and/or description.
Responses
deleteDelete an organization
/admin/organizations/{id}
Delete an organization
/admin/organizations/{id}
Deletes an organization and its memberships.
Responses
getGet groups belonging to an organization
/admin/organizations/{id}/groups
Get groups belonging to an organization
/admin/organizations/{id}/groups
Returns all groups that belong to the specified organization.
Parameters
Organization ID
Responses
getGet users belonging to an organization
/admin/organizations/{id}/users
Get users belonging to an organization
/admin/organizations/{id}/users
Returns all users that are members of the specified organization.
Parameters
Organization ID
Responses
getGet Postgres connection info
/admin/postgres/info
Get Postgres connection info
/admin/postgres/info
Returns connection metadata and server version for the admin UI
Responses
getList Postgres tables with size and row metadata
/admin/postgres/tables
List Postgres tables with size and row metadata
/admin/postgres/tables
Returns user tables with row count and storage metrics
Responses
getGet column metadata for a Postgres table
/admin/postgres/tables/{schema}/{table}/columns
Get column metadata for a Postgres table
/admin/postgres/tables/{schema}/{table}/columns
Returns column information from information_schema
Parameters
Responses
getGet paginated rows from a Postgres table
/admin/postgres/tables/{schema}/{table}/rows
Get paginated rows from a Postgres table
/admin/postgres/tables/{schema}/{table}/rows
Returns rows with pagination and optional sorting
Parameters
Responses
getGet total number of keys in Redis
/admin/redis/dbsize
Get total number of keys in Redis
/admin/redis/dbsize
Returns the total count of keys in the current Redis database
Responses
getList Redis keys with pagination
/admin/redis/keys
List Redis keys with pagination
/admin/redis/keys
Returns Redis keys with their types and TTLs using cursor-based pagination
Parameters
Redis SCAN cursor for pagination
Maximum number of keys to return per page
Responses
getGet Redis key value
/admin/redis/keys/{key}
Get Redis key value
/admin/redis/keys/{key}
Returns the value of a Redis key based on its type (string, set, hash)
Parameters
The Redis key to fetch
Responses
deleteDelete a Redis key
/admin/redis/keys/{key}
Delete a Redis key
/admin/redis/keys/{key}
Deletes a key from Redis
Parameters
The Redis key to delete
Responses
getList users
/admin/users
List users
/admin/users
Returns all users for admin management.
Responses
getGet a user by ID
/admin/users/{id}
Get a user by ID
/admin/users/{id}
Returns a single user for admin management.
Parameters
Responses
patchUpdate a user
/admin/users/{id}
Update a user
/admin/users/{id}
Updates user attributes for admin management.
Parameters
Request body
Responses
Auth
6 endpoints
Auth
postLogin with email and password
/auth/login
Login with email and password
/auth/login
Validates credentials and returns a bearer access token.
Request body
Responses
postLogout and invalidate current session
/auth/logout
Logout and invalidate current session
/auth/logout
Deletes the current session and refresh token.
Responses
postRefresh access token
/auth/refresh
Refresh access token
/auth/refresh
Exchange a valid refresh token for new access and refresh tokens (rotation).
Request body
Responses
postRegister a new user
/auth/register
Register a new user
/auth/register
Creates a new user account and returns access tokens for immediate login.
Request body
Responses
getList all active sessions for the current user
/auth/sessions
List all active sessions for the current user
/auth/sessions
Returns all sessions with metadata. Requires authentication.
Responses
deleteDelete a session
/auth/sessions/{sessionId}
Delete a session
/auth/sessions/{sessionId}
Revokes a session. Cannot delete the current session.
Parameters
Responses
Chat
1 endpoints
Chat
postCreate a chat completion via OpenRouter
/chat/completions
Create a chat completion via OpenRouter
/chat/completions
Proxies a chat completion request to OpenRouter using a default free model.
Request body
Responses
Emails
3 endpoints
Emails
getList emails with pagination
/emails
List emails with pagination
/emails
Returns a paginated list of stored emails with parsed metadata
Parameters
Number of emails to skip
Maximum number of emails to return
Responses
getGet email by ID
/emails/{id}
Get email by ID
/emails/{id}
Returns a single email with full raw data
Parameters
Email ID
Responses
deleteDelete email by ID
/emails/{id}
Delete email by ID
/emails/{id}
Deletes a single email
Parameters
Email ID
Responses
Health
1 endpoints
Health
getHealth check endpoint
/ping
Health check endpoint
/ping
Returns the current API version
Responses
SSE
1 endpoints
SSE
getServer-Sent Events endpoint for real-time updates
/sse
Server-Sent Events endpoint for real-time updates
/sse
Establishes an SSE connection for receiving real-time broadcasts via Redis pub/sub
Parameters
Comma-separated list of channels to subscribe to (default "broadcast")
Responses
VFS
3 endpoints
VFS
postSet up VFS keys for current user
/vfs/keys
Set up VFS keys for current user
/vfs/keys
Stores the user's VFS keypair. Can only be called once per user.
Request body
Responses
getGet current user's VFS public keys
/vfs/keys/me
Get current user's VFS public keys
/vfs/keys/me
Returns the public encryption and signing keys for the authenticated user.
Responses
postRegister an item in the VFS registry
/vfs/register
Register an item in the VFS registry
/vfs/register
Creates a VFS registry entry for a file, folder, contact, or other object.
Request body
Responses