API documentation

Your first request

Sign in, reveal your project’s API key, and replace VIDEO_URL and YOUR_KEY in the example below.

curl 'https://api.fetchfox.net/youtube/transcript' \
  --get --data-urlencode 'url=VIDEO_URL' \
  -H 'x-access-key: YOUR_KEY'

Authentication

Send your project key in the x-access-key header. Keep it on your server. GET requests use query parameters for resource inputs; POST requests use JSON with the same input names. Passing access_key in a URL is deprecated: use the header so your key stays out of browser history and intermediary URL logs. Existing query-key clients remain compatible during migration.

The same project key uses x-access-key in REST and Authorization: Bearer YOUR_KEY in MCP. Rotating it immediately invalidates the previous key.

Credits & errors

Read /credits for your balance. The x-credits-used response header reports each request’s charge. Validation errors and failed processing do not incur a success charge. Successful requests use the operation’s normal credit rate, including cached responses.

Errors include an HTTP status, an error code, and retryability where applicable. Use bounded retries for transient errors and respect Retry-After; do not retry missing or private content indefinitely.

Error catalog

Check the HTTP status and success first. Extraction failures include message, errorCode and retryable; authentication, admission and validation failures may omit the latter two fields. Do not assume every failure has the same body.

{
  "success": false,
  "message": "No transcript is available for this content.",
  "errorCode": "no_transcript",
  "retryable": false
}

Use exponential backoff, at most a few retries, and record the request ID. A timeout does not justify an unlimited retry loop. Validation bodies can also include framework fields such as statusCode, code and error.

Limits, latency, and freshness

Failed extraction attempts and cache hits count toward authenticated admission limits. Failed processing uses no credits; successful cached requests use the normal credit rate. The service-wide limits are shared by all trial users; 429 and Retry-After are authoritative.

Use a positive integer from 1 to 100. Results can be fewer than requested. Limits outside this range are rejected before extraction.

For operations exposing country, use an uppercase two-letter country code (for example US, IN or GB). Recognized country-name aliases map to AU, BR, CA, CN, FR, DE, GR, HK, IT, IN, IL, JP, MX, NL, PL, PT, RO, SG, KR, ES, SE, TR, GB and US. The parser also accepts other two-letter codes; provider exit availability is not guaranteed or independently certified for every country. Omit country for the default routing. Country is not a language-selection option.

Responses report your rate window in X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset. 20 free credits per calendar month (UTC). No credit card required. There is no separate monthly request-attempt allowance. Operational rate, concurrency and daily safety limits apply; failed upstream attempts can count toward these limits even though they use no credits. HTTP 429 includes Retry-After. Back off before retrying and limit retries.

Requests may take several seconds or longer depending on platform access, retries and caching. There is no published latency or uptime SLA. Your request history records each request’s duration; the status page shows the latest reported operation state.

Source data is a snapshot at extraction time. Authenticated free-tier YouTube transcript results can be cached for five minutes. The anonymous homepage preview is a separate, truncated demo with a 15-minute cache and its own limits; source captions and public counts may change independently. Store your own retrieval time when building a dataset or comparing historical values. A successful response does not guarantee every optional field exists.

Only use content you are permitted to access and process. SnipBob does not grant rights to platform content or guarantee that a use complies with platform terms. Review our Terms and the source platform’s rules.

{
  "mcpServers": {
    "fetchfox": {
      "url": "https://mcp.fetchfox.net/mcp",
      "headers": {
        "Authorization": "Bearer YOUR_KEY"
      }
    }
  }
}

Connect with MCP

Connect a Streamable HTTP MCP client to the endpoint below and send Authorization: Bearer YOUR_KEY. Calls share your REST credit balance.

Discovery exposes 17 tools. Expand a platform to see the available tools.

Use your project API key to connect; OAuth is not enabled for this deployment.

Guides for each endpoint

Read inputs, credit costs, examples, and limitations for each live operation. Read the quickstart as Markdown, or browse workflow tutorials and integrations.

19 endpoints

{}

{
  "description": "Current credit balance",
  "type": "object",
  "required": [
    "success",
    "data"
  ],
  "properties": {
    "success": {
      "type": "boolean"
    },
    "data": {
      "type": "object",
      "required": [
        "totalRemaining",
        "monthly",
        "purchased"
      ],
      "properties": {
        "totalRemaining": {
          "type": "number"
        },
        "monthly": {
          "type": "object",
          "required": [
            "limit",
            "used",
            "remaining",
            "cycleStart",
            "resetAt"
          ],
          "properties": {
            "limit": {
              "type": "number"
            },
            "used": {
              "type": "number"
            },
            "remaining": {
              "type": "number"
            },
            "cycleStart": {
              "anyOf": [
                {
                  "type": "string",
                  "format": "date-time"
                },
                {
                  "type": "null"
                }
              ]
            },
            "resetAt": {
              "anyOf": [
                {
                  "type": "string",
                  "format": "date-time"
                },
                {
                  "type": "null"
                }
              ]
            }
          }
        },
        "purchased": {
          "type": "object",
          "required": [
            "total",
            "used",
            "remaining"
          ],
          "properties": {
            "total": {
              "type": "number"
            },
            "used": {
              "type": "number"
            },
            "remaining": {
              "type": "number"
            }
          }
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "Full URL of the resource"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "cursor": {
      "type": "string",
      "maxLength": 16384
    },
    "access_key": {
      "type": "string",
      "description": "Deprecated: use the x-access-key header. Keys in URLs can leak through browser history and intermediary logs. Retained only for existing clients.",
      "deprecated": true
    }
  },
  "nullable": true,
  "required": [
    "url"
  ]
}

{
  "description": "Comments retrieved successfully",
  "type": "object",
  "required": [
    "success",
    "data"
  ],
  "properties": {
    "success": {
      "type": "boolean"
    },
    "data": {
      "type": "object",
      "properties": {
        "url": {
          "type": "string"
        },
        "postUrl": {
          "type": "string"
        },
        "commentCount": {
          "type": "integer",
          "nullable": true
        },
        "limit": {
          "type": "integer"
        },
        "creditsUsed": {
          "type": "integer"
        },
        "collectionStatus": {
          "type": "string",
          "enum": [
            "partial",
            "exhausted",
            "unknown"
          ],
          "description": "Exhausted describes the available upstream pagination, not all comments or replies."
        },
        "stopReason": {
          "type": "string",
          "enum": [
            "requested_limit",
            "upstream_exhausted",
            "repeated_cursor",
            "no_progress",
            "page_limit",
            "unknown"
          ]
        },
        "hasMore": {
          "type": "boolean",
          "description": "A safe continuation is available; false does not establish complete coverage."
        },
        "cursor": {
          "type": "string",
          "nullable": true,
          "description": "Opaque continuation, possibly within an upstream page. Preserve the same post and sort order."
        },
        "comments": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "text": {
                "type": "string"
              },
              "profilePicUrl": {
                "type": "string"
              },
              "likes": {
                "type": "integer",
                "nullable": true
              },
              "replyCount": {
                "type": "integer",
                "nullable": true
              },
              "date": {
                "type": "string"
              },
              "timestamp": {
                "type": "integer"
              },
              "name": {
                "type": "string"
              },
              "profileUrl": {
                "type": "string"
              },
              "isAuthor": {
                "type": "boolean"
              }
            }
          }
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "Full URL of the resource"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "cursor": {
      "type": "string",
      "maxLength": 16384,
      "description": "Opaque continuation from the previous response; pass unchanged."
    },
    "access_key": {
      "type": "string",
      "description": "Deprecated: use the x-access-key header. Keys in URLs can leak through browser history and intermediary logs. Retained only for existing clients.",
      "deprecated": true
    }
  },
  "nullable": true,
  "required": [
    "url"
  ]
}

{
  "description": "Channel posts retrieved successfully",
  "type": "object",
  "required": [
    "success",
    "data"
  ],
  "properties": {
    "success": {
      "type": "boolean"
    },
    "data": {
      "type": "object",
      "properties": {
        "profileUrl": {
          "type": "string"
        },
        "username": {
          "type": "string"
        },
        "items": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "shortcode": {
                "type": "string"
              },
              "url": {
                "type": "string"
              },
              "type": {
                "type": "string"
              },
              "caption": {
                "type": "string"
              },
              "duration": {
                "type": [
                  "number",
                  "null"
                ],
                "description": "Duration in seconds, or null when unavailable."
              },
              "likes": {
                "type": "integer"
              },
              "comments": {
                "type": "integer"
              },
              "views": {
                "type": [
                  "integer",
                  "null"
                ],
                "description": "Null when not supplied by the source; a reported zero is preserved."
              },
              "plays": {
                "type": [
                  "integer",
                  "null"
                ]
              },
              "timestamp": {
                "type": "integer"
              },
              "thumbnailUrl": {
                "type": "string"
              },
              "imageCollection": {
                "type": "object",
                "required": [
                  "status",
                  "order",
                  "sourceMediaCount",
                  "items"
                ],
                "properties": {
                  "status": {
                    "type": "string",
                    "enum": [
                      "complete",
                      "partial",
                      "unavailable",
                      "unknown",
                      "not_applicable"
                    ],
                    "description": "Image metadata coverage, not a guarantee that temporary URLs remain retrievable."
                  },
                  "order": {
                    "type": "string",
                    "enum": [
                      "source",
                      "unknown"
                    ]
                  },
                  "sourceMediaCount": {
                    "type": "integer",
                    "nullable": true,
                    "minimum": 1,
                    "description": "Original media count including videos, or null when unknown."
                  },
                  "items": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "id",
                        "position",
                        "url",
                        "status"
                      ],
                      "properties": {
                        "id": {
                          "type": "string",
                          "nullable": true
                        },
                        "position": {
                          "type": "integer",
                          "nullable": true,
                          "minimum": 1,
                          "description": "One-based original slot, including skipped video slots; null when not provable."
                        },
                        "url": {
                          "type": "string",
                          "nullable": true,
                          "description": "Temporary upstream image URL, not permanent storage."
                        },
                        "status": {
                          "type": "string",
                          "enum": [
                            "available",
                            "unavailable"
                          ]
                        }
                      }
                    }
                  }
                }
              },
              "author": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string"
                  },
                  "username": {
                    "type": "string"
                  },
                  "fullName": {
                    "type": "string"
                  },
                  "isVerified": {
                    "type": "boolean"
                  },
                  "profilePicUrl": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "count": {
          "type": "integer"
        },
        "hasMore": {
          "type": "boolean"
        },
        "cursor": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "Full URL of the resource"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "cursor": {
      "type": "string",
      "maxLength": 16384,
      "description": "Opaque continuation from the previous response; pass unchanged."
    },
    "access_key": {
      "type": "string",
      "description": "Deprecated: use the x-access-key header. Keys in URLs can leak through browser history and intermediary logs. Retained only for existing clients.",
      "deprecated": true
    }
  },
  "nullable": true,
  "required": [
    "url"
  ]
}

{
  "description": "Channel reels retrieved successfully",
  "type": "object",
  "required": [
    "success",
    "data"
  ],
  "properties": {
    "success": {
      "type": "boolean"
    },
    "data": {
      "type": "object",
      "properties": {
        "profileUrl": {
          "type": "string"
        },
        "username": {
          "type": "string"
        },
        "items": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "shortcode": {
                "type": "string"
              },
              "url": {
                "type": "string"
              },
              "caption": {
                "type": "string"
              },
              "likes": {
                "type": "integer"
              },
              "comments": {
                "type": "integer"
              },
              "views": {
                "type": [
                  "integer",
                  "null"
                ],
                "description": "Null when not supplied by the source; a reported zero is preserved."
              },
              "plays": {
                "type": [
                  "integer",
                  "null"
                ]
              },
              "duration": {
                "type": [
                  "number",
                  "null"
                ],
                "description": "Duration in seconds, or null when unavailable."
              },
              "thumbnailUrl": {
                "type": "string"
              },
              "author": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string"
                  },
                  "username": {
                    "type": "string"
                  },
                  "fullName": {
                    "type": "string"
                  },
                  "isVerified": {
                    "type": "boolean"
                  },
                  "profilePicUrl": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "count": {
          "type": "integer"
        },
        "hasMore": {
          "type": "boolean"
        },
        "cursor": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "Full URL of the resource"
    },
    "access_key": {
      "type": "string",
      "description": "Deprecated: use the x-access-key header. Keys in URLs can leak through browser history and intermediary logs. Retained only for existing clients.",
      "deprecated": true
    }
  },
  "nullable": true,
  "required": [
    "url"
  ]
}

{
  "description": "Profile stats retrieved successfully",
  "type": "object",
  "required": [
    "success",
    "data"
  ],
  "properties": {
    "success": {
      "type": "boolean"
    },
    "data": {
      "type": "object",
      "properties": {
        "profileUrl": {
          "type": "string"
        },
        "userId": {
          "type": "string"
        },
        "username": {
          "type": "string"
        },
        "nickname": {
          "type": "string"
        },
        "verified": {
          "type": "boolean",
          "nullable": true,
          "description": "Null when the source does not report verification."
        },
        "followers": {
          "type": "integer"
        },
        "following": {
          "type": "integer"
        },
        "totalPosts": {
          "type": "integer"
        },
        "approximateFields": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Counts derived from rounded public metadata rather than exact structured values."
        },
        "bio": {
          "type": "string"
        },
        "avatar": {
          "type": "string"
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "Full URL of the resource"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "cursor": {
      "type": "string",
      "maxLength": 16384
    },
    "access_key": {
      "type": "string",
      "description": "Deprecated: use the x-access-key header. Keys in URLs can leak through browser history and intermediary logs. Retained only for existing clients.",
      "deprecated": true
    },
    "sortBy": {
      "type": "string",
      "enum": [
        "popular",
        "recent"
      ]
    }
  },
  "nullable": true,
  "required": [
    "url"
  ]
}

{
  "description": "Comments retrieved successfully",
  "type": "object",
  "required": [
    "success",
    "data"
  ],
  "properties": {
    "success": {
      "type": "boolean"
    },
    "data": {
      "type": "object",
      "properties": {
        "url": {
          "type": "string"
        },
        "postUrl": {
          "type": "string"
        },
        "shortcode": {
          "type": "string"
        },
        "commentCount": {
          "type": "integer",
          "nullable": true
        },
        "limit": {
          "type": "integer"
        },
        "creditsUsed": {
          "type": "integer"
        },
        "collectionStatus": {
          "type": "string",
          "enum": [
            "partial",
            "exhausted",
            "unknown"
          ],
          "description": "Exhausted describes the available upstream pagination, not all comments or replies."
        },
        "stopReason": {
          "type": "string",
          "enum": [
            "requested_limit",
            "upstream_exhausted",
            "repeated_cursor",
            "no_progress",
            "page_limit",
            "unknown"
          ]
        },
        "hasMore": {
          "type": "boolean",
          "description": "A safe continuation is available; false does not establish complete coverage."
        },
        "cursor": {
          "type": "string",
          "nullable": true,
          "description": "Opaque continuation, possibly within an upstream page. Preserve the same post and sort order."
        },
        "comments": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "text": {
                "type": "string"
              },
              "profilePicUrl": {
                "type": "string"
              },
              "likes": {
                "type": "integer",
                "nullable": true
              },
              "replyCount": {
                "type": "integer",
                "nullable": true
              },
              "date": {
                "type": "string"
              },
              "timestamp": {
                "type": "integer"
              },
              "username": {
                "type": "string"
              },
              "fullName": {
                "type": "string"
              },
              "verified": {
                "type": "boolean"
              },
              "parentCommentId": {
                "type": "string",
                "nullable": true
              }
            }
          }
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "Full URL of the resource"
    },
    "access_key": {
      "type": "string",
      "description": "Deprecated: use the x-access-key header. Keys in URLs can leak through browser history and intermediary logs. Retained only for existing clients.",
      "deprecated": true
    },
    "requireViews": {
      "enum": [
        true,
        false,
        "true",
        "false",
        "1",
        "0"
      ],
      "description": "Require verified video views. Defaults to false; optional mode skips view-only recovery."
    }
  },
  "nullable": true,
  "required": [
    "url"
  ]
}

{
  "description": "Post stats retrieved successfully",
  "type": "object",
  "required": [
    "success",
    "data"
  ],
  "properties": {
    "success": {
      "type": "boolean"
    },
    "data": {
      "type": "object",
      "properties": {
        "postUrl": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "shortcode": {
          "type": "string"
        },
        "title": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "views": {
          "type": "integer",
          "nullable": true,
          "description": "Null when unavailable or not applicable to this media type. A verified zero video count is preserved."
        },
        "videoUrl": {
          "type": "string",
          "description": "Temporary Instagram video CDN URL"
        },
        "likes": {
          "type": "integer"
        },
        "comments": {
          "type": "integer"
        },
        "shares": {
          "type": "integer",
          "nullable": true,
          "description": "Unavailable from the current Instagram extractor; returns null."
        },
        "publishedAt": {
          "type": "string"
        },
        "author": {
          "type": "string"
        },
        "authorLink": {
          "type": "string"
        },
        "duration": {
          "type": "string",
          "nullable": true
        },
        "thumbnail": {
          "type": "string"
        },
        "isVideo": {
          "type": "boolean"
        },
        "contentType": {
          "type": "string"
        }
      }
    }
  }
}

{}

{
  "description": "Current tool status",
  "type": "object",
  "required": [
    "success",
    "data"
  ],
  "properties": {
    "success": {
      "type": "boolean"
    },
    "data": {
      "type": "object",
      "required": [
        "overall",
        "generatedAt",
        "tools"
      ],
      "properties": {
        "overall": {
          "type": "string",
          "enum": [
            "green",
            "yellow",
            "red",
            "unknown"
          ]
        },
        "generatedAt": {
          "type": "string",
          "format": "date-time"
        },
        "tools": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "id",
              "channel",
              "name",
              "status",
              "message",
              "updatedAt",
              "freshness"
            ],
            "properties": {
              "id": {
                "type": "string"
              },
              "channel": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "freshness": {
                "type": "object",
                "required": [
                  "state",
                  "ageSeconds"
                ],
                "properties": {
                  "state": {
                    "type": "string",
                    "enum": [
                      "fresh",
                      "stale",
                      "missing",
                      "invalid"
                    ]
                  },
                  "ageSeconds": {
                    "type": [
                      "number",
                      "null"
                    ]
                  }
                }
              },
              "status": {
                "type": "string",
                "enum": [
                  "green",
                  "yellow",
                  "red",
                  "unknown"
                ]
              },
              "message": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "updatedAt": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "date-time"
              }
            }
          }
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "Full URL of the resource"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "cursor": {
      "type": "string",
      "maxLength": 16384,
      "description": "Opaque continuation from the previous response; pass unchanged."
    },
    "access_key": {
      "type": "string",
      "description": "Deprecated: use the x-access-key header. Keys in URLs can leak through browser history and intermediary logs. Retained only for existing clients.",
      "deprecated": true
    },
    "cache": {
      "type": "boolean",
      "description": "Opt in to successful response caching. Successful requests use the normal operation credit rate, including cached responses."
    },
    "cache_ttl": {
      "type": "integer",
      "minimum": 60,
      "maximum": 2592000,
      "description": "Maximum response age in seconds. Default 86400; no stale fallback."
    },
    "no_cache": {
      "type": "boolean",
      "description": "Bypass all extraction and result caches."
    },
    "country": {
      "type": "string",
      "description": "Residential exit country (two-letter code)."
    }
  },
  "nullable": true,
  "required": [
    "url"
  ]
}

{
  "description": "Channel videos retrieved successfully",
  "type": "object",
  "required": [
    "success",
    "data"
  ],
  "properties": {
    "success": {
      "type": "boolean"
    },
    "data": {
      "type": "object",
      "properties": {
        "profileUrl": {
          "type": "string"
        },
        "channelName": {
          "type": "string"
        },
        "results": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "videoId": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "url": {
                "type": "string"
              },
              "thumbnail": {
                "type": "string"
              },
              "duration": {
                "type": "number"
              },
              "createTime": {
                "type": "string"
              },
              "durationSeconds": {
                "type": [
                  "number",
                  "null"
                ]
              },
              "thumbnailUrl": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "publishedAt": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "ISO 8601 timestamp, or null when unavailable."
              },
              "views": {
                "type": "integer"
              },
              "likes": {
                "type": "integer"
              },
              "comments": {
                "type": "integer"
              },
              "shares": {
                "type": "integer"
              },
              "collects": {
                "type": "integer"
              }
            }
          }
        },
        "hasMore": {
          "type": "boolean"
        },
        "cursor": {
          "type": "string"
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "Full URL of the resource"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "cursor": {
      "type": "string",
      "maxLength": 16384,
      "description": "Opaque continuation from the previous response; pass unchanged."
    },
    "access_key": {
      "type": "string",
      "description": "Deprecated: use the x-access-key header. Keys in URLs can leak through browser history and intermediary logs. Retained only for existing clients.",
      "deprecated": true
    },
    "includeShortShareUrl": {
      "type": "boolean",
      "description": "Add best-effort shortShareUrl (verified TikTok short link or null) to each comment. May add up to 10 seconds; no extra credits."
    }
  },
  "nullable": true,
  "required": [
    "url"
  ]
}

{
  "description": "Comments retrieved successfully",
  "type": "object",
  "required": [
    "success",
    "data"
  ],
  "properties": {
    "success": {
      "type": "boolean"
    },
    "data": {
      "type": "object",
      "properties": {
        "url": {
          "type": "string"
        },
        "collectionStatus": {
          "type": "string"
        },
        "stopReason": {
          "type": "string"
        },
        "creditsUsed": {
          "type": "integer"
        },
        "videoId": {
          "type": "string"
        },
        "comments": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "author": {
                "type": "string"
              },
              "username": {
                "type": "string"
              },
              "text": {
                "type": "string"
              },
              "likes": {
                "type": "integer",
                "nullable": true
              },
              "avatar": {
                "type": "string"
              },
              "date": {
                "type": "string",
                "nullable": true
              },
              "replyCount": {
                "type": "integer",
                "nullable": true
              },
              "shareUrl": {
                "type": "string",
                "description": "Existing desktop comment link."
              },
              "shortShareUrl": {
                "type": "string",
                "nullable": true,
                "description": "Present only when includeShortShareUrl=true. TikTok short link for app/browser handoff; null when unavailable. No guaranteed lifetime."
              }
            }
          }
        },
        "commentCount": {
          "type": "integer"
        },
        "hasMore": {
          "type": "boolean"
        },
        "cursor": {
          "type": "string",
          "nullable": true
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "description": "Search query"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "access_key": {
      "type": "string",
      "description": "Deprecated: use the x-access-key header. Keys in URLs can leak through browser history and intermediary logs. Retained only for existing clients.",
      "deprecated": true
    }
  },
  "nullable": true,
  "required": [
    "query"
  ]
}

{
  "description": "Search results returned",
  "type": "object",
  "required": [
    "success",
    "data"
  ],
  "properties": {
    "success": {
      "type": "boolean"
    },
    "data": {
      "type": "object",
      "properties": {
        "query": {
          "type": "string"
        },
        "results": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "desc": {
                "type": "string"
              },
              "url": {
                "type": "string"
              },
              "createTime": {
                "type": "integer"
              },
              "durationSeconds": {
                "type": [
                  "number",
                  "null"
                ]
              },
              "thumbnailUrl": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "publishedAt": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "ISO 8601 timestamp, or null when unavailable."
              },
              "author": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string"
                  },
                  "uniqueId": {
                    "type": "string"
                  },
                  "nickname": {
                    "type": "string"
                  },
                  "avatar": {
                    "type": "string"
                  },
                  "verified": {
                    "type": "boolean"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "views": {
                    "type": "integer"
                  },
                  "likes": {
                    "type": "integer"
                  },
                  "comments": {
                    "type": "integer"
                  },
                  "shares": {
                    "type": "integer"
                  },
                  "saves": {
                    "type": "integer"
                  }
                }
              }
            }
          }
        },
        "hasMore": {
          "type": "boolean"
        },
        "cursor": {
          "type": "string"
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "Full URL of the resource"
    },
    "access_key": {
      "type": "string",
      "description": "Deprecated: use the x-access-key header. Keys in URLs can leak through browser history and intermediary logs. Retained only for existing clients.",
      "deprecated": true
    }
  },
  "nullable": true,
  "required": [
    "url"
  ]
}

{
  "description": "Video stats retrieved successfully",
  "type": "object",
  "required": [
    "success",
    "data"
  ],
  "properties": {
    "success": {
      "type": "boolean"
    },
    "data": {
      "type": "object",
      "properties": {
        "url": {
          "type": "string"
        },
        "videoId": {
          "type": "string"
        },
        "title": {
          "type": "string"
        },
        "channelName": {
          "type": "string"
        },
        "channelLink": {
          "type": "string"
        },
        "likes": {
          "type": "integer"
        },
        "comments": {
          "type": "integer"
        },
        "collects": {
          "type": "integer"
        },
        "shares": {
          "type": "integer"
        },
        "views": {
          "type": "integer"
        },
        "description": {
          "type": "string"
        },
        "duration": {
          "type": "string"
        },
        "thumbnailUrl": {
          "type": [
            "string",
            "null"
          ]
        },
        "publishedAt": {
          "type": [
            "string",
            "null"
          ],
          "description": "ISO 8601 timestamp, or null when unavailable."
        },
        "durationSeconds": {
          "type": [
            "number",
            "null"
          ],
          "description": "Duration in seconds, or null when unavailable. Prefer this to the legacy duration field."
        },
        "contentType": {
          "type": "string"
        },
        "isShortForm": {
          "type": "boolean"
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "Full URL of the resource"
    },
    "access_key": {
      "type": "string",
      "description": "Deprecated: use the x-access-key header. Keys in URLs can leak through browser history and intermediary logs. Retained only for existing clients.",
      "deprecated": true
    }
  },
  "nullable": true,
  "required": [
    "url"
  ]
}

{
  "description": "Channel stats retrieved successfully",
  "type": "object",
  "required": [
    "success",
    "data"
  ],
  "properties": {
    "success": {
      "type": "boolean"
    },
    "data": {
      "type": "object",
      "properties": {
        "profileUrl": {
          "type": "string"
        },
        "username": {
          "type": "string"
        },
        "nickname": {
          "type": "string"
        },
        "bio": {
          "type": "string"
        },
        "verified": {
          "type": "boolean"
        },
        "avatar": {
          "type": "string"
        },
        "totalViews": {
          "type": "integer",
          "nullable": true
        },
        "subscribers": {
          "type": "integer",
          "nullable": true
        },
        "totalVideos": {
          "type": "integer",
          "nullable": true
        },
        "bioLink": {
          "type": "string"
        },
        "banner": {
          "type": "string"
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "Full URL of the resource"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "access_key": {
      "type": "string",
      "description": "Deprecated: use the x-access-key header. Keys in URLs can leak through browser history and intermediary logs. Retained only for existing clients.",
      "deprecated": true
    },
    "sortBy": {
      "type": "string",
      "enum": [
        "new",
        "top"
      ]
    }
  },
  "nullable": true,
  "required": [
    "url"
  ]
}

{
  "description": "Comments retrieved successfully",
  "type": "object",
  "required": [
    "success",
    "data"
  ],
  "properties": {
    "success": {
      "type": "boolean"
    },
    "data": {
      "type": "object",
      "properties": {
        "url": {
          "type": "string"
        },
        "collectionStatus": {
          "type": "string"
        },
        "stopReason": {
          "type": "string"
        },
        "creditsUsed": {
          "type": "integer"
        },
        "comments": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "nullable": true
              },
              "relativeTime": {
                "type": "string",
                "nullable": true
              },
              "author": {
                "type": "string"
              },
              "text": {
                "type": "string"
              },
              "likes": {
                "type": "integer",
                "nullable": true
              },
              "date": {
                "type": "string",
                "nullable": true
              },
              "avatar": {
                "type": "string"
              },
              "replyCount": {
                "type": "integer",
                "nullable": true
              },
              "position": {
                "type": "integer"
              }
            }
          }
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "access_key": {
      "type": "string",
      "description": "Deprecated: use the x-access-key header. Keys in URLs can leak through browser history and intermediary logs. Retained only for existing clients.",
      "deprecated": true
    },
    "sortBy": {
      "type": "string",
      "enum": [
        "relevance",
        "rating",
        "date",
        "views"
      ]
    },
    "uploadDate": {
      "type": "string",
      "enum": [
        "hour",
        "today",
        "week",
        "month",
        "year"
      ]
    },
    "type": {
      "type": "string",
      "enum": [
        "video",
        "shorts"
      ]
    }
  },
  "nullable": true,
  "required": [
    "query"
  ]
}

{
  "description": "Search results returned",
  "type": "object",
  "required": [
    "success",
    "data"
  ],
  "properties": {
    "success": {
      "type": "boolean"
    },
    "data": {
      "type": "object",
      "properties": {
        "query": {
          "type": "string"
        },
        "results": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "videoId": {
                "type": "string"
              },
              "title": {
                "type": "string"
              },
              "thumbnail": {
                "type": "string"
              },
              "channelName": {
                "type": "string"
              },
              "channelId": {
                "type": "string"
              },
              "channelUrl": {
                "type": "string"
              },
              "publishedTime": {
                "type": "string"
              },
              "duration": {
                "type": "string"
              },
              "views": {
                "type": "integer",
                "nullable": true
              },
              "viewsFormatted": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "url": {
                "type": "string"
              },
              "verified": {
                "type": "boolean"
              }
            }
          }
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "Full URL of the resource"
    },
    "access_key": {
      "type": "string",
      "description": "Deprecated: use the x-access-key header. Keys in URLs can leak through browser history and intermediary logs. Retained only for existing clients.",
      "deprecated": true
    }
  },
  "nullable": true,
  "required": [
    "url"
  ]
}

{
  "description": "Video stats retrieved successfully",
  "type": "object",
  "required": [
    "success",
    "data"
  ],
  "properties": {
    "success": {
      "type": "boolean"
    },
    "data": {
      "type": "object",
      "properties": {
        "url": {
          "type": "string"
        },
        "videoId": {
          "type": "string"
        },
        "title": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "channelName": {
          "type": "string"
        },
        "channelLink": {
          "type": "string"
        },
        "channelHandle": {
          "type": "string"
        },
        "views": {
          "type": "integer",
          "nullable": true
        },
        "likes": {
          "type": "integer",
          "nullable": true
        },
        "comments": {
          "type": "integer",
          "nullable": true
        },
        "duration": {
          "type": "string"
        },
        "publishedAt": {
          "type": [
            "string",
            "null"
          ]
        },
        "thumbnailUrl": {
          "type": "string"
        },
        "contentType": {
          "type": "string"
        },
        "isShortForm": {
          "type": "boolean"
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "Full URL of the resource"
    },
    "access_key": {
      "type": "string",
      "description": "Deprecated: use the x-access-key header. Keys in URLs can leak through browser history and intermediary logs. Retained only for existing clients.",
      "deprecated": true
    },
    "no_cache": {
      "type": "boolean",
      "description": "Bypass extraction and response caches."
    }
  },
  "nullable": true,
  "required": [
    "url"
  ]
}

{
  "description": "Transcript extracted successfully",
  "type": "object",
  "required": [
    "success",
    "data"
  ],
  "properties": {
    "success": {
      "type": "boolean"
    },
    "data": {
      "type": "object",
      "properties": {
        "url": {
          "type": "string"
        },
        "videoId": {
          "type": "string"
        },
        "transcript": {
          "type": "string",
          "description": "Full plain-text transcript"
        },
        "transcriptSegments": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "text": {
                "type": "string"
              },
              "start": {
                "type": "number"
              },
              "duration": {
                "type": "number"
              },
              "timestamp": {
                "type": "string"
              }
            }
          }
        },
        "wordCount": {
          "type": "integer"
        },
        "segments": {
          "type": "integer"
        },
        "language": {
          "type": "string"
        },
        "durationSeconds": {
          "type": "number"
        },
        "creditsUsed": {
          "type": "number"
        }
      }
    }
  }
}

{
  "anyOf": [
    {
      "type": "object",
      "required": [
        "requests"
      ],
      "properties": {
        "requests": {
          "type": "array",
          "minItems": 1,
          "maxItems": 5,
          "items": {
            "type": "object",
            "required": [
              "url"
            ],
            "properties": {
              "url": {
                "type": "string"
              }
            },
            "additionalProperties": true
          }
        },
        "access_key": {
          "type": "string",
          "description": "Deprecated: use the x-access-key header. Keys in URLs can leak through browser history and intermediary logs. Retained only for existing clients.",
          "deprecated": true
        }
      },
      "additionalProperties": true
    },
    {
      "type": "object",
      "required": [
        "urls"
      ],
      "properties": {
        "urls": {
          "type": "array",
          "minItems": 1,
          "maxItems": 5,
          "items": {
            "type": "string"
          },
          "description": "List of URLs to process"
        },
        "access_key": {
          "type": "string",
          "description": "Deprecated: use the x-access-key header. Keys in URLs can leak through browser history and intermediary logs. Retained only for existing clients.",
          "deprecated": true
        }
      },
      "additionalProperties": true
    }
  ]
}

{
  "description": "Batch results returned",
  "type": "object",
  "required": [
    "success",
    "results",
    "summary"
  ],
  "properties": {
    "success": {
      "type": "boolean"
    },
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean"
          },
          "url": {
            "type": "string"
          },
          "error": {
            "type": "string"
          },
          "errorCode": {
            "type": "string"
          },
          "retryable": {
            "type": "boolean"
          },
          "attempted": {
            "type": "boolean"
          },
          "creditsUsed": {
            "type": [
              "integer",
              "null"
            ]
          },
          "chargeStatus": {
            "type": "string"
          },
          "retryAfter": {
            "type": "integer"
          },
          "data": {
            "type": "object",
            "additionalProperties": true
          }
        }
      }
    },
    "summary": {
      "type": "object",
      "required": [
        "total",
        "successful",
        "failed",
        "creditsUsed"
      ],
      "properties": {
        "total": {
          "type": "integer"
        },
        "successful": {
          "type": "integer"
        },
        "failed": {
          "type": "integer"
        },
        "creditsUsed": {
          "type": "number"
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "Full URL of the resource"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "access_key": {
      "type": "string",
      "description": "Deprecated: use the x-access-key header. Keys in URLs can leak through browser history and intermediary logs. Retained only for existing clients.",
      "deprecated": true
    },
    "full_details": {
      "type": "boolean",
      "description": "When true, fill exact publishedAt + description for every returned video (not just the recent ones the channel feed covers) in a single request. Slower and higher bandwidth, so it's opt-in; enrichment is capped at 30 videos per request."
    }
  },
  "nullable": true,
  "required": [
    "url"
  ]
}

{
  "description": "Channel videos retrieved successfully",
  "type": "object",
  "required": [
    "success",
    "data"
  ],
  "properties": {
    "success": {
      "type": "boolean"
    },
    "data": {
      "type": "object",
      "properties": {
        "url": {
          "type": "string"
        },
        "type": {
          "type": "string",
          "description": "'playlist' or 'channel'"
        },
        "results": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "videoId": {
                "type": "string"
              },
              "title": {
                "type": "string"
              },
              "thumbnail": {
                "type": "string"
              },
              "channelName": {
                "type": "string"
              },
              "duration": {
                "type": "string"
              },
              "views": {
                "type": "integer",
                "nullable": true
              },
              "viewsFormatted": {
                "type": "string"
              },
              "publishedTime": {
                "type": "string",
                "description": "Relative publish time, e.g. \"2 weeks ago\"."
              },
              "publishedAt": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Exact publish date in ISO 8601 (e.g. 2026-06-30T20:13:54.000Z). Available for a channel's recent videos; null for older/paginated items and playlists."
              },
              "description": {
                "type": "string",
                "description": "Video description. Available for a channel's recent videos; empty otherwise."
              },
              "url": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}