API Reference

Every Shorty API endpoint as an interactive reference page, generated from the OpenAPI 3.1 spec.

Interactive reference for every endpoint of the Shorty developer API, generated from the OpenAPI 3.1 spec. Each page renders the method, path, parameters, request and response schemas, and a request builder you can call with your own API key.

New here? Start with the Developer API guide for authentication, the quickstart, and the conventions every endpoint follows.

Endpoint	What it does
`GET /v1/usage`	Get plan, limits, and usage
`GET /v1/articles`	List your articles
`GET /v1/articles/search`	Search your articles
`GET /v1/articles/{articleId}`	Get an article
`GET /v1/transcriptions`	List your transcriptions
`POST /v1/transcriptions`	Create a transcription
`GET /v1/transcriptions/{transcriptionId}`	Get a transcription
`GET /v1/jobs/{jobId}`	Get job status
`GET /v1/subtitles/{jobId}/download`	Download a subtitle artifact
`POST /v1/summaries`	Create a summary
`POST /v1/subtitles`	Create subtitles