API Reference — subpackage_deepfakeDetection

naftiko: 1.0.0-alpha2
info:
  label: API Reference — subpackage_deepfakeDetection
  description: 'API Reference — subpackage_deepfakeDetection. 5 operations. Lead operation: List all detects. Self-contained
    Naftiko capability covering one Resemble Ai business surface.'
  tags:
  - Resemble Ai
  - subpackage_deepfakeDetection
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    RESEMBLE_AI_API_KEY: RESEMBLE_AI_API_KEY
capability:
  consumes:
  - type: http
    namespace: resemble-ai-subpackage-deepfakedetection
    baseUri: https://f.cluster.resemble.ai
    description: API Reference — subpackage_deepfakeDetection business capability. Self-contained, no shared references.
    resources:
    - name: detect
      path: /detect
      operations:
      - name: listdetections
        method: GET
        description: List all detects
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: page
          in: query
          type: integer
          description: Page number (must be >= 1)
          required: true
        - name: page_size
          in: query
          type: integer
          description: Number of items per page (10-1000)
        - name: Authorization
          in: header
          type: string
          description: API token from https://app.resemble.ai/account/api
          required: true
      - name: createdetection
        method: POST
        description: Create deepfake detection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          description: API token from https://app.resemble.ai/account/api
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: detect-batch
      path: /detect/batch
      operations:
      - name: createdetectbatch
        method: POST
        description: Create a batch deepfake detection job
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          description: API token from https://app.resemble.ai/account/api
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: detect-batch-uuid
      path: /detect/batch/{uuid}
      operations:
      - name: getdetectbatch
        method: GET
        description: Get batch status
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: uuid
          in: path
          type: string
          description: Batch UUID returned by `POST /detect/batch`.
          required: true
        - name: Authorization
          in: header
          type: string
          description: API token from https://app.resemble.ai/account/api
          required: true
    - name: detect-uuid
      path: /detect/{uuid}
      operations:
      - name: getdetection
        method: GET
        description: Get deepfake detection result
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: uuid
          in: path
          type: string
          description: The UUID of the detect object
          required: true
        - name: Authorization
          in: header
          type: string
          description: API token from https://app.resemble.ai/account/api
          required: true
    authentication:
      type: bearer
      token: '{{env.RESEMBLE_AI_API_KEY}}'
  exposes:
  - type: rest
    namespace: resemble-ai-subpackage-deepfakedetection-rest
    port: 8080
    description: REST adapter for API Reference — subpackage_deepfakeDetection. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/detect
      name: detect
      description: REST surface for detect.
      operations:
      - method: GET
        name: listdetections
        description: List all detects
        call: resemble-ai-subpackage-deepfakedetection.listdetections
        with:
          page: rest.page
          page_size: rest.page_size
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createdetection
        description: Create deepfake detection
        call: resemble-ai-subpackage-deepfakedetection.createdetection
        with:
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/detect/batch
      name: detect-batch
      description: REST surface for detect-batch.
      operations:
      - method: POST
        name: createdetectbatch
        description: Create a batch deepfake detection job
        call: resemble-ai-subpackage-deepfakedetection.createdetectbatch
        with:
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/detect/batch/{uuid}
      name: detect-batch-uuid
      description: REST surface for detect-batch-uuid.
      operations:
      - method: GET
        name: getdetectbatch
        description: Get batch status
        call: resemble-ai-subpackage-deepfakedetection.getdetectbatch
        with:
          uuid: rest.uuid
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/detect/{uuid}
      name: detect-uuid
      description: REST surface for detect-uuid.
      operations:
      - method: GET
        name: getdetection
        description: Get deepfake detection result
        call: resemble-ai-subpackage-deepfakedetection.getdetection
        with:
          uuid: rest.uuid
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: resemble-ai-subpackage-deepfakedetection-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — subpackage_deepfakeDetection. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: list-all-detects
      description: List all detects
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: resemble-ai-subpackage-deepfakedetection.listdetections
      with:
        page: tools.page
        page_size: tools.page_size
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: create-deepfake-detection
      description: Create deepfake detection
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: resemble-ai-subpackage-deepfakedetection.createdetection
      with:
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: create-batch-deepfake-detection-job
      description: Create a batch deepfake detection job
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: resemble-ai-subpackage-deepfakedetection.createdetectbatch
      with:
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-batch-status
      description: Get batch status
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: resemble-ai-subpackage-deepfakedetection.getdetectbatch
      with:
        uuid: tools.uuid
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: get-deepfake-detection-result
      description: Get deepfake detection result
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: resemble-ai-subpackage-deepfakedetection.getdetection
      with:
        uuid: tools.uuid
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.