OpenShorts Internal API

The Internal API from OpenShorts — 8 operation(s) for internal.

GitHub OpenAPI

Operations 8

POST /internal/worker/claim Worker Claim #
GET /internal/worker/jobs/{job_id} Worker Job #
GET /internal/worker/jobs/{job_id}/transcript Worker Transcript #
GET /internal/worker/jobs/{job_id}/scenes Worker Scenes #
GET /internal/worker/jobs/{job_id}/source Worker Source #
POST /internal/worker/jobs/{job_id}/log Worker Log #
PUT /internal/worker/jobs/{job_id}/file Worker File #
POST /internal/worker/jobs/{job_id}/done Worker Done #

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/openshorts-app:openshorts-app-internal-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

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

OpenAPI Specification

openshorts-app-internal-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Fast Internal API
  version: 0.1.0
tags:
- name: Internal
paths:
  /internal/worker/claim:
    post:
      summary: Worker Claim
      operationId: worker_claim_internal_worker_claim_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      tags:
      - Internal
  /internal/worker/jobs/{job_id}:
    get:
      summary: Worker Job
      operationId: worker_job_internal_worker_jobs__job_id__get
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          title: Job Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Internal
  /internal/worker/jobs/{job_id}/transcript:
    get:
      summary: Worker Transcript
      description: 'The transcript this host prepared for the job (``main.py

        --prepare-only``), as data: the worker reuses it instead of transcribing

        on its CPU. Only for a live claim on a ready job, like the source.'
      operationId: worker_transcript_internal_worker_jobs__job_id__transcript_get
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          title: Job Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Internal
  /internal/worker/jobs/{job_id}/scenes:
    get:
      summary: Worker Scenes
      description: 'The scene probabilities this host''s card prepared for the job''s source

        (``main.prepare_scenes``), as data: the worker maps them onto its clips

        instead of running TransNetV2 on its CPU. Same rules as the transcript.'
      operationId: worker_scenes_internal_worker_jobs__job_id__scenes_get
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          title: Job Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Internal
  /internal/worker/jobs/{job_id}/source:
    get:
      summary: Worker Source
      operationId: worker_source_internal_worker_jobs__job_id__source_get
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          title: Job Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Internal
  /internal/worker/jobs/{job_id}/log:
    post:
      summary: Worker Log
      operationId: worker_log_internal_worker_jobs__job_id__log_post
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          title: Job Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Internal
  /internal/worker/jobs/{job_id}/file:
    put:
      summary: Worker File
      description: 'One chunk of an output file (``name``), appended at ``offset``.

        ``size`` on the last chunk: the file is complete and moves into the job

        dir. Only a job that is rendering takes files, within its budget.'
      operationId: worker_file_internal_worker_jobs__job_id__file_put
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          title: Job Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Internal
  /internal/worker/jobs/{job_id}/done:
    post:
      summary: Worker Done
      operationId: worker_done_internal_worker_jobs__job_id__done_post
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          title: Job Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Internal
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError