Skip to main content

Upload Media

The Upload API allows clients to upload media items (video or audio) to Subly for processing.

How it Works​

Clients request to upload a media item to Subly. The API will return a presigned URL that the client can use to upload the media to Subly.

What You Need​

Clients of the Upload API will need:

  • An API key to use in header x-api-key for all requests.

Endpoints

All API requests require the x-api-key header to be set with the API key received at registration.

API paths use base URL https://api.getsubly.com/v2

Upload Media Request​

Upload a media item (video or audio) and create a new media item in Subly. The API returns a signed URL that the client can use to upload the media file using a PUT request.

Endpoint: POST /media

Body Format: Content-Type: application/json

Body​

  • input
    • media
      • name (string): Name of the media file
      • format (string): Format of the media file e.g. MOV, MP4, MP3 (see full list here: MediaFormat)
      • language (string): Language code for transcription e.g. en-US, en-GB (see full list here: Language (Transcribe))
      • sizeBytes: (number): Size of the media file in bytes

Example​

{
  "input": {
    "media": {
      "name": "my-video.mp4",
      "format": "video/mp4",
      "language": "en-GB",
      "sizeBytes": 123456789
    }
  }
}

Response​

  • mediaId (string): ID of the new media item
  • signedUrl (string): Signed URL to upload the media file to