Podgist

Lists the tools, which need an API key, and the current price per call. Free; no key needed.

{
  "type": "object",
  "properties": {},
  "required": [],
  "additionalProperties": false
}

Public podcasts whose name contains the text, most-transcribed first, with their slug (for the podcast filter of search_transcripts). Free; no key needed. At most 20 results.

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 100
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false
}

Full-text search across transcripts: matching episodes with snippets, newest relevance first, 20 a page. Optional podcast slug and date range (YYYY-MM-DD). Needs an API key; billed per search (see list_services).

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    },
    "podcast": {
      "type": "string",
      "description": "A slug from find_podcasts."
    },
    "date_from": {
      "type": "string",
      "format": "date"
    },
    "date_to": {
      "type": "string",
      "format": "date"
    },
    "page": {
      "type": "integer",
      "minimum": 1,
      "maximum": 50
    }
  },
  "required": [
    "query"
  ],
  "additionalProperties": false
}

Starts a cited answer drawn only from what was said on podcasts. Returns a job_id; call get_answer with it until status is complete (usually under a minute). Needs an API key; billed per question (see list_services).

{
  "type": "object",
  "properties": {
    "question": {
      "type": "string",
      "minLength": 3,
      "maxLength": 500
    }
  },
  "required": [
    "question"
  ],
  "additionalProperties": false
}

The status and, once complete, the answer and its cited passages for a job from ask_question. Needs the API key that asked. Not billed.

{
  "type": "object",
  "properties": {
    "job_id": {
      "type": "string",
      "minLength": 8,
      "maxLength": 64
    }
  },
  "required": [
    "job_id"
  ],
  "additionalProperties": false
}

One episode's transcript, with speaker turns and timestamps, by podcast and episode id (the sid and pid of a search result). Only what the key's account may read. Needs an API key; billed per transcript (see list_services).

{
  "type": "object",
  "properties": {
    "podcast_id": {
      "type": "string",
      "format": "uuid"
    },
    "episode_id": {
      "type": "string",
      "format": "uuid"
    }
  },
  "required": [
    "podcast_id",
    "episode_id"
  ],
  "additionalProperties": false
}

The key's account balance and monthly allowance, and its calls and cost per day over the last 30 days. Needs an API key. Not billed.

{
  "type": "object",
  "properties": {},
  "required": [],
  "additionalProperties": false
}

Description, links, how many episodes are transcribed, the latest episode, and the price to transcribe an episode or subscribe. Free; no key needed.

{
  "type": "object",
  "properties": {
    "podcast": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200,
      "description": "A slug or podcast_id from find_podcasts."
    }
  },
  "required": [
    "podcast"
  ],
  "additionalProperties": false
}

Episodes newest first, 25 a page: title, date, length, whether transcribed (with its link) and, if not, the price to transcribe it. Page 1 is free with no key; each later page needs a key and is billed at the catalog rate (list_services).

{
  "type": "object",
  "properties": {
    "podcast": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200,
      "description": "A slug or podcast_id from find_podcasts."
    },
    "page": {
      "type": "integer",
      "minimum": 1,
      "maximum": 400
    },
    "transcribed_only": {
      "type": "boolean"
    }
  },
  "required": [
    "podcast"
  ],
  "additionalProperties": false
}

Reads a public RSS feed (or Apple/Spotify link) and lists its episodes with which are already on Podgist and the price to transcribe the rest. Free; no key needed; at most 10 a minute.

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "format": "uri",
      "maxLength": 2000
    }
  },
  "required": [
    "url"
  ],
  "additionalProperties": false
}

The AI-question credit packs and their prices. Free.

{
  "type": "object",
  "properties": {},
  "required": [],
  "additionalProperties": false
}

This week's topics across podcasts, or one topic by slug. Free.

{
  "type": "object",
  "properties": {
    "topic": {
      "type": "string",
      "maxLength": 200
    }
  },
  "required": [],
  "additionalProperties": false
}

Podgist's own news posts. Free.

{
  "type": "object",
  "properties": {},
  "required": [],
  "additionalProperties": false
}

The price for this account to transcribe one episode (or, if transcribed, to read it), held 30 minutes. Needs a key with the "order" scope. Not billed; nothing is bought until order.

{
  "type": "object",
  "properties": {
    "podcast": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200,
      "description": "A slug or podcast_id from find_podcasts."
    },
    "episode": {
      "type": "string",
      "format": "uuid",
      "description": "An episode_id from list_episodes."
    }
  },
  "required": [
    "podcast",
    "episode"
  ],
  "additionalProperties": false
}

The price to transcribe chosen episodes of a feed (episode ids from analyze_feed), with volume pricing. Needs a key with the "order" scope. Not billed until order.

{
  "type": "object",
  "properties": {
    "feed_url": {
      "type": "string",
      "format": "uri",
      "maxLength": 2000
    },
    "episode_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "minItems": 1,
      "maxItems": 500
    }
  },
  "required": [
    "feed_url",
    "episode_ids"
  ],
  "additionalProperties": false
}

A quote for one credit pack (tier from list_credit_tiers).

{
  "type": "object",
  "properties": {
    "tier": {
      "type": "integer",
      "minimum": 1
    }
  },
  "required": [
    "tier"
  ],
  "additionalProperties": false
}

A prepaid term of one month or year, paid from the balance, that never renews by itself: "podcast" (every transcript of one show), "all" (every transcript) or "professional" (all access plus the API).

{
  "type": "object",
  "properties": {
    "product": {
      "type": "string",
      "enum": [
        "podcast",
        "all",
        "professional"
      ]
    },
    "interval": {
      "type": "string",
      "enum": [
        "month",
        "year"
      ]
    },
    "podcast": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200,
      "description": "A slug or podcast_id from find_podcasts."
    }
  },
  "required": [
    "product",
    "interval"
  ],
  "additionalProperties": false
}

Buys what a quote is for, charging its price to the account's prepaid API balance (never a card). At most $50 an order and $200 a day. Episodes that are never transcribed are refunded automatically. Needs the "order" scope.

{
  "type": "object",
  "properties": {
    "quote_id": {
      "type": "string",
      "format": "uuid"
    },
    "idempotency_key": {
      "type": "string",
      "minLength": 8,
      "maxLength": 200,
      "description": "Any unique string; retrying with the same one never pays twice."
    }
  },
  "required": [
    "quote_id",
    "idempotency_key"
  ],
  "additionalProperties": false
}

One order and each episode's status (waiting, transcribed, refunded). Free.

{
  "type": "object",
  "properties": {
    "order_id": {
      "type": "integer",
      "minimum": 1
    }
  },
  "required": [
    "order_id"
  ],
  "additionalProperties": false
}

This account's orders paid from the API balance, newest first. Free.

{
  "type": "object",
  "properties": {
    "before": {
      "type": "integer",
      "minimum": 1
    }
  },
  "required": [],
  "additionalProperties": false
}

Plan, subscriptions, AI credits, follows, purchases and summary-email settings, as the account page shows them. Free.

{
  "type": "object",
  "properties": {},
  "required": [],
  "additionalProperties": false
}

The podcasts this account follows. Free.

{
  "type": "object",
  "properties": {},
  "required": [],
  "additionalProperties": false
}

Follow a podcast (as the Follow button does). Needs the "account" scope. Free.

{
  "type": "object",
  "properties": {
    "podcast": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200,
      "description": "A slug or podcast_id from find_podcasts."
    }
  },
  "required": [
    "podcast"
  ],
  "additionalProperties": false
}

Stop following a podcast. Needs the "account" scope. Free.

{
  "type": "object",
  "properties": {
    "podcast": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200,
      "description": "A slug or podcast_id from find_podcasts."
    }
  },
  "required": [
    "podcast"
  ],
  "additionalProperties": false
}

Turn the summary email on or off, set daily or weekly and the weekly day, or include one followed podcast (podcast + enabled). Needs the "account" scope. Free.

{
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "frequency": {
      "type": "string",
      "enum": [
        "daily",
        "weekly"
      ]
    },
    "start": {
      "type": "string"
    },
    "points": {
      "type": "integer",
      "minimum": 1
    },
    "podcast": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200,
      "description": "A slug or podcast_id from find_podcasts."
    }
  },
  "required": [],
  "additionalProperties": false
}

This account's questions, newest first, site and API alike. Free.

{
  "type": "object",
  "properties": {
    "q": {
      "type": "string",
      "maxLength": 200
    },
    "before": {
      "type": "string",
      "maxLength": 64
    }
  },
  "required": [],
  "additionalProperties": false
}

Remove a question from the Ask history (restore_ask puts it back). Needs the "account" scope.

{
  "type": "object",
  "properties": {
    "job_id": {
      "type": "string",
      "minLength": 8,
      "maxLength": 64
    }
  },
  "required": [
    "job_id"
  ],
  "additionalProperties": false
}

Put a deleted question back in the Ask history. Needs the "account" scope.

{
  "type": "object",
  "properties": {
    "job_id": {
      "type": "string",
      "minLength": 8,
      "maxLength": 64
    }
  },
  "required": [
    "job_id"
  ],
  "additionalProperties": false
}

The public link to one of this account's answered questions.

{
  "type": "object",
  "properties": {
    "job_id": {
      "type": "string",
      "minLength": 8,
      "maxLength": 64
    }
  },
  "required": [
    "job_id"
  ],
  "additionalProperties": false
}

A checkout link for a person to pay this quote by card (when the balance or a cap stops order). The quote can then only be paid by that link; asking again returns the same link. Needs the "billing" scope.

{
  "type": "object",
  "properties": {
    "quote_id": {
      "type": "string",
      "format": "uuid"
    }
  },
  "required": [
    "quote_id"
  ],
  "additionalProperties": false
}

A checkout link for a person to add funds to the API balance by card; nothing is charged by the agent. Needs the "billing" scope.

{
  "type": "object",
  "properties": {
    "amount": {
      "type": "number",
      "minimum": 1
    },
    "idempotency_key": {
      "type": "string",
      "minLength": 8,
      "maxLength": 200,
      "description": "Any unique string; retrying with the same one never pays twice."
    }
  },
  "required": [
    "amount",
    "idempotency_key"
  ],
  "additionalProperties": false
}

A link for a person to change the card, see invoices or cancel a card subscription. Needs the "billing" scope.

{
  "type": "object",
  "properties": {},
  "required": [],
  "additionalProperties": false
}

Cancel the account's card-paid Professional plan at period end (provider "stripe", undo to keep it), or its PayPal subscription (provider "paypal"), exactly as the account page does. Prepaid terms bought with the balance never renew, so need no cancelling. Needs the "billing" scope.

{
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "stripe",
        "paypal"
      ]
    },
    "undo": {
      "type": "boolean"
    }
  },
  "required": [
    "provider"
  ],
  "additionalProperties": false
}

Email the account's address a password-reset code, as "Forgot password" does; the person sets the new password. Needs the "account" scope.

{
  "type": "object",
  "properties": {},
  "required": [],
  "additionalProperties": false
}

Revoke the API key making this call, for good. Other keys are managed only by the person.

{
  "type": "object",
  "properties": {},
  "required": [],
  "additionalProperties": false
}