openapi: 3.0.3
info:
  title: Runway Character Performance API
  description: 'The Runway (RunwayML) developer API for generative AI media. All generation is asynchronous: a POST to a generation endpoint creates a task and returns a task id, which the client polls on GET /tasks/{id} until the task reaches SUCCEEDED or FAILED. Every request must include an Authorization Bearer API secret and a dated X-Runway-Version header (for example 2024-11-06). Usage is billed in credits (roughly $0.01 per credit) against a developer organization. This description was authored by API Evangelist from Runway''s public documentation and is not an official Runway artifact; verify shapes against docs.dev.runwayml.com.'
  version: '2024-11-06'
  contact:
    name: Runway
    url: https://docs.dev.runwayml.com
servers:
- url: https://api.dev.runwayml.com/v1
  description: Runway developer API
security:
- bearerAuth: []
tags:
- name: Character Performance
  description: Drive a character with a reference performance (Act-Two).
paths:
  /character_performance:
    post:
      operationId: characterPerformance
      tags:
      - Character Performance
      summary: Create a character-performance task
      description: Drive a target character (image or video) with a reference performance video using the Act-Two model. Returns a task id to poll.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CharacterPerformanceInput'
      responses:
        '200':
          description: The created task.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskCreated'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    TaskCreated:
      type: object
      properties:
        id:
          type: string
          description: The task id to poll on GET /tasks/{id}.
    CharacterPerformanceInput:
      type: object
      required:
      - character
      - reference
      - model
      properties:
        model:
          type: string
          enum:
          - act_two
          example: act_two
        character:
          type: object
          description: The target character to animate.
          properties:
            type:
              type: string
              enum:
              - image
              - video
            uri:
              type: string
        reference:
          type: object
          description: The reference performance video to transfer.
          properties:
            type:
              type: string
              enum:
              - video
            uri:
              type: string
        bodyControl:
          type: boolean
        seed:
          type: integer
  responses:
    RateLimited:
      description: Too many requests - the account rate or concurrency limit was exceeded.
    Unauthorized:
      description: Missing or invalid API secret.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API secret created in the Runway developer portal (dev.runwayml.com), passed as Authorization Bearer YOUR_API_SECRET. Requests must also send a dated X-Runway-Version header.