Draft: these docs describe OctaVideo as it will be at launch; some features may not be live yet.
OctaVideoDocs
API referenceVideos

List video thumbnails

GET
/videos/{videoId}/thumbnails

Returns the URLs of the thumbnails generated for a video. The list is empty until processing reaches the thumbnails stage.

Authorization

AccessKey
headerAccessKey<token>

The private key of a library, starting with ovk_. Copy it from API & embeds in the console, keep it on your server, and rotate it there if it leaks.

Path Parameters

videoId*string

ID of the video.

Formatuuid

Header Parameters

AccessKey*string

The library's private key. Same value as the AccessKey security scheme; listed here so code samples include it.

Response Body

The thumbnail URLs.

application/json
  1. response
data*
Example Request
curl -X GET 'https://api.octavideo.tech/api/v1/videos/6f1c2b9e-4a7d-4f3e-9b8a-2d5c7e1f0a34/thumbnails' \  -H 'AccessKey: ovk_YOUR_LIBRARY_PRIVATE_KEY'
Example Response
{  "data": {    "thumbnails": [      "https://media.example.com/libraries/0b8e5d3a-1c2f-4e6a-8b7d-9f0a1b2c3d4e/videos/6f1c2b9e-4a7d-4f3e-9b8a-2d5c7e1f0a34/thumbnails/001.jpg",      "https://media.example.com/libraries/0b8e5d3a-1c2f-4e6a-8b7d-9f0a1b2c3d4e/videos/6f1c2b9e-4a7d-4f3e-9b8a-2d5c7e1f0a34/thumbnails/002.jpg"    ]  }}

Transcribe a video POST

Starts a transcription of the video's speech. The body is optional: leave out `language` to auto-detect it. Transcription runs in the background, so the response is `202 Accepted` with a `job_id`.

Create a collection POST

Creates an empty collection in the library.