openapi: 3.2.0
info:
  title: Runway Character Performance Organization API
  description: The Runway (RunwayML) developer API for generative AI media.
  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: Organization
  description: Usage tier and credit balance for the API organization.
paths:
  /organization:
    get:
      operationId: getOrganization
      tags:
      - Organization
      summary: Get organization usage and credit balance
      description: Return the usage tier and remaining credit balance for the organization tied to the API key.
      responses:
        '200':
          description: Organization usage and credit information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Organization'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  responses:
    Unauthorized:
      description: Missing or invalid API secret.
  schemas:
    Organization:
      type: object
      properties:
        creditBalance:
          type: integer
          description: Remaining credits for the organization.
        tier:
          type: object
          description: Usage tier metadata, including per-model concurrency limits.
  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.