Docs/Models

ProjectOverview

object

An API project, its credit balance and connected content.

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

Fields

_idstringrequired

Unique project identifier.

meta.labelstringrequired

Human-readable project name.

creditsnumberrequired

Remaining credit balance.

feedsstring[]required

IDs of feeds the project can publish to.

showsstring[]required

IDs of shows connected to the project.

billing.subscriptionstringoptional

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

Example

{
  "_id": "j7k8l9m0n1o2",
  "meta": {
    "label": "My Podcast Network"
  },
  "credits": 100,
  "feeds": [
    "a1b2c3d4"
  ],
  "shows": [
    "def456"
  ],
  "billing": {
    "subscription": "sub_1A2b3C4d5E6f"
  }
}

Example

{
  "_id": "j7k8l9m0n1o2",
  "meta": {
    "label": "My Podcast Network"
  },
  "credits": 100,
  "feeds": [
    "a1b2c3d4"
  ],
  "shows": [
    "def456"
  ],
  "billing": {
    "subscription": "sub_1A2b3C4d5E6f"
  }
}