OpenShorts Clip API

The Clip API from OpenShorts — 6 operation(s) for clip.

GitHub OpenAPI

Operations 6

GET /api/clip/{job_id}/{clip_index}/transcript Get Clip Transcript #
GET /api/clip/{job_id}/{clip_index}/edl Get Clip Edl #
POST /api/clip/rerender Rerender Clip #
POST /api/clip/mode Set Clip Mode #
GET /api/clip/{job_id}/{clip_index}/scenes Get Clip Scenes #
POST /api/clip/reframe Reframe Clip #

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-clip-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-clip-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Fast Clip API
  version: 0.1.0
tags:
- name: Clip
paths:
  /api/clip/{job_id}/{clip_index}/transcript:
    get:
      summary: Get Clip Transcript
      description: Return word-level captions for a specific clip, formatted for Remotion.
      operationId: get_clip_transcript_api_clip__job_id___clip_index__transcript_get
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          title: Job Id
      - name: clip_index
        in: path
        required: true
        schema:
          type: integer
          title: Clip Index
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Clip
  /api/clip/{job_id}/{clip_index}/edl:
    get:
      summary: Get Clip Edl
      description: 'The clip''s editable recipe: which source segments it was cut from, the

        word timeline around them, and whether the source is still available for

        cuts outside the original range.'
      operationId: get_clip_edl_api_clip__job_id___clip_index__edl_get
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          title: Job Id
      - name: clip_index
        in: path
        required: true
        schema:
          type: integer
          title: Clip Index
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Clip
  /api/clip/rerender:
    post:
      summary: Rerender Clip
      description: 'Re-render a clip from an edited EDL (the clip editor''s save button).


        Two paths, chosen automatically:

        - FAST: every segment stays inside the range the canonical clip was cut

        from → recut straight from the already-reframed canonical file. No ML,

        no source needed.

        - SOURCE: a segment reaches outside → recut from the retained source and

        re-reframe with the same engine the pipeline used. 409 when the source

        already aged out.'
      operationId: rerender_clip_api_clip_rerender_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RerenderRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Clip
  /api/clip/mode:
    post:
      summary: Set Clip Mode
      description: Switch a clip between its normal render and pro mode.
      operationId: set_clip_mode_api_clip_mode_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClipModeRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Clip
  /api/clip/{job_id}/{clip_index}/scenes:
    get:
      summary: Get Clip Scenes
      description: 'Scenes of a clip, each with a SOURCE frame to frame it against.


        The frames come from the uncropped cut, not the delivered clip: the point

        is to show what the automatic crop threw away, which the 9:16 file no

        longer contains.'
      operationId: get_clip_scenes_api_clip__job_id___clip_index__scenes_get
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          title: Job Id
      - name: clip_index
        in: path
        required: true
        schema:
          type: integer
          title: Clip Index
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Clip
  /api/clip/reframe:
    post:
      summary: Reframe Clip
      description: 'Re-render a clip with hand-framed scenes, leaving its cut untouched.


        Deliberately separate from /api/clip/rerender: the overrides are keyed by

        scene index, and a scene index only means anything against a given cut. If

        framing rode along with a trim save, changing the trim would silently move

        every override onto the wrong shot.'
      operationId: reframe_clip_api_clip_reframe_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReframeRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Clip
components:
  schemas:
    ClipModeRequest:
      properties:
        job_id:
          type: string
          title: Job Id
        clip_index:
          type: integer
          title: Clip Index
        mode:
          type: string
          title: Mode
        input_filename:
          anyOf:
          - type: string
          - type: 'null'
          title: Input Filename
      type: object
      required:
      - job_id
      - clip_index
      - mode
      title: ClipModeRequest
    ReframeRequest:
      properties:
        job_id:
          type: string
          title: Job Id
        clip_index:
          type: integer
          title: Clip Index
        crop_overrides:
          additionalProperties: true
          type: object
          title: Crop Overrides
        reapply_captions:
          type: boolean
          title: Reapply Captions
          default: true
      type: object
      required:
      - job_id
      - clip_index
      - crop_overrides
      title: ReframeRequest
    RerenderSegment:
      properties:
        start:
          type: number
          title: Start
        end:
          type: number
          title: End
      type: object
      required:
      - start
      - end
      title: RerenderSegment
    RerenderRequest:
      properties:
        job_id:
          type: string
          title: Job Id
        clip_index:
          type: integer
          title: Clip Index
        segments:
          items:
            $ref: '#/components/schemas/RerenderSegment'
          type: array
          title: Segments
        snap_to_words:
          type: boolean
          title: Snap To Words
          default: false
        reapply_captions:
          type: boolean
          title: Reapply Captions
          default: true
        framing:
          anyOf:
          - type: string
          - type: 'null'
          title: Framing
      type: object
      required:
      - job_id
      - clip_index
      - segments
      title: RerenderRequest
    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