Your own systems work in a project with a key
Read and write your projects from your own scripts
Some of the work around a production's stills already lives in a script: a nightly pull into the archive, a tagging pass from a call sheet, a delivery that has to match the lab's naming. The API lets that script work in your projects without a browser.
How it works
Keys
An organization owner makes a key on the API Keys page and picks its scopes, the actions it is allowed to take. The key is shown once. It acts as that owner, so it sees the projects they see, and the activity log records what it did under their name.
A key is sent in an x-api-key header on every request. It keeps working until it expires or is revoked, or until the owner who made it leaves the organization.
What is covered
Assets: list, read, move, hide, publish, set metadata, delete. Folders and tags. Collections and what is in them. Approvals: make a talent link, read its progress, regenerate the passcode. Upload links. Uploads, as a presigned request to storage followed by a confirmation.
Members, roles, billing, permissions and deleting a project are not available through the API. Those stay in the app.
Limits
Six hundred requests a minute per key. Lists that can grow large are paged.
Where it fits
The archive pull
A studio lab runs a nightly job that lists the approved frames in each active project and pulls the originals into its own archive, with the credit and copyright already in the files.
The call-sheet tag
A coordinator's script reads the day's call sheet and tags the morning's upload by scene and character, so the frames are filed before anyone opens the project.
Technical details
- REST over HTTPS, JSON in and out
- One key per task, scoped to what the task needs
- Keys act as the owner who issued them, logged under that owner
- Project and asset reads apply the same visibility rules as the app
- Reference and guides at reelstorage.com/docs/api
Questions
- Who can make a key?
- An organization owner, from the API Keys page in organization settings. The key acts as that owner, narrowed to the scopes chosen when it was made. Keys are on every paid plan.
- What can a key do?
- What the owner who made it can do, minus anything left out of its scopes. Assets, folders, tags, collections, approvals and upload links are covered. Members, billing, permissions and deleting a project are never available to a key.
- Is there a rate limit?
- Yes. Six hundred requests a minute per key. Past that, requests are refused until the minute turns over.
- Do keys expire?
- Ninety days by default. Thirty days, one year and never are available. An owner can revoke a key at any time, and a key dies with its owner's membership.
- Is there a client library?
- No. The API is plain HTTPS with JSON, and the reference shows a request for every operation. Tell us if a library would help.
Tell us what you're shooting next.
Start with one title. Upload a shoot, bring its metadata in from a CSV, and confirm the cast. Then decide.
A person on our team reads it and writes back.