openapi.json

{
  "openapi": "3.1.0",
  "info": {
    "title": "BOB YouTube API",
    "version": "0.1.0",
    "description": "HTTP API over the BOB YouTube Docker/CLI contract. Responses include request_id/X-Request-ID. Failed jobs include a machine-readable failure object."
  },
  "servers": [
    {
      "url": "http://127.0.0.1:8080"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    },
    {
      "bobToken": []
    }
  ],
  "paths": {
    "/": {
      "get": {
        "summary": "Service discovery",
        "security": [],
        "responses": {
          "200": {
            "description": "Service metadata and endpoint list"
          },
          "429": {
            "description": "Rate limit exceeded"
          }
        }
      }
    },
    "/openapi.json": {
      "get": {
        "summary": "OpenAPI specification",
        "security": [],
        "responses": {
          "200": {
            "description": "OpenAPI document"
          },
          "429": {
            "description": "Rate limit exceeded"
          }
        }
      }
    },
    "/version": {
      "get": {
        "summary": "Service version",
        "security": [],
        "responses": {
          "200": {
            "description": "Service version metadata"
          },
          "429": {
            "description": "Rate limit exceeded"
          }
        }
      }
    },
    "/health": {
      "get": {
        "summary": "Runtime health and dependency report",
        "responses": {
          "200": {
            "description": "Service is healthy. Includes cookie_contract mount metadata when BOB_YOUTUBE_COOKIES_FILE is configured, plus queue_backend, queue_dir, queue_depth, lease_depth, and worker_count."
          },
          "500": {
            "description": "Dependency check failed"
          },
          "429": {
            "description": "Rate limit exceeded"
          }
        }
      }
    },
    "/library": {
      "get": {
        "summary": "Read the local corpus index",
        "parameters": [
          {
            "name": "refresh",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "enum": ["1", "true", "yes"]
            },
            "description": "Regenerate the index before returning it."
          }
        ],
        "responses": {
          "200": {
            "description": "Library index"
          },
          "500": {
            "description": "Index refresh failed"
          },
          "429": {
            "description": "Rate limit exceeded"
          }
        }
      }
    },
    "/where/{video_id}": {
      "get": {
        "summary": "Return the output directory for a video ID",
        "parameters": [
          {
            "name": "video_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Output path command succeeded"
          },
          "400": {
            "description": "Missing or invalid video ID"
          },
          "429": {
            "description": "Rate limit exceeded"
          }
        }
      }
    },
    "/jobs": {
      "get": {
        "summary": "List in-memory and loaded persisted jobs",
        "responses": {
          "200": {
            "description": "Job list"
          },
          "429": {
            "description": "Rate limit exceeded"
          }
        }
      },
      "post": {
        "summary": "Create a sync or async BOB YouTube job",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/JobRequest"
              },
              "examples": {
                "info": {
                  "value": {
                    "command": "info",
                    "url": "https://www.youtube.com/watch?v=VIDEO_ID",
                    "timeout": 120
                  }
                },
                "asyncBoth": {
                  "value": {
                    "command": "both",
                    "url": "https://www.youtube.com/watch?v=VIDEO_ID",
                    "async": true,
                    "langs": "hi-orig,-live_chat",
                    "profile": "agent",
                    "timeout": 3600,
                    "webhook_url": "https://example.com/bob-youtube/webhook",
                    "idempotency_key": "product-job-123"
                  }
                },
                "where": {
                  "value": {
                    "command": "where",
                    "video_id": "VIDEO_ID"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Synchronous job finished"
          },
          "202": {
            "description": "Asynchronous job accepted"
          },
          "400": {
            "description": "Invalid job request"
          },
          "401": {
            "description": "Missing or invalid token"
          },
          "429": {
            "description": "Rate limit exceeded"
          }
        }
      }
    },
    "/jobs/{job_id}": {
      "get": {
        "summary": "Read one job by ID",
        "parameters": [
          {
            "name": "job_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Job found"
          },
          "404": {
            "description": "Job not found"
          },
          "429": {
            "description": "Rate limit exceeded"
          }
        }
      }
    },
    "/jobs/{job_id}/log": {
      "get": {
        "summary": "Read one job log by ID",
        "parameters": [
          {
            "name": "job_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Plain-text job log"
          },
          "404": {
            "description": "Job or job log not found"
          },
          "429": {
            "description": "Rate limit exceeded"
          }
        }
      }
    },
    "/jobs/{job_id}/events": {
      "get": {
        "summary": "Read one job JSONL event stream by ID",
        "parameters": [
          {
            "name": "job_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Newline-delimited JSON job lifecycle events"
          },
          "404": {
            "description": "Job or job event stream not found"
          },
          "429": {
            "description": "Rate limit exceeded"
          }
        }
      }
    },
    "/metrics": {
      "get": {
        "summary": "Read service metrics",
        "responses": {
          "200": {
            "description": "Job counts, status counts, duration summary, failure categories, filesystem queue/lease state, output byte/throughput summaries, artifact type counters, library size/byte totals, and artifact-derived media/extractor metadata from info JSON"
          },
          "401": {
            "description": "Missing or invalid token"
          },
          "429": {
            "description": "Rate limit exceeded"
          }
        }
      }
    },
    "/metrics.prom": {
      "get": {
        "summary": "Read Prometheus text metrics",
        "responses": {
          "200": {
            "description": "Prometheus/OpenMetrics-style text exposition derived from the same service metrics as GET /metrics"
          },
          "401": {
            "description": "Missing or invalid token"
          },
          "429": {
            "description": "Rate limit exceeded"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer"
      },
      "bobToken": {
        "type": "apiKey",
        "in": "header",
        "name": "X-BOB-YOUTUBE-Token"
      }
    },
    "schemas": {
      "JobRequest": {
        "type": "object",
        "required": ["command"],
        "properties": {
          "command": {
            "type": "string",
            "enum": [
              "info",
              "subs",
              "metadata",
              "thumbnail",
              "transcript",
              "transcript-or-stt",
              "segments",
              "audio",
              "video",
              "both",
              "index",
              "rag",
              "embed",
              "stt",
              "raw",
              "where"
            ]
          },
          "url": {
            "type": "string",
            "format": "uri",
            "description": "Required for URL-based commands."
          },
          "langs": {
            "type": "string",
            "description": "Optional subtitle language selector for transcript/transcript-or-stt/both."
          },
          "video_id": {
            "type": "string",
            "description": "Required for where."
          },
          "path": {
            "type": "string",
            "description": "Required for segments and stt. Optional for rag; defaults to the output root."
          },
          "output_dir": {
            "type": "string",
            "description": "Optional for rag and stt. Defaults to rag-export for rag and the media file directory for stt."
          },
          "output_file": {
            "type": "string",
            "description": "Optional for embed. Defaults to embeddings.jsonl beside chunks.jsonl."
          },
          "args": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Required for raw. Explicit yt-dlp argument array; BOB still owns output root, archive, cookies, config, plugins, and command execution boundaries."
          },
          "profile": {
            "type": "string",
            "enum": ["default", "consumer", "research", "datacenter", "agent"]
          },
          "async": {
            "type": "boolean",
            "default": false
          },
          "max_retries": {
            "type": "integer",
            "minimum": 0,
            "maximum": 5,
            "default": 0,
            "description": "Per-job retry count. Each failed attempt is persisted in job.attempts and the JSONL event stream."
          },
          "webhook_url": {
            "type": "string",
            "format": "uri",
            "description": "Optional HTTP(S) callback URL for a signed job.finished webhook."
          },
          "webhook_secret": {
            "type": "string",
            "description": "Optional per-request HMAC secret for X-BOB-YOUTUBE-Signature-256. Not persisted. If omitted, BOB_YOUTUBE_WEBHOOK_SECRET is used."
          },
          "idempotency_key": {
            "type": "string",
            "description": "Optional key sent as X-Idempotency-Key and included in the webhook payload."
          },
          "webhook_max_attempts": {
            "type": "integer",
            "minimum": 1,
            "maximum": 5,
            "default": 3,
            "description": "Maximum signed webhook delivery attempts. Failed attempts are persisted in job.webhook.deliveries and JSONL events."
          },
          "timeout": {
            "type": "integer",
            "minimum": 1,
            "maximum": 86400,
            "default": 1800
          }
        },
        "additionalProperties": false
      }
    }
  }
}