API.Video · JSON-LD Context
Api Video Context
JSON-LD context defining the semantic vocabulary for Api Video from API.Video.
69 Classes
113 Properties
4 Namespaces
Namespaces
schema:
https://schema.org/
xsd:
http://www.w3.org/2001/XMLSchema#
dcterms:
http://purl.org/dc/terms/
api:
https://api.video/schema#
Classes
bad-request
refresh-token-payload
access-token
additional-bad-request-errors
authenticate-payload
analytics-plays-400-error
too-many-requests
pagination-link
analytics-metrics-over-time-response
analytics-aggregated-metrics-response
unrecognized-request-url
analytics-metrics-breakdown-response
captions-list-response
caption
captions-update-payload
not-found
captions-upload-payload
chapter
chapters-list-response
chapters-update-payload
live-stream-assets
restreams-response-object
live-stream-thumbnail-upload-payload
live-stream
live-stream-list-response
live-stream-update-payload
restreams-request-object
live-stream-creation-payload
player-theme-upload-logo-payload
player-themes-list-response
player-theme
player-theme-creation-payload
player-theme-update-payload
summary-source
conflict-error
summary-creation-payload
summary
summaries-list-response
summary-update-payload
list-tags-response
token-creation-payload
token-list-response
upload-token
video-status-encoding
video-status-encoding-metadata
token-upload-payload
video-source
video-source-live-stream-link
video
videos-list-response
video-creation-payload
video-assets
video-status
video-source-live-stream
video-watermark
video-clip
quality
discarded-video-update-payload
video-status-ingest
video-thumbnail-pick-payload
bytes-range
video-update-payload
video-thumbnail-upload-payload
video-upload-payload
watermarks-list-response
watermark-upload-payload
webhook
webhooks-creation-payload
webhooks-list-response
Properties
| Property | Type | Container |
|---|---|---|
| type | string | |
| title | string | |
| name | string | |
| status | integer | |
| problems | list | |
| refreshToken | string | |
| access_token | string | |
| token_type | string | |
| refresh_token | string | |
| expires_in | integer | |
| apiKey | string | |
| detail | string | |
| rel | string | |
| uri | reference | |
| context | ||
| data | list | |
| pagination | reference | |
| src | string | |
| srclang | string | |
| languageName | string | |
| default | boolean | |
| file | string | |
| language | string | |
| hls | reference | |
| iframe | string | |
| player | reference | |
| thumbnail | reference | |
| serverUrl | string | |
| streamKey | string | |
| liveStreamId | string | |
| public | boolean | |
| assets | reference | |
| playerId | string | |
| broadcasting | boolean | |
| restreams | list | |
| createdAt | dateTime | |
| updatedAt | dateTime | |
| link | string | |
| text | string | |
| linkHover | string | |
| linkActive | string | |
| trackPlayed | string | |
| trackUnplayed | string | |
| trackBackground | string | |
| backgroundTop | string | |
| backgroundBottom | string | |
| backgroundText | string | |
| enableApi | boolean | |
| enableControls | boolean | |
| forceAutoplay | boolean | |
| hideTitle | boolean | |
| forceLoop | boolean | |
| abstract | string | |
| takeaways | list | |
| videoId | string | |
| origin | string | |
| attributes | list | |
| summaryId | string | |
| sourceStatus | string | |
| ttl | integer | |
| token | string | |
| expiresAt | dateTime | |
| playable | boolean | |
| qualities | list | |
| metadata | reference | |
| width | integer | |
| height | integer | |
| bitrate | decimal | |
| duration | integer | |
| framerate | integer | |
| samplerate | integer | |
| videoCodec | string | |
| audioCodec | string | |
| aspectRatio | string | |
| liveStream | reference | |
| description | string | |
| publishedAt | dateTime | |
| discardedAt | dateTime | |
| deletesAt | dateTime | |
| discarded | boolean | |
| languageOrigin | string | |
| tags | list | |
| source | reference | |
| panoramic | boolean | |
| mp4Support | boolean | |
| clip | reference | |
| watermark | reference | |
| transcript | boolean | |
| transcriptSummary | boolean | |
| transcriptSummaryAttributes | list | |
| mp4 | reference | |
| ingest | reference | |
| encoding | reference | |
| links | list | |
| id | string | |
| top | string | |
| left | string | |
| bottom | string | |
| right | string | |
| opacity | string | |
| startTimecode | string | |
| endTimecode | string | |
| filesize | integer | |
| receivedBytes | list | |
| receivedParts | ||
| timecode | string | |
| from | integer | |
| to | integer | |
| total | integer | |
| webhookId | string | |
| events | list | |
| url | string | |
| signatureSecret | string |
JSON-LD Document
{
"@context": {
"@vocab": "https://api.video/schema#",
"schema": "https://schema.org/",
"xsd": "http://www.w3.org/2001/XMLSchema#",
"dcterms": "http://purl.org/dc/terms/",
"api": "https://api.video/schema#",
"bad-request": "api:bad-request",
"type": {
"@id": "api:type",
"@type": "xsd:string"
},
"title": {
"@id": "api:title",
"@type": "xsd:string"
},
"name": {
"@id": "api:name",
"@type": "xsd:string"
},
"status": {
"@id": "api:status",
"@type": "xsd:integer"
},
"problems": {
"@id": "api:problems",
"@container": "@list"
},
"refresh-token-payload": "api:refresh-token-payload",
"refreshToken": {
"@id": "api:refreshToken",
"@type": "xsd:string"
},
"access-token": "api:access-token",
"access_token": {
"@id": "api:access_token",
"@type": "xsd:string"
},
"token_type": {
"@id": "api:token_type",
"@type": "xsd:string"
},
"refresh_token": {
"@id": "api:refresh_token",
"@type": "xsd:string"
},
"expires_in": {
"@id": "api:expires_in",
"@type": "xsd:integer"
},
"additional-bad-request-errors": "api:additional-bad-request-errors",
"authenticate-payload": "api:authenticate-payload",
"apiKey": {
"@id": "api:apiKey",
"@type": "xsd:string"
},
"analytics-plays-400-error": "api:analytics-plays-400-error",
"detail": {
"@id": "api:detail",
"@type": "xsd:string"
},
"too-many-requests": "api:too-many-requests",
"pagination-link": "api:pagination-link",
"rel": {
"@id": "api:rel",
"@type": "xsd:string"
},
"uri": {
"@id": "api:uri",
"@type": "@id"
},
"analytics-metrics-over-time-response": "api:analytics-metrics-over-time-response",
"context": {
"@id": "api:context"
},
"data": {
"@id": "api:data",
"@container": "@list"
},
"pagination": {
"@id": "api:pagination",
"@type": "@id"
},
"analytics-aggregated-metrics-response": "api:analytics-aggregated-metrics-response",
"unrecognized-request-url": "api:unrecognized-request-url",
"analytics-metrics-breakdown-response": "api:analytics-metrics-breakdown-response",
"captions-list-response": "api:captions-list-response",
"caption": "api:caption",
"src": {
"@id": "api:src",
"@type": "xsd:string"
},
"srclang": {
"@id": "api:srclang",
"@type": "xsd:string"
},
"languageName": {
"@id": "api:languageName",
"@type": "xsd:string"
},
"default": {
"@id": "api:default",
"@type": "xsd:boolean"
},
"captions-update-payload": "api:captions-update-payload",
"not-found": "api:not-found",
"captions-upload-payload": "api:captions-upload-payload",
"file": {
"@id": "api:file",
"@type": "xsd:string"
},
"chapter": "api:chapter",
"language": {
"@id": "api:language",
"@type": "xsd:string"
},
"chapters-list-response": "api:chapters-list-response",
"chapters-update-payload": "api:chapters-update-payload",
"live-stream-assets": "api:live-stream-assets",
"hls": {
"@id": "api:hls",
"@type": "@id"
},
"iframe": {
"@id": "api:iframe",
"@type": "xsd:string"
},
"player": {
"@id": "api:player",
"@type": "@id"
},
"thumbnail": {
"@id": "api:thumbnail",
"@type": "@id"
},
"restreams-response-object": "api:restreams-response-object",
"serverUrl": {
"@id": "api:serverUrl",
"@type": "xsd:string"
},
"streamKey": {
"@id": "api:streamKey",
"@type": "xsd:string"
},
"live-stream-thumbnail-upload-payload": "api:live-stream-thumbnail-upload-payload",
"live-stream": "api:live-stream",
"liveStreamId": {
"@id": "api:liveStreamId",
"@type": "xsd:string"
},
"public": {
"@id": "api:public",
"@type": "xsd:boolean"
},
"assets": {
"@id": "api:assets",
"@type": "@id"
},
"playerId": {
"@id": "api:playerId",
"@type": "xsd:string"
},
"broadcasting": {
"@id": "api:broadcasting",
"@type": "xsd:boolean"
},
"restreams": {
"@id": "api:restreams",
"@container": "@list"
},
"createdAt": {
"@id": "api:createdAt",
"@type": "xsd:dateTime"
},
"updatedAt": {
"@id": "api:updatedAt",
"@type": "xsd:dateTime"
},
"live-stream-list-response": "api:live-stream-list-response",
"live-stream-update-payload": "api:live-stream-update-payload",
"restreams-request-object": "api:restreams-request-object",
"live-stream-creation-payload": "api:live-stream-creation-payload",
"player-theme-upload-logo-payload": "api:player-theme-upload-logo-payload",
"link": {
"@id": "api:link",
"@type": "xsd:string"
},
"player-themes-list-response": "api:player-themes-list-response",
"player-theme": "api:player-theme",
"text": {
"@id": "api:text",
"@type": "xsd:string"
},
"linkHover": {
"@id": "api:linkHover",
"@type": "xsd:string"
},
"linkActive": {
"@id": "api:linkActive",
"@type": "xsd:string"
},
"trackPlayed": {
"@id": "api:trackPlayed",
"@type": "xsd:string"
},
"trackUnplayed": {
"@id": "api:trackUnplayed",
"@type": "xsd:string"
},
"trackBackground": {
"@id": "api:trackBackground",
"@type": "xsd:string"
},
"backgroundTop": {
"@id": "api:backgroundTop",
"@type": "xsd:string"
},
"backgroundBottom": {
"@id": "api:backgroundBottom",
"@type": "xsd:string"
},
"backgroundText": {
"@id": "api:backgroundText",
"@type": "xsd:string"
},
"enableApi": {
"@id": "api:enableApi",
"@type": "xsd:boolean"
},
"enableControls": {
"@id": "api:enableControls",
"@type": "xsd:boolean"
},
"forceAutoplay": {
"@id": "api:forceAutoplay",
"@type": "xsd:boolean"
},
"hideTitle": {
"@id": "api:hideTitle",
"@type": "xsd:boolean"
},
"forceLoop": {
"@id": "api:forceLoop",
"@type": "xsd:boolean"
},
"player-theme-creation-payload": "api:player-theme-creation-payload",
"player-theme-update-payload": "api:player-theme-update-payload",
"summary-source": "api:summary-source",
"abstract": {
"@id": "api:abstract",
"@type": "xsd:string"
},
"takeaways": {
"@id": "api:takeaways",
"@container": "@list"
},
"conflict-error": "api:conflict-error",
"summary-creation-payload": "api:summary-creation-payload",
"videoId": {
"@id": "api:videoId",
"@type": "xsd:string"
},
"origin": {
"@id": "api:origin",
"@type": "xsd:string"
},
"attributes": {
"@id": "api:attributes",
"@container": "@list"
},
"summary": "api:summary",
"summaryId": {
"@id": "api:summaryId",
"@type": "xsd:string"
},
"sourceStatus": {
"@id": "api:sourceStatus",
"@type": "xsd:string"
},
"summaries-list-response": "api:summaries-list-response",
"summary-update-payload": "api:summary-update-payload",
"list-tags-response": "api:list-tags-response",
"token-creation-payload": "api:token-creation-payload",
"ttl": {
"@id": "api:ttl",
"@type": "xsd:integer"
},
"token-list-response": "api:token-list-response",
"upload-token": "api:upload-token",
"token": {
"@id": "api:token",
"@type": "xsd:string"
},
"expiresAt": {
"@id": "api:expiresAt",
"@type": "xsd:dateTime"
},
"video-status-encoding": "api:video-status-encoding",
"playable": {
"@id": "api:playable",
"@type": "xsd:boolean"
},
"qualities": {
"@id": "api:qualities",
"@container": "@list"
},
"metadata": {
"@id": "api:metadata",
"@type": "@id"
},
"video-status-encoding-metadata": "api:video-status-encoding-metadata",
"width": {
"@id": "api:width",
"@type": "xsd:integer"
},
"height": {
"@id": "api:height",
"@type": "xsd:integer"
},
"bitrate": {
"@id": "api:bitrate",
"@type": "xsd:decimal"
},
"duration": {
"@id": "api:duration",
"@type": "xsd:integer"
},
"framerate": {
"@id": "api:framerate",
"@type": "xsd:integer"
},
"samplerate": {
"@id": "api:samplerate",
"@type": "xsd:integer"
},
"videoCodec": {
"@id": "api:videoCodec",
"@type": "xsd:string"
},
"audioCodec": {
"@id": "api:audioCodec",
"@type": "xsd:string"
},
"aspectRatio": {
"@id": "api:aspectRatio",
"@type": "xsd:string"
},
"token-upload-payload": "api:token-upload-payload",
"video-source": "api:video-source",
"liveStream": {
"@id": "api:liveStream",
"@type": "@id"
},
"video-source-live-stream-link": "api:video-source-live-stream-link",
"video": "api:video",
"description": {
"@id": "api:description",
"@type": "xsd:string"
},
"publishedAt": {
"@id": "api:publishedAt",
"@type": "xsd:dateTime"
},
"discardedAt": {
"@id": "api:discardedAt",
"@type": "xsd:dateTime"
},
"deletesAt": {
"@id": "api:deletesAt",
"@type": "xsd:dateTime"
},
"discarded": {
"@id": "api:discarded",
"@type": "xsd:boolean"
},
"languageOrigin": {
"@id": "api:languageOrigin",
"@type": "xsd:string"
},
"tags": {
"@id": "api:tags",
"@container": "@list"
},
"source": {
"@id": "api:source",
"@type": "@id"
},
"panoramic": {
"@id": "api:panoramic",
"@type": "xsd:boolean"
},
"mp4Support": {
"@id": "api:mp4Support",
"@type": "xsd:boolean"
},
"videos-list-response": "api:videos-list-response",
"video-creation-payload": "api:video-creation-payload",
"clip": {
"@id": "api:clip",
"@type": "@id"
},
"watermark": {
"@id": "api:watermark",
"@type": "@id"
},
"transcript": {
"@id": "api:transcript",
"@type": "xsd:boolean"
},
"transcriptSummary": {
"@id": "api:transcriptSummary",
"@type": "xsd:boolean"
},
"transcriptSummaryAttributes": {
"@id": "api:transcriptSummaryAttributes",
"@container": "@list"
},
"video-assets": "api:video-assets",
"mp4": {
"@id": "api:mp4",
"@type": "@id"
},
"video-status": "api:video-status",
"ingest": {
"@id": "api:ingest",
"@type": "@id"
},
"encoding": {
"@id": "api:encoding",
"@type": "@id"
},
"video-source-live-stream": "api:video-source-live-stream",
"links": {
"@id": "api:links",
"@container": "@list"
},
"video-watermark": "api:video-watermark",
"id": {
"@id": "api:id",
"@type": "xsd:string"
},
"top": {
"@id": "api:top",
"@type": "xsd:string"
},
"left": {
"@id": "api:left",
"@type": "xsd:string"
},
"bottom": {
"@id": "api:bottom",
"@type": "xsd:string"
},
"right": {
"@id": "api:right",
"@type": "xsd:string"
},
"opacity": {
"@id": "api:opacity",
"@type": "xsd:string"
},
"video-clip": "api:video-clip",
"startTimecode": {
"@id": "api:startTimecode",
"@type": "xsd:string"
},
"endTimecode": {
"@id": "api:endTimecode",
"@type": "xsd:string"
},
"quality": "api:quality",
"discarded-video-update-payload": "api:discarded-video-update-payload",
"video-status-ingest": "api:video-status-ingest",
"filesize": {
"@id": "api:filesize",
"@type": "xsd:integer"
},
"receivedBytes": {
"@id": "api:receivedBytes",
"@container": "@list"
},
"receivedParts": {
"@id": "api:receivedParts"
},
"video-thumbnail-pick-payload": "api:video-thumbnail-pick-payload",
"timecode": {
"@id": "api:timecode",
"@type": "xsd:string"
},
"bytes-range": "api:bytes-range",
"from": {
"@id": "api:from",
"@type": "xsd:integer"
},
"to": {
"@id": "api:to",
"@type": "xsd:integer"
},
"total": {
"@id": "api:total",
"@type": "xsd:integer"
},
"video-update-payload": "api:video-update-payload",
"video-thumbnail-upload-payload": "api:video-thumbnail-upload-payload",
"video-upload-payload": "api:video-upload-payload",
"watermarks-list-response": "api:watermarks-list-response",
"watermark-upload-payload": "api:watermark-upload-payload",
"webhook": "api:webhook",
"webhookId": {
"@id": "api:webhookId",
"@type": "xsd:string"
},
"events": {
"@id": "api:events",
"@container": "@list"
},
"url": {
"@id": "api:url",
"@type": "xsd:string"
},
"signatureSecret": {
"@id": "api:signatureSecret",
"@type": "xsd:string"
},
"webhooks-creation-payload": "api:webhooks-creation-payload",
"webhooks-list-response": "api:webhooks-list-response"
},
"@type": "schema:Dataset",
"schema:name": "API.Video API JSON-LD context",
"schema:description": "A JSON-LD @context for the objects API.Video's own API contract declares: one class per component schema, one property per declared field, typed from the contract. Derived by script (derive-json-ld.py, 2026-11-05) from openapi/api-video-advanced-authentication-api-openapi.yml, openapi/api-video-analytics-api-openapi.yml, openapi/api-video-captions-api-openapi.yml.",
"dcterms:created": "2026-11-05",
"dcterms:source": [
"openapi/api-video-advanced-authentication-api-openapi.yml",
"openapi/api-video-analytics-api-openapi.yml",
"openapi/api-video-captions-api-openapi.yml",
"openapi/api-video-chapters-api-openapi.yml",
"openapi/api-video-live-streams-api-openapi.yml"
]
}