Uploads

Upload a file

Changed on

Uploads a temporary media file that can be referenced in API generation requests. The uploaded files will be automatically expired and deleted after a period of time. It is strongly recommended to use our SDKs for this which have a simplified interface that directly accepts file objects.

post/v1/uploads

Request

  • Base URL
    https://api.dev.runwayml.com
  • URL
    https://api.dev.runwayml.com/v1/uploads
  • Auth
    HTTP bearer

Headers

X-Runway-Version'2024-11-06' required

The version of the RunwayML API being used. You can read more about versioning here.

Request body

filenamestring required

The filename of the file to upload. Must have a valid extension and be a supported media type (image, video, or audio).

type'ephemeral' required

The type of upload to create

Response

The upload URL and Runway URI have been successfully created.

uploadUrlstring uri required

The URL to upload your media file to with a POST request.

fieldsobject required

Fields that must be included in the file upload request as form data.

runwayUristring required

The Runway upload URI to use in other API generation requests

Changes

  • bb2963960c9bRevision changes
    • info

      added the media type application/json for the response with the status

  • 6dab1bdab5d3Revision changes
    • info

      request body became optional

    • info

      removed the non-success response with the status

    • info

      the response's property pattern ^runway:\/\/.* was added for the status

    • info

      added 'propertyNames' constraint to the response property for the status