Trailer

Choose a video's reference by its REF id (free).

Body { refsId }: the film is looked up (free), checked against the policy and stored; its pacing becomes the plan's target, as numbers only, and any earlier comparison is cleared. 404 reference_not_found for a REF id refs does not list; 409 project_not_product for a story project; 403 references_unavailable when switched off or for a destination that takes no reference. Scope: story:write.

put/trailers/{jobId}/reference

Request

  • Base URL: https://docs.sleeperhit.studio/api/v1
  • URL: https://docs.sleeperhit.studio/api/v1/trailers/{jobId}/reference
  • Auth: HTTP bearer

Request body

refsIdstring required

A REF id, e.g. REF-3007.

Response

The video's reference, chosen.

jobIdstring required
availableboolean required

Whether this account may find and choose references for this video now (the live policy, its beta list and the video's destination decide).

checkIsCurrentboolean required

Whether check measured the video's latest master. False once a newer master exists: it may be compared again.

credit'References by refs' required
notestring required

Changes

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