The identity and technical contract details declared by the specification.
ProvisionedCostCenterSummary
object
The cost center created by a successful provision.
2 properties
2 required
EnterpriseDomainItem
object
Response model for an enterprise domain.
5 properties
5 required
MeetingAudioUrlResponse
object
Presigned GET URL for one meeting's audio, if present.
1 property
ProvisionedInvoiceSummary
object
The invoice sent (or already paid) by a successful provision.
2 properties
2 required
EnterprisePilotsResponse
object
Response model for listing enterprise pilots.
2 properties
2 required
SyncDomainsToWorkosResponse
object
Response model for syncing enterprise domains to WorkOS.
2 properties
2 required
PreviewResponse
object
1 property
1 required
SendInvoiceRequest
object
Request model for sending a pending invoice.
2 properties
2 required
EnterpriseBillingConfigCreate
object
Request model for creating a billing config.
12 properties
4 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
UpdatePilotEndRequest
object
Request model for updating an enterprise pilot end date.
1 property
1 required
CreateCodesResponse
object
Result of creating promo codes: count and the created rows.
2 properties
2 required
ConsensusPreviewRequest
object
Explicit consensus implementation selection.
1 property
1 required
FlowStatePreviewRequest
object
Request body for previewing generated profiles before send.
6 properties
1 required
ConsensusActualMode
string
The implementation path that produced a preview result.
FailedAddUserItem
object
Details about a user that failed to be added
2 properties
2 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
AdminMemorySearchResponse
object
1 property
1 required
AdminApplyReferralRequest
object
Request model for applying a referral code to a user on their behalf.
2 properties
2 required
AdminUpdateStripeCustomerIdRequest
object
3 properties
2 required
FlowStateProfilePreviewItem
object
Generated Flow State profile row for internal admin preview.
9 properties
7 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
FlowStateProfilePreviewResponse
object
Paginated generated profile preview.
2 properties
2 required
EnterpriseBillingConfigListResponse
object
Response model for list of billing configs.
1 property
1 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
UpdateWorkosDirectoryIdRequest
object
Request model for setting or unlinking workosdirectoryid on an enterprise.
1 property
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
EnterpriseMembersResponse
object
Response model for list of enterprise members with pagination
4 properties
4 required
PricingTierSchema
object
Schema for a single pricing tier.
2 properties
1 required
Body_add_users_to_enterprise_file_upload_api_v1_internal_enterprises__enterprise_id__members_upload_post
object
1 property
1 required
GenerateAndSendFlowStateRequest
object
Request body for the backend-owned all-user generate-and-send endpoint.
5 properties
1 required
BlockedDomainsListResponse
object
Response model for list of blocked domains.
2 properties
2 required
RemoveUsersFromEnterpriseRequest
object
Request model for removing users from an enterprise by email
1 property
1 required
UpdateEnterpriseSettingsRequest
object
1 property
1 required
PendingInvoiceResponse
object
Response model for checking pending invoice status.
1 property
ListOperationsResponse
object
1 property
1 required
CreateCodesRequest
object
Request to create one or more promo codes for a campaign.
2 properties
1 required
CreateEnterpriseFromAdminRequest
object
Request model for creating an enterprise with an admin user.
8 properties
3 required
ToggleDomainDeletedResponse
object
Response model for toggling domain deleted status.
2 properties
1 required
AdminMemorySearchRequest
object
Super-admin request: semantic-search each user's voice memory by context.
5 properties
3 required
AddBlockedDomainResponse
object
Response model for adding a blocked domain.
1 property
UpdateEnterpriseGatesRequest
object
1 property
1 required
Currency
string
Supported billing currencies as lowercase ISO 4217 codes.
MarketingJobStatusResponse
object
Latest persisted state of a marketing generate-or-send job.
11 properties
7 required
DisbandEnterpriseRequest
object
Request model for disbanding an enterprise.
1 property
1 required
UpdatePreserveContractedSeatsRequest
object
Request model for toggling preservecontractedseats on an enterprise.
1 property
1 required
HTTPValidationError
object
1 property
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
CampaignStatus
string
Lifecycle status of a promotional campaign.
GenerateFlowStateRequest
object
Request body for the marketing profile generation endpoint.
7 properties
1 required
AdminApplyReferralResponse
object
Response model for admin referral application.
1 property
1 required
AdminUpdateStripeCustomerIdResponse
object
6 properties
6 required
EnterpriseListItem
object
Response model for an enterprise in a list
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
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
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
CreateEnterprisePilotRequest
object
Request model for creating an enterprise pilot.
4 properties
4 required
UserInput
object
Input for a single user in bulk add operations.
3 properties
1 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
CodeListResponse
object
A page of promo codes with a total count.
2 properties
2 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
CreateCampaignRequest
object
Request to create a promo campaign.
9 properties
3 required
AdminUserLookupResponse
object
Admin view of a user's profile and subscription info.
15 properties
15 required
AlgorithmId
string
Closed registry of consensus implementations exposed for preview.
BlockedDomainItem
object
Response model for a blocked domain.
5 properties
5 required
TranscriptEntry
object
Generator-safe wire model enforcing the three persisted entry shapes.
7 properties
2 required
InternalCostCenterProvisionPreviewResponse
object
Server-computed provisioning math plus warnings/blockers. No writes are performed.
9 properties
9 required
CampaignListResponse
object
A page of promo campaigns with a total count.
2 properties
2 required
TranscriptSpeaker
object
Canonical speaker identity; source and ID form the stable key.
3 properties
3 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
AllEnterprisesResponse
object
Response model for list of all enterprises with pagination
4 properties
4 required
AdminMemoryListResult
object
Per-user list result. Payload dicts are stripped of internal Graphiti identifiers.
5 properties
2 required
AdminMemoryListRequest
object
Super-admin request: list all stored voice memories for each user.
3 properties
2 required
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
AddUsersToEnterpriseResponse
object
Response model for bulk add users operation
4 properties
1 required
OperationDescriptor
object
Metadata for a single registered op, surfaced to the operator UI.
4 properties
4 required
DirectorySyncUserAction
object
A single user action from a directory sync operation.
3 properties
2 required
EnterpriseDetailsResponse
object
Response model for enterprise details.
25 properties
25 required
EnterprisePilotItem
object
Single enterprise pilot item for list response.
6 properties
6 required
AddEnterpriseDomainResponse
object
Response model for adding a domain to an enterprise.
2 properties
1 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
ErrorDetail
object
Standard FastAPI HTTPException envelope: {"detail": "..."}.
1 property
1 required
UpdatePilotEndResponse
object
Response model for updating an enterprise pilot end date.
2 properties
2 required
AdminMemoryListResponse
object
1 property
1 required
CommitRequest
object
4 properties
4 required
SignalQuality
object
Bounded diagnostics emitted by the consensus engine.
9 properties
3 required
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
AddBlockedDomainRequest
object
Request model for adding a domain to the block list.
2 properties
1 required
AddUsersToEnterpriseRequest
object
Request model for bulk adding users to an enterprise.
3 properties
1 required
UpdateCampaignRequest
object
Partial-update request for an existing promo campaign.
10 properties
DomainVerificationRecord
object
TXT record the customer must publish to prove ownership of a domain.
3 properties
3 required
InternalCostCenterProvisionResponse
object
Successful-provision result: the created cost center, team, and invoice.
4 properties
4 required
CreateSalesLedEnterpriseResponse
object
Response model for creating a sales-led enterprise.
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
ToggleDomainDeletedRequest
object
Request model for toggling domain deleted status.
1 property
1 required
CodeListItem
object
A promo code summary row for the admin list view.
6 properties
6 required
UpdateUserTrialEndRequest
object
Request model for updating a user's personal trial end date (internal admin).
2 properties
2 required
UpdateUserTrialEndResponse
object
Response model for updating a user's personal trial end date.
3 properties
3 required
CampaignListItem
object
A promo campaign summary row for the admin list view.
14 properties
14 required
UpdateUsersRoleRequest
object
Request model for updating user roles in an enterprise.
2 properties
2 required
PublicDomainsListResponse
object
Response model for the static public/webmail domain list.
2 properties
2 required
ProvisionedTeamSummary
object
The team created by a successful provision.
1 property
1 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…
SendInvoiceResponse
object
Response model for sending an invoice.
3 properties
3 required
CreateSalesLedEnterpriseRequest
object
Request model for creating a sales-led enterprise with deferred invoicing.
12 properties
6 required
FlowStateMonthSummaryResponse
object
Month-level Flow State generation/send state for the admin portal.
11 properties
9 required
EnterpriseStatus
string
Whether an enterprise or team is active or disbanded.
UpdateUsersRoleResponse
object
Response model for bulk update users role operation.
3 properties
1 required
CampaignType
string
Category of a promotional campaign.
Body_remove_users_from_enterprise_file_upload_api_v1_internal_enterprises__enterprise_id__members_remove_upload_post
object
1 property
1 required
InternalCostCenterProvisionRequest
object
Shared body for preview-provision and provision (same payload for both).
5 properties
5 required
RemoveUsersFromEnterpriseResponse
object
Response model for remove users operation
2 properties
2 required
DisbandEnterpriseResponse
object
Response model for disbanding an enterprise.
3 properties
3 required
TranscriptMarkerType
string
Persisted non-speech transcript marker types.
EnterpriseBillingConfigResponse
object
Response model for a billing config.
15 properties
7 required
EnterpriseBillingConfigUpdate
object
Request model for updating a billing config.
11 properties
3 required
MarketingJobResponse
object
Response returned after kicking off a generate-or-send job.
3 properties
3 required
PreviewRequest
object
3 properties
3 required
DirectorySyncPreview
object
Dry-run diff of a directory sync, shown to the admin before confirming.
7 properties
7 required
DirectorySyncStartedResponse
object
Response for async directory sync endpoints (202 Accepted).
2 properties
2 required
AdminMemorySearchResult
object
Per-user search result. Payload dicts are stripped of internal Graphiti identifiers.
6 properties
2 required
ValidationError
object
5 properties
3 required
RedemptionListItem
object
A promo redemption summary row for the admin list view.
8 properties
8 required
ConsensusPreviewResponse
object
Ephemeral, non-persisted consensus preview result.
8 properties
5 required
StripeProductOption
string
TranscriptSpeakerSource
string
The transcript identity namespace that produced a speaker ID.
FailedUpdateUserItem
object
Details about a user that failed to have their role updated.
2 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Wispr AI publishes across the network.