Taddy API

https://taddy.org/developers/
Admin
Taddy API provides developers with access to over 4 million podcasts, 200 million episodes, blazing...
Tokens:112,392
Snippets:393
Trust Score:7.3
Update:10 months ago
Show doc for...
Tokens:
Raw
### Introduction and Getting Started

Source: https://taddy.org/developers/intro-to-taddy-graphql-api

This section outlines the initial steps to begin using the Taddy API. It includes signing up for a developer account, obtaining an API key from the dashboard, and preparing to make your first request.

```APIDOC
## Getting Started with Taddy's API

To get started using our API, follow these steps:

1.  **Signup for a developer account.**
2.  **Login to the dashboard** and get your API Key.
3.  Follow the steps in the next section to make your first API request.
```

--------------------------------

### GraphQL Input Types Reference

Source: https://taddy.org/developers/comics-api/get-comic-series

Reference for the input types used in Taddy API queries for comic series and issues. This includes ImageVariant for image sizes, SortOrder for issue sorting, and ContentRating for content classification.

```graphql
# Image Variants for coverImageUrl, bannerImageUrl
enum ImageVariant {
  SMALL
  MEDIUM
  LARGE
  ORIGINAL
}

# Sorting options for issues
enum SortOrder {
  LATEST
  OLDEST
  SEARCH
}

# Content rating types
enum ContentRating {
  EVERYONE
  TEEN
  MATURE
  ADULTS_ONLY
}
```

--------------------------------

### PodcastEpisode Webhook Event Example

Source: https://taddy.org/developers/podcast-api/webhooks

An example of a webhook event triggered by an update to a PodcastEpisode in Taddy. This event includes details about the episode, such as its title, description, audio URL, publication date, and duration.

```APIDOC
## PodcastEpisode Webhook Event

### Description
This webhook event is triggered when a PodcastEpisode resource is updated within Taddy. It provides comprehensive details about the specific episode.

### Method
POST

### Endpoint
/webhooks/taddy

### Request Body
- **uuid** (string) - Unique identifier for the webhook event.
- **taddyType** (string) - The type of Taddy resource, expected to be 'podcastepisode'.
- **action** (string) - The action performed, e.g., 'updated'.
- **timestamp** (integer) - Unix timestamp of when the event occurred.
- **data** (object) - Contains the details of the updated PodcastEpisode:
  - **uuid** (string) - Unique identifier for the podcast episode.
  - **hash** (string) - A hash of the podcast episode data for integrity checking.
  - **name** (string) - The title of the podcast episode.
  - **description** (string) - A detailed description of the episode, potentially including HTML.
  - **imageUrl** (null) - URL for episode-specific artwork (null in example).
  - **datePublished** (integer) - Unix timestamp of when the episode was published.
  - **guid** (string) - A globally unique identifier for the episode.
  - **subtitle** (string) - A short subtitle or summary of the episode.
  - **audioUrl** (string) - URL to the audio file of the episode.
  - **videoUrl** (null) - URL to a video version of the episode (null in example).
  - **fileLength** (integer) - The size of the audio file in bytes.
  - **fileType** (string) - The MIME type of the audio file (e.g., 'audio/mpeg').
  - **duration** (integer) - The duration of the episode in seconds.
  - **episodeType** (string) - The type of episode (e.g., 'FULL').
  - **seasonNumber** (null) - The season number if applicable (null in example).
  - **episodeNumber** (null) - The episode number within a season (null in example).
  - **websiteUrl** (string) - URL to the podcast series' website.

### Request Example
```json
{
  "uuid": "a2b41ecd-565c-4f29-8cf9-ac737bcc8d99",
  "taddyType": "podcastepisode",
  "action": "updated",
  "timestamp": 1673984261,
  "data": {
    "uuid": "a2b41ecd-565c-4f29-8cf9-ac737bcc8d99",
    "hash": "8130da98420b6ea1bcafd9a7e411625bf0437e93cd2e44b0a2291430e7cd940c",
    "name": "Consider the Burying Beetle. (Or Else.)",
    "description": "<p>The current level of biodiversity loss is extraordinary in human history: The global rate of species extinction is at least tens to hundreds of times higher than the average over the past 10 million years. </p><p>At the end of 2022, countries around the world came together in Montreal for an agreement akin to the Paris climate accord to tackle the biodiversity crisis. Here’s more on the effort and how it seeks to confront the problem.</p><p>Guest: <a href=\"https://www.nytimes.com/by/catrin-einhorn\">Catrin Einhorn</a>, who reports on biodiversity and climate for The New York Times.</p><p>Background reading: </p><ul><li>Last year, roughly 190 nations, aiming to halt a dangerous decline in biodiversity,<a href=\"https://www.nytimes.com/2022/12/19/climate/biodiversity-cop15-montreal-30x30.html\"> agreed to preserve 30 percent of the planet’s land and seas</a>. </li></ul><p>For more information on today’s episode, visit <a href=\"http://nytimes.com/thedaily?smid=pc-thedaily\">nytimes.com/thedaily</a>. Transcripts of each episode will be made available by the next workday. </p>\n",
    "imageUrl": null,
    "datePublished": 1673001900,
    "guid": "848d3475-dc4d-4c53-b97c-e69f05bad846",
    "subtitle": "The current level of biodiversity loss is extraordinary in human history: The global rate of species extinction is at least tens to hundreds of times higher than the average over the past 10 million years. \n\nAt the end of 2022, countries around the world came together in Montreal for an agreement akin to the Paris climate accord to tackle the biodiversity crisis. Here’s more on the effort and how it seeks to confront the problem.\n\nGuest: Catrin Einhorn, who reports on biodiversity and climate for The New York Times.",
    "audioUrl": "https://dts.podtrac.com/redirect.mp3/chrt.fm/track/8DB4DB/pdst.fm/e/nyt.simplecastaudio.com/03d8b493-87fc-4bd1-931f-8a8e9b945d8a/episodes/b8f7e904-bf5d-4c60-b3d7-de67dfc271fc/audio/128/default.mp3?aid=rss_feed&awCollectionId=03d8b493-87fc-4bd1-931f-8a8e9b945d8a&awEpisodeId=b8f7e904-bf5d-4c60-b3d7-de67dfc271fc&feed=54nAGcIl",
    "videoUrl": null,
    "fileLength": 24695702,
    "fileType": "audio/mpeg",
    "duration": 1543,
    "episodeType": "FULL",
    "seasonNumber": null,
    "episodeNumber": null,
    "websiteUrl": "https://www.nytimes.com/the-daily"
  }
}
```
```

--------------------------------

### PodcastSeries Webhook Event Example

Source: https://taddy.org/developers/podcast-api/webhooks

An example of a webhook event triggered by an update to a PodcastSeries in Taddy. This event includes details about the series, such as its title, description, image URL, publication date, and associated RSS feed information.

```APIDOC
## PodcastSeries Webhook Event

### Description
This webhook event is triggered when a PodcastSeries resource is updated within Taddy. It provides a snapshot of the series' current state.

### Method
POST

### Endpoint
/webhooks/taddy

### Request Body
- **uuid** (string) - Unique identifier for the webhook event.
- **taddyType** (string) - The type of Taddy resource, expected to be 'podcastseries'.
- **action** (string) - The action performed, e.g., 'updated'.
- **timestamp** (integer) - Unix timestamp of when the event occurred.
- **data** (object) - Contains the details of the updated PodcastSeries:
  - **uuid** (string) - Unique identifier for the podcast series.
  - **hash** (string) - A hash of the podcast series data for integrity checking.
  - **name** (string) - The name or title of the podcast series.
  - **description** (string) - A description of the podcast series.
  - **imageUrl** (string) - URL for the podcast series artwork.
  - **datePublished** (integer) - Unix timestamp of when the series was first published.
  - **language** (string) - The primary language of the podcast series.
  - **seriesType** (string) - Type of series (e.g., 'EPISODIC').
  - **contentType** (string) - The content type (e.g., 'AUDIO').
  - **isExplicitContent** (boolean) - Indicates if the series contains explicit content.
  - **copyright** (string) - Copyright information for the series.
  - **websiteUrl** (string) - URL to the podcast series' official website.
  - **rssUrl** (string) - URL to the series' RSS feed.
  - **rssOwnerName** (string) - The name of the RSS feed owner.
  - **rssOwnerPublicEmail** (string) - The public email of the RSS feed owner.
  - **authorName** (string) - The name of the series author or publisher.
  - **isCompleted** (boolean) - Indicates if the series is considered complete.
  - **isBlocked** (null) - Status indicating if the series is blocked (null in example).
  - **itunesId** (integer) - Apple Podcasts ID for the series.
  - **genres** (array) - List of genres associated with the series.
  - **childrenHash** (string) - Hash representing the state of associated episodes.
  - **popularityRank** (string) - Ranking of the series' popularity.
  - **itunesInfo** (object) - Additional iTunes-specific information:
    - **uuid** (string) - iTunes UUID.
    - **publisherId** (integer) - iTunes Publisher ID.
    - **publisherName** (string) - iTunes Publisher Name.
    - **baseArtworkUrl** (string) - Base URL for artwork.
    - **baseArtworkUrlOf** (string) - URL for artwork of a specific size.

### Request Example
```json
{
  "uuid": "cb8d858a-3ef4-4645-8942-67e55c0927f2",
  "taddyType": "podcastseries",
  "action": "updated",
  "timestamp": 1673984316,
  "data": {
    "uuid": "cb8d858a-3ef4-4645-8942-67e55c0927f2",
    "hash": "b8f97d07ce3a9916aeba1feda9db610b58aee8d62a2dfa0495a0b1893e857d91",
    "name": "The Daily",
    "description": "This is what the news should sound like. The biggest stories of our time, told by the best journalists in the world. Hosted by Michael Barbaro and Sabrina Tavernise. Twenty minutes a day, five days a week, ready by 6 a.m.",
    "imageUrl": "https://image.simplecastcdn.com/images/03d8b493-87fc-4bd1-931f-8a8e9b945d8a/2cce5659-f647-4366-b318-46e4b67afcfa/3000x3000/c81936f538106550b804e7e4fe2c236319bab7fba37941a6e8f7e5c3d3048b88fc5b2182fb790f7d446bdc820406456c94287f245db89d8656c105d5511ec3de.jpeg?aid=rss_feed",
    "datePublished": 1484687987,
    "language": "ENGLISH",
    "seriesType": "EPISODIC",
    "contentType": "AUDIO",
    "isExplicitContent": false,
    "copyright": "© 2020-2021 THE NEW YORK TIMES COMPANY; The New York Times encourages the use of RSS feeds for personal use in a news reader or as part of a non-commercial blog, subject to your agreement to our Terms of Service.",
    "websiteUrl": "https://www.nytimes.com/the-daily",
    "rssUrl": "https://feeds.simplecast.com/54nAGcIl",
    "rssOwnerName": "The New York Times",
    "rssOwnerPublicEmail": "thedaily@nytimes.com",
    "authorName": "The New York Times",
    "isCompleted": false,
    "isBlocked": null,
    "itunesId": 1200361736,
    "genres": [ "PODCASTSERIES_NEWS_DAILY_NEWS", "PODCASTSERIES_NEWS" ],
    "childrenHash": "95ef1fee188406c415e32915f85855eab3cf49e0f9052785e42ef368792333db",
    "popularityRank": "TOP_200",
    "itunesInfo": {
      "uuid": "cb8d858a-3ef4-4645-8942-67e55c0927f2",
      "publisherId": 121664449,
      "publisherName": "The New York Times",
      "baseArtworkUrl": "https://is1-ssl.mzstatic.com/image/thumb/Podcasts115/v4/1c/ac/04/1cac0421-4483-ff09-4f80-19710d9feda4/mza_12421371692158516891.jpeg/",
      "baseArtworkUrlOf": "https://is1-ssl.mzstatic.com/image/thumb/Podcasts115/v4/1c/ac/04/1cac0421-4483-ff09-4f80-19710d9feda4/mza_12421371692158516891.jpeg/640x640bb.png"
    }
  }
}
```
```

--------------------------------

### Example API Response for Creators

Source: https://taddy.org/developers/creator-api/get-multiple-creators

This JSON object represents a sample response from Taddy's API when querying for creator details using the getMultipleCreators function. It includes fields like UUID, name, bio, hash, content hash, avatar image URL, and tags for the requested creators.

```json
{
  "data": {
    "getMultipleComicSeries": [
      "uuid": "5a4977e8-b0da-4cc7-a516-16a0fb6973d8",
      "name": "Zachary Morris",
      "bio": null,
      "hash": "2b80ecea81312717bcbe1872aa80c52ede308993819fdbafa2027ee123ed565c",
      "contentHash": "9d982608495697f438e0e31d768fdb297d1e6984f013842b2ccc982562c343a6",
      "avatarImageUrl": "https://ax1.taddy.org/5a4977e8-b0da-4cc7-a516-16a0fb6973d8/c414e9a8-8d27-4280-9e43-a2e5445a9626/avatar-sm.webp",
      "tags": [
        "zachmorris",
        "willdrawforfood1",
        "cartoonist"
      ]
    ]
  }
}
```

--------------------------------

### Get Comic Series

Source: https://taddy.org/developers/comics-api/get-comic-series

Retrieves detailed information about a specific comic series using its UUID. This includes metadata, image URLs, creator information, and a list of issues.

```APIDOC
## GET /api/v1/comicseries/{uuid}

### Description
Retrieves detailed information about a specific comic series using its UUID. This includes metadata, image URLs, creator information, and a list of issues.

### Method
GET

### Endpoint
`/api/v1/comicseries/{uuid}`

### Parameters
#### Path Parameters
- **uuid** (string) - Required - The unique identifier for the comic series.

### Request Example
```graphql
{
  getComicSeries(uuid:"b00c3bc5-2758-483a-942c-4229eb742cb4") {
    uuid
    datePublished
    name
    description
    hash
    issuesHash
    tags
    genres
    language
    seriesType
    contentRating
    sssUrl
    cover_sm: coverImageUrl(variant:SMALL)
    cover_md: coverImageUrl(variant:MEDIUM)
    cover_lg: coverImageUrl(variant:LARGE)
    bannerImageUrl(variant:SMALL)
    thumbnailImageUrl
  	coverImageAsString
    bannerImageAsString
    thumbnailImageAsString
    creators{
      uuid
      name
      sssUrl
    }
    issues{
      uuid
      name
      bannerImageUrl
      thumbnailImageUrl
      storyImageUrls
    }
  }
}
```

### Response
#### Success Response (200)
- **uuid** (string) - The unique identifier of the comic series.
- **datePublished** (integer) - The timestamp when the comic series was published.
- **name** (string) - The title of the comic series.
- **description** (string) - A brief description of the comic series.
- **hash** (string) - A hash representing the series data.
- **issuesHash** (string) - A hash representing the issues data.
- **tags** (array[string]) - An array of tags associated with the comic series.
- **genres** (array[string]) - An array of genres for the comic series.
- **language** (string) - The language of the comic series.
- **seriesType** (string) - The type of series (e.g., WEBTOON).
- **contentRating** (string) - The content rating for the series.
- **sssUrl** (string) - The SSS feed URL for the comic series.
- **cover_sm** (string) - URL for the small cover image.
- **cover_md** (string) - URL for the medium cover image.
- **cover_lg** (string) - URL for the large cover image.
- **bannerImageUrl** (string) - URL for the banner image.
- **thumbnailImageUrl** (string) - URL for the thumbnail image.
- **coverImageAsString** (string) - JSON string representing cover image details.
- **bannerImageAsString** (string) - JSON string representing banner image details.
- **thumbnailImageAsString** (string) - JSON string representing thumbnail image details.
- **creators** (array[object]) - An array of creator objects.
  - **uuid** (string) - The unique identifier of the creator.
  - **name** (string) - The name of the creator.
  - **sssUrl** (string) - The SSS feed URL for the creator.
- **issues** (array[object]) - An array of issue objects.
  - **uuid** (string) - The unique identifier of the issue.
  - **name** (string) - The title of the issue.
  - **bannerImageUrl** (string) - URL for the issue's banner image.
  - **thumbnailImageUrl** (string) - URL for the issue's thumbnail image.
  - **storyImageUrls** (array[string]) - An array of URLs for the issue's story images.

#### Response Example
```json
{
  "data": {
    "getComicSeries": {
      "uuid": "b00c3bc5-2758-483a-942c-4229eb742cb4",
      "datePublished": 1683664725,
      "name": "Warrior's Strife",
      "description": "Frayja has trained all her life to become the greatest warrior in her clan. She has been taught to fear and hate elves and their magic. But a day on the battlefield dramatically alters her perspective on reality.",
      "hash": "397b0176c21bff026d7b58e7bf87147626d4b9c2f7c7a6ddb5de467aa8b1c751",
      "issuesHash": "c005d4e0aadf39c1a043ff3be40833480a2adab59cbffd3ea86620da0a21cc97",
      "tags": [
        "fantasy",
        "darkfantasy",
        "lgbtqia",
        "lgbt",
        "monsters",
        "viking",
        "elf",
        "magic",
        "action",
        "drama",
        "medieval"
      ],
      "genres": [
        "COMICSERIES_ROMANCE",
        "COMICSERIES_DRAMA"
      ],
      "language": "ENGLISH",
      "seriesType": "WEBTOON",
      "contentRating": "COMICSERIES_TEENS",
      "sssUrl": "https://taddy.org/feeds/sss/comicseries/b00c3bc5-2758-483a-942c-4229eb742cb4",
      "cover_sm": "https://ax1.taddy.org/b00c3bc5-2758-483a-942c-4229eb742cb4/97699676-ece5-4ab5-b089-5288cfa7421c/cover-sm.webp",
      "cover_md": "https://ax1.taddy.org/b00c3bc5-2758-483a-942c-4229eb742cb4/97699676-ece5-4ab5-b089-5288cfa7421c/cover-md.webp",
      "cover_lg": "https://ax1.taddy.org/b00c3bc5-2758-483a-942c-4229eb742cb4/97699676-ece5-4ab5-b089-5288cfa7421c/cover-lg.webp",
      "bannerImageUrl": "https://ax1.taddy.org/b00c3bc5-2758-483a-942c-4229eb742cb4/f8f972c4-6d77-404e-b5c3-5cf37c3172f3/banner-sm.webp",
      "thumbnailImageUrl": "https://ax1.taddy.org/b00c3bc5-2758-483a-942c-4229eb742cb4/a1718041-2b8c-42e9-94fe-099ade2b3417/thumbnail.webp",
      "coverImageAsString": "{\"base_url\":\"https://ax1.taddy.org/b00c3bc5-2758-483a-942c-4229eb742cb4/97699676-ece5-4ab5-b089-5288cfa7421c/\",\"cover_sm\":\"cover-sm.webp\",\"cover_md\":\"cover-md.webp\",\"cover_lg\":\"cover-lg.webp\"}",
      "bannerImageAsString": "{\"base_url\":\"https://ax1.taddy.org/b00c3bc5-2758-483a-942c-4229eb742cb4/f8f972c4-6d77-404e-b5c3-5cf37c3172f3/\",\"banner_sm\":\"banner-sm.webp\",\"banner_md\":\"banner-md.webp\",\"banner_lg\":\"banner-lg.webp\"}",
      "thumbnailImageAsString": "{\"base_url\":\"https://ax1.taddy.org/b00c3bc5-2758-483a-942c-4229eb742cb4/a1718041-2b8c-42e9-94fe-099ade2b3417/\",\"thumbnail\":\"thumbnail.webp\"}",
      "creators": [
        {
          "uuid": "cbce3184-9975-4212-9c0f-3b51113b4ad6",
          "name": "Christopher Becker",
          "sssUrl": "https://taddy.org/feeds/sss/creator/cbce3184-9975-4212-9c0f-3b51113b4ad6"
        }
      ],
      "issues": [
        {
          "uuid": "d99eba13-b183-41af-a53d-9dcdda7928d0",
          "name": "Chapter 16",
          "bannerImageUrl": "https://ax1.taddy.org/b00c3bc5-2758-483a-942c-4229eb742cb4/f8f972c4-6d77-404e-b5c3-5cf37c3172f3/banner-sm.webp",
          "thumbnailImageUrl": "https://ax1.taddy.org/b00c3bc5-2758-483a-942c-4229eb742cb4/d99eba13-b183-41af-a53d-9dcdda7928d0/7e64ff14-0f5a-4c18-b866-7a6683ca62aa/thumbnail.webp",
          "storyImageUrls": [
            "https://ay1.taddy.org/b00c3bc5-2758-483a-942c-4229eb742cb4/d99eba13-b183-41af-a53d-9dcdda7928d0/80b94c50-5ebd-44f0-ade4-d41f2fa7ae49/story.webp",
            "https://ay1.taddy.org/b00c3bc5-2758-483a-942c-4229eb742cb4/d99eba13-b183-41af-a53d-9dcdda7928d0/e6201d3b-23d7-4ac2-b3af-a88fc54e986f/story.webp",
            "https://ay1.taddy.org/b00c3bc5-2758-483a-942c-4229eb742cb4/d99eba13-b183-41af-a53d-9dcdda7928d0/9822851f-ab59-40d7-bf80-e447809acd60/story.webp",
            "https://ay1.taddy.org/b00c3bc5-2758-483a-942c-4229eb742cb4/d99eba13-b183-41af-a53d-9dcdda7928d0/d214683f-3b36-4e9a-a131-ac7d08cab378/story.webp",
            "https://ay1.taddy.org/b00c3bc5-2758-483a-942c-4229eb742cb4/d99eba13-b183-41af-a53d-9dcdda7928d0/5e29f90c-74e0-4093-ac49-42fc7fc722d3/story.webp",
            "https://ay1.taddy.org/b00c3bc5-2758-483a-942c-4229eb742cb4/d99eba13-b183-41af-a53d-9dcdda7928d0/d277ea8e-993e-45bd-a217-d17168f3ca6d/story.webp"
          ]
        }
      ]
    }
  }
}
```
```

--------------------------------

### Hello World - Making Your First Request

Source: https://taddy.org/developers/intro-to-taddy-graphql-api

Demonstrates how to make your first API request using a sample GraphQL query. It shows the query structure and provides instructions on how to include authentication headers.

```APIDOC
## Hello World (Making your first request)

Go to **api.taddy.org** on your browser and copy & paste the below query:

```graphql
{
  getPodcastSeries(name:"The Daily"){
    uuid
    name
    itunesId
    description
    imageUrl
    totalEpisodesCount
    itunesInfo{
      uuid
      baseArtworkUrlOf(size:640)
    }
  }
}
```

**Note:** All requests to Taddy API need to be authenticated to get a successful response. You will need to pass in your User ID and API Key in the headers (`X-USER-ID` and `X-API-KEY`). See the Authentication section below for more details.
```

--------------------------------

### Get Popular Podcasts by Genre (GraphQL)

Source: https://taddy.org/developers/podcast-api/most-popular-podcasts

This snippet illustrates fetching popular podcasts filtered by one or more genres using the getPopularContent query. The filterByGenres parameter accepts an array of genres, allowing for multiple selections. For example, it shows filtering by 'Business' related genres.

```graphql
{
  getPopularContent(filterByLanguage:ENGLISH, filterByGenres:[PODCASTSERIES_BUSINESS, PODCASTSERIES_NEWS_BUSINESS, PODCASTSERIES_BUSINESS_CAREERS, PODCASTSERIES_BUSINESS_INVESTING, PODCASTSERIES_BUSINESS_MARKETING, PODCASTSERIES_BUSINESS_MANAGEMENT, PODCASTSERIES_BUSINESS_NON_PROFIT, PODCASTSERIES_BUSINESS_ENTREPRENEURSHIP]){
    popularityRankId
    podcastSeries{
      uuid
      name
      description
      popularityRank
    }
  }
}
```

--------------------------------

### GraphQL Query to Get Comic Series Data

Source: https://taddy.org/developers/comics-api/get-comic-series

This GraphQL query retrieves comprehensive details for a specific comic series, including its metadata, creators, and issues. It allows for fetching various image resolutions and string representations of images. Dependencies include a valid GraphQL endpoint and the `uuid` of the comic series.

```graphql
{
  getComicSeries(uuid:"b00c3bc5-2758-483a-942c-4229eb742cb4"){
    uuid
    datePublished
    name
    description
    hash
    issuesHash
    tags
    genres
    language
    seriesType
    contentRating
    sssUrl
    cover_sm: coverImageUrl(variant:SMALL) # if you want to get multiple variant for the same image, you must use an alias
    cover_md: coverImageUrl(variant:MEDIUM)
    cover_lg: coverImageUrl(variant:LARGE)
    bannerImageUrl(variant:SMALL) # if you just need a specific varaint size, no need to use an alias
    thumbnailImageUrl
  	coverImageAsString
    bannerImageAsString
    thumbnailImageAsString
    creators{
      uuid
      name
      sssUrl
    }
    issues{
      uuid
      name
      bannerImageUrl
      thumbnailImageUrl
      storyImageUrls
    }
  }
}
```

--------------------------------

### Setting Up a Webhook

Source: https://taddy.org/developers/creator-api/webhooks

Instructions on how to set up a new webhook through the Taddy Dashboard, including the required information and plan limitations.

```APIDOC
## Setting Up a Webhook

1. Open up the **Taddy Dashboard** and click the “Setup a New Webhook” button.
2. Enter the endpoint URL where you want to receive notifications (must be publicly accessible).
3. Select the specific webhook events you wish to receive.

**Notes:**
* Requires a Business plan subscription.
* Webhook notifications do not count against monthly API limits.
* The endpoint URL must be publicly accessible over the internet (e.g., Ngrok can be used for local testing).
* The endpoint URL must be a `POST` endpoint.
* An optional Webhook Secret can be configured for enhanced security, sent as the `X-TADDY-WEBHOOK-SECRET` header.
```

--------------------------------

### Working with a GraphQL API

Source: https://taddy.org/developers/intro-to-taddy-graphql-api

Provides guidance on interacting with GraphQL APIs, recommending the use of GraphQL-specific libraries for a more streamlined development experience and listing popular libraries for various programming languages.

```APIDOC
## Working with a GraphQL API

When working with a GraphQL API, you can either:

1.  **Use a GraphQL specific library (Recommended):** These libraries are built to simplify working with GraphQL queries and responses. Popular libraries include:
    *   Javascript: GraphQL request
    *   Python: Graphene
    *   Ruby: GraphQL client
    *   iOS: Apollo or Swift GraphQL
    *   Android: Apollo or GraphQL Kotlin

For a full list of supported libraries in various languages, see: https://graphql.org/code/
```

--------------------------------

### Taddy API: Podcast Episode Search Parameters

Source: https://taddy.org/developers/podcast-api/get-podcast-episode

These are the properties you can use to identify and filter podcast episodes when querying the Taddy API. You can use 'uuid' for Taddy's internal ID, 'guid' from the RSS feed, or 'name' of the episode. 'seriesUuidForLookup' can be used with 'guid' or 'name' to narrow results to a specific podcast series.

```graphql
query {
  getPodcastEpisode(
    uuid: ID
    guid: String
    name: String
    seriesUuidForLookup: ID
  ) {
    # ... response fields
  }
}
```

--------------------------------

### Common GraphQL Queries

Source: https://taddy.org/developers/intro-to-taddy-graphql-api

Examples of common GraphQL queries for fetching podcast information, checking API request limits, and understanding pagination.

```APIDOC
## Common GraphQL Queries

### Get Podcast Series and Episodes (Default)

This query retrieves information about a podcast series and its latest 10 episodes.

```graphql
{
  getPodcastSeries(name:"This American Life"){
    uuid
    episodes{
      uuid
      name
      description
      audioUrl
    }
  }
}
```

### Get Podcast Series and Episodes (With Pagination Parameters)

This query explicitly sets pagination parameters for episodes, resulting in the same output as the default query.

```graphql
{
  getPodcastSeries(name:"This American Life"){
    uuid
    episodes(sortOrder:LATEST, page:1, limitPerPage:10){
      uuid
      name
      description
      audioUrl
    }
  }
}
```

### Get Second Page of Episodes

This query retrieves the second page of episodes for a podcast series (the next 10 episodes after the first page).

```graphql
{
  getPodcastSeries(name:"This American Life"){
    uuid
    episodes(page:2){
      uuid
      name
      description
      audioUrl
    }
  }
}
```

### Check API Requests Remaining

This query allows you to check the number of API requests remaining for the current month.

```graphql
{
  getApiRequestsRemaining
}
```
```

--------------------------------

### Query Comic Series Data

Source: https://taddy.org/developers/comics-api/get-comic-series

Retrieve detailed information about a comic series. You can query using the comic's unique identifier (uuid), its SSS Feed URL (sssUrl), or its name (name).

```APIDOC
## GET /query

### Description
Retrieves details for a specific comic series based on a unique identifier, SSS feed URL, or name.

### Method
GET

### Endpoint
/query

### Parameters
#### Query Parameters
- **uuid** (ID) - Optional - Unique identifier for a comic.
- **sssUrl** (String) - Optional - A comic's SSS Feed URL.
- **name** (String) - Optional - The name (title) of a comic. If multiple comics share the same name, the most popular one is returned.

### Response
#### Success Response (200)
- **uuid** (ID) - Unique identifier for this comic.
- **datePublished** (Int) - Date when the comic was published (Epoch time in seconds).
- **name** (String) - The name (title) for a comic.
- **description** (String) - The description for a comic.
- **status** (SeriesStatus) - Status of the comic.
- **coverImageUrl** (String) - The cover art for a comic. Optionally takes a 'variant' (ImageVariant) argument.
- **bannerImageUrl** (String) - The banner art for a comic. Optionally takes a 'variant' (ImageVariant) argument.
- **thumbnailImageUrl** (String) - The thumbnail art for a comic.
- **coverImageAsString** (String) - Stringified JSON details for the cover art.
- **bannerImageAsString** (String) - Stringified JSON details for the banner art.
- **thumbnailImageAsString** (String) - Stringified JSON details for the thumbnail art.
- **hash** (String) - A hash of all comic details.
- **issuesHash** (String) - A hash of the details for all issues for this comic.
- **issues** (Array<ComicIssue>) - A list of issues for this comic. Accepts 'sortOrder' (SortOrder), 'page' (Int), 'limitPerPage' (Int), 'searchTerm' (String), and 'includeRemovedIssues' (Boolean) arguments.
- **totalIssuesCount** (Int) - The number of issues for this comic. Accepts 'includeRemovedIssues' (Boolean) argument.
- **tags** (Array<String>) - Tags for the comic.
- **genres** (Array<Genre>) - Genres the comic belongs to, ordered by importance.
- **language** (Language) - The language the comic is in.
- **creators** (Array<Creator>) - Creators of the comic.
- **seriesType** (ComicSeriesType) - Type of the comic.
- **seriesLayout** (ComicSeriesLayout) - Layout of the comic.
- **contentRating** (ContentRating) - Rating of the comic.
- **sssUrl** (String) - URL for the comic's SSS feed.
- **sssOwnerName** (String) - Name to use for contacting the owner of this feed.
- **sssOwnerPublicEmail** (String) - Email to use for contacting the owner of this feed.
- **copyright** (String) - Copyright details for this feed.
- **feedRefreshDetails** (FeedRefreshDetails) - Details on how often the SSS feed is checked for new details.
- **isBlocked** (Boolean) - Indicates if the content has been blocked from updates due to policy violations.

#### Response Example
```json
{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "datePublished": 1678886400,
  "name": "Example Comic Series",
  "description": "An exciting adventure of.",
  "status": "ONGOING",
  "coverImageUrl": "https://example.com/cover.jpg",
  "bannerImageUrl": "https://example.com/banner.jpg",
  "thumbnailImageUrl": "https://example.com/thumbnail.jpg",
  "coverImageAsString": "{\"url\": \"https://example.com/cover.jpg\", \"alt\": \"Cover Art\"}",
  "bannerImageAsString": "{\"url\": \"https://example.com/banner.jpg\", \"alt\": \"Banner Art\"}",
  "thumbnailImageAsString": "{\"url\": \"https://example.com/thumbnail.jpg\", \"alt\": \"Thumbnail Art\"}",
  "hash": "abcdef123456",
  "issuesHash": "ghijkl789012",
  "issues": [
    {
      "uuid": "issue-uuid-1",
      "title": "Issue 1",
      "datePublished": 1678886400,
      "description": "The first issue.",
      "status": "PUBLISHED",
      "coverImageUrl": "https://example.com/issue1_cover.jpg"
    }
  ],
  "totalIssuesCount": 10,
  "tags": ["action", "adventure"],
  "genres": [{"name": "Action"}],
  "language": "ENGLISH",
  "creators": [{"name": "John Doe"}],
  "seriesType": "COMIC_BOOK",
  "seriesLayout": "STANDARD",
  "contentRating": "ALL_AGES",
  "sssUrl": "https://example.com/sss/feed",
  "sssOwnerName": "Comic Creator",
  "sssOwnerPublicEmail": "owner@example.com",
  "copyright": "© 2023 Comic Creator",
  "feedRefreshDetails": {"lastRefresh": 1678886400, "nextRefresh": 1678972800},
  "isBlocked": false
}
```
```

--------------------------------

### Authentication

Source: https://taddy.org/developers/intro-to-taddy-graphql-api

Explains the authentication process for the Taddy API. It details how to obtain your API Key from the dashboard and the required headers (`X-USER-ID` and `X-API-KEY`) for making authenticated requests.

```APIDOC
## Authentication

All requests to our API need to be authenticated. To get your API Key, log in to the **Taddy Dashboard**. You will see a “Get my API Key” button, clicking on it will reveal your API Key.

You will need to add both your User ID and API Key to the headers whenever you make an API request. Use the `X-USER-ID` and `X-API-KEY` keys and pass in your information as the values.

**Example Headers:**
```json
{
	"X-USER-ID": 7,
	"X-API-KEY": "96c5007c18858e86d..."
}
```
```

--------------------------------

### Taddy API Response Example

Source: https://taddy.org/developers/podcast-api/get-multiple-podcast-series

This is an example of the JSON response received from Taddy's API when requesting details for multiple podcast series. It shows the structured data for each podcast, including its metadata and iTunes-specific information.

```json
{
  "data": {
    "getMultiplePodcastSeries": [
      {
        "uuid": "cb8d858a-3ef4-4645-8942-67e55c0927f2",
        "name": "The Daily",
        "itunesId": 1200361736,
        "description": "This is what the news should sound like. The biggest stories of our time, told by the best journalists in the world. Hosted by Michael Barbaro and Sabrina Tavernise. Twenty minutes a day, five days a week, ready by 6 a.m.",
        "imageUrl": "https://image.simplecastcdn.com/images/03d8b493-87fc-4bd1-931f-8a8e9b945d8a/2cce5659-f647-4366-b318-46e4b67afcfa/3000x3000/c81936f538106550b804e7e4fe2c236319bab7fba37941a6e8f7e5c3d3048b88fc5b2182fb790f7d446bdc820406456c94287f245db89d8656c105d5511ec3de.jpeg?aid=rss_feed",
        "itunesInfo": {
          "uuid": "cb8d858a-3ef4-4645-8942-67e55c0927f2",
          "publisherName": "The New York Times",
          "baseArtworkUrlOf": "https://is1-ssl.mzstatic.com/image/thumb/Podcasts115/v4/1c/ac/04/1cac0421-4483-ff09-4f80-19710d9feda4/mza_12421371692158516891.jpeg/640x640bb.png"
        }
      },
      {
        "uuid": "d682a935-ad2d-46ee-a0ac-139198b83bcc",
        "name": "This American Life",
        "itunesId": 201671138,
        "description": "This American Life is a weekly public radio show, heard by 2.2 million people on more than 500 stations. Another 2.5 million people download the weekly podcast. It is hosted by Ira Glass, produced in collaboration with Chicago Public Media, delivered to stations by PRX The Public Radio Exchange, and has won all of the major broadcasting awards.",
        "imageUrl": "https://files.thisamericanlife.org/sites/all/themes/thislife/img/tal-name-1400x1400.png",
        "itunesInfo": {
          "uuid": "d682a935-ad2d-46ee-a0ac-139198b83bcc",
          "publisherName": "This American Life",
          "baseArtworkUrlOf": "https://is1-ssl.mzstatic.com/image/thumb/Podcasts123/v4/4e/b9/bb/4eb9bb9b-ed19-f0b7-7739-1177f1b35207/mza_8452563123961176873.png/640x640bb.png"
        }
      }
    ]
  }
}
```

--------------------------------

### Get Latest Podcast Episodes Query (GraphQL)

Source: https://taddy.org/developers/podcast-api/latest-episodes-from-multiple-podcasts

This GraphQL query retrieves the most recent podcast episodes. It requires an array of podcast UUIDs and specifies the fields to return, such as uuid, name, datePublished, and audioUrl. The example demonstrates how to structure the request to fetch data for specific podcasts.

```graphql
{
  getLatestPodcastEpisodes(uuids:["fc3c8bb1-1b2a-4619-a029-8866610ae292", "f8de4489-7054-4ce1-9325-87fb4a69e123", "afd89860-866c-4ceb-b4f0-c290d77dad90", "c86d311c-0744-4f6b-9e29-3317d9626a37"]){
    uuid
    name
    datePublished
    audioUrl
	}
}
```

--------------------------------

### Query Comic Series by Identifier (GraphQL)

Source: https://taddy.org/developers/comics-api/get-comic-series

This GraphQL query allows you to retrieve details about a specific comic series. You can identify the comic using its unique identifier (uuid), its SSS feed URL (sssUrl), or its name. The query returns a ComicSeries object containing various attributes.

```graphql
query GetComicSeries($uuid: ID!) {
  getComicSeries(uuid: $uuid) {
    uuid
    datePublished
    name
    description
    status
    coverImageUrl
    bannerImageUrl
    thumbnailImageUrl
    coverImageAsString
    bannerImageAsString
    thumbnailImageAsString
    hash
    issuesHash
    tags
    genres {
      name
    }
    language
    creators {
      name
    }
    seriesType
    seriesLayout
    contentRating
    sssUrl
    sssOwnerName
    sssOwnerPublicEmail
    copyright
    feedRefreshDetails {
      lastRefresh
      nextRefresh
    }
    isBlocked
  }
}
```
Tokens:
Raw