Developer API
All operations
Every endpoint of the Shorty developer API, grouped by resource, with request and response schemas and curl + TypeScript examples.
Every Shorty API endpoint, grouped by resource. Each page shows the method, path, parameters, request and response schemas, error codes, and curl + SDK examples.
Usage
- GET /v1/usage — Get plan, limits, and usage
Articles
- GET /v1/articles — List your articles
- GET /v1/articles/search — Search your articles
- GET /v1/articles/{articleId} — Get an article
Transcriptions
- GET /v1/transcriptions — List your transcriptions
- POST /v1/transcriptions — Create a transcription
- GET /v1/transcriptions/{transcriptionId} — Get a transcription
Jobs
- GET /v1/jobs/{jobId} — Get job status
Subtitles
- GET /v1/subtitles/{jobId}/download — Download a subtitle artifact
- POST /v1/subtitles — Create subtitles
Summaries
- POST /v1/summaries — Create a summary
Developer API
The Shorty developer API turns YouTube videos, web pages, and media into summaries, transcriptions, and subtitles over a versioned REST surface — the same engine behind the Shorty app, with API keys, idempotency, rate limits, webhooks, and a TypeScript SDK.
Error reference
Every error the Shorty API can return, as RFC 9457 problem responses with a stable machine-readable code. Switch on the code, not the HTTP status.