Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Wispr AI Internal Marketing API

The Internal Marketing API from Wispr AI — 6 operation(s) for internal marketing.

Wispr AI Internal Marketing 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 Internal Marketing. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 6 paths, and defines 11 schemas. It is described by OpenAPI 3.0.3, at version 0.5.2.

Requests are made against the base URL https://api.wisprflow.ai.

6 operations 6 paths 11 schemas 2 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 2

Wispr AI Internal Marketing 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 6

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

Internal Marketing 6
POST
/api/v1/internal/marketing/flow-state/generate
Generate Flow State Profiles
generate_flow_state_profiles body → 202422
POST
/api/v1/internal/marketing/flow-state/generate-send
Generate And Send Flow State Emails
generate_and_send_flow_state_emails body → 202422
POST
/api/v1/internal/marketing/flow-state/send
Send Flow State Emails
send_flow_state_emails body → 202422
GET
/api/v1/internal/marketing/flow-state/months/{reporting_month}
Get Flow State Month Summary
get_flow_state_month_summary 1 param → 200422
POST
/api/v1/internal/marketing/flow-state/preview
Preview Flow State Profiles
preview_flow_state_profiles body → 200422
GET
/api/v1/internal/marketing/flow-state/jobs/{job_id}
Get Flow State Job
get_flow_state_job 1 param → 200422

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are FlowStateMonthSummaryResponse (11 properties), MarketingJobStatusResponse (11 properties), FlowStateProfilePreviewItem (9 properties), GenerateFlowStateRequest (7 properties). Each schema is shown below with its type and property counts.

FlowStateProfilePreviewItem
object
Generated Flow State profile row for internal admin preview.
9 properties 7 required
FlowStatePreviewRequest
object
Request body for previewing generated profiles before send.
6 properties 1 required
FlowStateProfilePreviewResponse
object
Paginated generated profile preview.
2 properties 2 required
MarketingJobResponse
object
Response returned after kicking off a generate-or-send job.
3 properties 3 required
GenerateFlowStateRequest
object
Request body for the marketing profile generation endpoint.
7 properties 1 required
FlowStateMonthSummaryResponse
object
Month-level Flow State generation/send state for the admin portal.
11 properties 9 required
ValidationError
object
5 properties 3 required
MarketingJobStatusResponse
object
Latest persisted state of a marketing generate-or-send job.
11 properties 7 required
GenerateAndSendFlowStateRequest
object
Request body for the backend-owned all-user generate-and-send endpoint.
5 properties 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
HTTPValidationError
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wispr-ai-internal-marketing-api-openapi.yml Raw ↑

Other APIs Wispr AI publishes across the network.

Wispr AI Analytics API
Wispr AI Analytics Registry API
Wispr AI Attribution Tracking API
Wispr AI Authentication API
Wispr AI Automations API
Wispr AI Calendar API
Wispr AI Connectors API
Wispr AI Cost Centers API
Wispr AI Dash API
Wispr AI Dictionary API
Wispr AI Enterpret API
Wispr AI Enterprise API