Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Public API access token issued by /public/v1/oauth/token. Example: Authorization: Bearer fspt_.... Each resource request rechecks the token company's current provider access. Disabling access blocks existing tokens with 403 auth.provider_unavailable.

Headers

Idempotency-Key
string
required

Required for Public API write requests. Reusing the same key with the same method, path, and body replays the stored successful response; reusing it with a different request returns 409 idempotency.conflict.

Required string length: 1 - 200
Example:

"booking-create-20260714-001"

Path Parameters

videoId
string
required

Video library entry id.

Example:

"67f1234567890abcdef1234"

clientId
string
required

Client in the company bound to the Public API token.

Pattern: ^[a-fA-F0-9]{24}$

Body

application/json
language
string
required

Language code of the video being watched.

Example:

"en"

watchedDuration
number
required

Seconds watched so far.

Required range: x >= 0
Example:

120

totalDuration
number
required

Total video length in seconds.

Required range: x >= 0.001
Example:

300

Response

Progress saved and returned.

data
object
required
meta
object
required