VideohatiDocs
API referenceVideos

Create a video in `uploading` state

Create a video in `uploading` state

POST/v1/videos

This operation supports dashboard session-cookie authentication. Call it only from trusted server code; browsers must not manufacture or expose the session cookie.

Step 1 of the upload flow. Requires an API key with write scope, or session-cookie auth plus the projectId query parameter. Rate limit: 60 requests per 60 s per caller.

Error codes: unauthorized (401), insufficient_scope (403), account_not_approved (403), invalid_project_id (400), not_found (404), invalid_filename (400).

Authentication

  • apiKey — Project API key: Authorization: Bearer vh_live_... (live mode) or Authorization: Bearer vh_test_... (test mode). Keys carry read and/or write scopes.
  • sessionCookie — Dashboard session cookie set by POST /v1/auth/login. Video and playback endpoints additionally require the projectId query parameter under cookie auth.

Parameters

NameInTypeRequiredDescription
projectIdquerystring (Ulid)NoRequired 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: VideoCreateRequest

{
  "originalFilename": "lecture-01.mp4"
}

Responses

StatusMeaning
201Video created; continue with POST /v1/videos/{id}/upload/start.
400The request body or query failed validation. The per-operation description lists the exact error.code values.
401No valid credential was presented.
403The credential is valid but does not permit this action. The per-operation description lists the exact error.code values.
404The resource does not exist or is not visible to this caller.
429Rate limit exceeded.

Example request

{
  "originalFilename": "lecture-01.mp4"
}

Try it

POST
/v1/videos
Test mode only

API playground

Send a live request to api.videohati.com with a test-mode key.

This playground blocks vh_live_ keys. Use a key that starts with vh_test_ only; a request with a live key never leaves your browser.

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/videos