Runway Tasks API

The Tasks API from Runway — 1 operation(s) for tasks.

OpenAPI Specification

runway-ml-tasks-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Runway ML Image To Video Tasks API
  description: 'Runway API for generative media. Provides endpoints for generating

    video from images, video from video, and images from text, plus

    task management for asynchronous generation jobs.

    '
  version: 1.0.0
  contact:
    name: Runway Developer Portal
    url: https://docs.dev.runwayml.com/
servers:
- url: https://api.dev.runwayml.com/v1
  description: Runway API production base URL
security:
- bearerAuth: []
tags:
- name: Tasks
paths:
  /tasks/{id}:
    parameters:
    - in: path
      name: id
      required: true
      schema:
        type: string
      description: Task identifier.
    get:
      summary: Retrieve task details
      operationId: getTask
      responses:
        '200':
          description: Task details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Task'
        '404':
          description: Task not found
      tags:
      - Tasks
    delete:
      summary: Cancel or delete a task
      operationId: deleteTask
      responses:
        '204':
          description: Task cancelled or deleted
      tags:
      - Tasks
components:
  schemas:
    Task:
      type: object
      properties:
        id:
          type: string
        status:
          type: string
          enum:
          - PENDING
          - RUNNING
          - SUCCEEDED
          - FAILED
          - CANCELLED
          - THROTTLED
        createdAt:
          type: string
          format: date-time
        output:
          type: array
          items:
            type: string
        failure:
          type: string
        failureCode:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Runway API key issued via the Runway Developer Portal, supplied as a bearer token in the Authorization header.