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 Referral API

The Referral API from Wispr AI — 9 operation(s) for referral.

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

This API exposes 9 operations across 9 paths, and defines 12 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.

9 operations 9 paths 12 schemas 4 GET5 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 Referral 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 9

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

Referral 9
GET
/api/v1/referral/credits
Get Total Credits
get_total_credits → 200
GET
/api/v1/referral/
Get Referrals Info
get_referrals_info → 200
POST
/api/v1/referral/self-refer
Send Generic Download Email
send_generic_download_email body → 200422
POST
/api/v1/referral/refer
Refer Emails
refer_emails body → 200422
POST
/api/v1/referral/regenerate
Regenerate Referral Code
regenerate_referral_code → 200
GET
/api/v1/referral/{user_id}
Get Referral Code
get_referral_code 1 param → 200422
POST
/api/v1/referral/apply
Apply Referral Code
apply_referral_code body → 200422
POST
/api/v1/referral/download-link
Send Download Link
send_download_link body → 200422
GET
/api/v1/referral/student-challenge/leaderboard
Get Student Challenge Leaderboard
get_student_challenge_leaderboard → 200

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are Referral (7 properties), ValidationError (5 properties), StudentChallengeLeaderboardMember (4 properties), ApplyReferralCodeRequest (3 properties). Each schema is shown below with its type and property counts.

DirectDownloadLinkRequest
object
2 properties 2 required
SelfReferRequest
object
1 property 1 required
StudentChallengeLeaderboardMember
object
4 properties 2 required
ReferralCodeResponse
object
1 property 1 required
ApplyReferralCodeRequest
object
3 properties
ReferEmailsRequest
object
1 property 1 required
StudentChallengeLeaderboardResponse
object
1 property 1 required
ValidationError
object
5 properties 3 required
src__backend_service__schemas__api__referral__Platform
string
Valid platforms for download links
ReferralInfoResponse
object
3 properties
Referral
object
7 properties 3 required
HTTPValidationError
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wispr-ai-referral-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