> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hobbo.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Castbox Reviews

> This endpoint fetches listener reviews and episode metadata from a Castbox show or episode identified by its public URL.



## OpenAPI

````yaml POST /castbox/reviews
openapi: 3.1.0
info:
  title: OpenAPI Plant Store
  description: >-
    A sample API that uses a plant store as an example to demonstrate features
    in the OpenAPI specification
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.hobbo.ai
    description: Main API server
  - url: https://py-api.hobbo.ai
    description: Python API server for scraper endpoints
security:
  - ApiKeyAuth: []
paths:
  /castbox/reviews:
    post:
      description: >-
        This endpoint fetches listener reviews and episode metadata from a
        Castbox show or episode identified by its public URL.
      requestBody:
        description: Castbox review scraping parameters
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CastboxReviewsRequest'
        required: true
      responses:
        '200':
          description: Reviews fetched successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CastboxReviewsResponse'
              examples:
                validationError:
                  value:
                    all_reviews: []
                    extra_information: {}
                    message: <string>
        '400':
          description: Validation error or unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                validationError:
                  value:
                    error: <string>
      servers:
        - url: https://py-api.hobbo.ai
components:
  schemas:
    CastboxReviewsRequest:
      type: object
      required:
        - query
      properties:
        query:
          type: string
          description: Provide the Castbox episode or show URL.
        reviews_to_fetch:
          type:
            - number
            - 'null'
          description: >-
            Number of reviews to fetch (default: all reviews, or within
            30-second timeout).
        sync_date:
          type:
            - string
            - 'null'
          description: 'Fetches reviews posted on a specific date using format: YYYY-MM-DD.'
        is_text_formatted:
          type: boolean
          description: Returns the review text with visual formatting preserved.
          default: true
        pagination_data:
          type:
            - object
            - 'null'
          description: Pagination metadata returned by previous Castbox responses.
    CastboxReviewsResponse:
      type: object
      properties:
        all_reviews:
          type: array
          description: Array of fetched reviews
          items:
            type: object
            properties:
              query:
                type:
                  - string
                  - 'null'
                description: Original query URL
              author_name:
                type:
                  - string
                  - 'null'
                description: Name of the review author
              author_profile_image_url:
                type:
                  - string
                  - 'null'
                description: Profile image URL of the author
              author_profile_image_url_org:
                type:
                  - string
                  - 'null'
                description: Original/high resolution profile image URL
              author_id:
                type:
                  - string
                  - number
                  - 'null'
                description: Unique identifier of the reviewer
              review_id:
                type:
                  - string
                  - number
                  - 'null'
                description: Identifier of the review
              review_date:
                type:
                  - string
                  - 'null'
                description: Date when the review was posted
              review_text:
                type:
                  - string
                  - 'null'
                description: Content of the review
              resource_url:
                type:
                  - string
                  - 'null'
                description: Direct Castbox URL of the referenced resource
              resource_cover_image:
                type:
                  - string
                  - 'null'
                description: Cover image URL of the resource
              resource_release_date:
                type:
                  - string
                  - 'null'
                description: Release date of the resource
              resource_author_name:
                type:
                  - string
                  - 'null'
                description: Author or show name associated with the resource
              resource_media_url:
                type:
                  - string
                  - 'null'
                description: Media URL (audio/video) linked to the resource
              resource_title:
                type:
                  - string
                  - 'null'
                description: Title of the resource
              resource_type:
                type:
                  - string
                  - 'null'
                description: Resource type (episode, playlist, etc.)
              resource_duration:
                type:
                  - string
                  - 'null'
                description: Duration of the resource
              review_stat:
                type:
                  - object
                  - 'null'
                description: Additional review statistics such as helpful counts
                additionalProperties:
                  type:
                    - string
                    - number
                    - boolean
                    - 'null'
        extra_information:
          type: object
          properties:
            extra_information:
              type: object
              properties:
                pagination_data:
                  type:
                    - object
                    - 'null'
                  description: Pagination data returned from Castbox
              description: Additional metadata about the Castbox resource
            total_review_count:
              type:
                - integer
                - 'null'
              description: Total number of reviews fetched
            total_review_count_list:
              type:
                - array
                - 'null'
              items:
                type: integer
              description: List of review counts per page
        message:
          type: string
          description: Status message about the review extraction
    Error:
      type: object
      properties:
        status:
          type: integer
          description: HTTP status code
        data:
          type: object
          description: Empty object or additional error data
        success:
          type: boolean
          description: Indicates operation failed
          example: false
        message:
          type: string
          description: Error message describing what went wrong

````