prism

One video URL → detail + stats + transcript + top comments + commenter sample, across YouTube/TikTok/Rumble/Instagram.

Fans out the video detail, comments, an optional transcript (10cr, never charged when the video has none), and ≤3 commenter profiles, folding them into one unified payload. Every leg joins on the same video url. Sync by default; streams Server-Sent Events when include=transcript (the transcript leg can take 20s+). legs[] reports each fired leg's status, cost, and latency; coverage + partial_failure flag any degraded leg. Commenter profiles ship for TikTok + Instagram in v1.

get/prism/video-intel

Request

  • Base URL: https://www.socialcrawl.dev/v1
  • URL: https://www.socialcrawl.dev/v1/prism/video-intel
  • Auth: API key in header x-api-key

Query parameters

urlstring required

Absolute http(s) URL of a YouTube, TikTok, Rumble, or Instagram video.

commentsstring

How many top comments to fetch (0-50, default 20). 0 skips the comments leg.

includestring

CSV of optional costed legs: transcript (adds the dedicated transcript leg, +10cr, refunded when null) and/or commenter_profiles (≤3 commenter mini-profiles, TikTok/Instagram in v1).

app_demandboolean

Optional. 1 reads the caption first, then the comments, and returns data.app_demand: late when the caption already names an app, otherwise the count of comments that want an app they do not have, the count that name one, and that ratio. The ratio is withheld unless the comments support it. A low-confidence comment is not counted. No extra credits.

claimstring

Optional sentence. When set, data.sense_check says whether the comments support it, contradict it, or say nothing. A confidence under the cut, or one high-confidence contradiction, withholds the sentence. No extra credits.

Headers

Cache-Controlstring

Send no-cache to bypass the response cache and force a live fetch. Billed at the normal endpoint cost; the fresh result is written back to cache for the next caller. Only the no-cache directive triggers this. See the Response Schema guide for details.

Idempotency-Keystring

Optional UUID that makes the request safely retriable. The key is reserved atomically per account before billing. A concurrent retry receives 409 IDEMPOTENCY_IN_PROGRESS with a Retry-After of 1 second while the original is young, growing to a quarter of the time it has been running (at most 30); a crashed reservation expires after 5 minutes. A replay keeps the cached payload immutable except for billing metadata: credits_used becomes 0, idempotent_replay becomes true, and credits_remaining is refreshed to the current balance. A known current balance appears in both the body and X-Credits-Remaining header; no balance row resolves to 0. On a transient lookup failure, body credits_remaining is null and X-Credits-Remaining is omitted. Completed outcomes expire after 24 hours. If the claim store is unavailable, the request fails closed before billing. GET endpoints do not combine idempotent replay with Server-Sent Events: use Accept: application/json when sending this header. The unsupported key-plus-SSE combination is rejected before billing.

Response

Successful response

successboolean required

Whether the request succeeded

platformstring required

Platform name

endpointstring required

API endpoint path

credits_usedinteger required

Number of credits consumed

credits_remaininginteger nullable required

Current account balance, or null when this response could not establish one. Free cache hits always return null because they do not establish an authoritative post-request balance. An idempotency replay also returns null when its current-balance lookup fails. It is never a fabricated zero, so a zero here means the account really is empty. The authoritative reading is the one on a billed response, which comes straight from the deduction.

request_idstring required

Unique request identifier for support

cachedboolean required

Whether the response was served from cache

idempotent_replayboolean

True only when this response is an idempotency replay

Example response

{
  "success": true,
  "platform": "prism",
  "endpoint": "/v1/prism/video-intel",
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "req-abc123",
  "idempotent_replay": true,
  "meta": {
    "hint": {
      "code": "search_multi",
      "message": "You searched \"matcha\" on 3 platforms one call at a time; /v1/search/multi returns each platform's own search rows in one call at the same price per platform, and a platform with no rows is not charged.",
      "method": "GET",
      "path": "/v1/search/multi?query=matcha&platforms=instagram,tiktok,youtube"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.