Shorty API

API operations — Shorty API

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