List runs (GET /v1/runs) — ShortsIntel docs

GET/v1/runs

The Customer's recent Runs with their charges, newest first.

Price

Free.

Parameters

Name	In	Type	Required	Default	Description
`limit`	query	`integer`min 1; max 100	Optional	`25`	Items per page.
`cursor`	query	`string`	Optional	—	Opaque `next_cursor` from the previous page.
`status`	query	`string`one of `running`, `completed`, `partial`, `failed`	Optional	—	`running`, `completed`, `partial` or `failed`.
`kind`	query	`string`	Optional	—	Filter by run kind, as `run.kind` carries it: `video_lookup`, `video_search`, `video_intelligence`, `video_score`, `video_comments`, `creator_lookup`, `hashtag_lookup`, `sound_lookup`, `ads_search`, `ad_lookup`, `advertiser_lookup`, `research`, `research_refresh`, `tracker_cycle`, `collection_refresh`, `creator_videos`.

Responses

200 OK

{ items, next_cursor }.

object

itemsarray of objectrequired
- idstringrequired
- kindstringrequiredWhat was run, e.g. video_lookup.
- statusstringrequiredone of running, completed, partial, failedpartial keeps the completed items and charges for them, up to what the Balance covers; failed charges nothing.
- created_atstringrequiredRFC 3339.
- completed_atstringrequirednullableNull while the Run is still running.
- charge_creditsintegerrequiredWhat this Run actually cost, in Credits. A stored answer costs the same as a fresh one.
- list_price_creditsintegerrequiredThe full price of the work asked for, in Credits. Equal to charge_credits unless the Run charged for only part of it.
- cachedbooleanrequiredTrue when a stored result answered without paying the vendor.
- progressobjectWhat a running Research has done so far, refreshed as it works: stage (keywords, searching, filtering, analysing, writing_digest) and the counts known by then — keywords, found, kept, dropped_off_topic, and analysed of shortlisted. A count is absent until its stage produced it. Absent once the Run settles, and on every other kind.
  stagestringrequiredone of keywords, searching, filtering, analysing, writing_digest
  keywordsintegervalue at least 0
  searchesintegervalue at least 0
  foundintegervalue at least 0
  judgedintegervalue at least 0
  keptintegervalue at least 0
  dropped_off_topicintegervalue at least 0
  dropped_unsureintegervalue at least 0
  shortlistedintegervalue at least 0
  analysedintegervalue at least 0
  updated_atstringrequired
next_cursorstringrequirednullablePass back as cursor. Null on the last page.

200 · `{ items, next_cursor }`.

{
  "items": [
    {
      "id": "run_8f2c1ad04b",
      "kind": "video_lookup",
      "status": "completed",
      "created_at": "2026-09-08T09:14:02.418Z",
      "completed_at": "2026-09-08T09:14:04.930Z",
      "charge_credits": 3,
      "list_price_credits": 3,
      "cached": true
    },
    {
      "id": "run_c07a41bb92",
      "kind": "research",
      "status": "partial",
      "created_at": "2026-09-08T09:14:02.418Z",
      "completed_at": "2026-09-08T09:14:04.930Z",
      "charge_credits": 1036,
      "list_price_credits": 1036,
      "cached": false
    }
  ],
  "next_cursor": null
}

400 Bad Request

invalid_request for a cursor that is not a next_cursor this API issued. Nothing is charged.

object

RFC 9457 problem document, served as application/problem+json. Branch on code, never on the prose.

typestringrequired
titlestringrequired
statusintegerrequired
codestringrequiredone of missing_authorization, invalid_key, key_revoked, invalid_token, organization_not_selected, organization_access_revoked, connection_revoked, forbidden, invalid_request, unsupported_platform, unsupported_kind, kind_deprecated, not_found, video_too_long, idempotency_conflict, run_not_ready, advertiser_ambiguous, insufficient_balance, 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_errorStable machine-readable code.
detailstring

400 · Example

{
  "type": "https://www.shortsintel.com/docs/reference/errors/invalid_request",
  "title": "Invalid request",
  "status": 400,
  "code": "invalid_request",
  "detail": "`cursor` is not a cursor this API issued. Pass back the `next_cursor` from the previous page."
}

401 Unauthorized

missing_authorization, invalid_key, key_revoked or invalid_token.

object

RFC 9457 problem document, served as application/problem+json. Branch on code, never on the prose.

typestringrequired
titlestringrequired
statusintegerrequired
codestringrequiredone of missing_authorization, invalid_key, key_revoked, invalid_token, organization_not_selected, organization_access_revoked, connection_revoked, forbidden, invalid_request, unsupported_platform, unsupported_kind, kind_deprecated, not_found, video_too_long, idempotency_conflict, run_not_ready, advertiser_ambiguous, insufficient_balance, 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_errorStable machine-readable code.
detailstring

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."
}

404 Not Found

not_found — including anything belonging to another Customer.

object

RFC 9457 problem document, served as application/problem+json. Branch on code, never on the prose.

typestringrequired
titlestringrequired
statusintegerrequired
codestringrequiredone of missing_authorization, invalid_key, key_revoked, invalid_token, organization_not_selected, organization_access_revoked, connection_revoked, forbidden, invalid_request, unsupported_platform, unsupported_kind, kind_deprecated, not_found, video_too_long, idempotency_conflict, run_not_ready, advertiser_ambiguous, insufficient_balance, 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_errorStable machine-readable code.
detailstring

404 · Example

{
  "type": "https://www.shortsintel.com/docs/reference/errors/not_found",
  "title": "Not found",
  "status": 404,
  "code": "not_found",
  "detail": "No such resource for this Customer."
}

Request samples

curl "https://www.shortsintel.com/v1/runs?limit=25&status=running" \
  -H "Authorization: Bearer sk_live_YOUR_KEY"

const response = await fetch(
  "https://www.shortsintel.com/v1/runs?limit=25&status=running",
  {
    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/runs?limit=25&status=running",
    headers={
        "Authorization": "Bearer sk_live_YOUR_KEY",
    },
)
response.raise_for_status()

data = response.json()

Pagination: Following next_cursor through a list.

Price

Parameters

Responses

200 OK

400 Bad Request

401 Unauthorized

404 Not Found

Request samples

Related guides