GET
/
v1
/
viral-library
/
access
TypeScript client
import { OctosparkClient } from '@octospark/sdk'

const client = new OctosparkClient({
  token: process.env.OCTOSPARK_TOKEN
})

const response = await client.viralLibrary.getViralLibraryAccess()
{
  "pageCap": 123,
  "maxLimit": 123,
  "searchAllowed": true,
  "allowedSortBy": [],
  "dailyItemBudget": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Success

​
tier
enum<string>
required

free shows a capped, views-only window; full unlocks every page, sort, search and media file.

Available options:
free,
full
​
reason
enum<string>
required

Why the caller landed on this tier.

Available options:
anonymous,
no_active_subscription,
subscribed_user,
subscribed_api_key,
platform_admin,
guard_disabled
​
pageCap
number | null
required

Pages the caller may read before the sign-in wall; null when unlimited.

​
maxLimit
number
required

Largest page size the caller may request.

​
searchAllowed
boolean
required

Whether filter[q] is accepted on this tier.

​
allowedSortBy
enum<string>[]
required

Sort keys the caller may use.

Available options:
playCount,
likeCount,
commentCount,
shareCount,
saveCount,
postedAt,
engagementRate
​
dailyItemBudget
number | null
required

Items the caller may be served per rolling day; null when no per-principal budget applies.