How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Wispr AI

Wispr AI Sync WS API

The Sync WS API from Wispr AI — 3 operation(s) for sync ws.

Documentation Provider Profile APIs.io OpenAPI GitHub

Wispr AI Sync WS API is one of 50 APIs that Wispr AI publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Sync WS. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 3 operations across 3 paths, and defines 45 schemas. It is described by OpenAPI 3.2.0, at version 0.5.2.

Requests are made against a single base URL, https://api.wisprflow.ai.

3 operations 3 paths 45 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.5.2
Base URL
https://api.wisprflow.ai
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Wispr AI Sync WS API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (ApiKeyHeaderPatched). An API key is passed in the header as X-API-Key (APIKeyHeader).

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Sync WS 3
POST
/api/v1/sync/ws/admin/test-publish
Admin Test Publish
admin_test_publish 1 param body → 200422
GET
/api/v1/sync/ws/schema
Sync Ws Schema
sync_ws_schema → 200
GET
/api/v1/sync/ws/client-schema
Sync Ws Client Schema
sync_ws_client_schema → 200

Schemas 45

The contract defines 45 schemas that model the data the API accepts and returns. The most detailed are FlowState2025Response (24 properties), SubscriptionPayload (22 properties), UserPreferences (14 properties), VoiceProfileResponse (14 properties). Each schema is shown below with its type and property counts.

SyncEventEnterpriseSubscriptionChanged
object
An enterprise's subscription changed (enterprise Stripe webhook or an admin plan switch). Thin — every current member refetches its subscription state through…
4 properties 4 required
FlowStateProcessingStatus
string
SyncEventSubscriptionChanged
object
The user's subscription state changed (Stripe or RevenueCat webhook). Fat event — the full rendered SubscriptionPayload travels on the wire so the client appli…
4 properties 4 required
AdminTestPublishOptions
object
1 property
SyncEventMeetingTranscriptChanged
object
Refined transcript persisted for meetingid. Thin-ticket — client refetches transcript bytes through the existing inline sync path. Kept separate from meeting.c…
4 properties 4 required
NotificationResponse
object
A single notification as returned to the client.
10 properties 10 required
SyncEventNotificationCreated
object
A new notification has been created for the user. Inline (fat) event: the entire NotificationResponse travels on the wire so the client can render a toast imme…
4 properties 4 required
SyncEventVoiceProfileReady
object
A voice-profile background job finished and committed a profile row. Fat event — the full VoiceProfileResponse (same shape the desktop polls via GET /llm/voice…
4 properties 4 required
SyncEventEnterpriseMembershipChanged
object
An enterprise's membership roster changed (member added/removed via SCIM or admin action). Thin — the client refetches its subscription state through GET /paym…
4 properties 4 required
UserPreferences
object
14 properties
PolishInstructions
object
Saved toggle rules for Polish transforms (built-in defaults + custom).
2 properties
FlowState2025Response
object
24 properties 2 required
SyncClientAck
object
Client acknowledges receipt up to seq. Server uses for stream trimming heuristics.
2 properties 2 required
AdminTestPublishResponse
object
2 properties 2 required
AdminTestPublishRequest
object
4 properties 2 required
PreferencesResponse
object
Full snapshot of a user's preferences plus the server-assigned modifiedat watermark. Used as the inline payload for the preferences.changed sync event so peers…
2 properties 2 required
VoiceProfileProcessingStatus
string
Processing state of a user's voice profile generation.
SyncClientPing
object
Client liveness probe; server replies with the next heartbeat.
2 properties 2 required
SyncEventUnrecognized
object
Escape hatch for the admin test-publish endpoint. Lets the server emit a well-formed envelope whose type the client doesn't know yet, so the desktop harness ca…
4 properties 4 required
HTTPValidationError
object
1 property
SyncClientFrameEnvelope
object
Wrapper for the client-frame union — same OpenAPI surfacing trick.
1 property 1 required
NotificationPlatformType
string
Client platform(s) a notification targets.
SubscriptionPayload
object
Rendered subscription state mirroring stripeservice.getsubscriptiondetails. The fat subscription.changed event carries this so the client applies it directly —…
22 properties 3 required
SyncEventGapTooLarge
object
Server response when the requested resume point is too old. Emitted in response to subscribe { since: N } where the stream's oldest entry is newer than N — cli…
3 properties 3 required
NotetakerTranscriptRetention
string
PersonalizationStyle
string
Represents the style for personalization settings.
SyncEventHeartbeat
object
Keepalive frame emitted by the server on a fixed cadence.
3 properties 3 required
VoiceProfileResponse
object
The generated voice profile and its processing status for a user.
14 properties 1 required
NotificationType
string
Category of a user notification.
SyncEventCalendarChanged
object
Calendar state changed. Thin-ticket — client refetches the calendar list.
3 properties 3 required
SyncEventPreferencesChanged
object
User preferences updated. Inline (fat) — full PreferencesResponse travels on the wire so peers can converge via last-writer-wins on the modifiedat echo.
4 properties 4 required
IncidentStatusDetail
object
Active incident details returned in the status response.
5 properties 5 required
SyncClientSubscribe
object
First frame after the WS upgrade. Establishes the subscription and optionally resumes from since (the client's last delivered sequence; omitted on a cold start…
2 properties 1 required
ValidationError
object
5 properties 3 required
SyncEventFlowStateJobCompleted
object
A flow-state-2025 background job finished and committed its LLM fields. Fat event — the full FlowState2025Response (same shape the desktop polls via GET /llm/f…
4 properties 4 required
SyncEventAutomationsChanged
object
Automations set changed. Thin-ticket — the client refetches via the /automations/sync pull. Coarse (no automation id): the client re-pulls the whole resource,…
3 properties 3 required
SyncEventTodosChanged
object
Todos set changed. Thin-ticket — client refetches via the existing /todos/sync flow. Coarse (no todoid): the client re-pulls the whole resource, and a per-row…
3 properties 3 required
PersonalizationStyles
object
5 properties
SyncEventReconnectResync
object
Server-initiated reconnect signal. Client should drop its lastseq, reconnect, and call /sync/check to bootstrap from snapshot.
4 properties 4 required
RefineJobStatus
string
SyncEventEnvelope
object
Wrapper that surfaces the SyncEvent union to OpenAPI. The field name syncevent is load-bearing: openapi-generator-cli names the generated TS union type from th…
1 property 1 required
SyncEventIncidentBannerUpdated
object
The production incident banner changed for ALL users (global fanout). Fat event carrying the same IncidentStatusDetail the bootstrap /sync/check returns. paylo…
4 properties 3 required
OnboardingIntent
string
SyncEventNotesChanged
object
Notes set changed. Thin-ticket — client refetches via the existing notes sync flow.
3 properties 3 required
SyncEventMeetingChanged
object
A meeting row's user-visible state changed. Thin-ticket — client refetches the meeting row. A resource-level changed shape (matching notes.changed / calendar.c…
5 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wispr-ai-sync-ws-api-openapi.yml Raw ↑

Other APIs Wispr AI publishes across the network.

Wispr AI Analytics API
AE Profile APIs.io
Wispr AI Analytics Registry API
AE Profile APIs.io
Wispr AI Attribution Tracking API
AE Profile APIs.io
Wispr AI Authentication API
AE Profile APIs.io
Wispr AI Automations API
AE Profile APIs.io
Wispr AI Calendar API
AE Profile APIs.io
Wispr AI Connectors API
AE Profile APIs.io
Wispr AI Cost Centers API
AE Profile APIs.io
Wispr AI Dash API
AE Profile APIs.io
Wispr AI Dictionary API
AE Profile APIs.io
Wispr AI Enterpret API
AE Profile APIs.io
Wispr AI Enterprise API
AE Profile APIs.io
#Sync WS
← Back to W APIs
API Details
ID
wispr-ai:wispr-ai-sync-ws-api
Base URL
https://api.wisprflow.ai
Docs
https://wisprflow.ai/developers
Provider
Wispr AI
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=wispr-ai-sync-ws-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/wispr-ai-sync-ws-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Wispr AI Sync WS API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.