Tube Archivist

Tube Archivist Download API

The Download API from Tube Archivist — 3 operation(s) for download.

GitHub OpenAPI

Operations 8

GET /api/download/ Api download retrieve #
POST /api/download/ Api download create #
PATCH /api/download/ Api download partial update #
DELETE /api/download/ Api download destroy #
GET /api/download/{video_id}/ Api download retrieve 2 #
POST /api/download/{video_id}/ Api download create 2 #
DELETE /api/download/{video_id}/ Api download destroy 2 #
GET /api/download/aggs/ Api download aggs retrieve #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/tubearchivist/openapi/tubearchivist-download-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/tubearchivist/json-schema/tubearchivist-user-me-config-schema.json
📊
JSONSchema
https://artifacts.apis.io/tubearchivist/json-schema/tubearchivist-video-schema.json
📊
JSONSchema
https://artifacts.apis.io/tubearchivist/json-schema/tubearchivist-playlist-schema.json
📊
JSONSchema
https://artifacts.apis.io/tubearchivist/json-schema/tubearchivist-channel-schema.json
📊
JSONSchema
https://artifacts.apis.io/tubearchivist/json-schema/tubearchivist-dynamic-dict-schema.json
📊
JSONSchema
https://artifacts.apis.io/tubearchivist/json-schema/tubearchivist-download-item-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/tubearchivist:tubearchivist-download-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

tubearchivist-download-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Tubearchivist Download API
  version: v0.6.0
  description: 'Operations tagged Download across 2 of this provider''s published API definitions: schema.yaml, tubearchivist-openapi.yml. Each path carries the servers of the definition it was published in.'
tags:
- name: Download
paths:
  /api/download/:
    get:
      operationId: api_download_retrieve
      description: get download queue list
      parameters:
      - in: query
        name: channel
        schema:
          type: string
          minLength: 1
        description: channel ID
      - in: query
        name: error
        schema:
          type:
          - boolean
          - 'null'
      - in: query
        name: filter
        schema:
          enum:
          - pending
          - ignore
          type: string
          minLength: 1
        description: '* `pending` - pending

          * `ignore` - ignore'
      - in: query
        name: page
        schema:
          type: integer
      - in: query
        name: q
        schema:
          type: string
          minLength: 1
        description: Search Query
      - in: query
        name: vid_type
        schema:
          enum:
          - videos
          - streams
          - shorts
          type: string
          minLength: 1
        description: '* `videos` - videos

          * `streams` - streams

          * `shorts` - shorts'
      tags:
      - Download
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DownloadList'
          description: ''
      summary: Api download retrieve
      x-summary-source: derived
    post:
      operationId: api_download_create
      description: add list of videos to download queue
      parameters:
      - in: query
        name: autostart
        schema:
          type: boolean
      - in: query
        name: flat
        schema:
          type: boolean
      - in: query
        name: force
        schema:
          type: boolean
      tags:
      - Download
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddToDownloadList'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/AddToDownloadList'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/AddToDownloadList'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskResponse'
          description: New async task started
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad request
      summary: Api download create
      x-summary-source: derived
    patch:
      operationId: api_download_partial_update
      description: bulk update status
      parameters:
      - in: query
        name: channel
        schema:
          type: string
          minLength: 1
      - in: query
        name: error
        schema:
          type:
          - boolean
          - 'null'
      - in: query
        name: filter
        schema:
          enum:
          - pending
          - ignore
          - priority
          type: string
          minLength: 1
        description: '* `pending` - pending

          * `ignore` - ignore

          * `priority` - priority'
        required: true
      - in: query
        name: vid_type
        schema:
          enum:
          - videos
          - streams
          - shorts
          type: string
          minLength: 1
        description: '* `videos` - videos

          * `streams` - streams

          * `shorts` - shorts'
      tags:
      - Download
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedBulkUpdateDowloadData'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedBulkUpdateDowloadData'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedBulkUpdateDowloadData'
      security:
      - tokenAuth: []
      responses:
        '204':
          description: Status updated
      summary: Api download partial update
      x-summary-source: derived
    delete:
      operationId: api_download_destroy
      description: bulk delete download queue items by filter
      parameters:
      - in: query
        name: channel
        schema:
          type: string
          minLength: 1
        description: channel ID
      - in: query
        name: filter
        schema:
          enum:
          - pending
          - ignore
          type: string
          minLength: 1
        description: '* `pending` - pending

          * `ignore` - ignore'
        required: true
      - in: query
        name: vid_type
        schema:
          enum:
          - videos
          - streams
          - shorts
          type: string
          minLength: 1
        description: '* `videos` - videos

          * `streams` - streams

          * `shorts` - shorts'
      tags:
      - Download
      security:
      - tokenAuth: []
      responses:
        '204':
          description: Download items deleted
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad request
      summary: Api download destroy
      x-summary-source: derived
  /api/download/{video_id}/:
    get:
      operationId: api_download_retrieve_2
      description: get download queue item
      parameters:
      - in: path
        name: video_id
        schema:
          type: string
        required: true
      tags:
      - Download
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DownloadItem'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Download item not found
      summary: Api download retrieve 2
      x-summary-source: derived
    post:
      operationId: api_download_create_2
      description: post to video to change status
      parameters:
      - in: path
        name: video_id
        schema:
          type: string
        required: true
      tags:
      - Download
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DownloadQueueItemUpdate'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DownloadQueueItemUpdate'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DownloadQueueItemUpdate'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DownloadQueueItemUpdate'
          description: Download item update
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Download item not found
      summary: Api download create 2
      x-summary-source: derived
    delete:
      operationId: api_download_destroy_2
      description: delete single video from queue
      parameters:
      - in: path
        name: video_id
        schema:
          type: string
        required: true
      tags:
      - Download
      security:
      - tokenAuth: []
      responses:
        '204':
          description: delete download item
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Download item not found
      summary: Api download destroy 2
      x-summary-source: derived
  /api/download/aggs/:
    get:
      operationId: api_download_aggs_retrieve
      description: get aggs
      parameters:
      - in: query
        name: channel
        schema:
          type: string
          minLength: 1
        description: channel ID
      - in: query
        name: filter
        schema:
          enum:
          - pending
          - ignore
          type: string
          minLength: 1
        description: '* `pending` - pending

          * `ignore` - ignore'
        required: true
      - in: query
        name: vid_type
        schema:
          enum:
          - videos
          - streams
          - shorts
          type: string
          minLength: 1
        description: '* `videos` - videos

          * `streams` - streams

          * `shorts` - shorts'
      tags:
      - Download
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DownloadAggs'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: bad request
      summary: Api download aggs retrieve
      x-summary-source: derived
components:
  schemas:
    ErrorResponse:
      type: object
      description: error message
      properties:
        error:
          type: string
      required:
      - error
    PatchedBulkUpdateDowloadData:
      type: object
      description: serialize data
      properties:
        status:
          $ref: '#/components/schemas/BulkUpdateDowloadDataStatusEnum'
    DownloadItemStatusEnum:
      enum:
      - pending
      - ignore
      type: string
      description: '* `pending` - pending

        * `ignore` - ignore'
    AddDownloadItem:
      type: object
      description: serialize single item to add
      properties:
        youtube_id:
          type: string
        status:
          $ref: '#/components/schemas/AddDownloadItemStatusEnum'
      required:
      - status
      - youtube_id
    DownloadList:
      type: object
      description: serialize download list
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/DownloadItem'
        paginate:
          $ref: '#/components/schemas/Pagination'
      required:
      - data
      - paginate
    DownloadAggs:
      type: object
      description: serialize download channel bucket aggregations
      properties:
        doc_count_error_upper_bound:
          type: integer
        sum_other_doc_count:
          type: integer
        buckets:
          type: array
          items:
            $ref: '#/components/schemas/DownloadAggBucket'
      required:
      - buckets
      - doc_count_error_upper_bound
      - sum_other_doc_count
    AddToDownloadList:
      type: object
      description: serialize add to download queue data
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AddDownloadItem'
      required:
      - data
    AsyncTaskResponse:
      type: object
      description: serialize new async task
      properties:
        message:
          type: string
        task_id:
          type: string
        status:
          type: string
        filename:
          type: string
      required:
      - task_id
    Pagination:
      type: object
      description: serialize paginate response
      properties:
        page_size:
          type: integer
        page_from:
          type: integer
        prev_pages:
          type:
          - array
          - 'null'
          items:
            type: integer
        current_page:
          type: integer
        max_hits:
          type: boolean
        params:
          type: string
        last_page:
          type: integer
        next_pages:
          type:
          - array
          - 'null'
          items:
            type: integer
        total_hits:
          type: integer
      required:
      - current_page
      - last_page
      - max_hits
      - next_pages
      - page_from
      - page_size
      - params
      - prev_pages
      - total_hits
    DownloadItemVidTypeEnum:
      enum:
      - videos
      - streams
      - shorts
      - unknown
      type: string
      description: '* `videos` - videos

        * `streams` - streams

        * `shorts` - shorts

        * `unknown` - unknown'
    DownloadQueueItemUpdate:
      type: object
      description: update single download queue item
      properties:
        status:
          $ref: '#/components/schemas/DownloadQueueItemUpdateStatusEnum'
      required:
      - status
    DownloadItem:
      type: object
      description: serialize download item
      properties:
        auto_start:
          type: boolean
        channel_id:
          type: string
        channel_indexed:
          type: boolean
        channel_name:
          type: string
        duration:
          type: string
        message:
          type: string
        published:
          type:
          - string
          - 'null'
        status:
          $ref: '#/components/schemas/DownloadItemStatusEnum'
        timestamp:
          type:
          - integer
          - 'null'
        title:
          type: string
        vid_thumb_url:
          type:
          - string
          - 'null'
        vid_type:
          $ref: '#/components/schemas/DownloadItemVidTypeEnum'
        youtube_id:
          type: string
        _index:
          type: string
          title: ' index'
        _score:
          type: integer
          title: ' score'
      required:
      - channel_id
      - channel_indexed
      - channel_name
      - duration
      - published
      - timestamp
      - title
      - vid_thumb_url
      - vid_type
      - youtube_id
    BulkUpdateDowloadDataStatusEnum:
      enum:
      - pending
      - ignore
      - priority
      - clear_error
      type: string
      description: '* `pending` - pending

        * `ignore` - ignore

        * `priority` - priority

        * `clear_error` - clear_error'
    DownloadQueueItemUpdateStatusEnum:
      enum:
      - pending
      - ignore
      - ignore-force
      - priority
      type: string
      description: '* `pending` - pending

        * `ignore` - ignore

        * `ignore-force` - ignore-force

        * `priority` - priority'
    DownloadAggBucket:
      type: object
      description: serialize bucket
      properties:
        key:
          type: array
          items:
            type: string
        key_as_string:
          type: string
        doc_count:
          type: integer
      required:
      - doc_count
      - key
      - key_as_string
    AddDownloadItemStatusEnum:
      enum:
      - pending
      - ignore-force
      type: string
      description: '* `pending` - pending

        * `ignore-force` - ignore-force'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    cookieAuth:
      type: apiKey
      in: cookie
      name: sessionid
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"
x-refined-from:
- schema.yaml
- tubearchivist-openapi.yml