Docs/Models

Models

The data structures the API returns, shared across endpoints. They are grouped the same way the endpoints are, so a model sits where you would look for the endpoints that return it.

Project (1)

Your API project and what it is connected to.

ProjectOverviewAn API project, its credit balance and connected content.

Content (4)

Shows, episodes and the transcripts they carry.

ContentHitThe core content object returned across the API.
ContentIDA string that uniquely identifies a piece of content.
ContentTypeThe kind of content a hit represents.
TranscriptSegmentA span of transcript text with start and end times.

Search (1)

What a search returns beyond content itself.

NostrProfileA Nostr profile indexed in the Fountain graph.

Publishing (8)

The feeds and items you host, and how they perform.

FeedA podcast feed you host.
ItemAn item in a feed you host.
ItemStatusThe publishing state of an item.
PodcastCategoryA category a podcast show can be listed under.
StatsA feed’s or item’s download and payment statistics.
StatsBucketA metric attributed to a single time bucket.
StatsMetricOne period’s aggregate figures.
StatsRowOne group’s figures: current totals, the prior window, and an optional time series.

Uploads (4)

Media files on their way into Fountain.

AudioMetadataID3 tags extracted from an uploaded audio file.
MediaA tracked media upload.
MediaKindThe kind of media an upload holds.
MediaStatusThe processing state of a media upload.

Social (10)

Connected channels, and the posts published to them.

SocialChannelA connected social channel.
SocialChannelStatusThe connection state of a social channel.
SocialPlatformA social platform a project can connect a channel to.
SocialPostA social post created through the Fountain API.
SocialPostMediaSourceThe segment of Fountain content a social post was cut from.
SocialPostPublishModeHow a post should be approved, scheduled or published when updated.
SocialPostStatsEngagement figures for a published social post.
SocialPostStatusThe lifecycle state of a social post.
SocialPostUploadMedia attached to a social post.
SocialPostUploadTypeThe type of media attached to a social post.

Shared (1)

Types used across more than one part of the API.

JobStatusThe lifecycle state of an asynchronous job.