Skip to content

docs: clipping in the Public API and CLI - #252

Merged
nevo-david merged 1 commit into
mainfrom
feat/clipping
Sep 21, 2026
Merged

nevo-david merged 1 commit into
mainfrom
feat/clipping

Conversation

@nevo-david

@nevo-david nevo-david commented Sep 21, 2026 •

Copy link
Copy Markdown
Contributor

What kind of change does this PR introduce?

Docs (Public API, CLI, clipping guide). Adds POST /clipping, GET /clipping and GET /clipping/{id} with a Clipping tag and ClippingRequest/Clipping/ClippingSummary/ClippingClip schemas to public-api/openapi.json, the pages public-api/clipping/{create,get,list}.mdx and cli/clipping.mdx, and both in the docs.json navigation. cli/introduction.mdx lists the three clipping:* commands, and in general/clipping.mdx the "Not in the Public API or CLI" section becomes "From the Public API and the CLI". The create page documents the clipping minutes (402, when they are charged and refunded), the 429 caps, and that polling is not counted by the hourly rate limit. MCP and plan pages are unchanged.

Why was this change needed?

Clipping gets Public API endpoints (gitroomhq/postiz-app, branch feat/clipping-public-api) and CLI commands (gitroomhq/postiz-agent, branch feat/clipping), and the guide said explicitly that neither existed.

Other information:

Merge once the postiz-app PR is deployed and CLI 2.0.19 is published, otherwise the docs describe endpoints that answer 404.

QA

  1. Run npx mint dev in the repo; expect it to start without navigation or OpenAPI errors
  2. Open Public API in the sidebar; expect a Clipping group with Start a Clipping, Get a Clipping and List Clippings, each rendering its request, parameters and example response
  3. Open Start a Clipping; expect the 402, 406, 429 and 503 responses and the Clipping minutes section
  4. Open CLI in the sidebar; expect a Clipping page after Media Upload, and the three clipping:* rows in the Commands Overview of the CLI introduction
  5. Open General > Clipping; expect the "From the Public API and the CLI" section and working links to /public-api/clipping/create and /cli/clipping
  6. Run npx mint broken-links; expect no broken links

🤖 Generated with Claude Code

Summary by CodeRabbit

  • New Features
    • Added Public API support for turning long YouTube videos into short, captioned vertical clips.
    • Added endpoints to start, monitor, and list clipping jobs, with asynchronous processing and hosted clip URLs.
    • Added CLI commands for creating, checking, and listing clippings, including optional draft post creation.
    • Added configurable clip quantity and video-fit options, plus documented processing stages, limits, and billing.
  • Documentation
    • Added CLI, Public API, navigation, and workflow documentation, including an end-to-end clip-and-post example.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@postiz-contribution postiz-contribution Bot added the contribution:approved Approved contributor label Sep 21, 2026
@postiz-agent

postiz-agent Bot commented Sep 21, 2026

Copy link
Copy Markdown

✅ Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
✅ Code Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@coderabbitai

coderabbitai Bot commented Sep 21, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 5d77d57a-afbe-4523-b560-255cf54223be

📥 Commits

Reviewing files that changed from the base of the PR and between e37f371 and 5d1bd12.

📒 Files selected for processing (8)
  • cli/clipping.mdx
  • cli/introduction.mdx
  • docs.json
  • general/clipping.mdx
  • public-api/clipping/create.mdx
  • public-api/clipping/get.mdx
  • public-api/clipping/list.mdx
  • public-api/openapi.json
 ____________________________
< Copilot has nothing on me. >
 ----------------------------
  \
   \   \
        \ /\
        ( )
      .( o ).
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@nevo-david
nevo-david merged commit 74c9a1b into main Sep 21, 2026
7 of 9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

contribution:approved Approved contributor

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant