Tube Archivist

Tube Archivist Task API

The Task API from Tube Archivist — 7 operation(s) for task.

GitHub OpenAPI

Operations 13

GET /api/task/by-id/{task_id}/ Api task by id retrieve #
POST /api/task/by-id/{task_id}/ Api task by id create #
GET /api/task/by-name/ Api task by name list #
GET /api/task/by-name/{task_name}/ Api task by name retrieve #
POST /api/task/by-name/{task_name}/ Api task by name create #
GET /api/task/notification/ Api task notification retrieve #
POST /api/task/notification/ Api task notification create #
DELETE /api/task/notification/ Api task notification destroy #
POST /api/task/notification/test/ Api task notification test create #
GET /api/task/schedule/ Api task schedule retrieve #
GET /api/task/schedule/{task_name}/ Api task schedule retrieve 2 #
POST /api/task/schedule/{task_name}/ Api task schedule create #
DELETE /api/task/schedule/{task_name}/ Api task schedule destroy #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/tubearchivist/openapi/tubearchivist-task-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-task-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-task-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Tubearchivist Task API
  version: v0.6.0
  description: 'Operations tagged Task 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: Task
paths:
  /api/task/by-id/{task_id}/:
    get:
      operationId: api_task_by_id_retrieve
      description: get task by ID
      parameters:
      - in: path
        name: task_id
        schema:
          type: string
        required: true
      tags:
      - Task
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskResult'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: task not found
      summary: Api task by id retrieve
      x-summary-source: derived
    post:
      operationId: api_task_by_id_create
      description: post command to task
      parameters:
      - in: path
        name: task_id
        schema:
          type: string
        required: true
      tags:
      - Task
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaskIDData'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/TaskIDData'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/TaskIDData'
        required: true
      security:
      - tokenAuth: []
      responses:
        '204':
          description: task command sent
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: bad request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: task not found
      summary: Api task by id create
      x-summary-source: derived
  /api/task/by-name/:
    get:
      operationId: api_task_by_name_list
      description: get all stored task results
      tags:
      - Task
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TaskResult'
          description: ''
      summary: Api task by name list
      x-summary-source: derived
  /api/task/by-name/{task_name}/:
    get:
      operationId: api_task_by_name_retrieve
      description: get stored task by name
      parameters:
      - in: path
        name: task_name
        schema:
          type: string
        required: true
      tags:
      - Task
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TaskResult'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: task name not found
      summary: Api task by name retrieve
      x-summary-source: derived
    post:
      operationId: api_task_by_name_create
      description: start new task without args
      parameters:
      - in: path
        name: task_name
        schema:
          type: string
        required: true
      tags:
      - Task
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskResponse'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: bad request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: task name not found
      summary: Api task by name create
      x-summary-source: derived
  /api/task/notification/:
    get:
      operationId: api_task_notification_retrieve
      description: handle get request
      tags:
      - Task
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DynamicDict'
          description: ''
      summary: Api task notification retrieve
      x-summary-source: derived
    post:
      operationId: api_task_notification_create
      description: create notification
      tags:
      - Task
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaskNotificationPost'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/TaskNotificationPost'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/TaskNotificationPost'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DynamicDict'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: bad request
      summary: Api task notification create
      x-summary-source: derived
    delete:
      operationId: api_task_notification_destroy
      description: delete notification
      tags:
      - Task
      security:
      - tokenAuth: []
      responses:
        '204':
          description: notification url deleted
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: bad request
      summary: Api task notification destroy
      x-summary-source: derived
  /api/task/notification/test/:
    post:
      operationId: api_task_notification_test_create
      description: test notification
      tags:
      - Task
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaskNotificationTest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/TaskNotificationTest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/TaskNotificationTest'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          description: test notification sent
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: bad request
      summary: Api task notification test create
      x-summary-source: derived
  /api/task/schedule/:
    get:
      operationId: api_task_schedule_retrieve
      description: get all schedules
      tags:
      - Task
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomPeriodicTask'
          description: ''
      summary: Api task schedule retrieve
      x-summary-source: derived
  /api/task/schedule/{task_name}/:
    get:
      operationId: api_task_schedule_retrieve_2
      description: get single schedule by task_name
      parameters:
      - in: path
        name: task_name
        schema:
          type: string
        required: true
      tags:
      - Task
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomPeriodicTask'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: schedule not found
      summary: Api task schedule retrieve 2
      x-summary-source: derived
    post:
      operationId: api_task_schedule_create
      description: create/update schedule for task
      parameters:
      - in: path
        name: task_name
        schema:
          type: string
        required: true
      tags:
      - Task
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaskCreateData'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/TaskCreateData'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/TaskCreateData'
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomPeriodicTask'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: bad request
      summary: Api task schedule create
      x-summary-source: derived
    delete:
      operationId: api_task_schedule_destroy
      description: delete schedule by task_name
      parameters:
      - in: path
        name: task_name
        schema:
          type: string
        required: true
      tags:
      - Task
      security:
      - tokenAuth: []
      responses:
        '204':
          description: schedule deleted
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: schedule not found
      summary: Api task schedule destroy
      x-summary-source: derived
components:
  schemas:
    ErrorResponse:
      type: object
      description: error message
      properties:
        error:
          type: string
      required:
      - error
    TaskResult:
      type: object
      description: serialize task result stored in redis
      properties:
        status:
          $ref: '#/components/schemas/TaskResultStatusEnum'
        result:
          type:
          - string
          - 'null'
        traceback:
          type:
          - string
          - 'null'
        date_done:
          type: string
        name:
          type: string
        args:
          type: array
          items: {}
        children:
          type: array
          items:
            type: string
        kwargs:
          type: object
          additionalProperties: {}
        worker:
          type: string
        retries:
          type: integer
        queue:
          type: string
        task_id:
          type: string
      required:
      - date_done
      - name
      - result
      - status
      - task_id
      - traceback
    DynamicDict:
      type: object
      properties:
        update_subscribed:
          $ref: '#/components/schemas/TaskNotificationItem'
        download_pending:
          $ref: '#/components/schemas/TaskNotificationItem'
        extract_download:
          $ref: '#/components/schemas/TaskNotificationItem'
        check_reindex:
          $ref: '#/components/schemas/TaskNotificationItem'
        manual_import:
          $ref: '#/components/schemas/TaskNotificationItem'
        run_backup:
          $ref: '#/components/schemas/TaskNotificationItem'
        restore_backup:
          $ref: '#/components/schemas/TaskNotificationItem'
        rescan_filesystem:
          $ref: '#/components/schemas/TaskNotificationItem'
        thumbnail_check:
          $ref: '#/components/schemas/TaskNotificationItem'
        resync_metadata:
          $ref: '#/components/schemas/TaskNotificationItem'
        index_playlists:
          $ref: '#/components/schemas/TaskNotificationItem'
        subscribe_to:
          $ref: '#/components/schemas/TaskNotificationItem'
        version_check:
          $ref: '#/components/schemas/TaskNotificationItem'
    CustomPeriodicTask:
      type: object
      description: serialize CustomPeriodicTask
      properties:
        name:
          type: string
          description: Short Description For This Task
          maxLength: 200
        schedule:
          type: string
        schedule_human:
          type: string
        last_run_at:
          type: string
          format: date-time
        config:
          type: object
          additionalProperties: {}
      required:
      - config
      - last_run_at
      - name
      - schedule
      - schedule_human
    TaskIDDataCommandEnum:
      enum:
      - stop
      - kill
      type: string
      description: '* `stop` - stop

        * `kill` - kill'
    TaskNotificationItem:
      type: object
      description: serialize single task notification
      properties:
        urls:
          type: array
          items:
            type: string
        title:
          type: string
      required:
      - title
      - urls
    TaskNameEnum:
      enum:
      - update_subscribed
      - download_pending
      - extract_download
      - check_reindex
      - manual_import
      - run_backup
      - restore_backup
      - rescan_filesystem
      - thumbnail_check
      - resync_metadata
      - index_playlists
      - subscribe_to
      - version_check
      type: string
      description: '* `update_subscribed` - update_subscribed

        * `download_pending` - download_pending

        * `extract_download` - extract_download

        * `check_reindex` - check_reindex

        * `manual_import` - manual_import

        * `run_backup` - run_backup

        * `restore_backup` - restore_backup

        * `rescan_filesystem` - rescan_filesystem

        * `thumbnail_check` - thumbnail_check

        * `resync_metadata` - resync_metadata

        * `index_playlists` - index_playlists

        * `subscribe_to` - subscribe_to

        * `version_check` - version_check'
    TaskIDData:
      type: object
      description: serialize task by ID POST data
      properties:
        command:
          $ref: '#/components/schemas/TaskIDDataCommandEnum'
      required:
      - command
    TaskNotificationTest:
      type: object
      description: serialize task notification test POST
      properties:
        url:
          type: string
        task_name:
          $ref: '#/components/schemas/TaskNameEnum'
      required:
      - url
    TaskNotificationPost:
      type: object
      description: serialize task notification POST
      properties:
        task_name:
          $ref: '#/components/schemas/TaskNameEnum'
        url:
          type: string
      required:
      - task_name
    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
    TaskCreateData:
      type: object
      description: serialize task create data
      properties:
        schedule:
          type: string
        config:
          type: object
          additionalProperties: {}
    TaskResultStatusEnum:
      enum:
      - PENDING
      - STARTED
      - SUCCESS
      - FAILURE
      - RETRY
      - REVOKED
      type: string
      description: '* `PENDING` - PENDING

        * `STARTED` - STARTED

        * `SUCCESS` - SUCCESS

        * `FAILURE` - FAILURE

        * `RETRY` - RETRY

        * `REVOKED` - REVOKED'
  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