Developer API
Build on Shortzly over a REST API with scoped bearer tokens.
Base URL & authentication
All endpoints live under /api/v1. Authenticate with a bearer token:
curl https://shortzly.com/api/v1/projects \
-H "Authorization: Bearer YOUR_TOKEN"
Create and manage tokens on your API tokens settings page. A token is shown once at creation.
Scopes
Each token carries one or more scopes. Pick the least it needs:
read- read-only access (GET requests).write- create, update and delete (POST, PUT, PATCH, DELETE).mcp:use- use the Model Context Protocol server at/mcp. On its own it does not open this REST API.
A request without the scope its method needs is rejected with 403.
Rate limit
API requests are limited to 60 requests per minute per account. Exceeding it returns 429.
Endpoints
| Method | Path | Purpose |
|---|---|---|
GET |
/api/v1/projects |
List your projects |
POST |
/api/v1/projects |
Create a project from a URL or upload |
GET |
/api/v1/projects/{id} |
Get one project |
GET |
/api/v1/projects/{id}/highlights |
List a project's detected highlights |
POST |
/api/v1/projects/{id}/highlights/select |
Select highlights and start rendering |
GET |
/api/v1/clips |
List your rendered clips |
GET |
/api/v1/clips/{id} |
Get one clip (with its download URL) |
GET |
/api/v1/social/posts |
List your scheduled and published social posts |
POST |
/api/v1/social/posts |
Schedule or publish a clip to a connected account |
POST |
/api/v1/uploads/presigned |
Get a presigned URL to upload a source file up to 100 MB |
POST |
/api/v1/uploads/multipart |
Start a multipart upload (filename, content_type, size, within the plan upload limit) and get a presigned URL for each 64 MB part |
POST |
/api/v1/uploads/multipart/complete |
Finish a multipart upload with its key, upload_id and part_count once every part is in |
POST |
/api/v1/uploads/multipart/abort |
Cancel a multipart upload |
MCP server
Prefer to drive Shortzly from an AI client? The
MCP server
exposes the same capabilities as tools, using a token with the mcp:use scope.