The identity and technical contract details declared by the specification.
TranscriptSpeaker
object
Canonical speaker identity; source and ID form the stable key.
3 properties
3 required
UpdateCampaignRequest
object
Partial-update request for an existing promo campaign.
10 properties
UpdateEnterpriseGatesRequest
object
1 property
1 required
MarketingJobResponse
object
Response returned after kicking off a generate-or-send job.
3 properties
3 required
EnterpriseStatus
string
Whether an enterprise or team is active or disbanded.
AlgorithmId
string
Closed registry of consensus implementations exposed for preview.
ConsensusPreviewRequest
object
Explicit consensus implementation selection.
1 property
1 required
ConsensusPreviewResponse
object
Ephemeral, non-persisted consensus preview result.
8 properties
5 required
BillingInfo
object
Billing info propagated to the Stripe customer record. billingcontact is the email Stripe sends invoices and receipts to; overrides the Stripe customer's email…
2 properties
Body_add_users_to_enterprise_file_upload_api_v1_internal_enterprises__enterprise_id__members_upload_post
object
1 property
1 required
AddBlockedDomainResponse
object
Response model for adding a blocked domain.
1 property
AdminMemorySearchRequest
object
Super-admin request: semantic-search each user's voice memory by context.
5 properties
3 required
ToggleDomainDeletedRequest
object
Request model for toggling domain deleted status.
1 property
1 required
ListRecentInvoicesResponse
object
The two most-recent invoices an operator might want to act on. open covers the pastdue case as well — Stripe treats pastdue as just an open invoice past its du…
2 properties
2 required
CreateSalesLedEnterpriseCustomBillingRequest
object
Request model for the superadmin-only custom-billing sales-led path. Adds custombillingconfig as a required field — the dedicated subclass surfaces the auth es…
13 properties
7 required
GenerateAndSendFlowStateRequest
object
Request body for the backend-owned all-user generate-and-send endpoint.
5 properties
1 required
RemoveUsersFromEnterpriseRequest
object
Request model for removing users from an enterprise by email
1 property
1 required
AddBlockedDomainRequest
object
Request model for adding a domain to the block list.
2 properties
1 required
PublicDomainsListResponse
object
Response model for the static public/webmail domain list.
2 properties
2 required
AdminUpdateStripeCustomerIdResponse
object
6 properties
6 required
ReactivateEnterprisePilotRequest
object
Request model for reactivating a canceled enterprise pilot. The enterprise is identified by path param; the server resolves the admin email + primary domain fr…
1 property
1 required
AllEnterprisesResponse
object
Response model for list of all enterprises with pagination
4 properties
4 required
ProvisionedCostCenterSummary
object
The cost center created by a successful provision.
2 properties
2 required
DirectorySyncPreview
object
Dry-run diff of a directory sync, shown to the admin before confirming.
7 properties
7 required
UpdateWorkosDirectoryIdRequest
object
Request model for setting or unlinking workosdirectoryid on an enterprise.
1 property
1 required
ErrorDetail
object
Standard FastAPI HTTPException envelope: {"detail": "..."}.
1 property
1 required
SignalQuality
object
Bounded diagnostics emitted by the consensus engine.
9 properties
3 required
CostCenterListItem
object
One row in the cost-center picker the operator UI renders. name comes from CostCenter.name (default "Default" for legacy single-CC enterprises). status is the…
5 properties
5 required
FlowStateProfilePreviewResponse
object
Paginated generated profile preview.
2 properties
2 required
UpdateUsersRoleRequest
object
Request model for updating user roles in an enterprise.
2 properties
2 required
UpdateUserTrialEndRequest
object
Request model for updating a user's personal trial end date (internal admin).
2 properties
2 required
MeetingAudioUrlResponse
object
Presigned GET URL for one meeting's audio, if present.
1 property
TranscriptEntry
object
Generator-safe wire model enforcing the three persisted entry shapes.
7 properties
2 required
InternalCostCenterProvisionResponse
object
Successful-provision result: the created cost center, team, and invoice.
4 properties
4 required
FlowStateMonthSummaryResponse
object
Month-level Flow State generation/send state for the admin portal.
11 properties
9 required
EnterpriseMembersResponse
object
Response model for list of enterprise members with pagination
4 properties
4 required
EnterpriseDetailsResponse
object
Response model for enterprise details.
25 properties
25 required
EnterpriseBillingConfigResponse
object
Response model for a billing config.
15 properties
7 required
GenerateFlowStateRequest
object
Request body for the marketing profile generation endpoint.
7 properties
1 required
RemoveUsersFromEnterpriseResponse
object
Response model for remove users operation
2 properties
2 required
TranscriptSpeakerSource
string
The transcript identity namespace that produced a speaker ID.
EnterpriseMember
object
Response model for an enterprise member. firstName, lastName, email are nullable because the underlying User columns are nullable (see models/user.py). role is…
6 properties
6 required
Body_remove_users_from_enterprise_file_upload_api_v1_internal_enterprises__enterprise_id__members_remove_upload_post
object
1 property
1 required
SendFlowStateRequest
object
Request body for the marketing send endpoint. Requires at least one explicit filter (emails, domain, or userids) to prevent accidentally blasting every user wi…
7 properties
1 required
CampaignType
string
Category of a promotional campaign.
CodeListResponse
object
A page of promo codes with a total count.
2 properties
2 required
AddEnterpriseDomainResponse
object
Response model for adding a domain to an enterprise.
2 properties
1 required
StripeProductOption
string
CampaignStatus
string
Lifecycle status of a promotional campaign.
CampaignListResponse
object
A page of promo campaigns with a total count.
2 properties
2 required
Body_update_user_roles_file_upload_api_v1_internal_enterprises__enterprise_id__members_update_role_bulk_post
object
1 property
1 required
TranscriptMarkerType
string
Persisted non-speech transcript marker types.
AdminUpdateStripeCustomerIdRequest
object
3 properties
2 required
CodeListItem
object
A promo code summary row for the admin list view.
6 properties
6 required
ValidationError
object
5 properties
3 required
CustomBillingConfigInput
object
Custom-pricing fields collected inline during sales-led enterprise creation. All other billing-config fields are derived server-side: productname from plan, tr…
1 property
1 required
SendInvoiceResponse
object
Response model for sending an invoice.
3 properties
3 required
Currency
string
Supported billing currencies as lowercase ISO 4217 codes.
ConsensusActualMode
string
The implementation path that produced a preview result.
AddUsersToEnterpriseResponse
object
Response model for bulk add users operation
4 properties
1 required
RedemptionListItem
object
A promo redemption summary row for the admin list view.
8 properties
8 required
BlockedDomainsListResponse
object
Response model for list of blocked domains.
2 properties
2 required
FailedAddUserItem
object
Details about a user that failed to be added
2 properties
2 required
EnterpriseListItem
object
Response model for an enterprise in a list
3 properties
3 required
DisbandEnterpriseRequest
object
Request model for disbanding an enterprise.
1 property
1 required
AdminMemorySearchResult
object
Per-user search result. Payload dicts are stripped of internal Graphiti identifiers.
6 properties
2 required
PreviewResponse
object
1 property
1 required
ProvisionedTeamSummary
object
The team created by a successful provision.
1 property
1 required
InternalCostCenterProvisionPreviewResponse
object
Server-computed provisioning math plus warnings/blockers. No writes are performed.
9 properties
9 required
SyncDomainsToWorkosResponse
object
Response model for syncing enterprise domains to WorkOS.
2 properties
2 required
MarketingJobStatusResponse
object
Latest persisted state of a marketing generate-or-send job.
11 properties
7 required
EnterpriseDomainItem
object
Response model for an enterprise domain.
5 properties
5 required
AddEnterpriseDomainRequest
object
Request model for adding a domain to an enterprise.
3 properties
2 required
RedemptionListResponse
object
A page of promo redemptions with a total count.
2 properties
2 required
PreviewRequest
object
3 properties
3 required
UserInput
object
Input for a single user in bulk add operations.
3 properties
1 required
CreateCodesRequest
object
Request to create one or more promo codes for a campaign.
2 properties
1 required
ListCostCentersResponse
object
Cost centers under an enterprise, sorted by createdat ascending. The UI uses this to populate a picker before running a billing op: when an enterprise has exac…
1 property
1 required
AdminApplyReferralResponse
object
Response model for admin referral application.
1 property
1 required
DirectorySyncUserAction
object
A single user action from a directory sync operation.
3 properties
2 required
PendingInvoiceResponse
object
Response model for checking pending invoice status.
1 property
CreateCodesResponse
object
Result of creating promo codes: count and the created rows.
2 properties
2 required
EnterprisePilotItem
object
Single enterprise pilot item for list response.
6 properties
6 required
CampaignListItem
object
A promo campaign summary row for the admin list view.
14 properties
14 required
BlockedDomainItem
object
Response model for a blocked domain.
5 properties
5 required
CommitResponse
object
Minimal commit ack — the op ran. Stripe responses are surfaced so the UI can show what happened. No audit row is persisted; see the structured log line emitted…
2 properties
1 required
DirectorySyncStartedResponse
object
Response for async directory sync endpoints (202 Accepted).
2 properties
2 required
AdminMemorySearchResponse
object
1 property
1 required
AdminMemoryListRequest
object
Super-admin request: list all stored voice memories for each user.
3 properties
2 required
ListOperationsResponse
object
1 property
1 required
CreateSalesLedEnterpriseResponse
object
Response model for creating a sales-led enterprise.
2 properties
2 required
OperationDescriptor
object
Metadata for a single registered op, surfaced to the operator UI.
4 properties
4 required
SendInvoiceRequest
object
Request model for sending a pending invoice.
2 properties
2 required
CreateCampaignRequest
object
Request to create a promo campaign.
9 properties
3 required
AdminMemoryListResponse
object
1 property
1 required
EnterpriseBillingConfigListResponse
object
Response model for list of billing configs.
1 property
1 required
EnterpriseBillingConfigCreate
object
Request model for creating a billing config.
12 properties
4 required
FlowStatePreviewRequest
object
Request body for previewing generated profiles before send.
6 properties
1 required
EnterprisePilotsResponse
object
Response model for listing enterprise pilots.
2 properties
2 required
FailedUpdateUserItem
object
Details about a user that failed to have their role updated.
2 properties
2 required
EnterpriseBillingConfigUpdate
object
Request model for updating a billing config.
11 properties
3 required
UpdatePreserveContractedSeatsRequest
object
Request model for toggling preservecontractedseats on an enterprise.
1 property
1 required
DomainVerificationStatus
object
Per-domain verification state returned by the enterprise and internal APIs. The record field is populated only on superadmin (internal) reads while the domain…
11 properties
11 required
InternalCostCenterProvisionRequest
object
Shared body for preview-provision and provision (same payload for both).
5 properties
5 required
BillingAddress
object
Billing address fields propagated to the Stripe customer address object. All fields optional so admins can supply partial info. ISO 3166-1 alpha-2 country code…
6 properties
DomainVerificationInitiateResponse
object
Response returned by the superadmin initiate-verification endpoint. Narrower than :class:DomainVerificationStatus — does not expose check counters or capture p…
7 properties
7 required
HTTPValidationError
object
1 property
FlowStateProfilePreviewItem
object
Generated Flow State profile row for internal admin preview.
9 properties
7 required
UpdatePilotEndRequest
object
Request model for updating an enterprise pilot end date.
1 property
1 required
AddUsersToEnterpriseRequest
object
Request model for bulk adding users to an enterprise.
3 properties
1 required
ToggleDomainDeletedResponse
object
Response model for toggling domain deleted status.
2 properties
1 required
CreateEnterpriseFromAdminRequest
object
Request model for creating an enterprise with an admin user.
8 properties
3 required
CreateSalesLedEnterpriseRequest
object
Request model for creating a sales-led enterprise with deferred invoicing.
12 properties
6 required
UpdateUsersRoleResponse
object
Response model for bulk update users role operation.
3 properties
1 required
CreateEnterprisePilotRequest
object
Request model for creating an enterprise pilot.
4 properties
4 required
AdminMemoryListResult
object
Per-user list result. Payload dicts are stripped of internal Graphiti identifiers.
5 properties
2 required
PricingTierSchema
object
Schema for a single pricing tier.
2 properties
1 required
DisbandEnterpriseResponse
object
Response model for disbanding an enterprise.
3 properties
3 required
UpdateUserTrialEndResponse
object
Response model for updating a user's personal trial end date.
3 properties
3 required
AdminApplyReferralRequest
object
Request model for applying a referral code to a user on their behalf.
2 properties
2 required
DomainCapturePolicy
string
Whether unclaimed users on a verified domain are required to request to join the enterprise. unset indicates the admin has not chosen a policy — distinct from…
AdminUserLookupResponse
object
Admin view of a user's profile and subscription info.
15 properties
15 required
DomainVerificationRecord
object
TXT record the customer must publish to prove ownership of a domain.
3 properties
3 required
InvoiceSummary
object
A minimal Stripe invoice projection for the operator-UI picker. Fields are taken directly from the Stripe Invoice object. amountdue is in the currency's minor…
8 properties
8 required
UpdateEnterpriseSettingsRequest
object
1 property
1 required
ProvisionedInvoiceSummary
object
The invoice sent (or already paid) by a successful provision.
2 properties
2 required
UpdatePilotEndResponse
object
Response model for updating an enterprise pilot end date.
2 properties
2 required
CommitRequest
object
4 properties
4 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Wispr AI publishes across the network.