framefetch-net Batch API

openapi: 3.2.0
info:
  title: Framefetch Net Batch API
  version: 1.7.0
  contact:
    name: FrameFetch
    url: https://framefetch.net
  termsOfService: https://framefetch.net/impressum
  description: 'Operations tagged Batch across 2 of this provider''s published API definitions: openapi.json, framefetch-net-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://framefetch.net
security:
- bearerAuth: []
tags:
- name: Batch
paths:
  /v1/batch:
    post:
      operationId: batchExtract
      summary: Extract up to 10 video URLs in one call
      description: 'Fans out to the same engine as /v1/extract with bounded concurrency. Each url is SSRF-validated and processed independently: a failing url returns { url, ok:false, error } without failing the batch. Billed per SUCCESSFUL item at that item''s own cost; failed items are not billed. Auth, balance and rate-limit are enforced once at the batch level (one rate token per call). Frames/text_overlay need a per-url frames spec, which batch does not accept — request those via /v1/extract.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchRequest'
      responses:
        '200':
          description: Per-url results, in input order
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchResult'
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
        '402':
          $ref: '#/components/responses/Error'
        '429':
          $ref: '#/components/responses/Error'
      tags:
      - Batch
    servers:
    - url: https://framefetch.net
components:
  schemas:
    BatchResult:
      type: object
      properties:
        results:
          type: array
          description: One entry per input url, in order. On ok:true the ExtractResult fields are spread alongside url and ok; on ok:false an error object is included instead.
          items:
            type: object
            required:
            - url
            - ok
            properties:
              url:
                type: string
              ok:
                type: boolean
              error:
                type: object
                properties:
                  code:
                    type: string
                  message:
                    type: string
                  hint:
                    type: string
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            hint:
              type: string
    BatchRequest:
      type: object
      required:
      - urls
      properties:
        urls:
          type: array
          minItems: 1
          maxItems: 10
          items:
            type: string
            format: uri
          description: 1–10 supported-platform video URLs.
        fields:
          type: array
          items:
            type: string
            enum:
            - metadata
            - insights
            - transcript
            - frames
            - text_overlay
            - digest
            - audio_digest
            - structured
            - comments
            - comment_sentiment
            - delta
          default:
          - metadata
          description: Applied to every url. digest, delta, structured, audio_digest, comments and comment_sentiment work in batch (audio_digest always uses the default "alloy" voice — batch does not accept a top-level voice or translate param; comments always uses the default cap of 30 — batch does not accept a top-level comments_cap); frames/text_overlay need a per-url frames spec (not accepted here) — use /v1/extract for those.
  responses:
    Error:
      description: Error envelope
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'API key from POST /v1/keys, sent as ''Authorization: Bearer <key>''.'
x-refined-from:
- openapi.json
- framefetch-net-openapi.json