Rank a breakdown's sounds (GET /v1/breakdowns/{id}/sounds)

GET /v1/breakdowns/{id}/sounds

A Breakdown's sounds, lift basis creator_median, answered as GET /v1/research/{id}/sounds answers them.

Price

Free, forever, filtered or not. Collection is the only thing charged.

Parameters

Name	In	Type	Required	Default	Description
`id`	path	`string`	Required	—	Breakdown id — the id of its Run.
`platforms`	query	`string`	Optional	—	Comma-separated, or repeated, each one of `tiktok`, `instagram`, `youtube`, `facebook`; any other value is a 400. Omit for every platform the research covered. A sound is kept if it was seen on any platform you name; its counts still cover every platform.
`order_by`	query	`string` one of `video_count`, `views`	Optional	`video_count`	`video_count` is how many of the shortlist used the sound, `views` their views added up. Ties break on total views (most first), then the sound id, whatever the `order_by` or `sort` — the same order as the 25 inline on the research, so under `as_of=run` (the default) the default first page is that list and `offset=25` continues it.
`sort`	query	`string` one of `asc`, `desc`	Optional	`desc`	Direction. `desc` is best-first for every `order_by`. Sounds missing the value being sorted on come last in both directions: unknown is not the same as smallest.
`limit`	query	`integer` min 1; max 100	Optional	`25`	Sounds per page. Over the maximum, or negative, is a 400 rather than a silent clamp.
`offset`	query	`integer` min 0	Optional	`0`	Sounds to skip. Past the end returns an empty page with the true `total`.
`as_of`	query	`string` one of `run`, `latest`	Optional	`run`	Which snapshots to read. `run` (the default) is what the research saw, frozen, so the list agrees with the digest. `latest` serves the newest snapshot this API holds for each video, and filters and ordering run over those numbers (a `min_` filter means "over that many now"); `outlier` and `outlier_p90` are recomputed against the research's baseline, `velocity` and `percentile` stay as measured. `latest` is uneven until you refresh: a video is as fresh as the last time anything looked at it, else it keeps the research numbers; `POST /research/{id}/refresh` updates its refreshable videos (TikTok today). Every response states its basis.

Responses

200 OK

{ items, total, limit, offset, as_of }.

object

A page of one research read. items holds the page; it pages with limit and offset over a frozen set.

total integer required Rows matching the filters, before limit and offset.
limit integer required
offset integer required
as_of string required one of run, latest Which snapshots the numbers come from: run is what the research itself saw, frozen, so a read always agrees with the digest; latest is the newest snapshot this API holds for each video.
items array of object required
- value string required
- title string nullable
- platforms array of string required Every platform this tag was observed on in the shortlist. One rollup spans platforms; video_ids are platform:id if you want the split.
- video_count integer required
- total_views number required
- video_ids array of string required
- author string nullable Who made the sound, from the first video that named them. Null when none did; absent on research recorded before it existed.
- is_original boolean nullable True for original audio, false for a catalogue track, so a trend sound can be told from a voiceover. Null when no video said; absent on research recorded before it existed.

200 · `{ items, total, limit, offset, as_of }`.

{
  "items": [
    {
      "value": "7180000000000000000",
      "title": "original sound - someone",
      "author": "someone",
      "is_original": true,
      "platforms": [
        "tiktok"
      ],
      "video_count": 4,
      "total_views": 2140000,
      "video_ids": [
        "tiktok:7300000000000000000"
      ]
    }
  ],
  "total": 27,
  "limit": 25,
  "offset": 0,
  "as_of": "run"
}

400 Bad Request

invalid_request — an unknown platform, an unknown order_by, sort or as_of, a limit outside 1 to 100, or a negative or non-integer offset.

Code: invalid_request. The problem body and every code are on Errors.

object

RFC 9457 problem document, served as application/problem+json. Branch on code, never on the prose. retryable and action say whether to retry and what to do next.

type string required
title string required
status integer required
code string required one of missing_authorization, invalid_key, key_revoked, key_expired, invalid_token, organization_not_selected, organization_access_revoked, connection_revoked, forbidden, key_scope_insufficient, invalid_request, unsupported_platform, unsupported_kind, kind_deprecated, focus_unsupported_kind, not_found, comment_not_found, video_too_long, idempotency_conflict, run_not_ready, advertiser_ambiguous, insufficient_balance, max_credits_exceeded, key_spend_cap_exceeded, rate_limit_exceeded, concurrency_limit_exceeded, tracker_limit_exceeded, webhook_limit_exceeded, webhook_rotation_in_progress, collection_limit_exceeded, collection_name_taken, collection_kind_mismatch, media_unavailable, vendor_error, source_unavailable, service_unavailable, internal_error Stable machine-readable code.
detail string
errors array of object On invalid_request from a field that failed validation: one entry per problem, so you can find the field without parsing detail. Absent when no single field is at fault, e.g. a body that is not JSON.
- path string required Dotted path of the field to fix, e.g. collection_ids.1 or cursor. Empty for an issue with the request body as a whole.
- message string required What is wrong with that field.
request_id string The request this problem answers, the same as its X-Request-Id header. Quote it to support.
retryable boolean required Whether sending the same request again, after any wait named here, can succeed: true for a rate or concurrency limit, an upstream outage, an internal error or a Run not yet settled; false when the request must change or a person must act. Fixed per code.
action string required The next step, in one sentence.
remedy string What to do next, as the code's error reference page says it; fuller than action. On every problem a request answers with; a per-item error inside a result may omit it.
retry_after_seconds integer value at least 0 Seconds to wait before retrying; the same as the Retry-After header. On rate_limit_exceeded, concurrency_limit_exceeded, source_unavailable and service_unavailable.
expired_at string When the key expired. On key_expired.
resets_at string When the request window (rate_limit_exceeded) or the key's month (key_spend_cap_exceeded) resets.
limit integer The limit that was hit, on the *_limit_exceeded codes.
running integer Runs in flight. On concurrency_limit_exceeded.
active integer Active Trackers or webhook endpoints. On tracker_limit_exceeded and webhook_limit_exceeded.
requested integer Trackers the request would resume. On tracker_limit_exceeded from a Collection action.
count integer Collections held. On collection_limit_exceeded.
balance_credits integer The Balance, in Credits. On insufficient_balance.
required_credits integer What the call needs, in Credits (the worst case where quoted). On insufficient_balance.
max_credits integer The cap the call sent. On max_credits_exceeded.
estimate_credits integer The call's worst-case quote, in Credits. On max_credits_exceeded and key_spend_cap_exceeded.
cap_credits integer The key's monthly cap. On key_spend_cap_exceeded.
spent_credits integer The key's Charges this UTC month. On key_spend_cap_exceeded.
reserved_credits integer What the key's Runs in flight hold. On key_spend_cap_exceeded.
endpoints array of string The sources that could not answer. On source_unavailable.
endpoint string The source that could not answer. On source_unavailable.
candidates array of object The advertisers that carry the name, to ask again with. On advertiser_ambiguous.
supported_kinds array of string The kinds that are accepted. On kind_deprecated and focus_unsupported_kind.
duration_seconds number The video's length. On video_too_long.
max_duration_seconds number The longest video accepted. On video_too_long.
overlap_expires_at string When the previous secret stops working. On webhook_rotation_in_progress.
scope string always read_only The key's scope. On key_scope_insufficient.
required string always full The scope the call needs. On key_scope_insufficient.
collection_id string The Collection that already has the name. On collection_name_taken.
collection_kind string The Collection's kind. On collection_kind_mismatch.
kind string The kind that was offered. On collection_kind_mismatch.
run_id string The Run the Idempotency-Key already belongs to. On idempotency_conflict.
reason string A short machine-readable reason, where a code has several.
reference_id string Our reference for an unexpected failure, the same as request_id; quote it when reporting it.
run object The Run, on a failed Run's body, so its id is kept.
- id string required
- kind string required What was run, e.g. video_lookup.
- status string required one of running, completed, partial, failed partial keeps the completed items and charges for them, up to what the Balance covers; failed charges nothing.
- created_at string required RFC 3339.
- completed_at string required nullable Null while the Run is still running.
- charge_credits integer required What this Run actually cost, in Credits. A stored answer costs the same as a fresh one.
- list_price_credits integer required The full price of the work asked for, in Credits. Equal to charge_credits unless the Run charged for only part of it.
- cached boolean required True when a stored result answered without a fresh fetch.
- progress object What a running Research has done so far, refreshed as it works: its stage and the counts known by then, such as analysed of shortlisted. A count is absent until its stage produced it. Absent once the Run settles, and on every other kind.
  stage string required one of keywords, searching, reading_creators, filtering, analysing, writing_digest
  keywords integer value at least 0
  creators integer value at least 0
  creators_read integer value at least 0
  searches integer value at least 0
  found integer value at least 0
  judged integer value at least 0
  kept integer value at least 0
  dropped_off_topic integer value at least 0
  dropped_unsure integer value at least 0
  shortlisted integer value at least 0
  analysed integer value at least 0
  updated_at string required
error object The same problem, nested, on a failed Run's body.

400 · Example

{
  "type": "https://www.shortsintel.com/docs/reference/errors/invalid_request",
  "title": "Invalid request",
  "status": 400,
  "code": "invalid_request",
  "detail": "`limit` must be an integer between 1 and 100, and `offset` a non-negative integer.",
  "retryable": false,
  "action": "Fix the field named in `detail`, then send the corrected request."
}

401 Unauthorized

missing_authorization, invalid_key, key_revoked, key_expired or invalid_token.

Codes: missing_authorization, invalid_key, key_revoked, key_expired, invalid_token. The problem body and every code are on Errors.

object

RFC 9457 problem document, served as application/problem+json. Branch on code, never on the prose. retryable and action say whether to retry and what to do next.

type string required
title string required
status integer required
code string required one of missing_authorization, invalid_key, key_revoked, key_expired, invalid_token, organization_not_selected, organization_access_revoked, connection_revoked, forbidden, key_scope_insufficient, invalid_request, unsupported_platform, unsupported_kind, kind_deprecated, focus_unsupported_kind, not_found, comment_not_found, video_too_long, idempotency_conflict, run_not_ready, advertiser_ambiguous, insufficient_balance, max_credits_exceeded, key_spend_cap_exceeded, rate_limit_exceeded, concurrency_limit_exceeded, tracker_limit_exceeded, webhook_limit_exceeded, webhook_rotation_in_progress, collection_limit_exceeded, collection_name_taken, collection_kind_mismatch, media_unavailable, vendor_error, source_unavailable, service_unavailable, internal_error Stable machine-readable code.
detail string
errors array of object On invalid_request from a field that failed validation: one entry per problem, so you can find the field without parsing detail. Absent when no single field is at fault, e.g. a body that is not JSON.
- path string required Dotted path of the field to fix, e.g. collection_ids.1 or cursor. Empty for an issue with the request body as a whole.
- message string required What is wrong with that field.
request_id string The request this problem answers, the same as its X-Request-Id header. Quote it to support.
retryable boolean required Whether sending the same request again, after any wait named here, can succeed: true for a rate or concurrency limit, an upstream outage, an internal error or a Run not yet settled; false when the request must change or a person must act. Fixed per code.
action string required The next step, in one sentence.
remedy string What to do next, as the code's error reference page says it; fuller than action. On every problem a request answers with; a per-item error inside a result may omit it.
retry_after_seconds integer value at least 0 Seconds to wait before retrying; the same as the Retry-After header. On rate_limit_exceeded, concurrency_limit_exceeded, source_unavailable and service_unavailable.
expired_at string When the key expired. On key_expired.
resets_at string When the request window (rate_limit_exceeded) or the key's month (key_spend_cap_exceeded) resets.
limit integer The limit that was hit, on the *_limit_exceeded codes.
running integer Runs in flight. On concurrency_limit_exceeded.
active integer Active Trackers or webhook endpoints. On tracker_limit_exceeded and webhook_limit_exceeded.
requested integer Trackers the request would resume. On tracker_limit_exceeded from a Collection action.
count integer Collections held. On collection_limit_exceeded.
balance_credits integer The Balance, in Credits. On insufficient_balance.
required_credits integer What the call needs, in Credits (the worst case where quoted). On insufficient_balance.
max_credits integer The cap the call sent. On max_credits_exceeded.
estimate_credits integer The call's worst-case quote, in Credits. On max_credits_exceeded and key_spend_cap_exceeded.
cap_credits integer The key's monthly cap. On key_spend_cap_exceeded.
spent_credits integer The key's Charges this UTC month. On key_spend_cap_exceeded.
reserved_credits integer What the key's Runs in flight hold. On key_spend_cap_exceeded.
endpoints array of string The sources that could not answer. On source_unavailable.
endpoint string The source that could not answer. On source_unavailable.
candidates array of object The advertisers that carry the name, to ask again with. On advertiser_ambiguous.
supported_kinds array of string The kinds that are accepted. On kind_deprecated and focus_unsupported_kind.
duration_seconds number The video's length. On video_too_long.
max_duration_seconds number The longest video accepted. On video_too_long.
overlap_expires_at string When the previous secret stops working. On webhook_rotation_in_progress.
scope string always read_only The key's scope. On key_scope_insufficient.
required string always full The scope the call needs. On key_scope_insufficient.
collection_id string The Collection that already has the name. On collection_name_taken.
collection_kind string The Collection's kind. On collection_kind_mismatch.
kind string The kind that was offered. On collection_kind_mismatch.
run_id string The Run the Idempotency-Key already belongs to. On idempotency_conflict.
reason string A short machine-readable reason, where a code has several.
reference_id string Our reference for an unexpected failure, the same as request_id; quote it when reporting it.
run object The Run, on a failed Run's body, so its id is kept.
- id string required
- kind string required What was run, e.g. video_lookup.
- status string required one of running, completed, partial, failed partial keeps the completed items and charges for them, up to what the Balance covers; failed charges nothing.
- created_at string required RFC 3339.
- completed_at string required nullable Null while the Run is still running.
- charge_credits integer required What this Run actually cost, in Credits. A stored answer costs the same as a fresh one.
- list_price_credits integer required The full price of the work asked for, in Credits. Equal to charge_credits unless the Run charged for only part of it.
- cached boolean required True when a stored result answered without a fresh fetch.
- progress object What a running Research has done so far, refreshed as it works: its stage and the counts known by then, such as analysed of shortlisted. A count is absent until its stage produced it. Absent once the Run settles, and on every other kind.
  stage string required one of keywords, searching, reading_creators, filtering, analysing, writing_digest
  keywords integer value at least 0
  creators integer value at least 0
  creators_read integer value at least 0
  searches integer value at least 0
  found integer value at least 0
  judged integer value at least 0
  kept integer value at least 0
  dropped_off_topic integer value at least 0
  dropped_unsure integer value at least 0
  shortlisted integer value at least 0
  analysed integer value at least 0
  updated_at string required
error object The same problem, nested, on a failed Run's body.

401 · Example

{
  "type": "https://www.shortsintel.com/docs/reference/errors/invalid_key",
  "title": "Invalid key",
  "status": 401,
  "code": "invalid_key",
  "detail": "That API key does not exist. Keys look like `sk_live_...` and are created in the console.",
  "retryable": false,
  "action": "Check the whole key was copied, or create a new key in the console."
}

404 Not Found

not_found.

Code: not_found. The problem body and every code are on Errors.

object

RFC 9457 problem document, served as application/problem+json. Branch on code, never on the prose. retryable and action say whether to retry and what to do next.

type string required
title string required
status integer required
code string required one of missing_authorization, invalid_key, key_revoked, key_expired, invalid_token, organization_not_selected, organization_access_revoked, connection_revoked, forbidden, key_scope_insufficient, invalid_request, unsupported_platform, unsupported_kind, kind_deprecated, focus_unsupported_kind, not_found, comment_not_found, video_too_long, idempotency_conflict, run_not_ready, advertiser_ambiguous, insufficient_balance, max_credits_exceeded, key_spend_cap_exceeded, rate_limit_exceeded, concurrency_limit_exceeded, tracker_limit_exceeded, webhook_limit_exceeded, webhook_rotation_in_progress, collection_limit_exceeded, collection_name_taken, collection_kind_mismatch, media_unavailable, vendor_error, source_unavailable, service_unavailable, internal_error Stable machine-readable code.
detail string
errors array of object On invalid_request from a field that failed validation: one entry per problem, so you can find the field without parsing detail. Absent when no single field is at fault, e.g. a body that is not JSON.
- path string required Dotted path of the field to fix, e.g. collection_ids.1 or cursor. Empty for an issue with the request body as a whole.
- message string required What is wrong with that field.
request_id string The request this problem answers, the same as its X-Request-Id header. Quote it to support.
retryable boolean required Whether sending the same request again, after any wait named here, can succeed: true for a rate or concurrency limit, an upstream outage, an internal error or a Run not yet settled; false when the request must change or a person must act. Fixed per code.
action string required The next step, in one sentence.
remedy string What to do next, as the code's error reference page says it; fuller than action. On every problem a request answers with; a per-item error inside a result may omit it.
retry_after_seconds integer value at least 0 Seconds to wait before retrying; the same as the Retry-After header. On rate_limit_exceeded, concurrency_limit_exceeded, source_unavailable and service_unavailable.
expired_at string When the key expired. On key_expired.
resets_at string When the request window (rate_limit_exceeded) or the key's month (key_spend_cap_exceeded) resets.
limit integer The limit that was hit, on the *_limit_exceeded codes.
running integer Runs in flight. On concurrency_limit_exceeded.
active integer Active Trackers or webhook endpoints. On tracker_limit_exceeded and webhook_limit_exceeded.
requested integer Trackers the request would resume. On tracker_limit_exceeded from a Collection action.
count integer Collections held. On collection_limit_exceeded.
balance_credits integer The Balance, in Credits. On insufficient_balance.
required_credits integer What the call needs, in Credits (the worst case where quoted). On insufficient_balance.
max_credits integer The cap the call sent. On max_credits_exceeded.
estimate_credits integer The call's worst-case quote, in Credits. On max_credits_exceeded and key_spend_cap_exceeded.
cap_credits integer The key's monthly cap. On key_spend_cap_exceeded.
spent_credits integer The key's Charges this UTC month. On key_spend_cap_exceeded.
reserved_credits integer What the key's Runs in flight hold. On key_spend_cap_exceeded.
endpoints array of string The sources that could not answer. On source_unavailable.
endpoint string The source that could not answer. On source_unavailable.
candidates array of object The advertisers that carry the name, to ask again with. On advertiser_ambiguous.
supported_kinds array of string The kinds that are accepted. On kind_deprecated and focus_unsupported_kind.
duration_seconds number The video's length. On video_too_long.
max_duration_seconds number The longest video accepted. On video_too_long.
overlap_expires_at string When the previous secret stops working. On webhook_rotation_in_progress.
scope string always read_only The key's scope. On key_scope_insufficient.
required string always full The scope the call needs. On key_scope_insufficient.
collection_id string The Collection that already has the name. On collection_name_taken.
collection_kind string The Collection's kind. On collection_kind_mismatch.
kind string The kind that was offered. On collection_kind_mismatch.
run_id string The Run the Idempotency-Key already belongs to. On idempotency_conflict.
reason string A short machine-readable reason, where a code has several.
reference_id string Our reference for an unexpected failure, the same as request_id; quote it when reporting it.
run object The Run, on a failed Run's body, so its id is kept.
- id string required
- kind string required What was run, e.g. video_lookup.
- status string required one of running, completed, partial, failed partial keeps the completed items and charges for them, up to what the Balance covers; failed charges nothing.
- created_at string required RFC 3339.
- completed_at string required nullable Null while the Run is still running.
- charge_credits integer required What this Run actually cost, in Credits. A stored answer costs the same as a fresh one.
- list_price_credits integer required The full price of the work asked for, in Credits. Equal to charge_credits unless the Run charged for only part of it.
- cached boolean required True when a stored result answered without a fresh fetch.
- progress object What a running Research has done so far, refreshed as it works: its stage and the counts known by then, such as analysed of shortlisted. A count is absent until its stage produced it. Absent once the Run settles, and on every other kind.
  stage string required one of keywords, searching, reading_creators, filtering, analysing, writing_digest
  keywords integer value at least 0
  creators integer value at least 0
  creators_read integer value at least 0
  searches integer value at least 0
  found integer value at least 0
  judged integer value at least 0
  kept integer value at least 0
  dropped_off_topic integer value at least 0
  dropped_unsure integer value at least 0
  shortlisted integer value at least 0
  analysed integer value at least 0
  updated_at string required
error object The same problem, nested, on a failed Run's body.

404 · Example

{
  "type": "https://www.shortsintel.com/docs/reference/errors/not_found",
  "title": "Not found",
  "status": 404,
  "code": "not_found",
  "detail": "No research with that id for this Customer.",
  "retryable": false,
  "action": "Check the id or handle; list your resources to find the right one."
}

409 Conflict

run_not_ready — the research is still running, or failed with nothing to serve. If it is still running, poll GET /v1/runs/{id} and read again once it settles; a failed research never becomes readable.

Code: run_not_ready. The problem body and every code are on Errors.

object

RFC 9457 problem document, served as application/problem+json. Branch on code, never on the prose. retryable and action say whether to retry and what to do next.

type string required
title string required
status integer required
code string required one of missing_authorization, invalid_key, key_revoked, key_expired, invalid_token, organization_not_selected, organization_access_revoked, connection_revoked, forbidden, key_scope_insufficient, invalid_request, unsupported_platform, unsupported_kind, kind_deprecated, focus_unsupported_kind, not_found, comment_not_found, video_too_long, idempotency_conflict, run_not_ready, advertiser_ambiguous, insufficient_balance, max_credits_exceeded, key_spend_cap_exceeded, rate_limit_exceeded, concurrency_limit_exceeded, tracker_limit_exceeded, webhook_limit_exceeded, webhook_rotation_in_progress, collection_limit_exceeded, collection_name_taken, collection_kind_mismatch, media_unavailable, vendor_error, source_unavailable, service_unavailable, internal_error Stable machine-readable code.
detail string
errors array of object On invalid_request from a field that failed validation: one entry per problem, so you can find the field without parsing detail. Absent when no single field is at fault, e.g. a body that is not JSON.
- path string required Dotted path of the field to fix, e.g. collection_ids.1 or cursor. Empty for an issue with the request body as a whole.
- message string required What is wrong with that field.
request_id string The request this problem answers, the same as its X-Request-Id header. Quote it to support.
retryable boolean required Whether sending the same request again, after any wait named here, can succeed: true for a rate or concurrency limit, an upstream outage, an internal error or a Run not yet settled; false when the request must change or a person must act. Fixed per code.
action string required The next step, in one sentence.
remedy string What to do next, as the code's error reference page says it; fuller than action. On every problem a request answers with; a per-item error inside a result may omit it.
retry_after_seconds integer value at least 0 Seconds to wait before retrying; the same as the Retry-After header. On rate_limit_exceeded, concurrency_limit_exceeded, source_unavailable and service_unavailable.
expired_at string When the key expired. On key_expired.
resets_at string When the request window (rate_limit_exceeded) or the key's month (key_spend_cap_exceeded) resets.
limit integer The limit that was hit, on the *_limit_exceeded codes.
running integer Runs in flight. On concurrency_limit_exceeded.
active integer Active Trackers or webhook endpoints. On tracker_limit_exceeded and webhook_limit_exceeded.
requested integer Trackers the request would resume. On tracker_limit_exceeded from a Collection action.
count integer Collections held. On collection_limit_exceeded.
balance_credits integer The Balance, in Credits. On insufficient_balance.
required_credits integer What the call needs, in Credits (the worst case where quoted). On insufficient_balance.
max_credits integer The cap the call sent. On max_credits_exceeded.
estimate_credits integer The call's worst-case quote, in Credits. On max_credits_exceeded and key_spend_cap_exceeded.
cap_credits integer The key's monthly cap. On key_spend_cap_exceeded.
spent_credits integer The key's Charges this UTC month. On key_spend_cap_exceeded.
reserved_credits integer What the key's Runs in flight hold. On key_spend_cap_exceeded.
endpoints array of string The sources that could not answer. On source_unavailable.
endpoint string The source that could not answer. On source_unavailable.
candidates array of object The advertisers that carry the name, to ask again with. On advertiser_ambiguous.
supported_kinds array of string The kinds that are accepted. On kind_deprecated and focus_unsupported_kind.
duration_seconds number The video's length. On video_too_long.
max_duration_seconds number The longest video accepted. On video_too_long.
overlap_expires_at string When the previous secret stops working. On webhook_rotation_in_progress.
scope string always read_only The key's scope. On key_scope_insufficient.
required string always full The scope the call needs. On key_scope_insufficient.
collection_id string The Collection that already has the name. On collection_name_taken.
collection_kind string The Collection's kind. On collection_kind_mismatch.
kind string The kind that was offered. On collection_kind_mismatch.
run_id string The Run the Idempotency-Key already belongs to. On idempotency_conflict.
reason string A short machine-readable reason, where a code has several.
reference_id string Our reference for an unexpected failure, the same as request_id; quote it when reporting it.
run object The Run, on a failed Run's body, so its id is kept.
- id string required
- kind string required What was run, e.g. video_lookup.
- status string required one of running, completed, partial, failed partial keeps the completed items and charges for them, up to what the Balance covers; failed charges nothing.
- created_at string required RFC 3339.
- completed_at string required nullable Null while the Run is still running.
- charge_credits integer required What this Run actually cost, in Credits. A stored answer costs the same as a fresh one.
- list_price_credits integer required The full price of the work asked for, in Credits. Equal to charge_credits unless the Run charged for only part of it.
- cached boolean required True when a stored result answered without a fresh fetch.
- progress object What a running Research has done so far, refreshed as it works: its stage and the counts known by then, such as analysed of shortlisted. A count is absent until its stage produced it. Absent once the Run settles, and on every other kind.
  stage string required one of keywords, searching, reading_creators, filtering, analysing, writing_digest
  keywords integer value at least 0
  creators integer value at least 0
  creators_read integer value at least 0
  searches integer value at least 0
  found integer value at least 0
  judged integer value at least 0
  kept integer value at least 0
  dropped_off_topic integer value at least 0
  dropped_unsure integer value at least 0
  shortlisted integer value at least 0
  analysed integer value at least 0
  updated_at string required
error object The same problem, nested, on a failed Run's body.

409 · Example

{
  "type": "https://www.shortsintel.com/docs/reference/errors/run_not_ready",
  "title": "Run not ready",
  "status": 409,
  "code": "run_not_ready",
  "detail": "Research `run_c07a41bb92` is still running. Poll GET /v1/runs/run_c07a41bb92 until it reaches a terminal status.",
  "retryable": true,
  "action": "Poll the Run until it settles, then read again. If it failed, start a new Run."
}

Request samples

Use ShortsIntel to rank a breakdown's sounds.

- id: id_example
- platforms: tiktok,youtube
- order_by: video_count
- sort: desc
- limit: 25
- offset: 0
- as_of: run

Tell me what it will cost before you run it, then summarise what you find.

If you don't have ShortsIntel tools, don't guess: read https://www.shortsintel.com/agents.md, follow it to connect, then retry this request.

curl "https://www.shortsintel.com/v1/breakdowns/id_example/sounds?platforms=tiktok%2Cyoutube&order_by=video_count&sort=desc&limit=25&offset=0&as_of=run" \
  -H "Authorization: Bearer sk_live_YOUR_KEY"

const response = await fetch(
  "https://www.shortsintel.com/v1/breakdowns/id_example/sounds?platforms=tiktok%2Cyoutube&order_by=video_count&sort=desc&limit=25&offset=0&as_of=run",
  {
    method: "GET",
    headers: {
      "Authorization": "Bearer sk_live_YOUR_KEY",
    },
  },
);

if (!response.ok) {
  throw new Error(`ShortsIntel ${response.status}`);
}

const data = await response.json();

import requests

response = requests.get(
    "https://www.shortsintel.com/v1/breakdowns/id_example/sounds?platforms=tiktok%2Cyoutube&order_by=video_count&sort=desc&limit=25&offset=0&as_of=run",
    headers={
        "Authorization": "Bearer sk_live_YOUR_KEY",
    },
)
response.raise_for_status()

data = response.json()