FlipLetters

FlipLetters Render API

Cloud MP4 export (scope: render)

GitHub OpenAPI

Operations 3

GET /api/render Render capability probe, or job status when jobId is set #
POST /api/render Start a cloud MP4 render under the caller's plan #
DELETE /api/render Cancel a queued or in-flight cloud render #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/flipletters-com/openapi/flipletters-com-render-api-openapi.yml

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/flipletters-com:flipletters-com-render-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. 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

flipletters-com-render-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Flipletters Com Render API
  version: 1.0.0
  contact:
    name: FlipLetters
    email: dev@flipletters.com
    url: https://flipletters.com/docs/api
  license:
    name: Proprietary Studio API; flipcode parser is MIT
    url: https://www.npmjs.com/package/@flipletters/flipcode
  description: 'Operations tagged Render across 2 of this provider''s published API definitions: openapi.json, flipletters-com-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://app.flipletters.com
  description: FlipLetters Studio (live HTTP API)
tags:
- name: Render
  description: 'Cloud MP4 export (scope: render)'
paths:
  /api/render:
    get:
      tags:
      - Render
      summary: Render capability probe, or job status when jobId is set
      operationId: getRender
      parameters:
      - name: jobId
        in: query
        required: false
        schema:
          type: string
        description: When set, return that job's status. Requires render auth. Without jobId, returns { enabled, mode } with no auth.
      responses:
        '200':
          description: 'Capability { enabled, mode: local|cloud } or job { jobId, status, progress, url, fileName, error }'
        '401':
          $ref: '#/components/responses/ApiError'
        '403':
          $ref: '#/components/responses/ApiError'
        '404':
          $ref: '#/components/responses/ApiError'
    post:
      tags:
      - Render
      summary: Start a cloud MP4 render under the caller's plan
      operationId: postRender
      security:
      - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - project
              properties:
                project:
                  type: object
                  description: Studio project JSON (compiled from flipcode or the editor). Must include a non-empty slides array.
                  additionalProperties: true
                repeat:
                  type: integer
                  minimum: 1
                  maximum: 120
                  description: Loop count for ambience-style exports
                workspaceId:
                  type: string
                  description: Optional project id; required to match a workspace-scoped key
      responses:
        '200':
          description: '{ jobId, statusUrl }'
        '400':
          $ref: '#/components/responses/ApiError'
        '401':
          $ref: '#/components/responses/ApiError'
        '402':
          $ref: '#/components/responses/ApiError'
        '403':
          $ref: '#/components/responses/ApiError'
        '502':
          $ref: '#/components/responses/ApiError'
    delete:
      tags:
      - Render
      summary: Cancel a queued or in-flight cloud render
      operationId: deleteRender
      security:
      - bearerAuth: []
      parameters:
      - name: jobId
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: '{ ok, status: cancelled }'
        '400':
          $ref: '#/components/responses/ApiError'
        '401':
          $ref: '#/components/responses/ApiError'
        '403':
          $ref: '#/components/responses/ApiError'
        '404':
          $ref: '#/components/responses/ApiError'
        '409':
          $ref: '#/components/responses/ApiError'
    servers:
    - url: https://app.flipletters.com
      description: FlipLetters Studio (live HTTP API)
components:
  responses:
    ApiError:
      description: Structured FlipLetters API error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  schemas:
    ApiError:
      type: object
      required:
      - error
      - code
      - hint
      properties:
        error:
          type: string
          description: Human-readable message (string, for existing Studio UI)
        code:
          type: string
          description: Stable machine code, e.g. NOT_FOUND
        hint:
          type: string
          description: Resolution hint for agents and humans
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Firebase ID token or Studio API key `flk_…`. Keys are created by a signed-in human; they are never self-issued by agents.
    firebaseSession:
      type: http
      scheme: bearer
      description: Firebase ID token only (browser Studio session). API keys are rejected.
x-refined-from:
- openapi.json
- flipletters-com-openapi.json
x-provenance:
  method: harvested
  publisher: FlipLetters
  source: https://flipletters.com/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)