Runway Characters API — Documents

naftiko: 1.0.0-alpha2
info:
  label: Runway Characters API — Documents
  description: 'Runway Characters API — Documents. 2 operations. Lead operation: Upload a knowledge document. Self-contained
    Naftiko capability covering one Runway business surface.'
  tags:
  - Runway
  - Documents
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    RUNWAY_API_KEY: RUNWAY_API_KEY
capability:
  consumes:
  - type: http
    namespace: characters-documents
    baseUri: https://api.dev.runwayml.com/v1
    description: Runway Characters API — Documents business capability. Self-contained, no shared references.
    resources:
    - name: documents
      path: /documents
      operations:
      - name: createdocument
        method: POST
        description: Upload a knowledge document
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: documents-id
      path: /documents/{id}
      operations:
      - name: deletedocument
        method: DELETE
        description: Delete a knowledge document
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The unique identifier of the document to delete.
          required: true
    authentication:
      type: bearer
      token: '{{env.RUNWAY_API_KEY}}'
  exposes:
  - type: rest
    namespace: characters-documents-rest
    port: 8080
    description: REST adapter for Runway Characters API — Documents. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/documents
      name: documents
      description: REST surface for documents.
      operations:
      - method: POST
        name: createdocument
        description: Upload a knowledge document
        call: characters-documents.createdocument
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/documents/{id}
      name: documents-id
      description: REST surface for documents-id.
      operations:
      - method: DELETE
        name: deletedocument
        description: Delete a knowledge document
        call: characters-documents.deletedocument
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: characters-documents-mcp
    port: 9090
    transport: http
    description: MCP adapter for Runway Characters API — Documents. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: upload-knowledge-document
      description: Upload a knowledge document
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: characters-documents.createdocument
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-knowledge-document
      description: Delete a knowledge document
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: characters-documents.deletedocument
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.