Trailer

Find reference films for a business video (free).

References are short films from refs.video that match a business video's category, shape and length, shown 4 at a time, each credited "References by refs" and playable in place from its original post through that platform's own player (embed; never rehosted), or shown by its stills when its post cannot be embedded. Choosing one makes its pacing — average and longest shot, cut rate, first cut, voice — the planner's target, as numbers only: a reference is an idea, never content to copy. Finding, choosing and clearing a reference are free; product projects only. A POST although it only reads: what the writer is making rides the JSON body, never a URL an access log could keep. refs receives the abstracted brief — one category, one shape and a duration band — and at most four plain keywords drawn from the feature names and notes (single lowercase words: never the notes themselves, the product's or the release's name, a person's name, a number or a link), so what the writer types changes which films come up; keywords answers the words sent (empty when none were, or the day's keyword headroom is used). The films are then put in order of fit to the whole intent on our side: order: 'fit', else the search's own order (order: 'refs': no intent given, or the order could not be read now). A story project is 409 project_not_product; switched off or not open to this account is 403 references_unavailable; the day's free finds used up is 429 reference_allowance_reached. Scope: story:read.

post/story-projects/{projectId}/references

Request

  • Base URL: https://docs.sleeperhit.studio/api/v1
  • URL: https://docs.sleeperhit.studio/api/v1/story-projects/{projectId}/references
  • Auth: HTTP bearer

Request body

scope'feature' | 'release'

The video's scope: feature searches demo films by default, release launch films.

categorystring

A refs category the policy allows (default by scope).

aspectRatio'16:9' | '9:16' | '1:1'
targetSecondsnumber
featureIdsstring[]

The feature-map ids the video shows: the films are put in order of fit to them, and their names lend up to two keywords.

releaseNamestring

A release's name, for the order of fit. Never sent to refs (its words are kept out of the keywords).

notesstring

What the writer is making — who it is for, the moment that matters, what to lead with — for the order of fit and a few plain keywords. The notes themselves are never sent to refs.

Response

The reference films, each credited and playable in place.

projectIdstring required
categorystring required
aspectRatio'16:9' | '9:16' | '1:1' required
targetSecondsnumber required
order'fit' | 'refs' required

fit: the cards are in order of fit to the intent asked with (features, release, notes), closest first. refs: refs' own order (no intent, or the order could not be read now).

keywordsstring[] required

The plain keywords the films were also searched by, drawn from the feature names and notes (sorted). Empty when none were sent.

credit'References by refs' required
notestring required

Changes

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