footage.cool API

openapi: 3.1.0
info:
  title: footage.cool API
  version: '2026-11-08'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-08: 7 operation(s) read from 1 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; footage.cool has published no machine-readable contract that
    the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 0
    documentation: 7
    pages-with-code: 0
    pages-read: 1
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-08'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://www.footage.cool/api/datasets/catalog
paths:
  /api/datasets/accept:
    post:
      operationId: post_api_datasets_accept
      tags:
      - Api
      summary: after the buyer approves
      x-source: https://www.footage.cool/api/datasets/catalog
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiDatasetsAcceptRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiDatasetsAcceptResponse'
      x-evidence:
        kind: documentation
  /api/datasets/agreement.txt:
    get:
      operationId: get_api_datasets_agreement_txt
      tags:
      - Api
      summary: the agreement text
      x-source: https://www.footage.cool/api/datasets/catalog
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiDatasetsAgreementTxtResponse'
      x-evidence:
        kind: documentation
  /api/datasets/catalog:
    get:
      operationId: get_api_datasets_catalog
      tags:
      - Api
      summary: this document
      x-source: https://www.footage.cool/api/datasets/catalog
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiDatasetsCatalogResponse'
      x-evidence:
        kind: documentation
  /api/datasets/checkout:
    post:
      operationId: post_api_datasets_checkout
      tags:
      - Api
      summary: Stripe checkout_url (card orders) or a bank‑wire invoice (4k and larger orders)
      x-source: https://www.footage.cool/api/datasets/catalog
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiDatasetsCheckoutRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiDatasetsCheckoutResponse'
      x-evidence:
        kind: documentation
  /api/datasets/orders/{orderToken}:
    get:
      operationId: get_api_datasets_orders_orderToken
      tags:
      - Api
      summary: status; poll until delivered, then fetch download.manifest_url
      x-source: https://www.footage.cool/api/datasets/catalog
      parameters:
      - name: orderToken
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiDatasetsOrdersOrdertokenResponse'
      x-evidence:
        kind: documentation
  /api/datasets/quotes:
    post:
      operationId: post_api_datasets_quotes
      tags:
      - Api
      summary: order_token, price, agreement hash
      x-source: https://www.footage.cool/api/datasets/catalog
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiDatasetsQuotesRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiDatasetsQuotesResponse'
      x-evidence:
        kind: documentation
  /api/datasets/scope:
    post:
      operationId: post_api_datasets_scope
      tags:
      - Api
      summary: counts and hours (free, no email needed)
      x-source: https://www.footage.cool/api/datasets/catalog
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiDatasetsScopeRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiDatasetsScopeResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    PostApiDatasetsAcceptRequest:
      type: object
      properties:
        order_token:
          type: string
          description: Token of the order to accept.
        agreement_sha256:
          type: string
          description: SHA‑256 hash of the agreement the buyer has read.
        legal_name:
          type: string
          description: Legal name of the buyer organization.
        signer_name:
          type: string
          description: Name of the person signing the agreement.
        confirmed:
          type: boolean
          description: Must be true to confirm acceptance.
      required:
      - order_token
      - agreement_sha256
      - legal_name
      - signer_name
      - confirmed
    PostApiDatasetsAcceptResponse:
      type: object
      properties:
        status:
          type: string
          description: Result of the acceptance (e.g., accepted).
    GetApiDatasetsAgreementTxtResponse:
      type: object
      properties:
        body:
          type: string
          description: Plain‑text agreement document.
        X-Agreement-Sha256:
          type: string
          description: Header containing the SHA‑256 hash of the agreement.
    GetApiDatasetsCatalogResponse:
      type: object
      properties:
        entire catalog JSON:
          type: string
          description: The full dataset catalog as described on the page.
    PostApiDatasetsCheckoutRequest:
      type: object
      properties:
        order_token:
          type: string
          description: Token of the order to checkout.
      required:
      - order_token
    PostApiDatasetsCheckoutResponse:
      type: object
      properties:
        checkout_url:
          type: string
          description: URL to Stripe hosted checkout (for card orders).
        invoice:
          type: object
          description: Bank‑wire invoice details for 4k or large orders.
    GetApiDatasetsOrdersOrdertokenResponse:
      type: object
      properties:
        status:
          type: string
          description: Current order status (e.g., pending, delivered).
        download.manifest_url:
          type: string
          description: URL to the manifest file for downloading the dataset (available after delivery).
    PostApiDatasetsQuotesRequest:
      type: object
      properties:
        tier:
          type: string
          description: Pricing tier identifier.
        media_resolution:
          type: string
          description: Requested media resolution.
        filters:
          type: object
          description: Filter object.
        customer_email:
          type: string
          description: Buyer’s email address.
        customer_org:
          type: string
          description: Buyer’s organization name.
        intended_use:
          type: string
          description: Description of intended use.
      required:
      - tier
      - media_resolution
      - filters
      - customer_email
      - customer_org
      - intended_use
    PostApiDatasetsQuotesResponse:
      type: object
      properties:
        order_token:
          type: string
          description: Token identifying the pending order.
        price:
          type: object
          description: Pricing details (amount, currency).
        agreement_sha256:
          type: string
          description: SHA‑256 hash of the agreement that must be accepted.
    PostApiDatasetsScopeRequest:
      type: object
      properties:
        tier:
          type: string
          description: Pricing tier identifier (e.g., evaluation, research, commercial).
        media_resolution:
          type: string
          description: Requested media resolution (e.g., proxy, 4k).
        filters:
          type: object
          description: Filter object as defined in the page (year range, categories, etc.).
      required:
      - tier
      - media_resolution
      - filters
    PostApiDatasetsScopeResponse:
      type: object
      properties:
        clip_count:
          type: integer
          description: Number of clips matching the filters.
        hours_of_footage:
          type: number
          description: Total hours of footage for the matched clips.
tags:
- name: Api