Skip to content

Video subtitles

GET/api/v1/content/{id}/video-text

Access
API key
Permission
content:read

Read the owner subtitle/transcript editor source

Example request

curl "https://lac.pics/api/v1/content/Xq3u9RkT0bLmA7cV2pWz1eFy/video-text" \
  -H "Authorization: Bearer lac_api_YOUR_KEY"

Parameters

Path

  • idstringrequired

    The file or note id.

Responses

  • 200Success.VideoTextResponse
    • revisionintegerrequired

      The revision the edit is based on: revision from GET /pastes/{id}.

      0–2,147,483,647

    • trackobjectrequiredor null

      The subtitle track or null.

      4 fields
      • formatstringrequired

        plain: text, markdown: Markdown, code: highlighted code.

        values: "vtt" "text"

      • languagestringrequired
      • labelstringrequired

        The track caption in the player, up to 80 characters.

      • textstringrequired

        The note text, 1–200,000 characters.

    • transcriptstringrequired

      The transcript.

  • 400Typed error; protected video access fails closed. Preserve owner drafts after conflicts.
  • 401Typed error; protected video access fails closed. Preserve owner drafts after conflicts.
  • 403Typed error; protected video access fails closed. Preserve owner drafts after conflicts.
  • 404Typed error; protected video access fails closed. Preserve owner drafts after conflicts.
  • 409Typed error; protected video access fails closed. Preserve owner drafts after conflicts.
  • 413Typed error; protected video access fails closed. Preserve owner drafts after conflicts.
  • 429Typed error; protected video access fails closed. Preserve owner drafts after conflicts.
  • 500Typed error; protected video access fails closed. Preserve owner drafts after conflicts.
  • 503Typed error; protected video access fails closed. Preserve owner drafts after conflicts.

Example response

200 · application/json
{
  "revision": 1,
  "track": null,
  "transcript": "Hello!"
}

Error codes

Answers of any method with a key (an invalid or expired key, a missing permission, too many requests) are in Errors.

Video subtitles: GET /api/v1/content/{id}/video-text · lacuna API