Docs/Models

ProjectOverview

object

An API project, its credit balance, connected content and settings.

The public view of an API project. settings.feeds are the feeds it hosts and can publish to, settings.shows the external shows connected to it via Connect Show. Change settings with Update Project. API keys are never exposed.

Fields

_idstringrequired

Unique project identifier.

meta.creditsnumberrequired

Remaining credit balance.

meta.ownersobjectrequired

The users of the project by user ID, each with a role and permissions.

settings.labelstringrequired

Project name.

settings.feedsstring[]required

IDs of all hosted podcast feeds in the project. Use an ID as feed_id. The user can load only the feeds that they have permission for.

settings.showsstring[]required

IDs of the shows connected to the project. The content ID of a show is show:id:{id}.

settings.workflows.growth.enabledbooleanoptional

Daily Growth: each day, Fountain makes draft clip posts from the project’s shows. Absent until set.

billing.subscriptionstringoptional

Stripe subscription ID backing the project plan. Absent when the project has no plan.

meta.labelstringrequired

Deprecated: use settings.label.

creditsnumberrequired

Deprecated: use meta.credits.

feedsstring[]required

Deprecated: use settings.feeds.

showsstring[]required

Deprecated: use settings.shows.

Example

{
  "_id": "j7k8l9m0n1o2",
  "meta": {
    "credits": 100,
    "owners": {
      "u1v2w3x4y5z6": {
        "role": "ADMIN",
        "permissions": []
      }
    },
    "label": "My Podcast Network"
  },
  "settings": {
    "label": "My Podcast Network",
    "feeds": [
      "a1b2c3d4"
    ],
    "shows": [
      "def456"
    ],
    "workflows": {
      "growth": {
        "enabled": true
      }
    }
  },
  "billing": {
    "subscription": "sub_1A2b3C4d5E6f"
  },
  "credits": 100,
  "feeds": [
    "a1b2c3d4"
  ],
  "shows": [
    "def456"
  ]
}