> For the complete documentation index, see [llms.txt](https://docs.pullbay.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pullbay.com/api-reference/models.md).

# Models

## The Pagination object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"Pagination":{"type":"object","properties":{"page":{"type":"integer","nullable":true},"hasNextPage":{"type":"boolean","nullable":true},"cursor":{"type":"string","nullable":true},"offset":{"type":"string","nullable":true,"description":"Numeric offset string for offset-paginated endpoints (e.g. Google Maps place search)."}}}}}}
```

## The Pricing object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"Pricing":{"type":"object","properties":{"creditsCharged":{"type":"number"}}}}}}
```

## The ErrorEnvelope object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"ErrorEnvelope":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"},"success":{"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string"}}}}}}}}
```

## The ApartmentsProperty object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"ApartmentsProperty":{"type":"object","description":"An Apartments.com property summary (search result entry).","properties":{"id":{"type":"string"},"name":{"type":"string"},"bedRange":{"type":"string"},"rentRange":{"type":"string"},"address":{"type":"object","additionalProperties":true}}}}}}
```

## The ApartmentsPropertyDetail object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"ApartmentsPropertyDetail":{"type":"object","description":"Full property detail returned by /properties/{propertyId}.","properties":{"id":{"type":"string"},"propertyName":{"type":"string"},"url":{"type":"string"},"propertyWebsite":{"type":"string"},"lastUpdated":{"type":"string"},"description":{"type":"string"},"rating":{"type":"number"},"beds":{"type":"string"},"baths":{"type":"string"},"sqft":{"type":"string"},"baseRent":{"type":"object","additionalProperties":true},"totalRent":{"type":"object","additionalProperties":true},"location":{"type":"object","additionalProperties":true},"coordinates":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"}}},"contact":{"type":"object","additionalProperties":true},"specials":{"type":"object","nullable":true,"additionalProperties":true},"schools":{"type":"object","additionalProperties":true},"amenities":{"type":"array","items":{"type":"object","additionalProperties":true}},"fees":{"type":"array","items":{"type":"object","additionalProperties":true}},"models":{"type":"array","items":{"type":"object","additionalProperties":true}},"rentals":{"type":"array","items":{"type":"object","additionalProperties":true}},"transportation":{"type":"array","items":{"type":"object","additionalProperties":true}},"transitAndPOI":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}
```

## The ApartmentsPropertyImages object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"ApartmentsPropertyImages":{"type":"object","description":"Photos, floor plans, and virtual tours for a property.","properties":{"photos":{"type":"array","items":{"type":"object","additionalProperties":true}},"floorPlans":{"type":"array","items":{"type":"object","additionalProperties":true}},"virtualTours":{"type":"array","items":{"type":"object","additionalProperties":true}},"virtualTourExtended":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}
```

## The ApartmentsPropertyReview object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"ApartmentsPropertyReview":{"type":"object","description":"A review for an Apartments.com property.","properties":{"key":{"type":"string"},"title":{"type":"string"},"text":{"type":"string"},"rating":{"type":"number"},"submissionDate":{"type":"string"},"isOwner":{"type":"boolean"},"positiveFeedbackCount":{"type":"integer"},"comments":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}
```

## The Application object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"Application":{"type":"object","properties":{"id":{"type":"integer"},"appId":{"type":"string"},"title":{"type":"string"},"url":{"type":"string","format":"uri"},"description":{"type":"string"},"icon":{"type":"string","format":"uri"},"genres":{"type":"array","items":{"type":"string"}},"genreIds":{"type":"array","items":{"type":"string"}},"primaryGenre":{"type":"string"},"primaryGenreId":{"type":"integer"},"contentRating":{"type":"string"},"languages":{"type":"array","items":{"type":"string"}},"size":{"type":"string"},"requiredOsVersion":{"type":"string"},"released":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"},"releaseNotes":{"type":"string"},"version":{"type":"string"},"price":{"type":"number"},"currency":{"type":"string"},"free":{"type":"boolean"},"developerId":{"type":"integer"},"developer":{"type":"string"},"developerUrl":{"type":"string","format":"uri"},"developerWebsite":{"type":"string","format":"uri"},"score":{"type":"number"},"reviews":{"type":"integer"},"currentVersionScore":{"type":"number"},"currentVersionReviews":{"type":"integer"},"screenshots":{"type":"array","items":{"type":"string","format":"uri"}},"ipadScreenshots":{"type":"array","items":{"type":"string","format":"uri"}},"appletvScreenshots":{"type":"array","items":{"type":"string","format":"uri"}},"supportedDevices":{"type":"array","items":{"type":"string"}}}}}}}
```

## The Review object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"Review":{"type":"object","properties":{"id":{"type":"string"},"date":{"type":"string","format":"date-time"},"userName":{"type":"string"},"userUrl":{"type":"string","format":"uri"},"version":{"type":"string"},"score":{"type":"integer","minimum":1,"maximum":5},"title":{"type":"string"},"text":{"type":"string"},"url":{"type":"string","format":"uri"},"country":{"type":"string"}}}}}}
```

## The DuckDuckGoSearchResult object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"DuckDuckGoSearchResult":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"},"hostname":{"type":"string"},"icon":{"type":"string","format":"uri"},"url":{"type":"string","format":"uri"}}}}}}
```

## The DuckDuckGoImage object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"DuckDuckGoImage":{"type":"object","properties":{"title":{"type":"string"},"image":{"type":"string","format":"uri"},"thumbnail":{"type":"string","format":"uri"},"image_token":{"type":"string"},"thumbnail_token":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"},"source":{"type":"string"},"url":{"type":"string","format":"uri"}}}}}}
```

## The DuckDuckGoNewsArticle object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"DuckDuckGoNewsArticle":{"type":"object","properties":{"title":{"type":"string"},"excerpt":{"type":"string"},"url":{"type":"string","format":"uri"},"image":{"type":"string","format":"uri"},"date":{"type":"integer","description":"Unix timestamp in seconds"},"relativeTime":{"type":"string"},"syndicate":{"type":"string"},"isOld":{"type":"boolean"}}}}}}
```

## The DuckDuckGoVideo object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"DuckDuckGoVideo":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"},"url":{"type":"string","format":"uri"},"image":{"type":"string","format":"uri"},"duration":{"type":"string"},"publishedOn":{"type":"string"},"published":{"type":"string","format":"date-time"},"publisher":{"type":"string"},"viewCount":{"type":"integer"}}}}}}
```

## The GoogleMapsLocation object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"GoogleMapsLocation":{"type":"object","description":"Latitude/longitude pair.","properties":{"lat":{"type":"number","format":"float"},"lng":{"type":"number","format":"float"}}}}}}
```

## The GoogleMapsPlaceSearchResult object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"GoogleMapsPlaceSearchResult":{"type":"object","description":"Place result returned by /google-maps/place/search.","properties":{"url":{"type":"string","format":"uri"},"title":{"type":"string"},"description":{"type":"string","nullable":true},"address":{"type":"string"},"neighborhood":{"type":"string","nullable":true},"street":{"type":"string","nullable":true},"district":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"location":{"$ref":"#/components/schemas/GoogleMapsLocation"},"website":{"type":"string","format":"uri","nullable":true},"phone":{"type":"string","nullable":true},"price":{"type":"string","nullable":true},"totalScore":{"type":"number","format":"float"},"placeId":{"type":"string"},"fid":{"type":"string","description":"Google Maps feature ID, of the form '0x...:0x...'."},"reviewsCount":{"type":"integer"},"categories":{"type":"array","items":{"type":"string"}},"openingHours":{"type":"array","description":"Opening hours per weekday.","items":{"type":"object","additionalProperties":true}},"additionalInfo":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"boolean"}},"description":"Grouped feature flags (e.g. Service options, Accessibility, Offerings)."}}},"GoogleMapsLocation":{"type":"object","description":"Latitude/longitude pair.","properties":{"lat":{"type":"number","format":"float"},"lng":{"type":"number","format":"float"}}}}}}
```

## The GoogleMapsReviewsDistribution object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"GoogleMapsReviewsDistribution":{"type":"object","properties":{"oneStar":{"type":"integer"},"twoStar":{"type":"integer"},"threeStar":{"type":"integer"},"fourStar":{"type":"integer"},"fiveStar":{"type":"integer"}}}}}}
```

## The GoogleMapsPlace object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"GoogleMapsPlace":{"type":"object","description":"Full place detail returned by /google-maps/place/{fid}.","properties":{"url":{"type":"string","format":"uri"},"title":{"type":"string"},"address":{"type":"string"},"neighborhood":{"type":"string","nullable":true},"street":{"type":"string","nullable":true},"district":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"location":{"$ref":"#/components/schemas/GoogleMapsLocation"},"website":{"type":"string","format":"uri","nullable":true},"phone":{"type":"string","nullable":true},"phoneUnformatted":{"type":"string","nullable":true},"plusCode":{"type":"string","nullable":true},"price":{"type":"string","nullable":true},"totalScore":{"type":"number","format":"float"},"placeId":{"type":"string"},"cid":{"type":"string"},"fid":{"type":"string"},"reviewsCount":{"type":"integer"},"reviewsDistribution":{"$ref":"#/components/schemas/GoogleMapsReviewsDistribution"},"categories":{"type":"array","items":{"type":"string"}},"additionalInfo":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"boolean"}},"description":"Grouped feature flags (e.g. Service options, Accessibility, Amenities)."}}},"GoogleMapsLocation":{"type":"object","description":"Latitude/longitude pair.","properties":{"lat":{"type":"number","format":"float"},"lng":{"type":"number","format":"float"}}},"GoogleMapsReviewsDistribution":{"type":"object","properties":{"oneStar":{"type":"integer"},"twoStar":{"type":"integer"},"threeStar":{"type":"integer"},"fourStar":{"type":"integer"},"fiveStar":{"type":"integer"}}}}}}
```

## The GoogleMapsReviewer object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"GoogleMapsReviewer":{"type":"object","properties":{"name":{"type":"string"},"photo":{"type":"string","format":"uri"},"url":{"type":"string","format":"uri"},"totalReviews":{"type":"integer"},"totalPhotos":{"type":"integer"}}}}}}
```

## The GoogleMapsPlaceReview object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"GoogleMapsPlaceReview":{"type":"object","properties":{"id":{"type":"string"},"link":{"type":"string","format":"uri"},"text":{"type":"string"},"stars":{"type":"integer","minimum":1,"maximum":5},"date":{"type":"integer","description":"Unix timestamp in milliseconds"},"dateIso":{"type":"string","format":"date-time"},"likes":{"type":"integer","nullable":true},"photos":{"type":"array","items":{"type":"string"}},"reviewer":{"$ref":"#/components/schemas/GoogleMapsReviewer"},"ownersResponse":{"type":"object","additionalProperties":true,"description":"Owner's response to the review (empty object when none)."},"details":{"type":"object","additionalProperties":{"type":"string"},"description":"Free-form key/value pairs of review metadata (e.g. \"Visited on\", \"Wait time\")."}}},"GoogleMapsReviewer":{"type":"object","properties":{"name":{"type":"string"},"photo":{"type":"string","format":"uri"},"url":{"type":"string","format":"uri"},"totalReviews":{"type":"integer"},"totalPhotos":{"type":"integer"}}}}}}
```

## The GoogleNewsArticle object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"GoogleNewsArticle":{"type":"object","properties":{"title":{"type":"string"},"articleUrl":{"type":"string","format":"uri"},"publishedAt":{"type":"string","format":"date-time"},"imageUrl":{"type":"string","format":"uri-reference","nullable":true},"source":{"type":"string"},"sourceIconUrl":{"type":"string","format":"uri"},"author":{"type":"string","nullable":true}}}}}}
```

## The GooglePlayApplication object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"GooglePlayApplication":{"type":"object","properties":{"title":{"type":"string"},"appId":{"type":"string"},"url":{"type":"string","format":"uri-reference"},"icon":{"type":"string","format":"uri"},"headerImage":{"type":"string","format":"uri"},"summary":{"type":"string"},"description":{"type":"string"},"descriptionHTML":{"type":"string"},"score":{"type":"number"},"scoreText":{"type":"string"},"ratings":{"type":"integer"},"reviews":{"type":"integer"},"histogram":{"type":"object","additionalProperties":{"type":"integer"},"description":"Rating histogram, keyed by star count (1-5)."},"free":{"type":"boolean"},"price":{"type":"number"},"priceText":{"type":"string"},"currency":{"type":"string"},"offersIAP":{"type":"boolean"},"adSupported":{"type":"boolean"},"installs":{"type":"string"},"minInstalls":{"type":"integer"},"maxInstalls":{"type":"integer"},"androidVersion":{"type":"string"},"androidVersionText":{"type":"string"},"updated":{"type":"integer","description":"Unix timestamp in milliseconds"},"genre":{"type":"string"},"genreId":{"type":"string"},"developer":{"type":"string"},"developerId":{"type":"string"},"developerEmail":{"type":"string"},"developerWebsite":{"type":"string","format":"uri"},"developerInternalID":{"type":"string"},"privacyPolicy":{"type":"string","format":"uri"},"playstoreUrl":{"type":"string","format":"uri"},"screenshots":{"type":"array","items":{"type":"string"}}}}}}}
```

## The GooglePlayApplicationSummary object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"GooglePlayApplicationSummary":{"type":"object","description":"Lightweight app reference returned by search and similar endpoints.","properties":{"title":{"type":"string"},"appId":{"type":"string"},"url":{"type":"string","format":"uri-reference"},"icon":{"type":"string","format":"uri"},"summary":{"type":"string"},"score":{"type":"number"},"scoreText":{"type":"string"},"free":{"type":"boolean"},"price":{"type":"number"},"currency":{"type":"string"},"playstoreUrl":{"type":"string","format":"uri"},"developer":{"type":"string"},"developerId":{"type":"string"}}}}}}
```

## The GooglePlayReviewCriteria object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"GooglePlayReviewCriteria":{"type":"object","properties":{"criteria":{"type":"string"},"rating":{"type":"integer"}}}}}}
```

## The GooglePlayReview object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"GooglePlayReview":{"type":"object","properties":{"id":{"type":"string"},"userName":{"type":"string"},"userImage":{"type":"string","format":"uri"},"date":{"type":"string","format":"date-time"},"score":{"type":"integer","minimum":1,"maximum":5},"scoreText":{"type":"string"},"url":{"type":"string","format":"uri"},"title":{"type":"string","nullable":true},"text":{"type":"string"},"replyDate":{"type":"string","format":"date-time","nullable":true},"replyText":{"type":"string","nullable":true},"version":{"type":"string"},"thumbsUp":{"type":"integer"},"country":{"type":"string"},"criterias":{"type":"array","items":{"$ref":"#/components/schemas/GooglePlayReviewCriteria"}}}},"GooglePlayReviewCriteria":{"type":"object","properties":{"criteria":{"type":"string"},"rating":{"type":"integer"}}}}}}
```

## The GooglePlayPermission object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"GooglePlayPermission":{"type":"object","properties":{"permission":{"type":"string"},"type":{"type":"string"}}}}}}
```

## The GooglePlayDataSafetyItem object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"GooglePlayDataSafetyItem":{"type":"object","properties":{"data":{"type":"string"},"purpose":{"type":"string"},"type":{"type":"string"},"optional":{"type":"boolean"}}}}}}
```

## The GooglePlaySecurityPractice object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"GooglePlaySecurityPractice":{"type":"object","properties":{"practice":{"type":"string"},"description":{"type":"string"}}}}}}
```

## The GooglePlayDataSafety object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"GooglePlayDataSafety":{"type":"object","properties":{"sharedData":{"type":"array","items":{"$ref":"#/components/schemas/GooglePlayDataSafetyItem"}},"collectedData":{"type":"array","items":{"$ref":"#/components/schemas/GooglePlayDataSafetyItem"}},"securityPractices":{"type":"array","items":{"$ref":"#/components/schemas/GooglePlaySecurityPractice"}},"privacyPolicyUrl":{"type":"string","format":"uri"}}},"GooglePlayDataSafetyItem":{"type":"object","properties":{"data":{"type":"string"},"purpose":{"type":"string"},"type":{"type":"string"},"optional":{"type":"boolean"}}},"GooglePlaySecurityPractice":{"type":"object","properties":{"practice":{"type":"string"},"description":{"type":"string"}}}}}}
```

## The GoogleSearchResult object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"GoogleSearchResult":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"link":{"type":"string","format":"uri"},"snippet":{"type":"string"}}}}}}
```

## The RedditAuthor object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"RedditAuthor":{"type":"object","description":"Lightweight author reference embedded in posts and comments.","properties":{"id":{"type":"string"},"username":{"type":"string"},"isBlocked":{"type":"boolean"},"isDeleted":{"type":"boolean"}}}}}}
```

## The RedditSubredditRef object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"RedditSubredditRef":{"type":"object","description":"Lightweight subreddit reference embedded in posts and comments.","properties":{"id":{"type":"string"},"name":{"type":"string"},"prefixedName":{"type":"string"},"type":{"type":"string"}}}}}}
```

## The RedditPost object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"RedditPost":{"type":"object","description":"A Reddit post (link or self-text).","properties":{"type":{"type":"string"},"id":{"type":"string"},"title":{"type":"string"},"text":{"type":"string"},"textHTML":{"type":"string"},"url":{"type":"string"},"created":{"type":"integer","description":"Unix timestamp in seconds."},"editedAt":{"oneOf":[{"type":"integer"},{"type":"boolean"}]},"score":{"type":"integer"},"upvotes":{"type":"integer"},"downvotes":{"type":"integer"},"upvoteRatio":{"type":"number"},"numComments":{"type":"integer"},"viewCount":{"type":"integer","nullable":true},"goldCount":{"type":"integer"},"numCrossposts":{"type":"integer"},"isLocked":{"type":"boolean"},"isStickied":{"type":"boolean"},"isArchived":{"type":"boolean"},"isOriginalContent":{"type":"boolean"},"isCrosspostable":{"type":"boolean"},"isNSFW":{"type":"boolean"},"isSpoiler":{"type":"boolean"},"isMediaOnly":{"type":"boolean"},"isSponsored":{"type":"boolean"},"isMeta":{"type":"boolean"},"isGildable":{"type":"boolean"},"isScoreHidden":{"type":"boolean"},"contestMode":{"type":"boolean"},"hidden":{"type":"boolean"},"sendReplies":{"type":"boolean"},"author":{"$ref":"#/components/schemas/RedditAuthor"},"subreddit":{"$ref":"#/components/schemas/RedditSubredditRef"},"flair":{"type":"object","nullable":true},"thumbnail":{"type":"object","additionalProperties":true},"preview":{"type":"object","additionalProperties":true},"awards":{"type":"array","items":{"type":"object","additionalProperties":true}},"flairs":{"type":"array","items":{"type":"object","additionalProperties":true}},"gallery":{"type":"array","items":{"type":"object","additionalProperties":true}},"crosspostParents":{"type":"array","items":{"type":"object","additionalProperties":true}}}},"RedditAuthor":{"type":"object","description":"Lightweight author reference embedded in posts and comments.","properties":{"id":{"type":"string"},"username":{"type":"string"},"isBlocked":{"type":"boolean"},"isDeleted":{"type":"boolean"}}},"RedditSubredditRef":{"type":"object","description":"Lightweight subreddit reference embedded in posts and comments.","properties":{"id":{"type":"string"},"name":{"type":"string"},"prefixedName":{"type":"string"},"type":{"type":"string"}}}}}}
```

## The RedditComment object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"RedditComment":{"type":"object","description":"A Reddit comment.","properties":{"type":{"type":"string"},"id":{"type":"string"},"postId":{"type":"string"},"parentId":{"type":"string"},"body":{"type":"string"},"bodyHTML":{"type":"string"},"url":{"type":"string"},"createdAt":{"type":"integer","description":"Unix timestamp in seconds."},"editedAt":{"oneOf":[{"type":"integer"},{"type":"boolean"}]},"score":{"type":"integer"},"upvotes":{"type":"integer"},"downvotes":{"type":"integer"},"goldCount":{"type":"integer"},"totalAwardsReceived":{"type":"integer"},"controversiality":{"type":"integer"},"isLocked":{"type":"boolean"},"isStickied":{"type":"boolean"},"isArchived":{"type":"boolean"},"isSaved":{"type":"boolean"},"isScoreHidden":{"type":"boolean"},"isCollapsed":{"type":"boolean"},"noFollow":{"type":"boolean"},"sendReplies":{"type":"boolean"},"hasReplies":{"type":"boolean"},"author":{"$ref":"#/components/schemas/RedditAuthor"},"subreddit":{"$ref":"#/components/schemas/RedditSubredditRef"},"awards":{"type":"array","items":{"type":"object","additionalProperties":true}}}},"RedditAuthor":{"type":"object","description":"Lightweight author reference embedded in posts and comments.","properties":{"id":{"type":"string"},"username":{"type":"string"},"isBlocked":{"type":"boolean"},"isDeleted":{"type":"boolean"}}},"RedditSubredditRef":{"type":"object","description":"Lightweight subreddit reference embedded in posts and comments.","properties":{"id":{"type":"string"},"name":{"type":"string"},"prefixedName":{"type":"string"},"type":{"type":"string"}}}}}}
```

## The RedditUser object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"RedditUser":{"type":"object","description":"A Reddit user profile.","properties":{"type":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"createdAt":{"type":"integer","description":"Unix timestamp in seconds."},"iconImage":{"type":"string"},"snoovatarImage":{"type":"string"},"bannerImage":{"type":"string"},"awarderKarma":{"type":"integer"},"postKarma":{"type":"integer"},"commentKarma":{"type":"integer"},"totalKarma":{"type":"integer"},"hasVerifiedEmail":{"type":"boolean"},"over18":{"type":"boolean"}}}}}}
```

## The RedditSubreddit object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"RedditSubreddit":{"type":"object","description":"A subreddit profile.","properties":{"type":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"prefixedName":{"type":"string"},"title":{"type":"string"},"subType":{"type":"string"},"description":{"type":"string"},"descriptionHtml":{"type":"string"},"publicDescription":{"type":"string"},"publicDescriptionHtml":{"type":"string"},"submitText":{"type":"string"},"submitTextHtml":{"type":"string","nullable":true},"submissionType":{"type":"string"},"advertiserCategory":{"type":"string"},"language":{"type":"string"},"url":{"type":"string"},"headerTitle":{"type":"string"},"iconImage":{"type":"string"},"iconSize":{"type":"array","nullable":true,"items":{"type":"integer"}},"bannerImage":{"type":"string"},"bannerBackgroundImage":{"type":"string"},"bannerSize":{"type":"array","nullable":true,"items":{"type":"integer"}},"headerImage":{"type":"string"},"headerSize":{"type":"array","items":{"type":"integer"}},"primaryColor":{"type":"string"},"keyColor":{"type":"string"},"createdAt":{"type":"integer","description":"Unix timestamp in seconds."},"subscribers":{"type":"integer"},"commentScoreHideMins":{"type":"integer"},"notificationLevel":{"type":"string","nullable":true},"suggestedCommentSort":{"type":"string","nullable":true},"userFlairEnabled":{"type":"boolean"},"linkFlairEnabled":{"type":"boolean"},"wikiEnabled":{"type":"boolean"},"emojisEnabled":{"type":"boolean"},"spoilersEnabled":{"type":"boolean"},"allowImages":{"type":"boolean"},"allowVideos":{"type":"boolean"},"allowGalleries":{"type":"boolean"},"allowPolls":{"type":"boolean"},"allowPredictions":{"type":"boolean"},"allowTalks":{"type":"boolean"},"allowDiscovery":{"type":"boolean"},"isCrosspostable":{"type":"boolean"},"publicTraffic":{"type":"boolean"},"showMediaPreview":{"type":"boolean"},"showMedia":{"type":"boolean"},"collapseDeletedComments":{"type":"boolean"},"shouldArchivePosts":{"type":"boolean"},"canAssignUserFlair":{"type":"boolean"},"canAssignLinkFlair":{"type":"boolean"},"restrictCommenting":{"type":"boolean"},"restrictPosting":{"type":"boolean"},"communityReviewed":{"type":"boolean"},"flairPosition":{"type":"string"},"linkFlairPosition":{"type":"string"}}}}}}
```

## The InstagramUserIdLookup object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"InstagramUserIdLookup":{"type":"object","description":"Result of resolving an Instagram user ID from a handle.","properties":{"isAvailable":{"type":"boolean"},"handle":{"type":"string"},"id":{"type":"string","description":"Present only when `isAvailable` is true."}}}}}}
```

## The InstagramUser object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"InstagramUser":{"type":"object","description":"An Instagram user profile.","properties":{"type":{"type":"string"},"isAvailable":{"type":"boolean"},"id":{"type":"string"},"username":{"type":"string"},"fullName":{"type":"string"},"biography":{"type":"string"},"profilePicUrl":{"type":"string"},"website":{"type":"string"},"category":{"type":"string"},"cityName":{"type":"string","nullable":true},"isPrivate":{"type":"boolean"},"isVerified":{"type":"boolean"},"isBusiness":{"type":"boolean"},"hasVideos":{"type":"boolean"},"hasGuides":{"type":"boolean"},"postCount":{"type":"integer"},"followerCount":{"type":"integer"},"followingCount":{"type":"integer"},"totalReelsCount":{"type":"integer"},"bioLinks":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}
```

## The InstagramPostOwner object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"InstagramPostOwner":{"type":"object","description":"Lightweight user reference embedded in posts and stories.","properties":{"id":{"type":"string"},"username":{"type":"string"},"fullName":{"type":"string"},"profilePicUrl":{"type":"string"},"isVerified":{"type":"boolean"},"isPrivate":{"type":"boolean"}}}}}}
```

## The InstagramPost object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"InstagramPost":{"type":"object","description":"An Instagram post (image, video, carousel, or reel).","properties":{"type":{"type":"string","description":"photo / video / carousel / reel"},"id":{"type":"string"},"code":{"type":"string"},"url":{"type":"string"},"caption":{"type":"string"},"createdAt":{"type":"integer","description":"Unix timestamp in seconds."},"likeCount":{"type":"integer"},"commentCount":{"type":"integer"},"isAvailable":{"type":"boolean"},"isCarousel":{"type":"boolean"},"isVideo":{"type":"boolean"},"isPinned":{"type":"boolean"},"isPaidPartnership":{"type":"boolean"},"isLikeAndViewCountsDisabled":{"type":"boolean"},"owner":{"$ref":"#/components/schemas/InstagramPostOwner"},"coowners":{"type":"array","items":{"$ref":"#/components/schemas/InstagramPostOwner"}},"location":{"type":"object","nullable":true,"additionalProperties":true},"image":{"type":"object","nullable":true,"additionalProperties":true},"video":{"type":"object","nullable":true,"additionalProperties":true},"audio":{"type":"object","nullable":true,"additionalProperties":true},"carouselMedia":{"type":"array","items":{"type":"object","additionalProperties":true}}}},"InstagramPostOwner":{"type":"object","description":"Lightweight user reference embedded in posts and stories.","properties":{"id":{"type":"string"},"username":{"type":"string"},"fullName":{"type":"string"},"profilePicUrl":{"type":"string"},"isVerified":{"type":"boolean"},"isPrivate":{"type":"boolean"}}}}}}
```

## The InstagramComment object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"InstagramComment":{"type":"object","description":"A comment on an Instagram post.","properties":{"type":{"type":"string"},"id":{"type":"string"},"userId":{"type":"string"},"message":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"likeCount":{"type":"integer"},"replyCount":{"type":"integer"},"isRanked":{"type":"boolean"},"user":{"type":"object","additionalProperties":true,"properties":{"id":{"type":"string"},"username":{"type":"string"},"fullName":{"type":"string"},"profilePicUrl":{"type":"string"},"isPrivate":{"type":"boolean"},"isVerified":{"type":"boolean"}}}}}}}}
```

## The InstagramStory object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"InstagramStory":{"type":"object","description":"A single Instagram story slide.","properties":{"type":{"type":"string","description":"photo / video"},"id":{"type":"string"},"code":{"type":"string"},"createdAt":{"type":"integer","description":"Unix timestamp in seconds."},"expiringAt":{"type":"integer","description":"Unix timestamp in seconds."},"duration":{"type":"number"},"hasAudio":{"type":"boolean"},"hasTranslation":{"type":"boolean"},"canReshare":{"type":"boolean"},"canReply":{"type":"boolean"},"isVideo":{"type":"boolean"},"owner":{"$ref":"#/components/schemas/InstagramPostOwner"},"coowners":{"type":"array","items":{"$ref":"#/components/schemas/InstagramPostOwner"}},"image":{"type":"object","nullable":true,"additionalProperties":true},"video":{"type":"object","nullable":true,"additionalProperties":true},"audio":{"type":"object","nullable":true,"additionalProperties":true},"link":{"type":"object","nullable":true,"additionalProperties":true},"comments":{"type":"array","items":{"type":"object","additionalProperties":true}},"mentions":{"type":"array","items":{"type":"object","additionalProperties":true}},"hashtags":{"type":"array","items":{"type":"object","additionalProperties":true}}}},"InstagramPostOwner":{"type":"object","description":"Lightweight user reference embedded in posts and stories.","properties":{"id":{"type":"string"},"username":{"type":"string"},"fullName":{"type":"string"},"profilePicUrl":{"type":"string"},"isVerified":{"type":"boolean"},"isPrivate":{"type":"boolean"}}}}}}
```

## The TiktokUser object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"TiktokUser":{"type":"object","description":"A TikTok user profile.","properties":{"id":{"type":"string"},"username":{"type":"string"},"nickname":{"type":"string"},"url":{"type":"string"},"bio":{"type":"string"},"bioUrl":{"type":"string"},"avatar":{"type":"string"},"verified":{"type":"boolean"},"profileCategory":{"type":"string"},"followers":{"type":"integer"},"following":{"type":"integer"},"likes":{"type":"integer"},"videos":{"type":"integer"}}}}}}
```

## The TiktokPostChannel object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"TiktokPostChannel":{"type":"object","description":"Lightweight user reference embedded in posts (post's author / channel).","properties":{"id":{"type":"string"},"username":{"type":"string"},"name":{"type":"string"},"bio":{"type":"string"},"avatar":{"type":"string"}}}}}}
```

## The TiktokPost object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"TiktokPost":{"type":"object","description":"A TikTok post (video).","properties":{"id":{"type":"string"},"title":{"type":"string"},"postPage":{"type":"string"},"uploadedAt":{"type":"integer","description":"Unix timestamp in seconds."},"uploadedAtFormatted":{"type":"string","format":"date-time"},"views":{"type":"integer"},"likes":{"type":"integer"},"comments":{"type":"integer"},"shares":{"type":"integer"},"bookmarks":{"type":"integer"},"poi":{"type":"object","nullable":true},"channel":{"$ref":"#/components/schemas/TiktokPostChannel"},"collabInfo":{"type":"object","additionalProperties":true},"video":{"type":"object","additionalProperties":true},"song":{"type":"object","additionalProperties":true},"hashtags":{"type":"array","items":{"type":"object","additionalProperties":true}},"subtitleInformation":{"type":"array","items":{"type":"object","additionalProperties":true}}}},"TiktokPostChannel":{"type":"object","description":"Lightweight user reference embedded in posts (post's author / channel).","properties":{"id":{"type":"string"},"username":{"type":"string"},"name":{"type":"string"},"bio":{"type":"string"},"avatar":{"type":"string"}}}}}}
```

## The TiktokComment object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"TiktokComment":{"type":"object","description":"A comment or reply on a TikTok post.","properties":{"id":{"type":"string"},"parentId":{"type":"string","description":"Present only on replies — references the parent comment ID."},"awemeId":{"type":"string","description":"ID of the post the comment was made on."},"text":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"likeCount":{"type":"integer"},"replyCount":{"type":"integer","description":"Present only on top-level comments."},"commentLanguage":{"type":"string"},"isAuthorLiked":{"type":"boolean"},"user":{"type":"object","additionalProperties":true,"properties":{"id":{"type":"string"},"username":{"type":"string"},"nickname":{"type":"string"},"avatar":{"type":"string"},"verified":{"type":"boolean"}}}}}}}}
```

## The TiktokHashtag object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"TiktokHashtag":{"type":"object","description":"A TikTok hashtag profile.","properties":{"id":{"type":"string"},"name":{"type":"string"},"views":{"type":"integer"}}}}}}
```

## The TwitterUser object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"TwitterUser":{"type":"object","description":"A Twitter user profile.","properties":{"type":{"type":"string"},"id":{"type":"string"},"userName":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"twitterUrl":{"type":"string"},"description":{"type":"string"},"location":{"type":"string"},"profilePicture":{"type":"string"},"coverPicture":{"type":"string"},"isVerified":{"type":"boolean"},"isBlueVerified":{"type":"boolean","nullable":true},"protected":{"type":"boolean"},"canDm":{"type":"boolean"},"canMediaTag":{"type":"boolean"},"followers":{"type":"integer"},"following":{"type":"integer"},"fastFollowersCount":{"type":"integer"},"favouritesCount":{"type":"integer"},"listedCount":{"type":"integer"},"mediaCount":{"type":"integer"},"statusesCount":{"type":"integer"},"createdAt":{"type":"string"},"status":{"type":"string"}}}}}}
```

## The TwitterTweet object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"TwitterTweet":{"type":"object","description":"A single tweet.","properties":{"type":{"type":"string"},"id":{"type":"string"},"url":{"type":"string"},"twitterUrl":{"type":"string"},"text":{"type":"string"},"fullText":{"type":"string"},"source":{"type":"string"},"lang":{"type":"string"},"createdAt":{"type":"string"},"conversationId":{"type":"string"},"retweetCount":{"type":"integer"},"replyCount":{"type":"integer"},"likeCount":{"type":"integer"},"quoteCount":{"type":"integer"},"bookmarkCount":{"type":"integer"},"viewCount":{"type":"integer","nullable":true},"isReply":{"type":"boolean"},"isPinned":{"type":"boolean"},"isRetweet":{"type":"boolean"},"isQuote":{"type":"boolean"},"author":{"$ref":"#/components/schemas/TwitterUser"},"media":{"type":"array","items":{"type":"object","additionalProperties":true}}}},"TwitterUser":{"type":"object","description":"A Twitter user profile.","properties":{"type":{"type":"string"},"id":{"type":"string"},"userName":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"twitterUrl":{"type":"string"},"description":{"type":"string"},"location":{"type":"string"},"profilePicture":{"type":"string"},"coverPicture":{"type":"string"},"isVerified":{"type":"boolean"},"isBlueVerified":{"type":"boolean","nullable":true},"protected":{"type":"boolean"},"canDm":{"type":"boolean"},"canMediaTag":{"type":"boolean"},"followers":{"type":"integer"},"following":{"type":"integer"},"fastFollowersCount":{"type":"integer"},"favouritesCount":{"type":"integer"},"listedCount":{"type":"integer"},"mediaCount":{"type":"integer"},"statusesCount":{"type":"integer"},"createdAt":{"type":"string"},"status":{"type":"string"}}}}}}
```

## The TwitterUserAbout object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"TwitterUserAbout":{"type":"object","description":"Extended profile / about details for a Twitter user.","properties":{"accountBasedIn":{"type":"string"},"locationAccurate":{"type":"boolean"},"profileImageShape":{"type":"string"},"avatarUrl":{"type":"string"},"usernameChangeCount":{"type":"string"},"accountCreatedAt":{"type":"string"},"accountSource":{"type":"string"},"verifiedSince":{"type":"string"}}}}}}
```

## The YelpPlace object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"YelpPlace":{"type":"object","description":"A Yelp place / business profile.","properties":{"id":{"type":"string"},"alias":{"type":"string"},"title":{"type":"string"},"website":{"type":"string"},"phoneNumber":{"type":"string"},"avgRating":{"type":"number"},"unroundedAvgRating":{"type":"number"},"reviewCount":{"type":"integer"},"priceRange":{"type":"string"},"isBusinessClosed":{"type":"boolean"},"primaryPhoto":{"type":"string"},"mediaCount":{"type":"integer"},"address":{"type":"object","additionalProperties":true},"coordinates":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"}}},"categories":{"type":"array","items":{"type":"object","additionalProperties":true}},"operationHours":{"type":"array","items":{"type":"object","additionalProperties":true}},"amenities":{"type":"array","items":{"type":"object","additionalProperties":true}},"about":{"type":"object","additionalProperties":true}}}}}}
```

## The YelpReview object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"YelpReview":{"type":"object","description":"A Yelp review for a place.","properties":{"id":{"type":"string"},"url":{"type":"string"},"rating":{"type":"number"},"text":{"type":"string"},"language":{"type":"string"},"date":{"type":"string","format":"date-time"},"images":{"type":"array","items":{"type":"string"}},"feedback":{"type":"object","additionalProperties":true},"reviewer":{"type":"object","additionalProperties":true,"properties":{"id":{"type":"string"},"name":{"type":"string"},"profileUrl":{"type":"string"},"image":{"type":"string"}}}}}}}}
```

## The YelpSearchResult object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"YelpSearchResult":{"type":"object","description":"A Yelp search result entry (place summary).","properties":{"id":{"type":"string"},"alias":{"type":"string"},"name":{"type":"string"},"rating":{"type":"number"},"reviewCount":{"type":"integer"},"priceRange":{"type":"string"},"phone":{"type":"string","nullable":true},"website":{"type":"string","nullable":true},"coordinates":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"}}},"categories":{"type":"array","items":{"type":"object","additionalProperties":true}},"images":{"type":"array","items":{"type":"string"}}}}}}}
```

## The YoutubeThumbnail object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"YoutubeThumbnail":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"width":{"type":"integer"},"height":{"type":"integer"}}}}}}
```

## The YoutubeChannelRef object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"YoutubeChannelRef":{"type":"object","description":"Lightweight channel reference embedded in video or comment results.","properties":{"id":{"type":"string"},"name":{"type":"string"},"handle":{"type":"string"},"url":{"type":"string","format":"uri"},"subscriberCount":{"type":"string"},"badges":{"type":"array","items":{"type":"string"}},"thumbnails":{"type":"array","items":{"$ref":"#/components/schemas/YoutubeThumbnail"}}}},"YoutubeThumbnail":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"width":{"type":"integer"},"height":{"type":"integer"}}}}}}
```

## The YoutubeChannel object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"YoutubeChannel":{"type":"object","properties":{"type":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"handle":{"type":"string"},"url":{"type":"string","format":"uri"},"description":{"type":"string"},"thumbnails":{"type":"string","format":"uri"},"isFamilySafe":{"type":"boolean"},"subscriberCount":{"type":"string"},"availableCountries":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"joinedAt":{"type":"string"},"viewCount":{"type":"string"},"videoCount":{"type":"integer"}}}}}}
```

## The YoutubeVideo object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"YoutubeVideo":{"type":"object","description":"Video result from search, hashtag, or trending endpoints.","properties":{"type":{"type":"string"},"id":{"type":"string"},"url":{"type":"string","format":"uri"},"title":{"type":"string"},"description":{"type":"string"},"thumbnails":{"type":"array","items":{"$ref":"#/components/schemas/YoutubeThumbnail"}},"richThumbnail":{"type":"array","items":{"$ref":"#/components/schemas/YoutubeThumbnail"}},"channel":{"$ref":"#/components/schemas/YoutubeChannelRef"},"publishDate":{"type":"string"},"views":{"type":"string"},"duration":{"type":"string"}}},"YoutubeThumbnail":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"width":{"type":"integer"},"height":{"type":"integer"}}},"YoutubeChannelRef":{"type":"object","description":"Lightweight channel reference embedded in video or comment results.","properties":{"id":{"type":"string"},"name":{"type":"string"},"handle":{"type":"string"},"url":{"type":"string","format":"uri"},"subscriberCount":{"type":"string"},"badges":{"type":"array","items":{"type":"string"}},"thumbnails":{"type":"array","items":{"$ref":"#/components/schemas/YoutubeThumbnail"}}}}}}}
```

## The YoutubeVideoDetail object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"YoutubeVideoDetail":{"type":"object","description":"Full video metadata returned by /youtube/video.","properties":{"type":{"type":"string"},"id":{"type":"string"},"title":{"type":"string"},"status":{"type":"string"},"url":{"type":"string","format":"uri"},"description":{"type":"string"},"duration":{"type":"integer","description":"Length in seconds."},"views":{"type":"integer"},"likes":{"type":"integer"},"comments":{"type":"integer"},"channel":{"$ref":"#/components/schemas/YoutubeChannelRef"},"keywords":{"type":"array","items":{"type":"string"}},"superTitle":{"type":"string"},"category":{"type":"string"},"isRatingsAllowed":{"type":"boolean"},"isLive":{"type":"boolean"},"isFamilySafe":{"type":"boolean"},"isPrivate":{"type":"boolean"},"isExclusive":{"type":"boolean"},"thumbnails":{"type":"array","items":{"$ref":"#/components/schemas/YoutubeThumbnail"}}}},"YoutubeChannelRef":{"type":"object","description":"Lightweight channel reference embedded in video or comment results.","properties":{"id":{"type":"string"},"name":{"type":"string"},"handle":{"type":"string"},"url":{"type":"string","format":"uri"},"subscriberCount":{"type":"string"},"badges":{"type":"array","items":{"type":"string"}},"thumbnails":{"type":"array","items":{"$ref":"#/components/schemas/YoutubeThumbnail"}}}},"YoutubeThumbnail":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"width":{"type":"integer"},"height":{"type":"integer"}}}}}}
```

## The YoutubeCommentAuthor object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"YoutubeCommentAuthor":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"thumbnails":{"type":"string","format":"uri"}}}}}}
```

## The YoutubeComment object

```json
{"openapi":"3.0.3","info":{"title":"Pullbay API","version":"1.0.0"},"components":{"schemas":{"YoutubeComment":{"type":"object","properties":{"type":{"type":"string"},"id":{"type":"string"},"text":{"type":"string"},"likeCount":{"type":"string"},"replyCount":{"type":"string"},"publishedTime":{"type":"string"},"author":{"$ref":"#/components/schemas/YoutubeCommentAuthor"}}},"YoutubeCommentAuthor":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"thumbnails":{"type":"string","format":"uri"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.pullbay.com/api-reference/models.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
