Clipping
Quote a validated clipping source, queue analysis, inspect moments, then quote and render its output batch.
POST /api/sources/{id}/ai-analysis/quote
SlicePostDocs
Connect Codex, Claude, or your own app to tenant-scoped projects, private media, quotes, and durable processing jobs.
Create a key in Account → Developer access → API keys. The secret is shown once. Store it as SLICEPOST_API_KEY in your client environment.
curl https://www.slicepost.com/api/projects \
-H "Authorization: Bearer $SLICEPOST_API_KEY"Every API and MCP call uses a personal sp_beta_… bearer key. In Account, name each client key, choose a 30, 90, or 365 day expiry, and grant only the scopes it needs. You can create multiple keys; the list loads 50 at a time. Keys inherit the creator's approved workspace and stop when revoked, expired, or removed from beta.
For rotation, create a replacement, update your client, verify a read request, then revoke the old key. Lost secrets cannot be retrieved.
| Scope | Capability |
|---|---|
account:read | Usage and allowances |
projects:read | Projects, sources, assets |
projects:write | Create projects |
media:write | Private source uploads |
jobs:read | Quotes, validated metadata, and status |
jobs:write | Start, rerender, transcribe, recreate, cancel |
The API uses the same workspace ownership, private media, allowances, and durable job queue as the dashboard. Upload completion never starts paid work.
POST /api/projects with tool_type and a name.Idempotency-Key for chargeable work.202 response is accepted work. Poll its request until complete and inspect published assets.Signed upload URLs are short lived and private. If a transfer or request is interrupted, inspect its current state and reuse the same operation key before starting another.
Quote a validated clipping source, queue analysis, inspect moments, then quote and render its output batch.
POST /api/sources/{id}/ai-analysis/quoteList renderer-owned presets, quote a caption source, queue a captioned video, and poll its request.
GET /api/caption-presetsOpen a rendered clip or owned source range. Source validation is required before processing.
GET /api/editor/sessions/{id}Feature gated. Validate two owned reference assets before queueing an export.
/api/recreate/*Read request fields, endpoint paths, and response flow in the complete Markdown reference →
Use the same key as REST. Set SLICEPOST_API_KEY in the environment of the process that launches your client, add the configuration, then reconnect the client. Account → MCP connection has these snippets beside your key list.
[mcp_servers.slicepost]
url = "https://www.slicepost.com/mcp/"
bearer_token_env_var = "SLICEPOST_API_KEY"{
"mcpServers": {
"slicepost": {
"type": "http",
"url": "https://www.slicepost.com/mcp/",
"headers": {
"Authorization": "Bearer ${SLICEPOST_API_KEY}"
}
}
}
}The MCP URL ends in /mcp/. The Claude Code example belongs in a project .mcp.json and keeps the key in your environment. The client must support Streamable HTTP and bearer headers. The MCP tools coordinate jobs; your client still transfers media bytes using the returned signed upload instructions.
| Workflow | Representative tools |
|---|---|
| Workspace | get_workspace, list_projects, create_project |
| Media | prepare_source_upload, complete_source_upload, validate_source |
| Clipping | quote_ai_clips, start_ai_clip_analysis, render_ai_clip_outputs |
| Caption Maker | list_caption_styles, quote_caption_video, create_caption_video |
| Editor | create_editor_session, quote_editor_transcription, rerender_editor_session |
| Job control | cancel_job |
Available processing depends on your beta workspace. Quote first, confirm chargeable work with the user, reuse an idempotency key on retry, and poll status before presenting an output as complete. See every tool name and workflow →
Dashboard, REST, and MCP share one workspace balance. Clipping charges complete analyzed source minutes, rounded down. Caption Maker and optional editor transcription use caption/transcription minutes. Initial AI outputs and later edits or rerenders are included.
Clipping, Caption Maker, and editor rerender queues require an Idempotency-Key header; uploads and standalone editor creation use a body key. Reuse the same key after a lost response to avoid duplicate work.
| Status | Meaning |
|---|---|
| 401 | Missing, expired, malformed, or revoked key |
| 403 | Missing scope or beta access |
| 404 | Missing or cross-workspace resource |
| 409 | Lifecycle, idempotency, or allowance conflict |
| 422 | Invalid settings |
| 429 | Back off for Retry-After |
| 503 | Feature or dependency unavailable |
/mcp/ URL, client environment, and reconnect the client.Retry-After, and reuse the same idempotency key.Share the X-SlicePost-Request-ID with support; keep the key and signed media URL private.