Create a playback session
Create a playback session
/v1/playback/sessionsThis operation supports dashboard session-cookie authentication. Call it only from trusted server code; browsers must not manufacture or expose the session cookie.
Server-side call: never expose your API key to the browser. Returns a
signed manifestUrl, a sessionToken for the player, and a
watermarkToken. The video must have at least one playable rendition.
Requires an API key with read scope, or session-cookie auth plus
projectId. Rate limit: 30 requests per 60 s per caller.
Error codes: unauthorized (401), insufficient_scope (403),
account_not_approved (403), invalid_project_id (400),
not_found (404), video_not_found (404),
video_not_playable (409), invalid_body (400).
Authentication
- apiKey — Project API key:
Authorization: Bearer vh_live_...(live mode) orAuthorization: Bearer vh_test_...(test mode). Keys carryreadand/orwritescopes. - sessionCookie — Dashboard session cookie set by
POST /v1/auth/login. Video and playback endpoints additionally require theprojectIdquery parameter under cookie auth.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
projectId | query | string (Ulid) | No | Required when authenticating with the session cookie; ignored under API-key auth (the key is already project-scoped). |
Request body
required
Content type: application/json
Schema: PlaybackSessionCreateRequest
{
"videoId": "01JZ9WV3N8GQ5T2M7K4C6XBARH",
"ttlSeconds": 3600,
"watermarkText": "Ahmed K."
}Responses
| Status | Meaning |
|---|---|
201 | Playback session created. |
400 | The request body or query failed validation. The per-operation description lists the exact error.code values. |
401 | No valid credential was presented. |
403 | The credential is valid but does not permit this action. The per-operation description lists the exact error.code values. |
404 | The resource does not exist or is not visible to this caller. |
409 | The request conflicts with the resource's current state. The per-operation description lists the exact error.code values. |
429 | Rate limit exceeded. |
Example request
{
"videoId": "01JZ9WV3N8GQ5T2M7K4C6XBARH",
"ttlSeconds": 3600,
"watermarkText": "Ahmed K."
}Try it
/v1/playback/sessionsAPI playground
Send a live request to api.videohati.com with a test-mode key.
The key is stored in your browser on docs.videohati.com only.
Required when authenticating with the session cookie; ignored under API-key auth (the key is already project-scoped).
https://api.staging.videohati.com/v1/playback/sessions