# SuperWize

## Docs

- [Transcribe audio](https://docs.superwize.ai/api-reference/audio/transcribe-audio.md): Transcribes base64-encoded audio input to text. The server may run language fallback logic for Urdu/Hindi accuracy.
- [Check login email](https://docs.superwize.ai/api-reference/authentication/check-login-email.md): Checks whether an email has a credential-based account and whether that email is already verified.
- [Create API key](https://docs.superwize.ai/api-reference/authentication/create-api-key.md): Creates a user-managed API key for direct API access via x-api-key.
- [Get API token for current session](https://docs.superwize.ai/api-reference/authentication/get-api-token-for-current-session.md): Returns the current authenticated session token for external API calls using Authorization: Bearer.
- [List API keys](https://docs.superwize.ai/api-reference/authentication/list-api-keys.md): Lists API keys for the current user (without plaintext key values).
- [Resend verification email](https://docs.superwize.ai/api-reference/authentication/resend-verification-email.md): Attempts to resend account verification mail for an address. For privacy, unknown users also return success.
- [Revoke API key](https://docs.superwize.ai/api-reference/authentication/revoke-api-key.md): Revokes a specific API key owned by the current user.
- [Sync Google profile image](https://docs.superwize.ai/api-reference/authentication/sync-google-profile-image.md): Backfills user image from linked Google account when current image is missing or stale.
- [Add conversation to group](https://docs.superwize.ai/api-reference/bookmarks/add-conversation-to-group.md): Adds a conversation to a bookmark group (idempotent).
- [Create bookmark group](https://docs.superwize.ai/api-reference/bookmarks/create-bookmark-group.md): Creates a bookmark group owned by the current user.
- [Delete bookmark group](https://docs.superwize.ai/api-reference/bookmarks/delete-bookmark-group.md): Deletes a bookmark group and its items.
- [Get bookmark group](https://docs.superwize.ai/api-reference/bookmarks/get-bookmark-group.md): Returns a bookmark group by id with the list of bookmarked conversation ids.
- [List bookmark groups](https://docs.superwize.ai/api-reference/bookmarks/list-bookmark-groups.md): Returns all bookmark groups for the current user with item counts.
- [List conversations in bookmark group](https://docs.superwize.ai/api-reference/bookmarks/list-conversations-in-bookmark-group.md): Returns paginated conversation details for all bookmarked conversations in a specific bookmark group.
- [List groups containing a conversation](https://docs.superwize.ai/api-reference/bookmarks/list-groups-containing-a-conversation.md): Returns all bookmark groups for the current user that contain the given conversation id.
- [Remove conversation from group](https://docs.superwize.ai/api-reference/bookmarks/remove-conversation-from-group.md): Removes a conversation from a bookmark group.
- [Update bookmark group](https://docs.superwize.ai/api-reference/bookmarks/update-bookmark-group.md): Updates bookmark group name and/or color.
- [Auto-title conversation](https://docs.superwize.ai/api-reference/chat/auto-title-conversation.md): Generates and stores a short title for a conversation using early conversation content.
- [Batch get response feedback](https://docs.superwize.ai/api-reference/chat/batch-get-response-feedback.md): Returns feedback for multiple response ids in one request.
- [Check write permission](https://docs.superwize.ai/api-reference/chat/check-write-permission.md): Checks whether the current user has writer access for the conversation.
- [Delete conversation](https://docs.superwize.ai/api-reference/chat/delete-conversation.md): Deletes a conversation and related local references such as branch/bookmark records.
- [Generate home suggestions](https://docs.superwize.ai/api-reference/chat/generate-home-suggestions.md): Returns suggestion prompts shown in the chat home UI.
- [Get branch info](https://docs.superwize.ai/api-reference/chat/get-branch-info.md): Returns branch metadata for a conversation, including parent references when available.
- [Get branch parent history](https://docs.superwize.ai/api-reference/chat/get-branch-parent-history.md): Returns normalized parent conversation history up to the branch point item.
- [Get conversation](https://docs.superwize.ai/api-reference/chat/get-conversation.md): Returns metadata for a single conversation by id.
- [Get conversation items](https://docs.superwize.ai/api-reference/chat/get-conversation-items.md): Returns paginated raw conversation items/messages for a specific conversation.
- [Get latest deep research run](https://docs.superwize.ai/api-reference/chat/get-latest-deep-research-run.md): Returns latest deep-research run for a conversation, including refreshed status when still running.
- [Get response feedback](https://docs.superwize.ai/api-reference/chat/get-response-feedback.md): Returns stored thumbs-up/thumbs-down feedback for a response id, if any.
- [List conversations](https://docs.superwize.ai/api-reference/chat/list-conversations.md): Returns paginated conversations available to the current user.
- [Rename conversation](https://docs.superwize.ai/api-reference/chat/rename-conversation.md): Updates conversation title metadata.
- [Set response feedback](https://docs.superwize.ai/api-reference/chat/set-response-feedback.md): Creates, updates, or clears user feedback for a response.
- [Set study mode (deprecated)](https://docs.superwize.ai/api-reference/chat/set-study-mode-deprecated.md): Deprecated endpoint for toggling study-mode metadata on a conversation.
- [Share conversation](https://docs.superwize.ai/api-reference/chat/share-conversation.md): Grants global reader access to a conversation using upstream permission controls.
- [Start deep research job](https://docs.superwize.ai/api-reference/chat/start-deep-research-job.md): Starts a deep-research run in background mode and returns identifiers so clients can poll or subscribe for status.
- [Stream chat response (legacy)](https://docs.superwize.ai/api-reference/chat/stream-chat-response-legacy.md): Legacy streaming chat endpoint with optional image inputs.
- [Stream chat response (v2)](https://docs.superwize.ai/api-reference/chat/stream-chat-response-v2.md): Legacy streaming chat endpoint for clients on API >= 1.0.2. Supports multimodal images and tool execution.
- [Stream chat response (v3)](https://docs.superwize.ai/api-reference/chat/stream-chat-response-v3.md): Current streaming chat endpoint for clients on API >= 1.1.2. Supports uploaded files, branching context, and tool execution.
- [Stream deep research (v1.1.3+)](https://docs.superwize.ai/api-reference/chat/stream-deep-research-v113+.md): Streams deep-research lifecycle and output events for clients on API >= 1.1.3 while running the task in background mode.
- [Test stream endpoint](https://docs.superwize.ai/api-reference/chat/test-stream-endpoint.md): Diagnostic endpoint that emits a short deterministic event stream to validate streaming behavior.
- [Truncate conversation from item](https://docs.superwize.ai/api-reference/chat/truncate-conversation-from-item.md): Deletes items from a specified item id onward to support edit-and-continue conversation flows.
- [Unshare conversation](https://docs.superwize.ai/api-reference/chat/unshare-conversation.md): Revokes global reader access from a previously shared conversation.
- [Claim signup bonus](https://docs.superwize.ai/api-reference/credits/claim-signup-bonus.md): Attempts to claim one-time signup bonus credits for the current authenticated user (non-anonymous users only).
- [Get credit config](https://docs.superwize.ai/api-reference/credits/get-credit-config.md): Returns credit operation costs and low-balance threshold used by clients.
- [Get credit summary](https://docs.superwize.ai/api-reference/credits/get-credit-summary.md): Returns balances, tier, reset time, and low-credit flags for the current user.
- [Get credit usage history](https://docs.superwize.ai/api-reference/credits/get-credit-usage-history.md): Returns paginated credit deduction history for the authenticated user.
- [Grant ad reward (development)](https://docs.superwize.ai/api-reference/credits/grant-ad-reward-development.md): Development-only endpoint to grant bonus credits for rewarded ad testing. In production, reward grants are handled by server-side verification callbacks.
- [Get file by id](https://docs.superwize.ai/api-reference/files/get-file-by-id.md): Fetches a previously uploaded file as a data URL by its MKA1 file id.
- [Upload file](https://docs.superwize.ai/api-reference/files/upload-file.md): Uploads a data URL file to MKA1 and returns the created file metadata. Use this before chat v3 file attachments.
- [Create group chat](https://docs.superwize.ai/api-reference/group-chat/create-group-chat.md): Creates a group chat and corresponding upstream conversation with the creator as the first member.
- [Create group invite link](https://docs.superwize.ai/api-reference/group-chat/create-group-invite-link.md): Creates an invite token/link for joining a group chat, with optional expiry.
- [Delete group chat](https://docs.superwize.ai/api-reference/group-chat/delete-group-chat.md): Deletes an existing group chat. Only the creator is allowed to delete it.
- [Get group chat](https://docs.superwize.ai/api-reference/group-chat/get-group-chat.md): Returns group details, members, and creator/mute flags for the current member.
- [Get group messages](https://docs.superwize.ai/api-reference/group-chat/get-group-messages.md): Returns paginated group messages enriched with sender and tool-output metadata.
- [Get invite information](https://docs.superwize.ai/api-reference/group-chat/get-invite-information.md): Returns group preview information for an invite token without joining.
- [Join group via invite token](https://docs.superwize.ai/api-reference/group-chat/join-group-via-invite-token.md): Joins the current authenticated user to a group chat from an invite token.
- [Leave group chat](https://docs.superwize.ai/api-reference/group-chat/leave-group-chat.md): Removes the current user from a group chat and revokes upstream write permissions.
- [List group chats](https://docs.superwize.ai/api-reference/group-chat/list-group-chats.md): Returns all group chats where the current user is a member.
- [Request manual AI response](https://docs.superwize.ai/api-reference/group-chat/request-manual-ai-response.md): Starts a manual AI response stream for a group and emits realtime AI events.
- [Send group message](https://docs.superwize.ai/api-reference/group-chat/send-group-message.md): Creates a user message in the group conversation, publishes realtime events, and may trigger AI follow-up logic.
- [Subscribe to realtime group events](https://docs.superwize.ai/api-reference/group-chat/subscribe-to-realtime-group-events.md): Opens an event stream for realtime group updates and heartbeats for a group member.
- [Update group settings](https://docs.superwize.ai/api-reference/group-chat/update-group-settings.md): Updates group-level settings such as intelligent responses.
- [Update notification settings](https://docs.superwize.ai/api-reference/group-chat/update-notification-settings.md): Updates per-user notification mute state for a group chat.
- [Convert image to JPEG](https://docs.superwize.ai/api-reference/images/convert-image-to-jpeg.md): Converts an input image data URL into JPEG format. Returns a discriminated result with conversion errors in-body.
- [Fetch cached external image](https://docs.superwize.ai/api-reference/images/fetch-cached-external-image.md): Fetches an image URL, caches it server-side, and returns base64 content.
- [Get image by file id (legacy)](https://docs.superwize.ai/api-reference/images/get-image-by-file-id-legacy.md): Legacy image retrieval endpoint kept for backward compatibility. Prefer files.getFileByFileId.
- [Upload image (legacy)](https://docs.superwize.ai/api-reference/images/upload-image-legacy.md): Legacy image upload endpoint kept for backward compatibility. Prefer files.uploadFile.
- [SuperWize API overview](https://docs.superwize.ai/api-reference/introduction.md)
- [Get mini app by id](https://docs.superwize.ai/api-reference/mini-apps/get-mini-app-by-id.md): Returns one mini app fixture by id.
- [List enabled mini apps](https://docs.superwize.ai/api-reference/mini-apps/list-enabled-mini-apps.md): Returns the list of enabled mini apps from bundled fixtures.
- [Get article sources](https://docs.superwize.ai/api-reference/news/get-article-sources.md): Returns ordered source citations for a specific news article.
- [Get category news feed](https://docs.superwize.ai/api-reference/news/get-category-news-feed.md): Returns curated news for a single category and locale, including run status and fallback metadata.
- [Get news article](https://docs.superwize.ai/api-reference/news/get-news-article.md): Returns one news article by id and locale, including markdown content and source preview URLs.
- [Get top stories feed](https://docs.superwize.ai/api-reference/news/get-top-stories-feed.md): Returns top stories across categories for the requested locale and their latest generation statuses.
- [Submit article feedback](https://docs.superwize.ai/api-reference/news/submit-article-feedback.md): Stores thumbs-up or thumbs-down article feedback for the authenticated user.
- [Register push token](https://docs.superwize.ai/api-reference/notifications/register-push-token.md): Registers or updates an Expo push token for the authenticated user and device.
- [Send deep-research webhook test notification](https://docs.superwize.ai/api-reference/notifications/send-deep-research-webhook-test-notification.md): Sends a synthetic deep-research status push payload for webhook flow testing. Restricted to @meetkai.com users.
- [Send test push notification](https://docs.superwize.ai/api-reference/notifications/send-test-push-notification.md): Sends a test push notification to all active device tokens for the current user.
- [Get account type](https://docs.superwize.ai/api-reference/preferences/get-account-type.md): Returns current account type and whether account-type selection is locked.
- [Get user preferences](https://docs.superwize.ai/api-reference/preferences/get-user-preferences.md): Returns current preferences for the authenticated user.
- [Update account type](https://docs.superwize.ai/api-reference/preferences/update-account-type.md): Sets account type (general/student/teacher). For most users this is a one-time action and becomes locked.
- [Update user preferences](https://docs.superwize.ai/api-reference/preferences/update-user-preferences.md): Partially updates the current user preferences. Anonymous users receive default preferences.
- [Get current release metadata](https://docs.superwize.ai/api-reference/release-notes/get-current-release-metadata.md): Returns current release notes payload consumed by in-app release/update modals.
- [Check subscription update timestamp](https://docs.superwize.ai/api-reference/subscription/check-subscription-update-timestamp.md): Lightweight polling endpoint that returns only the last subscription update timestamp.
- [Get subscription status](https://docs.superwize.ai/api-reference/subscription/get-subscription-status.md): Returns the current subscription tier and active state for the authenticated user.
- [Send support contact email](https://docs.superwize.ai/api-reference/support/send-support-contact-email.md): Submits a support/contact request email to the configured SuperWize support inbox.
- [API health check](https://docs.superwize.ai/api-reference/system/api-health-check.md): Returns basic service liveness for uptime checks and load balancers.
- [Add widget thread message](https://docs.superwize.ai/api-reference/widgets/add-widget-thread-message.md): Adds a message/event to a widget thread with server-side validation (including quiz-specific constraints).
- [Get or create widget thread](https://docs.superwize.ai/api-reference/widgets/get-or-create-widget-thread.md): Returns the active widget thread for the current user, creating one if missing.
- [Get widget by id](https://docs.superwize.ai/api-reference/widgets/get-widget-by-id.md): Returns widget details and the latest thread for the current user when accessible.
- [Get widget by response ids](https://docs.superwize.ai/api-reference/widgets/get-widget-by-response-ids.md): Returns widget details for the first matching response id in a set. Supports merged assistant-message lookups.
- [Update widget thread status](https://docs.superwize.ai/api-reference/widgets/update-widget-thread-status.md): Updates thread status to active, completed, or abandoned.

## OpenAPI Specs

- [openapi](https://api.superwize.ai/api/openapi.json)