Rapid

Rapid

API Docs

v0.0.279

Rapid API

API documentation for Rapid

Admin

26 endpoints
get

List all groups with member counts

/admin/groups

Returns all groups with their member counts

Responses

200List of groups with member counts
500Database error
post

Create a new group

/admin/groups

Creates a new group with the given name and optional description

Request body

application/json

Responses

201Group created successfully
400Invalid request body
409Group name already exists
500Database error
get

Get group details with members

/admin/groups/{id}

Returns a group with its members

Parameters

idpathRequiredstring

The group ID

Responses

200Group details with members
404Group not found
500Database error
put

Update a group

/admin/groups/{id}

Updates a group's name and/or description

Parameters

idpathRequiredstring

The group ID

Request body

application/json

Responses

200Group updated successfully
404Group not found
409Group name already exists
500Database error
delete

Delete a group

/admin/groups/{id}

Deletes a group and all its memberships

Parameters

idpathRequiredstring

The group ID

Responses

200Group deleted successfully
500Database error
get

Get group members

/admin/groups/{id}/members

Returns all members of a group

Parameters

idpathRequiredstring

The group ID

Responses

200List of group members
404Group not found
500Database error
post

Add a member to a group

/admin/groups/{id}/members

Adds a user to a group

Parameters

idpathRequiredstring

The group ID

Request body

application/json

Responses

201Member added successfully
400Invalid request body
404Group or user not found
409User already a member
500Database error
delete

Remove a member from a group

/admin/groups/{id}/members/{userId}

Removes a user from a group

Parameters

idpathRequiredstring

The group ID

userIdpathRequiredstring

The user ID

Responses

200Member removed successfully
500Database error
get

List organizations

/admin/organizations

Returns all organizations for admin management.

Responses

200List of organizations
500Database error
post

Create a new organization

/admin/organizations

Creates an organization with the given name and optional description.

Responses

201Organization created successfully
400Invalid request body
409Organization name already exists
500Database error
get

Get an organization by ID

/admin/organizations/{id}

Returns a single organization for admin management.

Responses

200Organization found
404Organization not found
500Database error
put

Update an organization

/admin/organizations/{id}

Updates an organization's name and/or description.

Responses

200Organization updated successfully
400Invalid request body
404Organization not found
409Organization name already exists
500Database error
delete

Delete an organization

/admin/organizations/{id}

Deletes an organization and its memberships.

Responses

200Organization deleted successfully
500Database error
get

Get groups belonging to an organization

/admin/organizations/{id}/groups

Returns all groups that belong to the specified organization.

Parameters

idpathRequiredstring

Organization ID

Responses

200List of organization groups
404Organization not found
500Database error
get

Get users belonging to an organization

/admin/organizations/{id}/users

Returns all users that are members of the specified organization.

Parameters

idpathRequiredstring

Organization ID

Responses

200List of organization users
404Organization not found
500Database error
get

Get Postgres connection info

/admin/postgres/info

Returns connection metadata and server version for the admin UI

Responses

200Connection details
500Postgres connection error
get

List Postgres tables with size and row metadata

/admin/postgres/tables

Returns user tables with row count and storage metrics

Responses

200List of tables
500Postgres connection error
get

Get column metadata for a Postgres table

/admin/postgres/tables/{schema}/{table}/columns

Returns column information from information_schema

Parameters

schemapathRequiredstring
tablepathRequiredstring

Responses

200Column metadata
404Table not found
500Postgres connection error
get

Get paginated rows from a Postgres table

/admin/postgres/tables/{schema}/{table}/rows

Returns rows with pagination and optional sorting

Parameters

schemapathRequiredstring
tablepathRequiredstring
limitqueryinteger
offsetqueryinteger
sortColumnquerystring
sortDirectionquerystring

Responses

200Paginated rows
404Table not found
500Postgres connection error
get

Get total number of keys in Redis

/admin/redis/dbsize

Returns the total count of keys in the current Redis database

Responses

200Total key count
500Redis connection error
get

List Redis keys with pagination

/admin/redis/keys

Returns Redis keys with their types and TTLs using cursor-based pagination

Parameters

cursorquerystring

Redis SCAN cursor for pagination

limitqueryinteger

Maximum number of keys to return per page

Responses

200Paginated list of Redis keys
500Redis connection error
get

Get Redis key value

/admin/redis/keys/{key}

Returns the value of a Redis key based on its type (string, set, hash)

Parameters

keypathRequiredstring

The Redis key to fetch

Responses

200Key value retrieved successfully
404Key not found
500Redis connection error
delete

Delete a Redis key

/admin/redis/keys/{key}

Deletes a key from Redis

Parameters

keypathRequiredstring

The Redis key to delete

Responses

200Key deletion result
500Redis connection error
get

List users

/admin/users

Returns all users for admin management.

Responses

200List of users
500Postgres connection error
get

Get a user by ID

/admin/users/{id}

Returns a single user for admin management.

Parameters

idpathRequiredstring

Responses

200User found
404User not found
500Postgres connection error
patch

Update a user

/admin/users/{id}

Updates user attributes for admin management.

Parameters

idpathRequiredstring

Request body

application/json

Responses

200Updated user
400Invalid payload
404User not found
500Postgres connection error

Auth

6 endpoints
post

Login with email and password

/auth/login

Validates credentials and returns a bearer access token.

Request body

application/json

Responses

200Authenticated response
400Invalid request payload
401Invalid credentials
500Server error
post

Logout and invalidate current session

/auth/logout

Deletes the current session and refresh token.

Responses

200Logged out successfully
401Unauthorized
500Server error
post

Refresh access token

/auth/refresh

Exchange a valid refresh token for new access and refresh tokens (rotation).

Request body

application/json

Responses

200New tokens issued
400Invalid request payload
401Invalid or expired refresh token
500Server error
post

Register a new user

/auth/register

Creates a new user account and returns access tokens for immediate login.

Request body

application/json

Responses

200Registration successful, user logged in
400Invalid request payload or email domain not allowed
409Email already registered
500Server error
get

List all active sessions for the current user

/auth/sessions

Returns all sessions with metadata. Requires authentication.

Responses

200List of sessions
401Unauthorized
500Server error
delete

Delete a session

/auth/sessions/{sessionId}

Revokes a session. Cannot delete the current session.

Parameters

sessionIdpathRequiredstring

Responses

200Session deleted
401Unauthorized
403Cannot delete current session
404Session not found
500Server error

Chat

1 endpoints
post

Create a chat completion via OpenRouter

/chat/completions

Proxies a chat completion request to OpenRouter using a default free model.

Request body

application/json

Responses

200OpenRouter response payload
400Invalid request payload
500Server configuration error

Emails

3 endpoints
get

List emails with pagination

/emails

Returns a paginated list of stored emails with parsed metadata

Parameters

offsetqueryinteger

Number of emails to skip

limitqueryinteger

Maximum number of emails to return

Responses

200List of emails
500Server error
get

Get email by ID

/emails/{id}

Returns a single email with full raw data

Parameters

idpathRequiredstring

Email ID

Responses

200Email details
404Email not found
500Server error
delete

Delete email by ID

/emails/{id}

Deletes a single email

Parameters

idpathRequiredstring

Email ID

Responses

200Email deleted
404Email not found
500Server error

Health

1 endpoints
get

Health check endpoint

/ping

Returns the current API version

Responses

200Successful response

SSE

1 endpoints
get

Server-Sent Events endpoint for real-time updates

/sse

Establishes an SSE connection for receiving real-time broadcasts via Redis pub/sub

Parameters

channelsquerystring

Comma-separated list of channels to subscribe to (default "broadcast")

Responses

200SSE stream established

VFS

3 endpoints
post

Set up VFS keys for current user

/vfs/keys

Stores the user's VFS keypair. Can only be called once per user.

Request body

application/json

Responses

201Keys stored successfully
400Invalid request payload
401Unauthorized
409Keys already exist for this user
500Server error
get

Get current user's VFS public keys

/vfs/keys/me

Returns the public encryption and signing keys for the authenticated user.

Responses

200User's public keys
401Unauthorized
404User has not set up VFS keys
500Server error
post

Register an item in the VFS registry

/vfs/register

Creates a VFS registry entry for a file, folder, contact, or other object.

Request body

application/json

Responses

201Item registered successfully
400Invalid request payload
401Unauthorized
409Item already registered
500Server error