OpenShorts · JSON-LD Context

Openshorts App Context

JSON-LD context defining the semantic vocabulary for Openshorts App from OpenShorts.

43 Classes 133 Properties 4 Namespaces
View Context View on GitHub

Namespaces

schema: https://schema.org/
xsd: http://www.w3.org/2001/XMLSchema#
dcterms: http://purl.org/dc/terms/
openshorts: https://openshorts.app/schema#

Classes

AttributionPayload AutopilotUpdate Body_process_endpoint_api_process_post Body_saasshorts_actor_upload_api_saasshorts_actor_upload_post Body_thumbnail_analyze_api_thumbnail_analyze_post Body_thumbnail_generate_api_thumbnail_generate_post Body_thumbnail_publish_api_thumbnail_publish_post Body_thumbnail_upload_api_thumbnail_upload_post CancelRequest CaptionWordIn CheckoutRequest ClipModeRequest ConsentRequest CreateKeyRequest DeleteAccountRequest DenyRequest EditRequest EffectsGenerateRequest EstimateRequest HTTPValidationError HookRequest LoginExchangeRequest LoginMethodRequest MagicLinkRequest MagicVerifyRequest ManualRun MetadataRequest ReframeRequest RemoveSubtitlesRequest RerenderRequest RerenderSegment ReviewLoginRequest SaaSActorRequest SaaSAnalyzeRequest SaaSGenerateRequest SaaSPostRequest SocialPostRequest SubtitleRequest SurveyAnswer ThumbnailDescribeRequest ThumbnailTitlesRequest TranslateRequest ValidationError

Properties

Property Type Container
referrer
landing_path
utm_source
utm_medium
utm_campaign
enabled
rights_ack
autopublish
publish_platforms
clips_to_publish
max_minutes
publish_hour
timezone
file
url
acknowledged
output_format
layouts
force_low_quality
webhook_url
webhook_secret
target_clips
clip_min_seconds
clip_max_seconds
auto_hook
auto_hook_style
thumbnail_session_id
captions
upload_id
source_start
source_end
session_id
title string
extra_prompt string
count integer
burn_text boolean
frame string
face
background
description string
thumbnail_url string
api_key
user_id
reason string
details
rating
review
review_public_ok boolean
text string
startMs integer
endMs integer
price_id string
source string
job_id string
clip_index integer
mode string
input_filename
client_id string
redirect_uri string
state
code_challenge string
code_challenge_method
scope
response_type
name
confirm_email string
seconds
detail list
position
size
duration_seconds
style
font
remove
code string
verifier string
email string
token string
video_id string
topic string
keyword
audience
crop_overrides
reapply_captions boolean
segments list
snap_to_words boolean
framing
start decimal
end decimal
password string
actor_description string
num_options integer
product_description
num_scripts integer
language string
actor_gender string
script
voice_id
selected_actor_url
retry_job_id
video_mode string
share_to_gallery boolean
platforms list
scheduled_date
font_size integer
font_name string
font_color string
border_color string
border_width integer
bg_color string
bg_opacity decimal
highlight_color string
effect string
base_opacity decimal
uppercase boolean
reveal boolean
shadow integer
max_chars
max_duration
preset
words
skipped boolean
source_other
goals list
role
message
target_language string
source_language
loc list
msg string
type string
input
ctx

JSON-LD Document

Raw ↑
{
  "@context": {
    "@vocab": "https://openshorts.app/schema#",
    "schema": "https://schema.org/",
    "xsd": "http://www.w3.org/2001/XMLSchema#",
    "dcterms": "http://purl.org/dc/terms/",
    "openshorts": "https://openshorts.app/schema#",
    "AttributionPayload": "openshorts:AttributionPayload",
    "referrer": {
      "@id": "openshorts:referrer"
    },
    "landing_path": {
      "@id": "openshorts:landing_path"
    },
    "utm_source": {
      "@id": "openshorts:utm_source"
    },
    "utm_medium": {
      "@id": "openshorts:utm_medium"
    },
    "utm_campaign": {
      "@id": "openshorts:utm_campaign"
    },
    "AutopilotUpdate": "openshorts:AutopilotUpdate",
    "enabled": {
      "@id": "openshorts:enabled"
    },
    "rights_ack": {
      "@id": "openshorts:rights_ack"
    },
    "autopublish": {
      "@id": "openshorts:autopublish"
    },
    "publish_platforms": {
      "@id": "openshorts:publish_platforms"
    },
    "clips_to_publish": {
      "@id": "openshorts:clips_to_publish"
    },
    "max_minutes": {
      "@id": "openshorts:max_minutes"
    },
    "publish_hour": {
      "@id": "openshorts:publish_hour"
    },
    "timezone": {
      "@id": "openshorts:timezone"
    },
    "Body_process_endpoint_api_process_post": "openshorts:Body_process_endpoint_api_process_post",
    "file": {
      "@id": "openshorts:file"
    },
    "url": {
      "@id": "openshorts:url"
    },
    "acknowledged": {
      "@id": "openshorts:acknowledged"
    },
    "output_format": {
      "@id": "openshorts:output_format"
    },
    "layouts": {
      "@id": "openshorts:layouts"
    },
    "force_low_quality": {
      "@id": "openshorts:force_low_quality"
    },
    "webhook_url": {
      "@id": "openshorts:webhook_url"
    },
    "webhook_secret": {
      "@id": "openshorts:webhook_secret"
    },
    "target_clips": {
      "@id": "openshorts:target_clips"
    },
    "clip_min_seconds": {
      "@id": "openshorts:clip_min_seconds"
    },
    "clip_max_seconds": {
      "@id": "openshorts:clip_max_seconds"
    },
    "auto_hook": {
      "@id": "openshorts:auto_hook"
    },
    "auto_hook_style": {
      "@id": "openshorts:auto_hook_style"
    },
    "thumbnail_session_id": {
      "@id": "openshorts:thumbnail_session_id"
    },
    "captions": {
      "@id": "openshorts:captions"
    },
    "upload_id": {
      "@id": "openshorts:upload_id"
    },
    "source_start": {
      "@id": "openshorts:source_start"
    },
    "source_end": {
      "@id": "openshorts:source_end"
    },
    "Body_saasshorts_actor_upload_api_saasshorts_actor_upload_post": "openshorts:Body_saasshorts_actor_upload_api_saasshorts_actor_upload_post",
    "Body_thumbnail_analyze_api_thumbnail_analyze_post": "openshorts:Body_thumbnail_analyze_api_thumbnail_analyze_post",
    "session_id": {
      "@id": "openshorts:session_id"
    },
    "Body_thumbnail_generate_api_thumbnail_generate_post": "openshorts:Body_thumbnail_generate_api_thumbnail_generate_post",
    "title": {
      "@id": "openshorts:title",
      "@type": "xsd:string"
    },
    "extra_prompt": {
      "@id": "openshorts:extra_prompt",
      "@type": "xsd:string"
    },
    "count": {
      "@id": "openshorts:count",
      "@type": "xsd:integer"
    },
    "burn_text": {
      "@id": "openshorts:burn_text",
      "@type": "xsd:boolean"
    },
    "frame": {
      "@id": "openshorts:frame",
      "@type": "xsd:string"
    },
    "face": {
      "@id": "openshorts:face"
    },
    "background": {
      "@id": "openshorts:background"
    },
    "Body_thumbnail_publish_api_thumbnail_publish_post": "openshorts:Body_thumbnail_publish_api_thumbnail_publish_post",
    "description": {
      "@id": "openshorts:description",
      "@type": "xsd:string"
    },
    "thumbnail_url": {
      "@id": "openshorts:thumbnail_url",
      "@type": "xsd:string"
    },
    "api_key": {
      "@id": "openshorts:api_key"
    },
    "user_id": {
      "@id": "openshorts:user_id"
    },
    "Body_thumbnail_upload_api_thumbnail_upload_post": "openshorts:Body_thumbnail_upload_api_thumbnail_upload_post",
    "CancelRequest": "openshorts:CancelRequest",
    "reason": {
      "@id": "openshorts:reason",
      "@type": "xsd:string"
    },
    "details": {
      "@id": "openshorts:details"
    },
    "rating": {
      "@id": "openshorts:rating"
    },
    "review": {
      "@id": "openshorts:review"
    },
    "review_public_ok": {
      "@id": "openshorts:review_public_ok",
      "@type": "xsd:boolean"
    },
    "CaptionWordIn": "openshorts:CaptionWordIn",
    "text": {
      "@id": "openshorts:text",
      "@type": "xsd:string"
    },
    "startMs": {
      "@id": "openshorts:startMs",
      "@type": "xsd:integer"
    },
    "endMs": {
      "@id": "openshorts:endMs",
      "@type": "xsd:integer"
    },
    "CheckoutRequest": "openshorts:CheckoutRequest",
    "price_id": {
      "@id": "openshorts:price_id",
      "@type": "xsd:string"
    },
    "source": {
      "@id": "openshorts:source",
      "@type": "xsd:string"
    },
    "ClipModeRequest": "openshorts:ClipModeRequest",
    "job_id": {
      "@id": "openshorts:job_id",
      "@type": "xsd:string"
    },
    "clip_index": {
      "@id": "openshorts:clip_index",
      "@type": "xsd:integer"
    },
    "mode": {
      "@id": "openshorts:mode",
      "@type": "xsd:string"
    },
    "input_filename": {
      "@id": "openshorts:input_filename"
    },
    "ConsentRequest": "openshorts:ConsentRequest",
    "client_id": {
      "@id": "openshorts:client_id",
      "@type": "xsd:string"
    },
    "redirect_uri": {
      "@id": "openshorts:redirect_uri",
      "@type": "xsd:string"
    },
    "state": {
      "@id": "openshorts:state"
    },
    "code_challenge": {
      "@id": "openshorts:code_challenge",
      "@type": "xsd:string"
    },
    "code_challenge_method": {
      "@id": "openshorts:code_challenge_method"
    },
    "scope": {
      "@id": "openshorts:scope"
    },
    "response_type": {
      "@id": "openshorts:response_type"
    },
    "CreateKeyRequest": "openshorts:CreateKeyRequest",
    "name": {
      "@id": "openshorts:name"
    },
    "DeleteAccountRequest": "openshorts:DeleteAccountRequest",
    "confirm_email": {
      "@id": "openshorts:confirm_email",
      "@type": "xsd:string"
    },
    "DenyRequest": "openshorts:DenyRequest",
    "EditRequest": "openshorts:EditRequest",
    "EffectsGenerateRequest": "openshorts:EffectsGenerateRequest",
    "EstimateRequest": "openshorts:EstimateRequest",
    "seconds": {
      "@id": "openshorts:seconds"
    },
    "HTTPValidationError": "openshorts:HTTPValidationError",
    "detail": {
      "@id": "openshorts:detail",
      "@container": "@list"
    },
    "HookRequest": "openshorts:HookRequest",
    "position": {
      "@id": "openshorts:position"
    },
    "size": {
      "@id": "openshorts:size"
    },
    "duration_seconds": {
      "@id": "openshorts:duration_seconds"
    },
    "style": {
      "@id": "openshorts:style"
    },
    "font": {
      "@id": "openshorts:font"
    },
    "remove": {
      "@id": "openshorts:remove"
    },
    "LoginExchangeRequest": "openshorts:LoginExchangeRequest",
    "code": {
      "@id": "openshorts:code",
      "@type": "xsd:string"
    },
    "verifier": {
      "@id": "openshorts:verifier",
      "@type": "xsd:string"
    },
    "LoginMethodRequest": "openshorts:LoginMethodRequest",
    "email": {
      "@id": "openshorts:email",
      "@type": "xsd:string"
    },
    "MagicLinkRequest": "openshorts:MagicLinkRequest",
    "MagicVerifyRequest": "openshorts:MagicVerifyRequest",
    "token": {
      "@id": "openshorts:token",
      "@type": "xsd:string"
    },
    "ManualRun": "openshorts:ManualRun",
    "video_id": {
      "@id": "openshorts:video_id",
      "@type": "xsd:string"
    },
    "MetadataRequest": "openshorts:MetadataRequest",
    "topic": {
      "@id": "openshorts:topic",
      "@type": "xsd:string"
    },
    "keyword": {
      "@id": "openshorts:keyword"
    },
    "audience": {
      "@id": "openshorts:audience"
    },
    "ReframeRequest": "openshorts:ReframeRequest",
    "crop_overrides": {
      "@id": "openshorts:crop_overrides"
    },
    "reapply_captions": {
      "@id": "openshorts:reapply_captions",
      "@type": "xsd:boolean"
    },
    "RemoveSubtitlesRequest": "openshorts:RemoveSubtitlesRequest",
    "RerenderRequest": "openshorts:RerenderRequest",
    "segments": {
      "@id": "openshorts:segments",
      "@container": "@list"
    },
    "snap_to_words": {
      "@id": "openshorts:snap_to_words",
      "@type": "xsd:boolean"
    },
    "framing": {
      "@id": "openshorts:framing"
    },
    "RerenderSegment": "openshorts:RerenderSegment",
    "start": {
      "@id": "openshorts:start",
      "@type": "xsd:decimal"
    },
    "end": {
      "@id": "openshorts:end",
      "@type": "xsd:decimal"
    },
    "ReviewLoginRequest": "openshorts:ReviewLoginRequest",
    "password": {
      "@id": "openshorts:password",
      "@type": "xsd:string"
    },
    "SaaSActorRequest": "openshorts:SaaSActorRequest",
    "actor_description": {
      "@id": "openshorts:actor_description",
      "@type": "xsd:string"
    },
    "num_options": {
      "@id": "openshorts:num_options",
      "@type": "xsd:integer"
    },
    "product_description": {
      "@id": "openshorts:product_description"
    },
    "SaaSAnalyzeRequest": "openshorts:SaaSAnalyzeRequest",
    "num_scripts": {
      "@id": "openshorts:num_scripts",
      "@type": "xsd:integer"
    },
    "language": {
      "@id": "openshorts:language",
      "@type": "xsd:string"
    },
    "actor_gender": {
      "@id": "openshorts:actor_gender",
      "@type": "xsd:string"
    },
    "SaaSGenerateRequest": "openshorts:SaaSGenerateRequest",
    "script": {
      "@id": "openshorts:script"
    },
    "voice_id": {
      "@id": "openshorts:voice_id"
    },
    "selected_actor_url": {
      "@id": "openshorts:selected_actor_url"
    },
    "retry_job_id": {
      "@id": "openshorts:retry_job_id"
    },
    "video_mode": {
      "@id": "openshorts:video_mode",
      "@type": "xsd:string"
    },
    "share_to_gallery": {
      "@id": "openshorts:share_to_gallery",
      "@type": "xsd:boolean"
    },
    "SaaSPostRequest": "openshorts:SaaSPostRequest",
    "platforms": {
      "@id": "openshorts:platforms",
      "@container": "@list"
    },
    "scheduled_date": {
      "@id": "openshorts:scheduled_date"
    },
    "SocialPostRequest": "openshorts:SocialPostRequest",
    "SubtitleRequest": "openshorts:SubtitleRequest",
    "font_size": {
      "@id": "openshorts:font_size",
      "@type": "xsd:integer"
    },
    "font_name": {
      "@id": "openshorts:font_name",
      "@type": "xsd:string"
    },
    "font_color": {
      "@id": "openshorts:font_color",
      "@type": "xsd:string"
    },
    "border_color": {
      "@id": "openshorts:border_color",
      "@type": "xsd:string"
    },
    "border_width": {
      "@id": "openshorts:border_width",
      "@type": "xsd:integer"
    },
    "bg_color": {
      "@id": "openshorts:bg_color",
      "@type": "xsd:string"
    },
    "bg_opacity": {
      "@id": "openshorts:bg_opacity",
      "@type": "xsd:decimal"
    },
    "highlight_color": {
      "@id": "openshorts:highlight_color",
      "@type": "xsd:string"
    },
    "effect": {
      "@id": "openshorts:effect",
      "@type": "xsd:string"
    },
    "base_opacity": {
      "@id": "openshorts:base_opacity",
      "@type": "xsd:decimal"
    },
    "uppercase": {
      "@id": "openshorts:uppercase",
      "@type": "xsd:boolean"
    },
    "reveal": {
      "@id": "openshorts:reveal",
      "@type": "xsd:boolean"
    },
    "shadow": {
      "@id": "openshorts:shadow",
      "@type": "xsd:integer"
    },
    "max_chars": {
      "@id": "openshorts:max_chars"
    },
    "max_duration": {
      "@id": "openshorts:max_duration"
    },
    "preset": {
      "@id": "openshorts:preset"
    },
    "words": {
      "@id": "openshorts:words"
    },
    "SurveyAnswer": "openshorts:SurveyAnswer",
    "skipped": {
      "@id": "openshorts:skipped",
      "@type": "xsd:boolean"
    },
    "source_other": {
      "@id": "openshorts:source_other"
    },
    "goals": {
      "@id": "openshorts:goals",
      "@container": "@list"
    },
    "role": {
      "@id": "openshorts:role"
    },
    "ThumbnailDescribeRequest": "openshorts:ThumbnailDescribeRequest",
    "ThumbnailTitlesRequest": "openshorts:ThumbnailTitlesRequest",
    "message": {
      "@id": "openshorts:message"
    },
    "TranslateRequest": "openshorts:TranslateRequest",
    "target_language": {
      "@id": "openshorts:target_language",
      "@type": "xsd:string"
    },
    "source_language": {
      "@id": "openshorts:source_language"
    },
    "ValidationError": "openshorts:ValidationError",
    "loc": {
      "@id": "openshorts:loc",
      "@container": "@list"
    },
    "msg": {
      "@id": "openshorts:msg",
      "@type": "xsd:string"
    },
    "type": {
      "@id": "openshorts:type",
      "@type": "xsd:string"
    },
    "input": {
      "@id": "openshorts:input"
    },
    "ctx": {
      "@id": "openshorts:ctx"
    }
  },
  "@type": "schema:Dataset",
  "schema:name": "OpenShorts API JSON-LD context",
  "schema:description": "A JSON-LD @context for the objects OpenShorts'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-20) from openapi/openshorts-app-openapi.json.",
  "dcterms:created": "2026-11-20",
  "dcterms:source": [
    "openapi/openshorts-app-openapi.json"
  ]
}