List every clip's composed banner lines, ranked, with the burned one marked

Read the banner lines this run already composed for each clip, best first.

Costs nothing: no quota, no burn, no render, no money. Each clip returns its lines ordered by urank (1 = best), each carrying the lane and rank pair the banner write routes take as the line's address, plus selected (the variant actually burned, or null when none is) and provenance (where the burned line came from: title_fallback means the shipped banner was a fallback even though these composed lines existed). To apply a different line, hand its exact lane and rank to POST /v1/runs/{run_id}/clips/{clip_id}/banner-text, which is text-only and spends nothing, or to POST /v1/runs/{run_id}/clips/{clip_id}/banner to burn it onto the master. Only clips that can carry a banner family are listed, which is the same set those routes accept. unaddressable_items is normally 0 and counts lines withheld from that clip because the stored record gave them a malformed address; when it is above 0 the clip has that many more lines than items shows, and none of them can be burned until the record is repaired. Recover from run_not_found by calling GET /v1/runs and choosing an id returned for this account, from run_not_ready by polling GET /v1/runs/{run_id}/progress until the run is terminal, and from scope_missing by minting a runs:read key. For rate_limited or service_unavailable, wait retry_after_sec and retry once.

get/runs/{run_id}/banner-hooks

Request

  • Base URL: https://www.clipzyn.com/v1
  • URL: https://www.clipzyn.com/v1/runs/{run_id}/banner-hooks
  • Auth: HTTP bearer

Path parameters

run_idstring required

Response

Successful Response

object required

Changes

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