Report a use of a video moment (network)

record_usage over REST. Reports that a moment was used and returns a signed receipt. The use is checked against the rights policy in force: a permitted use is recorded on the usage ledger, and a refused use is logged as refused and is never counted as a use. The video must be public and its creator listed on the network. Any range of a published video is accepted.

post/public/usage

Request

  • Base URL: https://api.agentcdn.com
  • URL: https://api.agentcdn.com/public/usage
  • Auth: none declared

Request body

moment_uristring

String arv:{asset_id}#t={start_ms},{end_ms}. Copy it from a search result. A value of another shape answers 400 moment_invalid.

moment_idstring

String. The moment id from a search result. Send it with the range as a cross-check. It cannot name a moment alone. A value of another shape answers 400 moment_invalid.

asset_idstring

String. A video id. Use with start_ms and end_ms to report any range on a published video. A value of another shape answers 400 moment_invalid.

start_msinteger

Whole number. Range start in milliseconds. A value of another shape answers 400 moment_invalid.

end_msinteger

Whole number. Range end in milliseconds. A value of another shape answers 400 moment_invalid.

actionstring required

What the agent did with the moment: one term of the RightsSummary, for example cite, quote or segment_display. A term the rights do not define is refused. A term the rights policy does not define answers 403 action_not_permitted.

idempotency_keystring

Up to 128 characters A-Z, a-z, 0-9, dot, underscore, colon or hyphen, for example a UUID. Send a new key for each separate use and the same key when you retry. A repeat within the same UTC hour returns the original receipt.

Response

A signed UsageReceipt (ARV 1.0 section 3.5). Verify jws with the manifest's jwks_url.

arv'1.0' required
receipt_idstring required
moment_uristring required
moment_idstring required
actionstring required
policy_versioninteger required
served_atstring required
citationstring
jwsstring required
payment_refstring
entitlement_refstring

Changes

No recorded changes to this operation across all 2 revisions of this API.