Swarmio Video API

openapi: 3.2.0
info:
  title: SwarmIO Cloud Video API
  version: 1.0.0
  description: 'The x402-payable and public agent surface of ioswarm.io — this root document is what agent discovery (x402scan register-origin, the agentcash probe) reads. The full contract, including the credit-billed account API (sk_swarm_ key), is at /api/v1/openapi.json; the human/agent doc is /llms.txt.


    AI that does real work for you. One POST kicks off a job that searches the web, reads sources, and writes a cited report; poll for the result.


    Agent onboarding (no browser, no human): 1) GET /api/v1/auth/config → Supabase url + anon key. 2) POST {supabase_url}/auth/v1/signup → access_token (email confirmation off). 3) POST /api/v1/agent/register → agent id. 4) POST /api/v1/account/api-keys → sk_swarm_ key (shown once). 5) Authorization: Bearer sk_swarm_… on everything else. Starter credits land automatically on the first authenticated call.


    The full agent doc is https://ioswarm.io/llms.txt; the A2A agent card is at /.well-known/agent-card.json; an MCP facade is at /mcp.'
  x-guidance: 'Agent surface. Paid x402 primitives answer a bare call with a 402 carrying the payment requirements (v1 in the body, v2 base64 in the PAYMENT-REQUIRED header): sign the EIP-3009 transferWithAuthorization they describe and re-send the identical request with X-PAYMENT (v1) or PAYMENT-SIGNATURE (v2). Paid per call: /api/v1/search ($0.02, 25 free/day), /api/v1/search/report ($0.05), /api/v1/news/brief ($0.05), /api/v1/market/price ($0.02, 10 free/day), /api/v1/video/transcript ($0.02, 10 free/day), /api/v1/video/search ($0.02, 25 free/day), /api/v1/x402/quote ($0.01), /api/v1/x402/fetch ($0.02), /api/v1/x402/chat ($0.02), /api/v1/feeds/{feed} ($0.01-$0.02; a free 24h-delayed edition sits at /api/v1/feeds/{feed}/sample). Long-running jobs: POST /api/v1/x402/run/{mode} ($0.25-$1.85 per run; the paying wallet becomes the account). Credit-billed account surface (API key, not x402): GET /api/v1/auth/config to discover the Supabase backend, sign up (email confirmation is off), POST /api/v1/agent/register, then POST /api/v1/account/api-keys for an sk_swarm_ key.'
  contact:
    url: https://ioswarm.io
    email: support@ioservices.io
servers:
- url: https://ioswarm.io
tags:
- name: Video
paths:
  /api/v1/video/transcript:
    post:
      operationId: videoTranscript
      summary: YouTube captions for one video as timestamped segments (title, duration…
      security: []
      x-payment-info:
        price:
          mode: fixed
          currency: USD
          amount: '0.020000'
        protocols:
        - x402: {}
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: One of url or video_id is required.
              properties:
                url:
                  type: string
                  description: a YouTube URL — watch, shorts, youtu.be, live, embed
                video_id:
                  type: string
                  description: an 11-character YouTube video id (alternative to url)
                lang:
                  type: string
                  description: caption language (default "en")
                format:
                  type: string
                  enum:
                  - segments
                  - text
                  description: segments (default, timestamped) or one flat text
      parameters:
      - name: X-PAYMENT
        in: header
        required: false
        schema:
          type: string
        description: 'v1: the signed payment payload, base64.'
      - name: PAYMENT-SIGNATURE
        in: header
        required: false
        schema:
          type: string
        description: 'v2: the signed payment payload, base64.'
      responses:
        '200':
          description: '{known, video_id, url, title, duration_sec, lang, segment_count, segments, text, truncated?, error?, timeout?, quota | paid}.'
        '402':
          description: Over the free quota — the payment requirements (v1 in the body, v2 in PAYMENT-REQUIRED).
        '400':
          description: Neither url nor video_id (or a garbage body with a payment header) — refused before the facilitator is asked.
        '503':
          description: Machine payments are not configured.
      tags:
      - Video
  /api/v1/video/search:
    post:
      operationId: videoSearch
      summary: YouTube video search — title, channel, duration, view count, live status, with…
      security: []
      x-payment-info:
        price:
          mode: fixed
          currency: USD
          amount: '0.020000'
        protocols:
        - x402: {}
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - query
              properties:
                query:
                  type: string
                  description: what to search for
                limit:
                  type: integer
                  minimum: 1
                  maximum: 50
                  description: results (default 10)
                sort:
                  type: string
                  enum:
                  - relevance
                  - rating
                  - date
                  - views
                within:
                  type: string
                  enum:
                  - hour
                  - today
                  - week
                  - month
                  - year
                  description: recency filter (server-side; the only way to get genuinely recent results)
                duration:
                  type: string
                  enum:
                  - short
                  - medium
                  - long
      parameters:
      - name: X-PAYMENT
        in: header
        required: false
        schema:
          type: string
        description: 'v1: the signed payment payload, base64.'
      - name: PAYMENT-SIGNATURE
        in: header
        required: false
        schema:
          type: string
        description: 'v2: the signed payment payload, base64.'
      responses:
        '200':
          description: '{known, query, count, results: [{id, title, url, channel, duration_sec, view_count, live_status}], error?, timeout?, quota | paid}.'
        '402':
          description: Over the free quota — the payment requirements (v1 in the body, v2 in PAYMENT-REQUIRED).
        '400':
          description: Missing query (or a garbage body with a payment header) — refused before the facilitator is asked.
        '503':
          description: Machine payments are not configured.
      tags:
      - Video
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: An sk_swarm_ API key (long-lived; self-mint via /api/v1/account/api-keys) or a Supabase access_token (short-lived; from signup).