Reference

Every endpoint, grouped as in openapi.yaml. Each entry says what it does, which credential and scope it needs, every parameter (where it goes, its type, whether it is required, its allowed values, units and default), what comes back, an example request and response, and the error codes it can answer. Paths are added to the base address https://www.recuromedia.com/api/1.0. The example responses are real responses of our API (ids and names replaced); "...": "..." marks a place where we left fields out to keep an example short.

Service, sign-in and account

Service

  • GET /health Tells you that the service is up, whether its database answers, which API version it runs, which optional features are switched on, and the website's addresses.
  • GET /openapi.yaml Downloads the description of this API in the OpenAPI 3.1 format:

Sign-in

Account

  • GET /me Tells you who you are signed in as and what your account can do:
  • GET /catalogue Lists everything a job can be made of:
  • POST /quotes Tells you what a job would cost and whether it would start, without starting it.

Uploads, media and previews

Uploads

Media

  • POST /media/imports Makes a media from a file that is on the internet already (your own storage, Dropbox, Google Drive) instead of uploading it from your computer.
  • GET /media Lists your media, newest first, a page at a time.
  • GET /media/{media_id} Shows one media:
  • GET /media/{media_id}/scenes Lists the scenes the analysis found (a scene is a stretch of film between two cuts), with their first and last frame, start time, whether they are black-and-white or colour, and a sharpness score.
  • GET /media/{media_id}/thumbnail.jpg Gives you a still image (JPEG) of the media at a point in time - for a list or a preview picture in your own program.
  • DELETE /media/{media_id} Deletes a media together with its previews and jobs, as the workspace does.

Previews

Jobs and keyframes

Jobs

Keyframes