{"openapi":"3.1.0","info":{"title":"crawlfeed API","version":"1.0.0","description":"Unified social and commerce data API. One key, one envelope, one error vocabulary across\nevery platform.\n\n**Every successful response is `{ data, meta }`.** `meta` carries `credits_used`,\n`credits_remaining`, `cache`, `data_age_s`, `request_id` and, on a page,\n`next_cursor`. Errors are RFC 9457 problem details with a stable `code` — match on\n`code`, never on the message.\n\n## Authentication\n\n`Authorization: Bearer sk_live_…` (or `sk_test_…`). Create a key in the dashboard; it is\nshown once. `/docs` and `/openapi.json` need no key.\n\n## Credits\n\n| platform | credits |\n| --- | --- |\n| amazon, apple_music, appstore, bluesky, facebook, github, google, hackernews, instagram, kick, kwai, linktree, pinterest, reddit, rumble, soundcloud, spotify, threads, tiktok, truthsocial, twitch, x, youtube | 1 |\n| linkedin, snapchat, telegram | 2 |\n\n`?fresh=true` skips the cache and costs 2× the base.\n`?enrich=arabic` adds 3 credits. A fan-out search costs the base of\neach platform it reaches.\n\n**Failures are not charged.** Upstream errors, timeouts, rate limits and validation errors\nare refunded, so a failed call never costs a credit.\n\n## Caching\n\nReads are cached in KV: profiles 1 h, posts and a single post 15 min, comments 10 min,\nsearch 5 min. `X-Cache: HIT|MISS` and `X-Data-Age: <seconds>` report what you got;\na cache hit is charged normally. Use `?fresh=true` to bypass it.\n\n## Pagination\n\nPaged routes return an opaque `meta.next_cursor`. Pass it back as `?cursor=` to continue.\nIts absence means there is nothing more. Cursors are not portable between platforms or ops.\n\n## Not every platform serves every operation\n\nPlatforms differ, and this API does not pretend otherwise: an operation a platform does not\noffer returns `503 platform_unavailable` with a detail naming the missing route, rather\nthan an empty result that looks like \"no data\". Commerce operations are storefront platforms\nonly.\n\nGitHub posts are public repositories; Spotify posts are artist albums. App Store profiles\nare apps looked up by numeric ID or bundle ID. Hacker News has no official search endpoint.\nReddit and Spotify content cannot be sent through `?enrich=arabic` or an enriched fan-out search.\n\n## Tiers\n\nTier A (these routes) normalises into the universal schema. Tier C\n(`GET /v1/raw/{provider}/{path}`) proxies an allow-listed provider route verbatim with the\nsame envelope, credits and errors, but no schema promise — the long tail, without waiting\nfor a mapper."},"servers":[{"url":"https://api.crawlfeed.dev"}],"security":[{"bearerAuth":[]}],"tags":[{"name":"account","description":"Your key, balance and limits."},{"name":"profiles","description":"Public profiles, by handle."},{"name":"posts","description":"Posts and their comments."},{"name":"search","description":"Search one platform, or fan out across several."},{"name":"comments","description":"Comments and replies."},{"name":"media","description":"Transcripts, reels and collections: playlists, boards, highlights."},{"name":"music","description":"Tracks, sounds and the videos that use them."},{"name":"communities","description":"Subreddits, groups and X communities, and their posts."},{"name":"shops","description":"TikTok Shop and creator storefronts: products and reviews."},{"name":"ads","description":"Public ad libraries: Meta, Google, LinkedIn and TikTok."},{"name":"events","description":"Public events."},{"name":"commerce","description":"Storefronts, products and reviews.","x-internal":true},{"name":"enrich","description":"Arabic dialect, sentiment, entities and topics."},{"name":"raw","description":"Tier C passthrough: provider payloads, no schema promise."}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"API key: `Authorization: Bearer sk_live_…` or `sk_test_…`"}},"schemas":{"Health":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]},"environment":{"type":"string"},"platforms":{"type":"object","additionalProperties":{"type":"string","enum":["ok","degraded","down","unknown"]}}},"required":["status","environment","platforms"]},"Me":{"type":"object","properties":{"key":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string"},"prefix":{"type":"string","minLength":1},"environment":{"type":"string","enum":["live","test"]},"created_at":{"type":"string","format":"date-time"},"last_used_at":{"type":"string","nullable":true,"format":"date-time"}},"required":["id","name","prefix","environment","created_at","last_used_at"]},"credits":{"type":"object","properties":{"balance":{"type":"integer","minimum":0}},"required":["balance"]},"limits":{"type":"object","properties":{"rate":{"$ref":"#/components/schemas/RateLimit"}},"required":["rate"]}},"required":["key","credits","limits"]},"RateLimit":{"type":"object","nullable":true,"properties":{"capacity":{"type":"integer","minimum":0,"exclusiveMinimum":true},"refill_per_s":{"type":"number","minimum":0,"exclusiveMinimum":true},"remaining":{"type":"number","minimum":0}},"required":["capacity","refill_per_s","remaining"]},"Meta":{"type":"object","properties":{"credits_used":{"type":"integer","minimum":0},"credits_remaining":{"type":"integer","minimum":0},"cache":{"type":"string","enum":["HIT","MISS"]},"data_age_s":{"type":"integer","minimum":0},"request_id":{"type":"string","minLength":1},"next_cursor":{"type":"string","minLength":1},"raw":{"nullable":true},"platforms":{"type":"object","properties":{"tiktok":{"type":"string","enum":["ok","error","pending"]},"instagram":{"type":"string","enum":["ok","error","pending"]},"x":{"type":"string","enum":["ok","error","pending"]},"youtube":{"type":"string","enum":["ok","error","pending"]},"snapchat":{"type":"string","enum":["ok","error","pending"]},"facebook":{"type":"string","enum":["ok","error","pending"]},"threads":{"type":"string","enum":["ok","error","pending"]},"linkedin":{"type":"string","enum":["ok","error","pending"]},"twitch":{"type":"string","enum":["ok","error","pending"]},"telegram":{"type":"string","enum":["ok","error","pending"]},"linktree":{"type":"string","enum":["ok","error","pending"]},"bluesky":{"type":"string","enum":["ok","error","pending"]},"salla":{"type":"string","enum":["ok","error","pending"]},"zid":{"type":"string","enum":["ok","error","pending"]},"mock":{"type":"string","enum":["ok","error","pending"]},"reddit":{"type":"string","enum":["ok","error","pending"]},"pinterest":{"type":"string","enum":["ok","error","pending"]},"truthsocial":{"type":"string","enum":["ok","error","pending"]},"kick":{"type":"string","enum":["ok","error","pending"]},"rumble":{"type":"string","enum":["ok","error","pending"]},"kwai":{"type":"string","enum":["ok","error","pending"]},"github":{"type":"string","enum":["ok","error","pending"]},"spotify":{"type":"string","enum":["ok","error","pending"]},"soundcloud":{"type":"string","enum":["ok","error","pending"]},"apple_music":{"type":"string","enum":["ok","error","pending"]},"google":{"type":"string","enum":["ok","error","pending"]},"amazon":{"type":"string","enum":["ok","error","pending"]},"hackernews":{"type":"string","enum":["ok","error","pending"]},"appstore":{"type":"string","enum":["ok","error","pending"]}}},"job_id":{"type":"string","minLength":1}},"required":["credits_used","credits_remaining","cache","data_age_s","request_id"]},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","format":"uri"},"title":{"type":"string"},"status":{"type":"integer","minimum":400,"maximum":599},"detail":{"type":"string"},"code":{"type":"string","enum":["unauthorized","insufficient_credits","rate_limited","not_found","platform_unavailable","invalid_request","upstream_timeout","internal_error"]},"request_id":{"type":"string","minLength":1},"retry_after":{"type":"integer","minimum":0}},"required":["type","title","status","detail","code","request_id"]},"Profile":{"type":"object","properties":{"platform":{"type":"string","enum":["tiktok","instagram","x","youtube","snapchat","facebook","threads","linkedin","twitch","telegram","linktree","bluesky","salla","zid","mock","reddit","pinterest","truthsocial","kick","rumble","kwai","github","spotify","soundcloud","apple_music","google","amazon","hackernews","appstore"]},"id":{"type":"string","minLength":1},"url":{"type":"string","format":"uri"},"fetched_at":{"type":"string","format":"date-time"},"source":{"anyOf":[{"type":"string","enum":["official"]},{"type":"string","enum":["own"]},{"type":"string","pattern":"^upstream:.*$"}]},"raw":{"nullable":true},"enrichment":{"$ref":"#/components/schemas/Enrichment"},"handle":{"type":"string","minLength":1},"display_name":{"type":"string","nullable":true},"bio":{"type":"string","nullable":true},"avatar_url":{"type":"string","nullable":true,"format":"uri"},"verified":{"type":"boolean"},"followers":{"type":"integer","nullable":true,"minimum":0},"following":{"type":"integer","nullable":true,"minimum":0},"posts_count":{"type":"integer","nullable":true,"minimum":0},"lang":{"type":"string","nullable":true,"minLength":2},"country":{"type":"string","nullable":true,"minLength":2,"maxLength":2},"links":{"type":"array","items":{"type":"string","format":"uri"}}},"required":["platform","id","url","fetched_at","source","handle","display_name","bio","avatar_url","verified","followers","following","posts_count","lang","country","links"]},"Enrichment":{"type":"object","nullable":true,"properties":{"dialect":{"type":"string","enum":["gulf","egyptian","levantine","maghrebi","msa","mixed","not_arabic"]},"sentiment":{"type":"object","properties":{"label":{"type":"string","enum":["positive","neutral","negative"]},"score":{"type":"number","minimum":-1,"maximum":1}},"required":["label","score"]},"entities":{"type":"array","items":{"$ref":"#/components/schemas/Entity"}},"topics":{"type":"array","items":{"type":"string"}}},"required":["dialect","sentiment","entities","topics"]},"Entity":{"type":"object","properties":{"text":{"type":"string","minLength":1},"type":{"type":"string","minLength":1}},"required":["text","type"]},"Post":{"type":"object","properties":{"platform":{"type":"string","enum":["tiktok","instagram","x","youtube","snapchat","facebook","threads","linkedin","twitch","telegram","linktree","bluesky","salla","zid","mock","reddit","pinterest","truthsocial","kick","rumble","kwai","github","spotify","soundcloud","apple_music","google","amazon","hackernews","appstore"]},"id":{"type":"string","minLength":1},"url":{"type":"string","format":"uri"},"fetched_at":{"type":"string","format":"date-time"},"source":{"anyOf":[{"type":"string","enum":["official"]},{"type":"string","enum":["own"]},{"type":"string","pattern":"^upstream:.*$"}]},"raw":{"nullable":true},"enrichment":{"$ref":"#/components/schemas/Enrichment"},"author":{"type":"object","properties":{"platform":{"type":"string","enum":["tiktok","instagram","x","youtube","snapchat","facebook","threads","linkedin","twitch","telegram","linktree","bluesky","salla","zid","mock","reddit","pinterest","truthsocial","kick","rumble","kwai","github","spotify","soundcloud","apple_music","google","amazon","hackernews","appstore"]},"id":{"type":"string","minLength":1},"handle":{"type":"string","minLength":1},"display_name":{"type":"string","nullable":true},"avatar_url":{"type":"string","nullable":true,"format":"uri"}},"required":["platform","id","handle","display_name","avatar_url"]},"text":{"type":"string"},"lang":{"type":"string","nullable":true,"minLength":2},"created_at":{"type":"string","nullable":true,"format":"date-time"},"media":{"type":"array","items":{"$ref":"#/components/schemas/Media"}},"engagement":{"$ref":"#/components/schemas/Engagement"},"hashtags":{"type":"array","items":{"type":"string"}},"mentions":{"type":"array","items":{"type":"string"}},"is_ad":{"type":"boolean"}},"required":["platform","id","url","fetched_at","source","author","text","lang","created_at","media","engagement","hashtags","mentions","is_ad"]},"Media":{"type":"object","properties":{"type":{"type":"string","enum":["image","video","audio"]},"url":{"type":"string","format":"uri"},"thumbnail_url":{"type":"string","nullable":true,"format":"uri"},"duration_s":{"type":"number","minimum":0}},"required":["type","url","thumbnail_url"]},"Engagement":{"type":"object","properties":{"likes":{"type":"integer","nullable":true,"minimum":0},"comments":{"type":"integer","nullable":true,"minimum":0},"shares":{"type":"integer","nullable":true,"minimum":0},"views":{"type":"integer","nullable":true,"minimum":0},"saves":{"type":"integer","nullable":true,"minimum":0}},"required":["likes","comments","shares","views","saves"]},"Comment":{"type":"object","properties":{"platform":{"type":"string","enum":["tiktok","instagram","x","youtube","snapchat","facebook","threads","linkedin","twitch","telegram","linktree","bluesky","salla","zid","mock","reddit","pinterest","truthsocial","kick","rumble","kwai","github","spotify","soundcloud","apple_music","google","amazon","hackernews","appstore"]},"id":{"type":"string","minLength":1},"url":{"type":"string","format":"uri"},"fetched_at":{"type":"string","format":"date-time"},"source":{"anyOf":[{"type":"string","enum":["official"]},{"type":"string","enum":["own"]},{"type":"string","pattern":"^upstream:.*$"}]},"raw":{"nullable":true},"enrichment":{"$ref":"#/components/schemas/Enrichment"},"post_id":{"type":"string","minLength":1},"author":{"type":"object","properties":{"platform":{"type":"string","enum":["tiktok","instagram","x","youtube","snapchat","facebook","threads","linkedin","twitch","telegram","linktree","bluesky","salla","zid","mock","reddit","pinterest","truthsocial","kick","rumble","kwai","github","spotify","soundcloud","apple_music","google","amazon","hackernews","appstore"]},"id":{"type":"string","minLength":1},"handle":{"type":"string","minLength":1},"display_name":{"type":"string","nullable":true},"avatar_url":{"type":"string","nullable":true,"format":"uri"}},"required":["platform","id","handle","display_name","avatar_url"]},"text":{"type":"string"},"lang":{"type":"string","nullable":true,"minLength":2},"created_at":{"type":"string","nullable":true,"format":"date-time"},"likes":{"type":"integer","nullable":true,"minimum":0},"reply_to_id":{"type":"string","nullable":true}},"required":["platform","id","url","fetched_at","source","post_id","author","text","lang","created_at","likes","reply_to_id"]},"Audience":{"type":"object","properties":{"platform":{"type":"string","enum":["tiktok","instagram","x","youtube","snapchat","facebook","threads","linkedin","twitch","telegram","linktree","bluesky","salla","zid","mock","reddit","pinterest","truthsocial","kick","rumble","kwai","github","spotify","soundcloud","apple_music","google","amazon","hackernews","appstore"]},"id":{"type":"string","minLength":1},"url":{"type":"string","format":"uri"},"fetched_at":{"type":"string","format":"date-time"},"source":{"anyOf":[{"type":"string","enum":["official"]},{"type":"string","enum":["own"]},{"type":"string","pattern":"^upstream:.*$"}]},"raw":{"nullable":true},"enrichment":{"$ref":"#/components/schemas/Enrichment"},"handle":{"type":"string","minLength":1},"countries":{"type":"array","items":{"$ref":"#/components/schemas/AudienceCountry"}}},"required":["platform","id","url","fetched_at","source","handle","countries"]},"AudienceCountry":{"type":"object","properties":{"country":{"type":"string","nullable":true,"minLength":2,"maxLength":2},"name":{"type":"string"},"share":{"type":"number","minimum":0,"maximum":1},"count":{"type":"integer","nullable":true,"minimum":0}},"required":["country","name","share","count"]},"LiveStream":{"type":"object","properties":{"platform":{"type":"string","enum":["tiktok","instagram","x","youtube","snapchat","facebook","threads","linkedin","twitch","telegram","linktree","bluesky","salla","zid","mock","reddit","pinterest","truthsocial","kick","rumble","kwai","github","spotify","soundcloud","apple_music","google","amazon","hackernews","appstore"]},"id":{"type":"string","minLength":1},"url":{"type":"string","format":"uri"},"fetched_at":{"type":"string","format":"date-time"},"source":{"anyOf":[{"type":"string","enum":["official"]},{"type":"string","enum":["own"]},{"type":"string","pattern":"^upstream:.*$"}]},"raw":{"nullable":true},"enrichment":{"$ref":"#/components/schemas/Enrichment"},"host":{"type":"object","properties":{"platform":{"type":"string","enum":["tiktok","instagram","x","youtube","snapchat","facebook","threads","linkedin","twitch","telegram","linktree","bluesky","salla","zid","mock","reddit","pinterest","truthsocial","kick","rumble","kwai","github","spotify","soundcloud","apple_music","google","amazon","hackernews","appstore"]},"id":{"type":"string","minLength":1},"handle":{"type":"string","minLength":1},"display_name":{"type":"string","nullable":true},"avatar_url":{"type":"string","nullable":true,"format":"uri"}},"required":["platform","id","handle","display_name","avatar_url"]},"is_live":{"type":"boolean"},"title":{"type":"string","nullable":true},"viewers":{"type":"integer","nullable":true,"minimum":0},"likes":{"type":"integer","nullable":true,"minimum":0},"started_at":{"type":"string","nullable":true,"format":"date-time"},"thumbnail_url":{"type":"string","nullable":true,"format":"uri"}},"required":["platform","id","url","fetched_at","source","host","is_live","title","viewers","likes","started_at","thumbnail_url"]},"LinkedProfile":{"type":"object","properties":{"platform":{"type":"string","enum":["tiktok","instagram","x","youtube","snapchat","facebook","threads","linkedin","twitch","telegram","linktree","bluesky","salla","zid","mock","reddit","pinterest","truthsocial","kick","rumble","kwai","github","spotify","soundcloud","apple_music","google","amazon","hackernews","appstore"]},"id":{"type":"string","minLength":1},"url":{"type":"string","format":"uri"},"fetched_at":{"type":"string","format":"date-time"},"source":{"anyOf":[{"type":"string","enum":["official"]},{"type":"string","enum":["own"]},{"type":"string","pattern":"^upstream:.*$"}]},"raw":{"nullable":true},"enrichment":{"$ref":"#/components/schemas/Enrichment"},"handle":{"type":"string","minLength":1},"confidence":{"type":"number","minimum":0,"maximum":1},"evidence":{"type":"array","items":{"type":"string"}}},"required":["platform","id","url","fetched_at","source","handle","confidence","evidence"]},"Transcript":{"type":"object","properties":{"platform":{"type":"string","enum":["tiktok","instagram","x","youtube","snapchat","facebook","threads","linkedin","twitch","telegram","linktree","bluesky","salla","zid","mock","reddit","pinterest","truthsocial","kick","rumble","kwai","github","spotify","soundcloud","apple_music","google","amazon","hackernews","appstore"]},"id":{"type":"string","minLength":1},"url":{"type":"string","format":"uri"},"fetched_at":{"type":"string","format":"date-time"},"source":{"anyOf":[{"type":"string","enum":["official"]},{"type":"string","enum":["own"]},{"type":"string","pattern":"^upstream:.*$"}]},"raw":{"nullable":true},"enrichment":{"$ref":"#/components/schemas/Enrichment"},"post_id":{"type":"string","minLength":1},"lang":{"type":"string","nullable":true,"minLength":2},"text":{"type":"string"},"segments":{"type":"array","items":{"$ref":"#/components/schemas/TranscriptSegment"}}},"required":["platform","id","url","fetched_at","source","post_id","lang","text","segments"]},"TranscriptSegment":{"type":"object","properties":{"start_s":{"type":"number","nullable":true,"minimum":0},"end_s":{"type":"number","nullable":true,"minimum":0},"text":{"type":"string"}},"required":["start_s","end_s","text"]},"Suggestion":{"type":"object","properties":{"platform":{"type":"string","enum":["tiktok","instagram","x","youtube","snapchat","facebook","threads","linkedin","twitch","telegram","linktree","bluesky","salla","zid","mock","reddit","pinterest","truthsocial","kick","rumble","kwai","github","spotify","soundcloud","apple_music","google","amazon","hackernews","appstore"]},"id":{"type":"string","minLength":1},"url":{"type":"string","format":"uri"},"fetched_at":{"type":"string","format":"date-time"},"source":{"anyOf":[{"type":"string","enum":["official"]},{"type":"string","enum":["own"]},{"type":"string","pattern":"^upstream:.*$"}]},"raw":{"nullable":true},"enrichment":{"$ref":"#/components/schemas/Enrichment"},"text":{"type":"string","minLength":1},"kind":{"type":"string","enum":["query","profile"]},"profile":{"type":"object","nullable":true,"properties":{"platform":{"type":"string","enum":["tiktok","instagram","x","youtube","snapchat","facebook","threads","linkedin","twitch","telegram","linktree","bluesky","salla","zid","mock","reddit","pinterest","truthsocial","kick","rumble","kwai","github","spotify","soundcloud","apple_music","google","amazon","hackernews","appstore"]},"id":{"type":"string","minLength":1},"handle":{"type":"string","minLength":1},"display_name":{"type":"string","nullable":true},"avatar_url":{"type":"string","nullable":true,"format":"uri"}},"required":["platform","id","handle","display_name","avatar_url"]},"position":{"type":"integer","nullable":true,"minimum":0}},"required":["platform","id","url","fetched_at","source","text","kind","profile","position"]},"Collection":{"type":"object","properties":{"platform":{"type":"string","enum":["tiktok","instagram","x","youtube","snapchat","facebook","threads","linkedin","twitch","telegram","linktree","bluesky","salla","zid","mock","reddit","pinterest","truthsocial","kick","rumble","kwai","github","spotify","soundcloud","apple_music","google","amazon","hackernews","appstore"]},"id":{"type":"string","minLength":1},"url":{"type":"string","format":"uri"},"fetched_at":{"type":"string","format":"date-time"},"source":{"anyOf":[{"type":"string","enum":["official"]},{"type":"string","enum":["own"]},{"type":"string","pattern":"^upstream:.*$"}]},"raw":{"nullable":true},"enrichment":{"$ref":"#/components/schemas/Enrichment"},"kind":{"type":"string","enum":["playlist","board","highlight","album","podcast"]},"title":{"type":"string"},"description":{"type":"string","nullable":true},"owner":{"type":"object","nullable":true,"properties":{"platform":{"type":"string","enum":["tiktok","instagram","x","youtube","snapchat","facebook","threads","linkedin","twitch","telegram","linktree","bluesky","salla","zid","mock","reddit","pinterest","truthsocial","kick","rumble","kwai","github","spotify","soundcloud","apple_music","google","amazon","hackernews","appstore"]},"id":{"type":"string","minLength":1},"handle":{"type":"string","minLength":1},"display_name":{"type":"string","nullable":true},"avatar_url":{"type":"string","nullable":true,"format":"uri"}},"required":["platform","id","handle","display_name","avatar_url"]},"items_count":{"type":"integer","nullable":true,"minimum":0},"cover_url":{"type":"string","nullable":true,"format":"uri"},"created_at":{"type":"string","nullable":true,"format":"date-time"}},"required":["platform","id","url","fetched_at","source","kind","title","description","owner","items_count","cover_url","created_at"]},"Track":{"type":"object","properties":{"platform":{"type":"string","enum":["tiktok","instagram","x","youtube","snapchat","facebook","threads","linkedin","twitch","telegram","linktree","bluesky","salla","zid","mock","reddit","pinterest","truthsocial","kick","rumble","kwai","github","spotify","soundcloud","apple_music","google","amazon","hackernews","appstore"]},"id":{"type":"string","minLength":1},"url":{"type":"string","format":"uri"},"fetched_at":{"type":"string","format":"date-time"},"source":{"anyOf":[{"type":"string","enum":["official"]},{"type":"string","enum":["own"]},{"type":"string","pattern":"^upstream:.*$"}]},"raw":{"nullable":true},"enrichment":{"$ref":"#/components/schemas/Enrichment"},"title":{"type":"string"},"artists":{"type":"array","items":{"type":"string"}},"album":{"type":"string","nullable":true},"duration_s":{"type":"number","nullable":true,"minimum":0},"cover_url":{"type":"string","nullable":true,"format":"uri"},"audio_url":{"type":"string","nullable":true,"format":"uri"},"released_at":{"type":"string","nullable":true,"format":"date-time"},"plays":{"type":"integer","nullable":true,"minimum":0},"posts_count":{"type":"integer","nullable":true,"minimum":0},"explicit":{"type":"boolean","nullable":true}},"required":["platform","id","url","fetched_at","source","title","artists","album","duration_s","cover_url","audio_url","released_at","plays","posts_count","explicit"]},"Product":{"type":"object","properties":{"platform":{"type":"string","enum":["tiktok","instagram","x","youtube","snapchat","facebook","threads","linkedin","twitch","telegram","linktree","bluesky","salla","zid","mock","reddit","pinterest","truthsocial","kick","rumble","kwai","github","spotify","soundcloud","apple_music","google","amazon","hackernews","appstore"]},"id":{"type":"string","minLength":1},"url":{"type":"string","format":"uri"},"fetched_at":{"type":"string","format":"date-time"},"source":{"anyOf":[{"type":"string","enum":["official"]},{"type":"string","enum":["own"]},{"type":"string","pattern":"^upstream:.*$"}]},"raw":{"nullable":true},"enrichment":{"$ref":"#/components/schemas/Enrichment"},"store":{"$ref":"#/components/schemas/StoreSummary"},"title":{"type":"string"},"description":{"type":"string","nullable":true},"price":{"$ref":"#/components/schemas/Price"},"images":{"type":"array","items":{"type":"string","format":"uri"}},"in_stock":{"type":"boolean"},"rating":{"type":"number","nullable":true,"minimum":0,"maximum":5},"reviews_count":{"type":"integer","nullable":true,"minimum":0},"categories":{"type":"array","items":{"type":"string"}}},"required":["platform","id","url","fetched_at","source","store","title","description","price","images","in_stock","rating","reviews_count","categories"]},"StoreSummary":{"type":"object","properties":{"platform":{"type":"string","enum":["tiktok","instagram","x","youtube","snapchat","facebook","threads","linkedin","twitch","telegram","linktree","bluesky","salla","zid","mock","reddit","pinterest","truthsocial","kick","rumble","kwai","github","spotify","soundcloud","apple_music","google","amazon","hackernews","appstore"]},"id":{"type":"string","minLength":1},"name":{"type":"string"},"url":{"type":"string","format":"uri"}},"required":["platform","id","name","url"]},"Price":{"type":"object","properties":{"amount":{"type":"number","minimum":0},"currency":{"type":"string","minLength":3,"maxLength":3}},"required":["amount","currency"]},"Review":{"type":"object","properties":{"platform":{"type":"string","enum":["tiktok","instagram","x","youtube","snapchat","facebook","threads","linkedin","twitch","telegram","linktree","bluesky","salla","zid","mock","reddit","pinterest","truthsocial","kick","rumble","kwai","github","spotify","soundcloud","apple_music","google","amazon","hackernews","appstore"]},"id":{"type":"string","minLength":1},"url":{"type":"string","format":"uri"},"fetched_at":{"type":"string","format":"date-time"},"source":{"anyOf":[{"type":"string","enum":["official"]},{"type":"string","enum":["own"]},{"type":"string","pattern":"^upstream:.*$"}]},"raw":{"nullable":true},"enrichment":{"$ref":"#/components/schemas/Enrichment"},"product_id":{"type":"string","minLength":1},"author":{"type":"object","properties":{"platform":{"type":"string","enum":["tiktok","instagram","x","youtube","snapchat","facebook","threads","linkedin","twitch","telegram","linktree","bluesky","salla","zid","mock","reddit","pinterest","truthsocial","kick","rumble","kwai","github","spotify","soundcloud","apple_music","google","amazon","hackernews","appstore"]},"id":{"type":"string","minLength":1},"handle":{"type":"string","minLength":1},"display_name":{"type":"string","nullable":true},"avatar_url":{"type":"string","nullable":true,"format":"uri"}},"required":["platform","id","handle","display_name","avatar_url"]},"rating":{"type":"number","minimum":0,"maximum":5},"text":{"type":"string"},"lang":{"type":"string","nullable":true,"minLength":2},"created_at":{"type":"string","nullable":true,"format":"date-time"}},"required":["platform","id","url","fetched_at","source","product_id","author","rating","text","lang","created_at"]},"Ad":{"type":"object","properties":{"platform":{"type":"string","enum":["tiktok","instagram","x","youtube","snapchat","facebook","threads","linkedin","twitch","telegram","linktree","bluesky","salla","zid","mock","reddit","pinterest","truthsocial","kick","rumble","kwai","github","spotify","soundcloud","apple_music","google","amazon","hackernews","appstore"]},"id":{"type":"string","minLength":1},"url":{"type":"string","format":"uri"},"fetched_at":{"type":"string","format":"date-time"},"source":{"anyOf":[{"type":"string","enum":["official"]},{"type":"string","enum":["own"]},{"type":"string","pattern":"^upstream:.*$"}]},"raw":{"nullable":true},"enrichment":{"$ref":"#/components/schemas/Enrichment"},"advertiser":{"$ref":"#/components/schemas/AdvertiserSummary"},"text":{"type":"string"},"headline":{"type":"string","nullable":true},"media":{"type":"array","items":{"$ref":"#/components/schemas/Media"}},"call_to_action":{"type":"string","nullable":true},"landing_url":{"type":"string","nullable":true,"format":"uri"},"started_at":{"type":"string","nullable":true,"format":"date-time"},"ended_at":{"type":"string","nullable":true,"format":"date-time"},"is_active":{"type":"boolean","nullable":true},"countries":{"type":"array","items":{"type":"string"}},"formats":{"type":"array","items":{"type":"string"}}},"required":["platform","id","url","fetched_at","source","advertiser","text","headline","media","call_to_action","landing_url","started_at","ended_at","is_active","countries","formats"]},"AdvertiserSummary":{"type":"object","properties":{"id":{"type":"string","nullable":true},"name":{"type":"string"},"url":{"type":"string","nullable":true,"format":"uri"}},"required":["id","name","url"]},"Advertiser":{"type":"object","properties":{"platform":{"type":"string","enum":["tiktok","instagram","x","youtube","snapchat","facebook","threads","linkedin","twitch","telegram","linktree","bluesky","salla","zid","mock","reddit","pinterest","truthsocial","kick","rumble","kwai","github","spotify","soundcloud","apple_music","google","amazon","hackernews","appstore"]},"id":{"type":"string","minLength":1},"url":{"type":"string","format":"uri"},"fetched_at":{"type":"string","format":"date-time"},"source":{"anyOf":[{"type":"string","enum":["official"]},{"type":"string","enum":["own"]},{"type":"string","pattern":"^upstream:.*$"}]},"raw":{"nullable":true},"enrichment":{"$ref":"#/components/schemas/Enrichment"},"name":{"type":"string"},"avatar_url":{"type":"string","nullable":true,"format":"uri"},"country":{"type":"string","nullable":true},"ads_count":{"type":"integer","nullable":true,"minimum":0},"domains":{"type":"array","items":{"type":"string"}}},"required":["platform","id","url","fetched_at","source","name","avatar_url","country","ads_count","domains"]},"Event":{"type":"object","properties":{"platform":{"type":"string","enum":["tiktok","instagram","x","youtube","snapchat","facebook","threads","linkedin","twitch","telegram","linktree","bluesky","salla","zid","mock","reddit","pinterest","truthsocial","kick","rumble","kwai","github","spotify","soundcloud","apple_music","google","amazon","hackernews","appstore"]},"id":{"type":"string","minLength":1},"url":{"type":"string","format":"uri"},"fetched_at":{"type":"string","format":"date-time"},"source":{"anyOf":[{"type":"string","enum":["official"]},{"type":"string","enum":["own"]},{"type":"string","pattern":"^upstream:.*$"}]},"raw":{"nullable":true},"enrichment":{"$ref":"#/components/schemas/Enrichment"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"starts_at":{"type":"string","nullable":true,"format":"date-time"},"ends_at":{"type":"string","nullable":true,"format":"date-time"},"location":{"type":"string","nullable":true},"host":{"type":"object","nullable":true,"properties":{"platform":{"type":"string","enum":["tiktok","instagram","x","youtube","snapchat","facebook","threads","linkedin","twitch","telegram","linktree","bluesky","salla","zid","mock","reddit","pinterest","truthsocial","kick","rumble","kwai","github","spotify","soundcloud","apple_music","google","amazon","hackernews","appstore"]},"id":{"type":"string","minLength":1},"handle":{"type":"string","minLength":1},"display_name":{"type":"string","nullable":true},"avatar_url":{"type":"string","nullable":true,"format":"uri"}},"required":["platform","id","handle","display_name","avatar_url"]},"cover_url":{"type":"string","nullable":true,"format":"uri"},"going":{"type":"integer","nullable":true,"minimum":0},"interested":{"type":"integer","nullable":true,"minimum":0},"is_online":{"type":"boolean","nullable":true}},"required":["platform","id","url","fetched_at","source","name","description","starts_at","ends_at","location","host","cover_url","going","interested","is_online"]},"RawResult":{"type":"object","properties":{"data":{"nullable":true},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]},"SearchResult":{"oneOf":[{"type":"object","properties":{"platform":{"type":"string","enum":["tiktok","instagram","x","youtube","snapchat","facebook","threads","linkedin","twitch","telegram","linktree","bluesky","salla","zid","mock","reddit","pinterest","truthsocial","kick","rumble","kwai","github","spotify","soundcloud","apple_music","google","amazon","hackernews","appstore"]},"id":{"type":"string","minLength":1},"url":{"type":"string","format":"uri"},"fetched_at":{"type":"string","format":"date-time"},"source":{"anyOf":[{"type":"string","enum":["official"]},{"type":"string","enum":["own"]},{"type":"string","pattern":"^upstream:.*$"}]},"raw":{"nullable":true},"enrichment":{"$ref":"#/components/schemas/Enrichment"},"handle":{"type":"string","minLength":1},"display_name":{"type":"string","nullable":true},"bio":{"type":"string","nullable":true},"avatar_url":{"type":"string","nullable":true,"format":"uri"},"verified":{"type":"boolean"},"followers":{"type":"integer","nullable":true,"minimum":0},"following":{"type":"integer","nullable":true,"minimum":0},"posts_count":{"type":"integer","nullable":true,"minimum":0},"lang":{"type":"string","nullable":true,"minLength":2},"country":{"type":"string","nullable":true,"minLength":2,"maxLength":2},"links":{"type":"array","items":{"type":"string","format":"uri"}},"kind":{"type":"string","enum":["profile"]}},"required":["platform","id","url","fetched_at","source","handle","display_name","bio","avatar_url","verified","followers","following","posts_count","lang","country","links","kind"]},{"type":"object","properties":{"platform":{"type":"string","enum":["tiktok","instagram","x","youtube","snapchat","facebook","threads","linkedin","twitch","telegram","linktree","bluesky","salla","zid","mock","reddit","pinterest","truthsocial","kick","rumble","kwai","github","spotify","soundcloud","apple_music","google","amazon","hackernews","appstore"]},"id":{"type":"string","minLength":1},"url":{"type":"string","format":"uri"},"fetched_at":{"type":"string","format":"date-time"},"source":{"anyOf":[{"type":"string","enum":["official"]},{"type":"string","enum":["own"]},{"type":"string","pattern":"^upstream:.*$"}]},"raw":{"nullable":true},"enrichment":{"$ref":"#/components/schemas/Enrichment"},"author":{"type":"object","properties":{"platform":{"type":"string","enum":["tiktok","instagram","x","youtube","snapchat","facebook","threads","linkedin","twitch","telegram","linktree","bluesky","salla","zid","mock","reddit","pinterest","truthsocial","kick","rumble","kwai","github","spotify","soundcloud","apple_music","google","amazon","hackernews","appstore"]},"id":{"type":"string","minLength":1},"handle":{"type":"string","minLength":1},"display_name":{"type":"string","nullable":true},"avatar_url":{"type":"string","nullable":true,"format":"uri"}},"required":["platform","id","handle","display_name","avatar_url"]},"text":{"type":"string"},"lang":{"type":"string","nullable":true,"minLength":2},"created_at":{"type":"string","nullable":true,"format":"date-time"},"media":{"type":"array","items":{"$ref":"#/components/schemas/Media"}},"engagement":{"$ref":"#/components/schemas/Engagement"},"hashtags":{"type":"array","items":{"type":"string"}},"mentions":{"type":"array","items":{"type":"string"}},"is_ad":{"type":"boolean"},"kind":{"type":"string","enum":["post"]}},"required":["platform","id","url","fetched_at","source","author","text","lang","created_at","media","engagement","hashtags","mentions","is_ad","kind"]},{"type":"object","properties":{"platform":{"type":"string","enum":["tiktok","instagram","x","youtube","snapchat","facebook","threads","linkedin","twitch","telegram","linktree","bluesky","salla","zid","mock","reddit","pinterest","truthsocial","kick","rumble","kwai","github","spotify","soundcloud","apple_music","google","amazon","hackernews","appstore"]},"id":{"type":"string","minLength":1},"url":{"type":"string","format":"uri"},"fetched_at":{"type":"string","format":"date-time"},"source":{"anyOf":[{"type":"string","enum":["official"]},{"type":"string","enum":["own"]},{"type":"string","pattern":"^upstream:.*$"}]},"raw":{"nullable":true},"enrichment":{"$ref":"#/components/schemas/Enrichment"},"post_id":{"type":"string","minLength":1},"author":{"type":"object","properties":{"platform":{"type":"string","enum":["tiktok","instagram","x","youtube","snapchat","facebook","threads","linkedin","twitch","telegram","linktree","bluesky","salla","zid","mock","reddit","pinterest","truthsocial","kick","rumble","kwai","github","spotify","soundcloud","apple_music","google","amazon","hackernews","appstore"]},"id":{"type":"string","minLength":1},"handle":{"type":"string","minLength":1},"display_name":{"type":"string","nullable":true},"avatar_url":{"type":"string","nullable":true,"format":"uri"}},"required":["platform","id","handle","display_name","avatar_url"]},"text":{"type":"string"},"lang":{"type":"string","nullable":true,"minLength":2},"created_at":{"type":"string","nullable":true,"format":"date-time"},"likes":{"type":"integer","nullable":true,"minimum":0},"reply_to_id":{"type":"string","nullable":true},"kind":{"type":"string","enum":["comment"]}},"required":["platform","id","url","fetched_at","source","post_id","author","text","lang","created_at","likes","reply_to_id","kind"]},{"type":"object","properties":{"platform":{"type":"string","enum":["tiktok","instagram","x","youtube","snapchat","facebook","threads","linkedin","twitch","telegram","linktree","bluesky","salla","zid","mock","reddit","pinterest","truthsocial","kick","rumble","kwai","github","spotify","soundcloud","apple_music","google","amazon","hackernews","appstore"]},"id":{"type":"string","minLength":1},"url":{"type":"string","format":"uri"},"fetched_at":{"type":"string","format":"date-time"},"source":{"anyOf":[{"type":"string","enum":["official"]},{"type":"string","enum":["own"]},{"type":"string","pattern":"^upstream:.*$"}]},"raw":{"nullable":true},"enrichment":{"$ref":"#/components/schemas/Enrichment"},"store":{"$ref":"#/components/schemas/StoreSummary"},"title":{"type":"string"},"description":{"type":"string","nullable":true},"price":{"$ref":"#/components/schemas/Price"},"images":{"type":"array","items":{"type":"string","format":"uri"}},"in_stock":{"type":"boolean"},"rating":{"type":"number","nullable":true,"minimum":0,"maximum":5},"reviews_count":{"type":"integer","nullable":true,"minimum":0},"categories":{"type":"array","items":{"type":"string"}},"kind":{"type":"string","enum":["product"]}},"required":["platform","id","url","fetched_at","source","store","title","description","price","images","in_stock","rating","reviews_count","categories","kind"]},{"type":"object","properties":{"platform":{"type":"string","enum":["tiktok","instagram","x","youtube","snapchat","facebook","threads","linkedin","twitch","telegram","linktree","bluesky","salla","zid","mock","reddit","pinterest","truthsocial","kick","rumble","kwai","github","spotify","soundcloud","apple_music","google","amazon","hackernews","appstore"]},"id":{"type":"string","minLength":1},"url":{"type":"string","format":"uri"},"fetched_at":{"type":"string","format":"date-time"},"source":{"anyOf":[{"type":"string","enum":["official"]},{"type":"string","enum":["own"]},{"type":"string","pattern":"^upstream:.*$"}]},"raw":{"nullable":true},"enrichment":{"$ref":"#/components/schemas/Enrichment"},"product_id":{"type":"string","minLength":1},"author":{"type":"object","properties":{"platform":{"type":"string","enum":["tiktok","instagram","x","youtube","snapchat","facebook","threads","linkedin","twitch","telegram","linktree","bluesky","salla","zid","mock","reddit","pinterest","truthsocial","kick","rumble","kwai","github","spotify","soundcloud","apple_music","google","amazon","hackernews","appstore"]},"id":{"type":"string","minLength":1},"handle":{"type":"string","minLength":1},"display_name":{"type":"string","nullable":true},"avatar_url":{"type":"string","nullable":true,"format":"uri"}},"required":["platform","id","handle","display_name","avatar_url"]},"rating":{"type":"number","minimum":0,"maximum":5},"text":{"type":"string"},"lang":{"type":"string","nullable":true,"minLength":2},"created_at":{"type":"string","nullable":true,"format":"date-time"},"kind":{"type":"string","enum":["review"]}},"required":["platform","id","url","fetched_at","source","product_id","author","rating","text","lang","created_at","kind"]},{"type":"object","properties":{"platform":{"type":"string","enum":["tiktok","instagram","x","youtube","snapchat","facebook","threads","linkedin","twitch","telegram","linktree","bluesky","salla","zid","mock","reddit","pinterest","truthsocial","kick","rumble","kwai","github","spotify","soundcloud","apple_music","google","amazon","hackernews","appstore"]},"id":{"type":"string","minLength":1},"url":{"type":"string","format":"uri"},"fetched_at":{"type":"string","format":"date-time"},"source":{"anyOf":[{"type":"string","enum":["official"]},{"type":"string","enum":["own"]},{"type":"string","pattern":"^upstream:.*$"}]},"raw":{"nullable":true},"enrichment":{"$ref":"#/components/schemas/Enrichment"},"title":{"type":"string"},"artists":{"type":"array","items":{"type":"string"}},"album":{"type":"string","nullable":true},"duration_s":{"type":"number","nullable":true,"minimum":0},"cover_url":{"type":"string","nullable":true,"format":"uri"},"audio_url":{"type":"string","nullable":true,"format":"uri"},"released_at":{"type":"string","nullable":true,"format":"date-time"},"plays":{"type":"integer","nullable":true,"minimum":0},"posts_count":{"type":"integer","nullable":true,"minimum":0},"explicit":{"type":"boolean","nullable":true},"kind":{"type":"string","enum":["track"]}},"required":["platform","id","url","fetched_at","source","title","artists","album","duration_s","cover_url","audio_url","released_at","plays","posts_count","explicit","kind"]},{"type":"object","properties":{"platform":{"type":"string","enum":["tiktok","instagram","x","youtube","snapchat","facebook","threads","linkedin","twitch","telegram","linktree","bluesky","salla","zid","mock","reddit","pinterest","truthsocial","kick","rumble","kwai","github","spotify","soundcloud","apple_music","google","amazon","hackernews","appstore"]},"id":{"type":"string","minLength":1},"url":{"type":"string","format":"uri"},"fetched_at":{"type":"string","format":"date-time"},"source":{"anyOf":[{"type":"string","enum":["official"]},{"type":"string","enum":["own"]},{"type":"string","pattern":"^upstream:.*$"}]},"raw":{"nullable":true},"enrichment":{"$ref":"#/components/schemas/Enrichment"},"kind":{"type":"string","enum":["collection"]},"title":{"type":"string"},"description":{"type":"string","nullable":true},"owner":{"type":"object","nullable":true,"properties":{"platform":{"type":"string","enum":["tiktok","instagram","x","youtube","snapchat","facebook","threads","linkedin","twitch","telegram","linktree","bluesky","salla","zid","mock","reddit","pinterest","truthsocial","kick","rumble","kwai","github","spotify","soundcloud","apple_music","google","amazon","hackernews","appstore"]},"id":{"type":"string","minLength":1},"handle":{"type":"string","minLength":1},"display_name":{"type":"string","nullable":true},"avatar_url":{"type":"string","nullable":true,"format":"uri"}},"required":["platform","id","handle","display_name","avatar_url"]},"items_count":{"type":"integer","nullable":true,"minimum":0},"cover_url":{"type":"string","nullable":true,"format":"uri"},"created_at":{"type":"string","nullable":true,"format":"date-time"}},"required":["platform","id","url","fetched_at","source","kind","title","description","owner","items_count","cover_url","created_at"]},{"type":"object","properties":{"platform":{"type":"string","enum":["tiktok","instagram","x","youtube","snapchat","facebook","threads","linkedin","twitch","telegram","linktree","bluesky","salla","zid","mock","reddit","pinterest","truthsocial","kick","rumble","kwai","github","spotify","soundcloud","apple_music","google","amazon","hackernews","appstore"]},"id":{"type":"string","minLength":1},"url":{"type":"string","format":"uri"},"fetched_at":{"type":"string","format":"date-time"},"source":{"anyOf":[{"type":"string","enum":["official"]},{"type":"string","enum":["own"]},{"type":"string","pattern":"^upstream:.*$"}]},"raw":{"nullable":true},"enrichment":{"$ref":"#/components/schemas/Enrichment"},"title":{"type":"string"},"snippet":{"type":"string","nullable":true},"domain":{"type":"string"},"position":{"type":"integer","nullable":true,"minimum":0,"exclusiveMinimum":true},"published_at":{"type":"string","nullable":true,"format":"date-time"},"kind":{"type":"string","enum":["web"]}},"required":["platform","id","url","fetched_at","source","title","snippet","domain","position","published_at","kind"]}]}},"parameters":{}},"paths":{"/health":{"get":{"tags":["meta"],"summary":"Liveness check","responses":{"200":{"description":"Service is up","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Health"}}}}}}},"/v1/me":{"get":{"tags":["account"],"summary":"The calling API key, its credit balance and limits","security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Key, credits, limits","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Me"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/profile":{"get":{"tags":["profiles"],"summary":"Get a public profile by handle","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["tiktok","instagram","x","youtube","snapchat","facebook","threads","linkedin","twitch","telegram","linktree","bluesky","salla","zid","mock","reddit","pinterest","truthsocial","kick","rumble","kwai","github","spotify","soundcloud","apple_music","google","amazon","hackernews","appstore"],"description":"Platform to query","example":"tiktok"},"required":true,"description":"Platform to query","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"example":"alice","description":"Public handle"},"required":true,"description":"Public handle","name":"handle","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"},{"schema":{"type":"string","enum":["arabic"],"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3."},"required":false,"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3.","name":"enrich","in":"query"}],"responses":{"200":{"description":"Profile","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Profile"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/posts":{"get":{"tags":["posts"],"summary":"List a profile’s recent posts","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["tiktok","instagram","x","youtube","snapchat","facebook","threads","linkedin","twitch","telegram","linktree","bluesky","salla","zid","mock","reddit","pinterest","truthsocial","kick","rumble","kwai","github","spotify","soundcloud","apple_music","google","amazon","hackernews","appstore"],"description":"Platform to query","example":"tiktok"},"required":true,"description":"Platform to query","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"example":"alice","description":"Public handle"},"required":true,"description":"Public handle","name":"handle","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor from a previous response’s `meta.next_cursor`"},"required":false,"description":"Opaque cursor from a previous response’s `meta.next_cursor`","name":"cursor","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"},{"schema":{"type":"string","enum":["arabic"],"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3."},"required":false,"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3.","name":"enrich","in":"query"}],"responses":{"200":{"description":"Posts, newest first; `meta.next_cursor` when more are available","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Post"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/post":{"get":{"tags":["posts"],"summary":"Get a single post by id","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["tiktok","instagram","x","youtube","snapchat","facebook","threads","linkedin","twitch","telegram","linktree","bluesky","salla","zid","mock","reddit","pinterest","truthsocial","kick","rumble","kwai","github","spotify","soundcloud","apple_music","google","amazon","hackernews","appstore"],"description":"Platform to query","example":"tiktok"},"required":true,"description":"Platform to query","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"example":"p_alice_1","description":"Platform post id"},"required":true,"description":"Platform post id","name":"id","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"},{"schema":{"type":"string","enum":["arabic"],"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3."},"required":false,"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3.","name":"enrich","in":"query"}],"responses":{"200":{"description":"Post","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Post"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/comments":{"get":{"tags":["comments"],"summary":"List comments on a post","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["tiktok","instagram","x","youtube","snapchat","facebook","threads","linkedin","twitch","telegram","linktree","bluesky","salla","zid","mock","reddit","pinterest","truthsocial","kick","rumble","kwai","github","spotify","soundcloud","apple_music","google","amazon","hackernews","appstore"],"description":"Platform to query","example":"tiktok"},"required":true,"description":"Platform to query","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"example":"p_alice_1"},"required":true,"name":"post_id","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor from a previous response’s `meta.next_cursor`"},"required":false,"description":"Opaque cursor from a previous response’s `meta.next_cursor`","name":"cursor","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"},{"schema":{"type":"string","enum":["arabic"],"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3."},"required":false,"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3.","name":"enrich","in":"query"}],"responses":{"200":{"description":"Comments; `meta.next_cursor` when more are available","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Comment"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/followers":{"get":{"tags":["profiles"],"summary":"Followers","description":"Accounts that follow a profile. Returns a page of `Profile`. Costs the platform base.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["tiktok","github"],"description":"Platforms that serve this operation","example":"tiktok"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"Username without the @, or the profile URL.","example":"charlidamelio"},"required":true,"description":"Username without the @, or the profile URL.","name":"handle","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor from a previous response’s `meta.next_cursor`"},"required":false,"description":"Opaque cursor from a previous response’s `meta.next_cursor`","name":"cursor","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"},{"schema":{"type":"string","enum":["arabic"],"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3."},"required":false,"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3.","name":"enrich","in":"query"}],"responses":{"200":{"description":"Profile list; `meta.next_cursor` when more","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Profile"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/following":{"get":{"tags":["profiles"],"summary":"Following","description":"Accounts a profile follows. Returns a page of `Profile`. Costs the platform base.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["tiktok","github"],"description":"Platforms that serve this operation","example":"tiktok"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"Username without the @, or the profile URL.","example":"charlidamelio"},"required":true,"description":"Username without the @, or the profile URL.","name":"handle","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor from a previous response’s `meta.next_cursor`"},"required":false,"description":"Opaque cursor from a previous response’s `meta.next_cursor`","name":"cursor","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"},{"schema":{"type":"string","enum":["arabic"],"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3."},"required":false,"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3.","name":"enrich","in":"query"}],"responses":{"200":{"description":"Profile list; `meta.next_cursor` when more","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Profile"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/audience":{"get":{"tags":["profiles"],"summary":"Audience","description":"Where a creator's audience is, by country. Returns one `Audience`. Costs 26 credits on tiktok; the platform base elsewhere.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["tiktok"],"description":"Platforms that serve this operation","example":"tiktok"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"Username without the @, or the profile URL.","example":"charlidamelio"},"required":true,"description":"Username without the @, or the profile URL.","name":"handle","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"}],"responses":{"200":{"description":"Audience","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Audience"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/live":{"get":{"tags":["profiles"],"summary":"Live","description":"Whether a creator is live right now, with viewers and title. Returns one `LiveStream`. Costs the platform base.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["tiktok","twitch"],"description":"Platforms that serve this operation","example":"tiktok"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"Username without the @, or the profile URL.","example":"charlidamelio"},"required":true,"description":"Username without the @, or the profile URL.","name":"handle","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"}],"responses":{"200":{"description":"LiveStream","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/LiveStream"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/trending/profiles":{"get":{"tags":["profiles"],"summary":"Trending profiles","description":"Popular creators or developers right now. Returns a page of `Profile`. Costs the platform base.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["tiktok","github"],"description":"Platforms that serve this operation","example":"tiktok"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"ISO country code, e.g. US.","example":"US"},"required":false,"description":"ISO country code, e.g. US.","name":"country","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Programming language (GitHub)."},"required":false,"description":"Programming language (GitHub).","name":"language","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor from a previous response’s `meta.next_cursor`"},"required":false,"description":"Opaque cursor from a previous response’s `meta.next_cursor`","name":"cursor","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"},{"schema":{"type":"string","enum":["arabic"],"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3."},"required":false,"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3.","name":"enrich","in":"query"}],"responses":{"200":{"description":"Profile list; `meta.next_cursor` when more","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Profile"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/linked-profiles":{"get":{"tags":["profiles"],"summary":"Linked profiles","description":"The same creator's accounts on other platforms, matched through their public links. Returns a page of `LinkedProfile`. Costs 10 credits on instagram, 10 credits on tiktok, 10 credits on youtube, 10 credits on x, 10 credits on facebook; the platform base elsewhere.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["instagram","tiktok","youtube","x","facebook"],"description":"Platforms that serve this operation","example":"instagram"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"Username without the @.","example":"charlidamelio"},"required":true,"description":"Username without the @.","name":"handle","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor from a previous response’s `meta.next_cursor`"},"required":false,"description":"Opaque cursor from a previous response’s `meta.next_cursor`","name":"cursor","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"}],"responses":{"200":{"description":"LinkedProfile list; `meta.next_cursor` when more","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LinkedProfile"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/company":{"get":{"tags":["profiles"],"summary":"Company","description":"A company page as a profile. Returns one `Profile`. Costs the platform base.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["linkedin"],"description":"Platforms that serve this operation","example":"linkedin"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"Company slug or page URL.","example":"openai"},"required":true,"description":"Company slug or page URL.","name":"handle","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"},{"schema":{"type":"string","enum":["arabic"],"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3."},"required":false,"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3.","name":"enrich","in":"query"}],"responses":{"200":{"description":"Profile","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Profile"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/company/posts":{"get":{"tags":["posts"],"summary":"Company posts","description":"A company page's posts. Returns a page of `Post`. Costs the platform base.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["linkedin"],"description":"Platforms that serve this operation","example":"linkedin"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"Company slug or page URL.","example":"openai"},"required":true,"description":"Company slug or page URL.","name":"handle","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor from a previous response’s `meta.next_cursor`"},"required":false,"description":"Opaque cursor from a previous response’s `meta.next_cursor`","name":"cursor","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"},{"schema":{"type":"string","enum":["arabic"],"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3."},"required":false,"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3.","name":"enrich","in":"query"}],"responses":{"200":{"description":"Post list; `meta.next_cursor` when more","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Post"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/reels":{"get":{"tags":["posts"],"summary":"Reels and shorts","description":"A profile's short-form videos: reels, shorts. Returns a page of `Post`. Costs the platform base.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["instagram","facebook","youtube"],"description":"Platforms that serve this operation","example":"instagram"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"Username without the @, or the profile URL.","example":"charlidamelio"},"required":true,"description":"Username without the @, or the profile URL.","name":"handle","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor from a previous response’s `meta.next_cursor`"},"required":false,"description":"Opaque cursor from a previous response’s `meta.next_cursor`","name":"cursor","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"},{"schema":{"type":"string","enum":["arabic"],"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3."},"required":false,"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3.","name":"enrich","in":"query"}],"responses":{"200":{"description":"Post list; `meta.next_cursor` when more","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Post"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/photos":{"get":{"tags":["posts"],"summary":"Photos","description":"A page's photos. Returns a page of `Post`. Costs the platform base.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["facebook"],"description":"Platforms that serve this operation","example":"facebook"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"Username without the @, or the profile URL.","example":"charlidamelio"},"required":true,"description":"Username without the @, or the profile URL.","name":"handle","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor from a previous response’s `meta.next_cursor`"},"required":false,"description":"Opaque cursor from a previous response’s `meta.next_cursor`","name":"cursor","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"},{"schema":{"type":"string","enum":["arabic"],"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3."},"required":false,"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3.","name":"enrich","in":"query"}],"responses":{"200":{"description":"Post list; `meta.next_cursor` when more","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Post"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/pull-requests":{"get":{"tags":["posts"],"summary":"Pull requests","description":"Pull requests a developer opened, newest first. Returns a page of `Post`. Costs the platform base.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["github"],"description":"Platforms that serve this operation","example":"github"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"GitHub username or profile URL.","example":"torvalds"},"required":true,"description":"GitHub username or profile URL.","name":"handle","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor from a previous response’s `meta.next_cursor`"},"required":false,"description":"Opaque cursor from a previous response’s `meta.next_cursor`","name":"cursor","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"},{"schema":{"type":"string","enum":["arabic"],"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3."},"required":false,"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3.","name":"enrich","in":"query"}],"responses":{"200":{"description":"Post list; `meta.next_cursor` when more","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Post"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/tagged":{"get":{"tags":["posts"],"summary":"Tagged posts","description":"Posts a profile is tagged in. Returns a page of `Post`. Costs the platform base.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["instagram"],"description":"Platforms that serve this operation","example":"instagram"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"Numeric user id or username.","example":"charlidamelio"},"required":true,"description":"Numeric user id or username.","name":"handle","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor from a previous response’s `meta.next_cursor`"},"required":false,"description":"Opaque cursor from a previous response’s `meta.next_cursor`","name":"cursor","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"},{"schema":{"type":"string","enum":["arabic"],"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3."},"required":false,"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3.","name":"enrich","in":"query"}],"responses":{"200":{"description":"Post list; `meta.next_cursor` when more","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Post"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/live/videos":{"get":{"tags":["posts"],"summary":"Live videos","description":"A channel's live and past live streams. Returns a page of `Post`. Costs the platform base.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["youtube"],"description":"Platforms that serve this operation","example":"youtube"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"Username without the @, or the profile URL.","example":"charlidamelio"},"required":true,"description":"Username without the @, or the profile URL.","name":"handle","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor from a previous response’s `meta.next_cursor`"},"required":false,"description":"Opaque cursor from a previous response’s `meta.next_cursor`","name":"cursor","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"},{"schema":{"type":"string","enum":["arabic"],"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3."},"required":false,"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3.","name":"enrich","in":"query"}],"responses":{"200":{"description":"Post list; `meta.next_cursor` when more","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Post"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/hashtag":{"get":{"tags":["posts"],"summary":"Hashtag","description":"Posts using a hashtag. Returns a page of `Post`. Costs the platform base.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["tiktok","instagram","youtube"],"description":"Platforms that serve this operation","example":"tiktok"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"Hashtag without the #.","example":"coffee"},"required":true,"description":"Hashtag without the #.","name":"tag","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor from a previous response’s `meta.next_cursor`"},"required":false,"description":"Opaque cursor from a previous response’s `meta.next_cursor`","name":"cursor","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"},{"schema":{"type":"string","enum":["arabic"],"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3."},"required":false,"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3.","name":"enrich","in":"query"}],"responses":{"200":{"description":"Post list; `meta.next_cursor` when more","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Post"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/trending":{"get":{"tags":["posts"],"summary":"Trending","description":"What is trending on the platform right now. Returns a page of `Post`. Costs the platform base.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["tiktok","instagram","youtube","github"],"description":"Platforms that serve this operation","example":"tiktok"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"ISO country code, e.g. US.","example":"US"},"required":false,"description":"ISO country code, e.g. US.","name":"country","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Programming language (GitHub)."},"required":false,"description":"Programming language (GitHub).","name":"language","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor from a previous response’s `meta.next_cursor`"},"required":false,"description":"Opaque cursor from a previous response’s `meta.next_cursor`","name":"cursor","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"},{"schema":{"type":"string","enum":["arabic"],"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3."},"required":false,"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3.","name":"enrich","in":"query"}],"responses":{"200":{"description":"Post list; `meta.next_cursor` when more","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Post"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/transcript":{"get":{"tags":["media"],"summary":"Transcript","description":"The spoken text of a video, with timings when available. Returns one `Transcript`. Costs 10 credits on tiktok; the platform base elsewhere.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["tiktok","instagram","youtube","facebook","x","linkedin","reddit","rumble"],"description":"Platforms that serve this operation","example":"tiktok"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"The video or post id, or its URL."},"required":true,"description":"The video or post id, or its URL.","name":"id","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"}],"responses":{"200":{"description":"Transcript","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Transcript"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/replies":{"get":{"tags":["comments"],"summary":"Replies","description":"Replies to one comment. Returns a page of `Comment`. Costs the platform base.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["tiktok","instagram"],"description":"Platforms that serve this operation","example":"tiktok"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"The post the comment is on (id or URL)."},"required":true,"description":"The post the comment is on (id or URL).","name":"post_id","in":"query"},{"schema":{"type":"string","minLength":1,"description":"The comment to read replies to."},"required":true,"description":"The comment to read replies to.","name":"comment_id","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor from a previous response’s `meta.next_cursor`"},"required":false,"description":"Opaque cursor from a previous response’s `meta.next_cursor`","name":"cursor","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"},{"schema":{"type":"string","enum":["arabic"],"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3."},"required":false,"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3.","name":"enrich","in":"query"}],"responses":{"200":{"description":"Comment list; `meta.next_cursor` when more","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Comment"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/search/posts":{"get":{"tags":["search"],"summary":"Search posts","description":"Posts matching a keyword. Returns a page of `Post`. Costs the platform base.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["tiktok","instagram","youtube","linkedin","reddit","threads","pinterest","rumble"],"description":"Platforms that serve this operation","example":"tiktok"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"What to search for.","example":"coffee"},"required":true,"description":"What to search for.","name":"q","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor from a previous response’s `meta.next_cursor`"},"required":false,"description":"Opaque cursor from a previous response’s `meta.next_cursor`","name":"cursor","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"},{"schema":{"type":"string","enum":["arabic"],"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3."},"required":false,"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3.","name":"enrich","in":"query"}],"responses":{"200":{"description":"Post list; `meta.next_cursor` when more","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Post"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/search/profiles":{"get":{"tags":["search"],"summary":"Search profiles","description":"Profiles matching a keyword. Returns a page of `Profile`. Costs the platform base.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["tiktok","instagram","threads"],"description":"Platforms that serve this operation","example":"tiktok"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"What to search for.","example":"coffee"},"required":true,"description":"What to search for.","name":"q","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor from a previous response’s `meta.next_cursor`"},"required":false,"description":"Opaque cursor from a previous response’s `meta.next_cursor`","name":"cursor","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"},{"schema":{"type":"string","enum":["arabic"],"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3."},"required":false,"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3.","name":"enrich","in":"query"}],"responses":{"200":{"description":"Profile list; `meta.next_cursor` when more","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Profile"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/search/top":{"get":{"tags":["search"],"summary":"Top results","description":"The platform's Top tab for a keyword: videos and photo carousels, ranked. Returns a page of `Post`. Costs the platform base.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["tiktok"],"description":"Platforms that serve this operation","example":"tiktok"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"What to search for.","example":"coffee"},"required":true,"description":"What to search for.","name":"q","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor from a previous response’s `meta.next_cursor`"},"required":false,"description":"Opaque cursor from a previous response’s `meta.next_cursor`","name":"cursor","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"},{"schema":{"type":"string","enum":["arabic"],"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3."},"required":false,"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3.","name":"enrich","in":"query"}],"responses":{"200":{"description":"Post list; `meta.next_cursor` when more","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Post"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/search/suggestions":{"get":{"tags":["search"],"summary":"Search suggestions","description":"What the search box suggests as someone types: terms, and on YouTube, channels. Returns a page of `Suggestion`. Costs the platform base.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["tiktok","youtube"],"description":"Platforms that serve this operation","example":"tiktok"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"The start of a search.","example":"coffee"},"required":true,"description":"The start of a search.","name":"q","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor from a previous response’s `meta.next_cursor`"},"required":false,"description":"Opaque cursor from a previous response’s `meta.next_cursor`","name":"cursor","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"}],"responses":{"200":{"description":"Suggestion list; `meta.next_cursor` when more","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Suggestion"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/topic":{"get":{"tags":["search"],"summary":"Topic","description":"Posts the platform curates for a topic, most popular first. Returns a page of `Post`. Costs the platform base.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["instagram"],"description":"Platforms that serve this operation","example":"instagram"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"A topic, e.g. basketball.","example":"basketball"},"required":true,"description":"A topic, e.g. basketball.","name":"q","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor from a previous response’s `meta.next_cursor`"},"required":false,"description":"Opaque cursor from a previous response’s `meta.next_cursor`","name":"cursor","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"},{"schema":{"type":"string","enum":["arabic"],"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3."},"required":false,"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3.","name":"enrich","in":"query"}],"responses":{"200":{"description":"Post list; `meta.next_cursor` when more","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Post"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/collections":{"get":{"tags":["media"],"summary":"Collections","description":"A profile's playlists, boards or story highlights. Returns a page of `Collection`. Costs the platform base.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["instagram","pinterest","youtube"],"description":"Platforms that serve this operation","example":"instagram"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"Username without the @, or the profile URL.","example":"charlidamelio"},"required":true,"description":"Username without the @, or the profile URL.","name":"handle","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor from a previous response’s `meta.next_cursor`"},"required":false,"description":"Opaque cursor from a previous response’s `meta.next_cursor`","name":"cursor","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"}],"responses":{"200":{"description":"Collection list; `meta.next_cursor` when more","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Collection"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/collection":{"get":{"tags":["media"],"summary":"Collection","description":"One playlist, album or podcast. Returns one `Collection`. Costs the platform base.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["youtube","spotify","apple_music"],"description":"Platforms that serve this operation","example":"youtube"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"Playlist, album or podcast id, or its URL."},"required":true,"description":"Playlist, album or podcast id, or its URL.","name":"id","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"}],"responses":{"200":{"description":"Collection","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Collection"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/collection/posts":{"get":{"tags":["media"],"summary":"Collection posts","description":"The posts in a playlist, board, highlight or podcast. Returns a page of `Post`. Costs the platform base.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["youtube","instagram","pinterest","tiktok","spotify"],"description":"Platforms that serve this operation","example":"youtube"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"Playlist, board, highlight or podcast id, or its URL."},"required":true,"description":"Playlist, board, highlight or podcast id, or its URL.","name":"id","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor from a previous response’s `meta.next_cursor`"},"required":false,"description":"Opaque cursor from a previous response’s `meta.next_cursor`","name":"cursor","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"},{"schema":{"type":"string","enum":["arabic"],"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3."},"required":false,"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3.","name":"enrich","in":"query"}],"responses":{"200":{"description":"Post list; `meta.next_cursor` when more","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Post"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/collection/tracks":{"get":{"tags":["music"],"summary":"Collection tracks","description":"The tracks in a playlist or album. Returns a page of `Track`. Costs the platform base.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["spotify","apple_music"],"description":"Platforms that serve this operation","example":"spotify"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"Playlist or album id, or its URL."},"required":true,"description":"Playlist or album id, or its URL.","name":"id","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor from a previous response’s `meta.next_cursor`"},"required":false,"description":"Opaque cursor from a previous response’s `meta.next_cursor`","name":"cursor","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"}],"responses":{"200":{"description":"Track list; `meta.next_cursor` when more","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Track"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/track":{"get":{"tags":["music"],"summary":"Track","description":"One track or sound. Returns one `Track`. Costs the platform base.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["tiktok","spotify","soundcloud","apple_music"],"description":"Platforms that serve this operation","example":"tiktok"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"Track or sound id, or its URL."},"required":true,"description":"Track or sound id, or its URL.","name":"id","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"}],"responses":{"200":{"description":"Track","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Track"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/track/posts":{"get":{"tags":["music"],"summary":"Posts using a sound","description":"Videos that use a sound. Returns a page of `Post`. Costs the platform base.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["tiktok","instagram"],"description":"Platforms that serve this operation","example":"tiktok"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"Sound or audio id, or its URL."},"required":true,"description":"Sound or audio id, or its URL.","name":"id","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor from a previous response’s `meta.next_cursor`"},"required":false,"description":"Opaque cursor from a previous response’s `meta.next_cursor`","name":"cursor","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"},{"schema":{"type":"string","enum":["arabic"],"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3."},"required":false,"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3.","name":"enrich","in":"query"}],"responses":{"200":{"description":"Post list; `meta.next_cursor` when more","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Post"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/tracks":{"get":{"tags":["music"],"summary":"Tracks","description":"An artist's tracks. Returns a page of `Track`. Costs the platform base.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["soundcloud","spotify"],"description":"Platforms that serve this operation","example":"soundcloud"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"Artist handle, id or URL.","example":"charlidamelio"},"required":true,"description":"Artist handle, id or URL.","name":"handle","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor from a previous response’s `meta.next_cursor`"},"required":false,"description":"Opaque cursor from a previous response’s `meta.next_cursor`","name":"cursor","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"}],"responses":{"200":{"description":"Track list; `meta.next_cursor` when more","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Track"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/community":{"get":{"tags":["communities"],"summary":"Community","description":"A community (subreddit, group) as a profile. Returns one `Profile`. Costs the platform base.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["reddit","facebook","x"],"description":"Platforms that serve this operation","example":"reddit"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"Community name or URL.","example":"r/coffee"},"required":true,"description":"Community name or URL.","name":"id","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"},{"schema":{"type":"string","enum":["arabic"],"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3."},"required":false,"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3.","name":"enrich","in":"query"}],"responses":{"200":{"description":"Profile","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Profile"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/community/posts":{"get":{"tags":["communities"],"summary":"Community posts","description":"Posts in a community, or a channel’s community tab. Returns a page of `Post`. Costs the platform base.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["reddit","facebook","x","youtube"],"description":"Platforms that serve this operation","example":"reddit"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"Community name or URL, or a YouTube channel handle."},"required":true,"description":"Community name or URL, or a YouTube channel handle.","name":"id","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor from a previous response’s `meta.next_cursor`"},"required":false,"description":"Opaque cursor from a previous response’s `meta.next_cursor`","name":"cursor","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"},{"schema":{"type":"string","enum":["arabic"],"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3."},"required":false,"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3.","name":"enrich","in":"query"}],"responses":{"200":{"description":"Post list; `meta.next_cursor` when more","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Post"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/community/search":{"get":{"tags":["communities"],"summary":"Search a community","description":"Posts matching a keyword inside one community. Returns a page of `Post`. Costs the platform base.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["reddit"],"description":"Platforms that serve this operation","example":"reddit"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"Community name or URL.","example":"r/coffee"},"required":true,"description":"Community name or URL.","name":"id","in":"query"},{"schema":{"type":"string","minLength":1,"description":"What to search for.","example":"coffee"},"required":true,"description":"What to search for.","name":"q","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor from a previous response’s `meta.next_cursor`"},"required":false,"description":"Opaque cursor from a previous response’s `meta.next_cursor`","name":"cursor","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"},{"schema":{"type":"string","enum":["arabic"],"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3."},"required":false,"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3.","name":"enrich","in":"query"}],"responses":{"200":{"description":"Post list; `meta.next_cursor` when more","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Post"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/community/post":{"get":{"tags":["communities"],"summary":"Community post","description":"One community-tab post. Returns one `Post`. Costs the platform base.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["youtube"],"description":"Platforms that serve this operation","example":"youtube"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"The post URL."},"required":true,"description":"The post URL.","name":"id","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"},{"schema":{"type":"string","enum":["arabic"],"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3."},"required":false,"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3.","name":"enrich","in":"query"}],"responses":{"200":{"description":"Post","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Post"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/shop/search":{"get":{"tags":["shops"],"summary":"Search products","description":"Products matching a keyword. Returns a page of `Product`. Costs the platform base.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["tiktok"],"description":"Platforms that serve this operation","example":"tiktok"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"What to search for.","example":"coffee"},"required":true,"description":"What to search for.","name":"q","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor from a previous response’s `meta.next_cursor`"},"required":false,"description":"Opaque cursor from a previous response’s `meta.next_cursor`","name":"cursor","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"}],"responses":{"200":{"description":"Product list; `meta.next_cursor` when more","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/shop/products":{"get":{"tags":["shops"],"summary":"Shop products","description":"A shop's or creator storefront's products. Returns a page of `Product`. Costs the platform base.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["tiktok","amazon"],"description":"Platforms that serve this operation","example":"tiktok"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"The shop or storefront URL."},"required":true,"description":"The shop or storefront URL.","name":"shop","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor from a previous response’s `meta.next_cursor`"},"required":false,"description":"Opaque cursor from a previous response’s `meta.next_cursor`","name":"cursor","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"}],"responses":{"200":{"description":"Product list; `meta.next_cursor` when more","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/shop/product":{"get":{"tags":["shops"],"summary":"Product","description":"One product, with price, stock and rating. Returns one `Product`. Costs the platform base.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["tiktok"],"description":"Platforms that serve this operation","example":"tiktok"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"The product URL."},"required":true,"description":"The product URL.","name":"id","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"}],"responses":{"200":{"description":"Product","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Product"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/shop/reviews":{"get":{"tags":["shops"],"summary":"Product reviews","description":"Reviews of one product. Returns a page of `Review`. Costs the platform base.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["tiktok"],"description":"Platforms that serve this operation","example":"tiktok"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"The product URL or id."},"required":true,"description":"The product URL or id.","name":"id","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor from a previous response’s `meta.next_cursor`"},"required":false,"description":"Opaque cursor from a previous response’s `meta.next_cursor`","name":"cursor","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"}],"responses":{"200":{"description":"Review list; `meta.next_cursor` when more","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Review"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/shop/showcase":{"get":{"tags":["shops"],"summary":"Creator showcase","description":"Products a creator features. Returns a page of `Product`. Costs the platform base.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["tiktok"],"description":"Platforms that serve this operation","example":"tiktok"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"Username without the @, or the profile URL.","example":"charlidamelio"},"required":true,"description":"Username without the @, or the profile URL.","name":"handle","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor from a previous response’s `meta.next_cursor`"},"required":false,"description":"Opaque cursor from a previous response’s `meta.next_cursor`","name":"cursor","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"}],"responses":{"200":{"description":"Product list; `meta.next_cursor` when more","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/marketplace/search":{"get":{"tags":["shops"],"summary":"Marketplace search","description":"Marketplace listings near a location. Returns a page of `Product`. Costs the platform base.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["facebook"],"description":"Platforms that serve this operation","example":"facebook"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"What to search for.","example":"coffee"},"required":true,"description":"What to search for.","name":"q","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Latitude.","example":"40.7128"},"required":true,"description":"Latitude.","name":"lat","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Longitude.","example":"-74.006"},"required":true,"description":"Longitude.","name":"lng","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor from a previous response’s `meta.next_cursor`"},"required":false,"description":"Opaque cursor from a previous response’s `meta.next_cursor`","name":"cursor","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"}],"responses":{"200":{"description":"Product list; `meta.next_cursor` when more","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/marketplace/item":{"get":{"tags":["shops"],"summary":"Marketplace item","description":"One marketplace listing. Returns one `Product`. Costs the platform base.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["facebook"],"description":"Platforms that serve this operation","example":"facebook"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"Listing id or URL."},"required":true,"description":"Listing id or URL.","name":"id","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"}],"responses":{"200":{"description":"Product","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Product"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/ads/search":{"get":{"tags":["ads"],"summary":"Search ads","description":"Ads in the public ad library matching a keyword. Returns a page of `Ad`. Costs the platform base.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["facebook","tiktok","linkedin"],"description":"Platforms that serve this operation","example":"facebook"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"What to search for.","example":"coffee"},"required":true,"description":"What to search for.","name":"q","in":"query"},{"schema":{"type":"string","minLength":1,"description":"ISO country code.","example":"US"},"required":false,"description":"ISO country code.","name":"country","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor from a previous response’s `meta.next_cursor`"},"required":false,"description":"Opaque cursor from a previous response’s `meta.next_cursor`","name":"cursor","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"}],"responses":{"200":{"description":"Ad list; `meta.next_cursor` when more","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Ad"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/ads":{"get":{"tags":["ads"],"summary":"An advertiser's ads","description":"Every ad an advertiser is running or ran. Returns a page of `Ad`. Costs the platform base.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["facebook","google","linkedin","tiktok"],"description":"Platforms that serve this operation","example":"facebook"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"Advertiser name, page id or domain.","example":"nike.com"},"required":true,"description":"Advertiser name, page id or domain.","name":"advertiser","in":"query"},{"schema":{"type":"string","minLength":1,"description":"ISO country code.","example":"US"},"required":false,"description":"ISO country code.","name":"country","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor from a previous response’s `meta.next_cursor`"},"required":false,"description":"Opaque cursor from a previous response’s `meta.next_cursor`","name":"cursor","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"}],"responses":{"200":{"description":"Ad list; `meta.next_cursor` when more","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Ad"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/ad":{"get":{"tags":["ads"],"summary":"Ad","description":"One ad from the ad library. Returns one `Ad`. Costs the platform base.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["facebook","google","linkedin","tiktok"],"description":"Platforms that serve this operation","example":"facebook"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"Ad id or ad-library URL."},"required":true,"description":"Ad id or ad-library URL.","name":"id","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"}],"responses":{"200":{"description":"Ad","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Ad"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/ad/transcript":{"get":{"tags":["ads"],"summary":"Ad transcript","description":"The spoken text of a video ad. Returns one `Transcript`. Costs the platform base.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["facebook"],"description":"Platforms that serve this operation","example":"facebook"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"Ad id or ad-library URL."},"required":true,"description":"Ad id or ad-library URL.","name":"id","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"}],"responses":{"200":{"description":"Transcript","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Transcript"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/advertisers/search":{"get":{"tags":["ads"],"summary":"Search advertisers","description":"Find an advertiser, and the id its ads are filed under. Returns a page of `Advertiser`. Costs the platform base.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["facebook","google"],"description":"Platforms that serve this operation","example":"facebook"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"What to search for.","example":"coffee"},"required":true,"description":"What to search for.","name":"q","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor from a previous response’s `meta.next_cursor`"},"required":false,"description":"Opaque cursor from a previous response’s `meta.next_cursor`","name":"cursor","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"}],"responses":{"200":{"description":"Advertiser list; `meta.next_cursor` when more","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Advertiser"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/events":{"get":{"tags":["events"],"summary":"Events","description":"A page's upcoming and past events, or a streamer's schedule. Returns a page of `Event`. Costs the platform base.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["facebook","twitch"],"description":"Platforms that serve this operation","example":"facebook"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"Username without the @, or the profile URL.","example":"charlidamelio"},"required":true,"description":"Username without the @, or the profile URL.","name":"handle","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor from a previous response’s `meta.next_cursor`"},"required":false,"description":"Opaque cursor from a previous response’s `meta.next_cursor`","name":"cursor","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"}],"responses":{"200":{"description":"Event list; `meta.next_cursor` when more","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Event"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/events/search":{"get":{"tags":["events"],"summary":"Search events","description":"Public events matching a keyword. Returns a page of `Event`. Costs the platform base.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["facebook"],"description":"Platforms that serve this operation","example":"facebook"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"What to search for.","example":"coffee"},"required":true,"description":"What to search for.","name":"q","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor from a previous response’s `meta.next_cursor`"},"required":false,"description":"Opaque cursor from a previous response’s `meta.next_cursor`","name":"cursor","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"}],"responses":{"200":{"description":"Event list; `meta.next_cursor` when more","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Event"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/event":{"get":{"tags":["events"],"summary":"Event","description":"One event. Returns one `Event`. Costs the platform base.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["facebook"],"description":"Platforms that serve this operation","example":"facebook"},"required":true,"description":"Platforms that serve this operation","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"description":"Event id or URL."},"required":true,"description":"Event id or URL.","name":"id","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"}],"responses":{"200":{"description":"Event","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Event"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/raw/{provider}/{path}":{"get":{"tags":["raw"],"summary":"Proxy an allow-listed provider route (raw tier, no schema promise)","description":"Returns the provider payload untouched on `meta.raw`, with our envelope, credits, cache and errors. Only allow-listed paths are proxyable; anything else is `404` and is never charged. Query params are forwarded verbatim — provider credentials are injected server-side and never appear in a response.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","minLength":1,"description":"Upstream provider","example":"scrapecreators"},"required":true,"description":"Upstream provider","name":"provider","in":"path"},{"schema":{"type":"string","minLength":1,"description":"The provider's own route path","example":"v1/linkedin/company"},"required":true,"description":"The provider's own route path","name":"path","in":"path"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now"},"required":false,"description":"Bypass the cache and fetch from upstream now","name":"fresh","in":"query"}],"responses":{"200":{"description":"Provider payload on `meta.raw`; `data` is always null","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RawResult"}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/search":{"get":{"tags":["search"],"summary":"Search a platform","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["tiktok","instagram","x","youtube","snapchat","facebook","threads","linkedin","twitch","telegram","linktree","bluesky","salla","zid","mock","reddit","pinterest","truthsocial","kick","rumble","kwai","github","spotify","soundcloud","apple_music","google","amazon","hackernews","appstore"],"description":"Platform to query","example":"tiktok"},"required":true,"description":"Platform to query","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"example":"alice"},"required":true,"name":"q","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor from a previous response’s `meta.next_cursor`"},"required":false,"description":"Opaque cursor from a previous response’s `meta.next_cursor`","name":"cursor","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"},{"schema":{"type":"string","enum":["arabic"],"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3."},"required":false,"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3.","name":"enrich","in":"query"}],"responses":{"200":{"description":"Mixed results discriminated by `kind`","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SearchResult"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/store":{"get":{"tags":["commerce"],"x-internal":true,"summary":"Storefront profile (name, logo, links) as a Profile","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["salla","zid"],"description":"Storefront platform","example":"salla"},"required":true,"description":"Storefront platform","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"example":"alkhathlan","description":"Store slug (`salla.sa/<slug>`) or full storefront URL"},"required":true,"description":"Store slug (`salla.sa/<slug>`) or full storefront URL","name":"handle","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"},{"schema":{"type":"string","enum":["arabic"],"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3."},"required":false,"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3.","name":"enrich","in":"query"}],"responses":{"200":{"description":"Store","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Profile"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/products":{"get":{"tags":["commerce"],"x-internal":true,"summary":"List a store’s products, newest first","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["salla","zid"],"description":"Storefront platform","example":"salla"},"required":true,"description":"Storefront platform","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"example":"alkhathlan","description":"Store slug (`salla.sa/<slug>`) or full storefront URL"},"required":true,"description":"Store slug (`salla.sa/<slug>`) or full storefront URL","name":"handle","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor from a previous response’s `meta.next_cursor`"},"required":false,"description":"Opaque cursor from a previous response’s `meta.next_cursor`","name":"cursor","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"},{"schema":{"type":"string","enum":["arabic"],"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3."},"required":false,"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3.","name":"enrich","in":"query"}],"responses":{"200":{"description":"Products; `meta.next_cursor` when more are available","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/product":{"get":{"tags":["commerce"],"x-internal":true,"summary":"Get one product by id","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["salla","zid"],"description":"Storefront platform","example":"salla"},"required":true,"description":"Storefront platform","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"example":"alkhathlan","description":"Store slug (`salla.sa/<slug>`) or full storefront URL"},"required":true,"description":"Store slug (`salla.sa/<slug>`) or full storefront URL","name":"handle","in":"query"},{"schema":{"type":"string","minLength":1,"example":"12542179"},"required":true,"name":"id","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"},{"schema":{"type":"string","enum":["arabic"],"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3."},"required":false,"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3.","name":"enrich","in":"query"}],"responses":{"200":{"description":"Product","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Product"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/{platform}/reviews":{"get":{"tags":["commerce"],"x-internal":true,"summary":"List reviews for a product","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["salla","zid"],"description":"Storefront platform","example":"salla"},"required":true,"description":"Storefront platform","name":"platform","in":"path"},{"schema":{"type":"string","minLength":1,"example":"alkhathlan","description":"Store slug (`salla.sa/<slug>`) or full storefront URL"},"required":true,"description":"Store slug (`salla.sa/<slug>`) or full storefront URL","name":"handle","in":"query"},{"schema":{"type":"string","minLength":1,"example":"12542179"},"required":true,"name":"product_id","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor from a previous response’s `meta.next_cursor`"},"required":false,"description":"Opaque cursor from a previous response’s `meta.next_cursor`","name":"cursor","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Include the untouched upstream payload under `raw`"},"required":false,"description":"Include the untouched upstream payload under `raw`","name":"include_raw","in":"query"},{"schema":{"type":"string","enum":["true","false"],"default":"false","description":"Bypass the cache and fetch from upstream now (2× credits)"},"required":false,"description":"Bypass the cache and fetch from upstream now (2× credits)","name":"fresh","in":"query"},{"schema":{"type":"string","enum":["arabic"],"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3."},"required":false,"description":"Attach an `enrichment` (dialect, sentiment, entities, topics) to each returned object (+3 credits). Failure leaves `enrichment: null` and refunds the +3.","name":"enrich","in":"query"}],"responses":{"200":{"description":"Reviews; `meta.next_cursor` when more are available","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Review"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/search":{"get":{"tags":["search"],"summary":"Search several platforms in one call","description":"Fans out concurrently. Costs the sum of the per-platform search costs; a platform that fails is refunded and marked `error` in `meta.platforms`. If the fan-out exceeds its budget the response is `202` with a `meta.job_id` to poll at `/v1/jobs/{job_id}`.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","minLength":1,"example":"alice"},"required":true,"name":"q","in":"query"},{"schema":{"type":"string","description":"Comma-separated platforms; defaults to every registered platform","example":"tiktok,instagram"},"required":false,"description":"Comma-separated platforms; defaults to every registered platform","name":"platforms","in":"query"},{"schema":{"type":"string","enum":["arabic"],"description":"Attach an `enrichment` to each result (+3 credits)"},"required":false,"description":"Attach an `enrichment` to each result (+3 credits)","name":"enrich","in":"query"}],"responses":{"200":{"description":"All requested platforms finished; `meta.platforms` reports each outcome","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SearchResult"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"202":{"description":"Partial results; the rest are still running under `meta.job_id`. Poll `/v1/jobs/{job_id}`.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SearchResult"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/jobs/{job_id}":{"get":{"tags":["search"],"summary":"Poll a fan-out search job","description":"Free. `200` once every platform has reported, `202` while any is still pending.","security":[{"bearerAuth":[]}],"parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"job_id","in":"path"}],"responses":{"200":{"description":"Job complete; `data` holds every result collected","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SearchResult"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"202":{"description":"Still running; `data` holds what has arrived so far","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SearchResult"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/v1/enrich":{"post":{"tags":["enrich"],"summary":"Classify texts (dialect, sentiment, entities, topics)","description":"Costs 3 credits per request for up to 50 texts. Results are cached by content hash, so repeating a text is fast (and still charged).","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"text":{"type":"array","items":{"type":"string","minLength":1},"minItems":1,"maxItems":50,"example":["واجد حلو هذا المنتج","the shipping was late"]}},"required":["text"]}}}},"responses":{"200":{"description":"One enrichment per input text, in order","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Enrichment"}},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","meta"]}}}},"400":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Missing, malformed, unknown or revoked API key","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Insufficient credits (nothing was charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not found (unknown platform, handle or id)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limited; `retry_after` seconds and a `Retry-After` header are set","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"503":{"description":"Platform unavailable (upstream error; never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"504":{"description":"Upstream timeout (never charged)","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}}}