BeatAPI · JSON-LD Context
Beatapi Context
JSON-LD context defining the semantic vocabulary for Beatapi from BeatAPI.
120 Classes
235 Properties
4 Namespaces
Namespaces
schema:
https://schema.org/
xsd:
http://www.w3.org/2001/XMLSchema#
dcterms:
http://purl.org/dc/terms/
beatapi:
https://beatapi.io/schema#
Classes
DecisionNoulQuestion
DecisionChoiceQuestion
DecisionScoreQuestion
DecisionBoxQuestion
DecisionAsset
DecisionRequest
DecisionResponse
TextModel
TextModelList
TextPassthroughRequest
OpenAITextError
AnthropicTextError
Workflow
TaskStatus
StoryboardShot
Storyboard
ShotMedia
TaskUsage
Task
Effect
EffectResponse
EffectListResponse
File
WebhookEndpoint
WebhookEvent
WorkflowList
WorkflowListResponse
GenerationModel
GenerationModelList
GenerationModelListResponse
QwenImage21Request
NanoBananaImageRequest
NanoBanana2ImageRequest
NanoBanana21ImageRequest
NanoBanana2LiteImageRequest
NanoBananaProImageRequest
GptImage2Request
GptImage25FlareRequest
GptImage25SunburstRequest
Seedream5ProImageRequest
Seedream5LiteImageRequest
GrokImagineImage20Request
MinimaxH3VideoRequest
MinimaxH3FastVideoRequest
MinimaxH3NormalVideoRequest
GrokImagineVideo15Request
Seedance2VideoRequest
Seedance2FastVideoRequest
Seedance2MiniVideoRequest
Veo31TextOrFrameVideoRequest
Veo31ReferenceVideoRequest
Seedance25VideoRequest
KlingShot
KlingElement
Kling3VideoRequest
KlingV4Element
KlingV4VideoRequest
Kling26MotionControlVideoRequest
Kling3MotionControlVideoRequest
Wan30VideoRequest
Wan30PrimeVideoRequest
HappyHorse10VideoRequest
HappyHorse11VideoRequest
MinimaxH3MaxVideoRequest
MinimaxH3MaxTurboVideoRequest
TaskResponse
Usage
UsageResponse
UsageRecord
UsageRecordResponse
UsageRecordListResponse
Account
AccountResponse
NotificationSettings
NotificationSettingsResponse
NotificationSettingsUpdateRequest
Payment
PaymentListResponse
ApiKey
ApiKeyResponse
ApiKeyCreatedResponse
ApiKeyListResponse
ApiKeyCreateRequest
ApiKeyUpdateRequest
ApiKeyDeletedResponse
ApiKeySecretResponse
VideoAnalysisTaskCreateRequest
StandardMusicVideoTaskCreateRequest
PremiumMusicVideoTaskRequestBase
EditMusicVideoShotRequest
RealtimeSession
RealtimeSessionCreateResponse
RealtimeSessionResponse
FileResponse
WebhookEndpointList
WebhookEndpointListResponse
WebhookEndpointResponse
DeleteResponse
CapabilityContract
CapabilitySearchRequest
CapabilityCard
CapabilityGroup
CapabilityNext
CapabilitySearchPage
CapabilityRunRequest
CapabilityRunResult
WebSearchRequest
WebSearchResult
WebSearchResponse
WebCallUsage
WebReadRequest
WebReadResult
WebReadFailure
WebReadResponse
WebMapRequest
WebMapResponse
WebResearchRequest
WebResearchSource
WebResearchResponse
Error
Properties
| Property | Type | Container |
|---|---|---|
| type | string | |
| instructions | reference | |
| criteria | ||
| format | string | |
| data_base64 | string | |
| model | string | |
| state | ||
| questions | ||
| assets | ||
| stream | boolean | |
| id | string | |
| answers | ||
| usage | ||
| object | string | |
| created | integer | |
| owned_by | string | |
| data | list | |
| error | ||
| name | string | |
| description | string | |
| index | integer | |
| status | reference | |
| duration_seconds | integer | |
| prompt | string | |
| lyric_text | string | |
| media | ||
| created_at | integer | |
| updated_at | integer | |
| shots | list | |
| task_id | string | |
| shot_id | string | |
| request_id | string | |
| credits_reserved | decimal | |
| credits_charged | decimal | |
| billable_duration_seconds | integer | |
| credits_settled | decimal | |
| credits_refunded | decimal | |
| task_kind | string | |
| capability_id | string | |
| capability_version | integer | |
| workflow | string | |
| effect_id | string | |
| effect_version | integer | |
| media_type | string | |
| stage | reference | |
| storyboard | reference | |
| completed_at | integer | |
| poll_after_seconds | integer | |
| typical_seconds | ||
| output | ||
| error_code | string | |
| error_message | string | |
| retryable | boolean | |
| output_type | string | |
| category | string | |
| tags | list | |
| input | ||
| options | ||
| preview | ||
| version | integer | |
| url | reference | |
| key | string | |
| mime_type | string | |
| size_bytes | integer | |
| purpose | string | |
| events | list | |
| secret | string | |
| event | string | |
| input_modes | list | |
| aspect_ratio | string | |
| background | string | |
| enhance_prompt | boolean | |
| images | list | |
| output_format | string | |
| resolution | string | |
| seed | integer | |
| size | string | |
| reference_images | list | |
| reference_videos | list | |
| reference_audios | list | |
| duration | integer | |
| generate_audio | boolean | |
| quality | string | |
| watermark | string | |
| enable_translation | boolean | |
| task_type | string | |
| element_input_urls | list | |
| element_input_audio_urls | list | |
| start_time | integer | |
| end_time | integer | |
| sound | boolean | |
| multi_shots | boolean | |
| multi_prompt | list | |
| elements | list | |
| tag | string | |
| element_input_video_urls | list | |
| keep_original_sound | boolean | |
| character_orientation | string | |
| background_source | string | |
| period | string | |
| since | integer | |
| until | integer | |
| credit_balance | decimal | |
| total_tasks | integer | |
| concurrency | ||
| by_workflow | list | |
| by_capability | list | |
| by_model | list | |
| by_api_key | list | |
| realtime | ||
| api_key | ||
| currency | string | |
| username | string | |
| display_name | string | |
| string | ||
| threshold_credits | decimal | |
| effective_threshold_credits | decimal | |
| default_threshold_credits | decimal | |
| notification_email | string | |
| account_email | string | |
| order_no | string | |
| amount_paid | decimal | |
| credits | decimal | |
| payment_method | string | |
| paid_at | integer | |
| title | string | |
| key_prefix | string | |
| last_used_at | integer | |
| expires_at | integer | |
| remaining_credits | decimal | |
| credits_used | decimal | |
| models | list | |
| allowed_ips | list | |
| video_url | reference | |
| analysis_depth | string | |
| max_output_tokens | integer | |
| mv_tier | string | |
| audio_url | reference | |
| language | string | |
| style | string | |
| lip_sync | boolean | |
| lip_ref_url | reference | |
| add_subtitle | boolean | |
| subtitle_color | string | |
| srt_url | reference | |
| compose_mode | string | |
| mv_mode | string | |
| max_duration_seconds | integer | |
| allowed_origins | list | |
| connected_at | dateTime | |
| closed_at | dateTime | |
| reference | string | |
| kind | string | |
| readiness | string | |
| categories | list | |
| platforms | list | |
| entities | list | |
| operations | list | |
| input_schema | ||
| output_schema | ||
| schema_hash | string | |
| pricing | ||
| pagination | ||
| limits | ||
| errors | ||
| documentation | ||
| execution | ||
| versions | ||
| validation | ||
| query | string | |
| platform | string | |
| limit | integer | |
| cursor | string | |
| view | string | |
| group_by | string | |
| summary | string | |
| price | string | |
| signature | string | |
| label | string | |
| count | integer | |
| examples | list | |
| search | ||
| action | string | |
| call | ||
| note | string | |
| total | integer | |
| next_cursor | string | |
| understood | ||
| recommended | ||
| groups | list | |
| hints | list | |
| next | reference | |
| catalog_features | list | |
| operation | string | |
| max_items | integer | |
| fields | list | |
| idempotency_key | string | |
| output_text | string | |
| items | list | |
| items_path | string | |
| items_total | integer | |
| items_shown | integer | |
| truncated | boolean | |
| result_ref | ||
| max_results | integer | |
| time_range | string | |
| include_domains | list | |
| exclude_domains | list | |
| country | string | |
| position | integer | |
| snippet | string | |
| published_at | string | |
| results | list | |
| answer_box | ||
| related_searches | list | |
| billing_unit | string | |
| quantity | integer | |
| price_usd | string | |
| price_version | string | |
| urls | list | |
| max_chars | integer | |
| content | string | |
| reason | string | |
| failed | list | |
| max_depth | integer | |
| include_external | boolean | |
| select_paths | list | |
| exclude_paths | list | |
| include_x | boolean | |
| author | string | |
| read_status | string | |
| research_notes | string | |
| sources | list | |
| partial_reasons | list | |
| x_search |
JSON-LD Document
{
"@context": {
"@vocab": "https://beatapi.io/schema#",
"schema": "https://schema.org/",
"xsd": "http://www.w3.org/2001/XMLSchema#",
"dcterms": "http://purl.org/dc/terms/",
"beatapi": "https://beatapi.io/schema#",
"DecisionNoulQuestion": "beatapi:DecisionNoulQuestion",
"type": {
"@id": "beatapi:type",
"@type": "xsd:string"
},
"instructions": {
"@id": "beatapi:instructions",
"@type": "@id"
},
"criteria": {
"@id": "beatapi:criteria"
},
"DecisionChoiceQuestion": "beatapi:DecisionChoiceQuestion",
"DecisionScoreQuestion": "beatapi:DecisionScoreQuestion",
"DecisionBoxQuestion": "beatapi:DecisionBoxQuestion",
"DecisionAsset": "beatapi:DecisionAsset",
"format": {
"@id": "beatapi:format",
"@type": "xsd:string"
},
"data_base64": {
"@id": "beatapi:data_base64",
"@type": "xsd:string"
},
"DecisionRequest": "beatapi:DecisionRequest",
"model": {
"@id": "beatapi:model",
"@type": "xsd:string"
},
"state": {
"@id": "beatapi:state"
},
"questions": {
"@id": "beatapi:questions"
},
"assets": {
"@id": "beatapi:assets"
},
"stream": {
"@id": "beatapi:stream",
"@type": "xsd:boolean"
},
"DecisionResponse": "beatapi:DecisionResponse",
"id": {
"@id": "beatapi:id",
"@type": "xsd:string"
},
"answers": {
"@id": "beatapi:answers"
},
"usage": {
"@id": "beatapi:usage"
},
"TextModel": "beatapi:TextModel",
"object": {
"@id": "beatapi:object",
"@type": "xsd:string"
},
"created": {
"@id": "beatapi:created",
"@type": "xsd:integer"
},
"owned_by": {
"@id": "beatapi:owned_by",
"@type": "xsd:string"
},
"TextModelList": "beatapi:TextModelList",
"data": {
"@id": "beatapi:data",
"@container": "@list"
},
"TextPassthroughRequest": "beatapi:TextPassthroughRequest",
"OpenAITextError": "beatapi:OpenAITextError",
"error": {
"@id": "beatapi:error"
},
"AnthropicTextError": "beatapi:AnthropicTextError",
"Workflow": "beatapi:Workflow",
"name": {
"@id": "beatapi:name",
"@type": "xsd:string"
},
"description": {
"@id": "beatapi:description",
"@type": "xsd:string"
},
"TaskStatus": "beatapi:TaskStatus",
"StoryboardShot": "beatapi:StoryboardShot",
"index": {
"@id": "beatapi:index",
"@type": "xsd:integer"
},
"status": {
"@id": "beatapi:status",
"@type": "@id"
},
"duration_seconds": {
"@id": "beatapi:duration_seconds",
"@type": "xsd:integer"
},
"prompt": {
"@id": "beatapi:prompt",
"@type": "xsd:string"
},
"lyric_text": {
"@id": "beatapi:lyric_text",
"@type": "xsd:string"
},
"media": {
"@id": "beatapi:media"
},
"created_at": {
"@id": "beatapi:created_at",
"@type": "xsd:integer"
},
"updated_at": {
"@id": "beatapi:updated_at",
"@type": "xsd:integer"
},
"Storyboard": "beatapi:Storyboard",
"shots": {
"@id": "beatapi:shots",
"@container": "@list"
},
"ShotMedia": "beatapi:ShotMedia",
"task_id": {
"@id": "beatapi:task_id",
"@type": "xsd:string"
},
"shot_id": {
"@id": "beatapi:shot_id",
"@type": "xsd:string"
},
"request_id": {
"@id": "beatapi:request_id",
"@type": "xsd:string"
},
"TaskUsage": "beatapi:TaskUsage",
"credits_reserved": {
"@id": "beatapi:credits_reserved",
"@type": "xsd:decimal"
},
"credits_charged": {
"@id": "beatapi:credits_charged",
"@type": "xsd:decimal"
},
"billable_duration_seconds": {
"@id": "beatapi:billable_duration_seconds",
"@type": "xsd:integer"
},
"credits_settled": {
"@id": "beatapi:credits_settled",
"@type": "xsd:decimal"
},
"credits_refunded": {
"@id": "beatapi:credits_refunded",
"@type": "xsd:decimal"
},
"Task": "beatapi:Task",
"task_kind": {
"@id": "beatapi:task_kind",
"@type": "xsd:string"
},
"capability_id": {
"@id": "beatapi:capability_id",
"@type": "xsd:string"
},
"capability_version": {
"@id": "beatapi:capability_version",
"@type": "xsd:integer"
},
"workflow": {
"@id": "beatapi:workflow",
"@type": "xsd:string"
},
"effect_id": {
"@id": "beatapi:effect_id",
"@type": "xsd:string"
},
"effect_version": {
"@id": "beatapi:effect_version",
"@type": "xsd:integer"
},
"media_type": {
"@id": "beatapi:media_type",
"@type": "xsd:string"
},
"stage": {
"@id": "beatapi:stage",
"@type": "@id"
},
"storyboard": {
"@id": "beatapi:storyboard",
"@type": "@id"
},
"completed_at": {
"@id": "beatapi:completed_at",
"@type": "xsd:integer"
},
"poll_after_seconds": {
"@id": "beatapi:poll_after_seconds",
"@type": "xsd:integer"
},
"typical_seconds": {
"@id": "beatapi:typical_seconds"
},
"output": {
"@id": "beatapi:output"
},
"error_code": {
"@id": "beatapi:error_code",
"@type": "xsd:string"
},
"error_message": {
"@id": "beatapi:error_message",
"@type": "xsd:string"
},
"retryable": {
"@id": "beatapi:retryable",
"@type": "xsd:boolean"
},
"Effect": "beatapi:Effect",
"output_type": {
"@id": "beatapi:output_type",
"@type": "xsd:string"
},
"category": {
"@id": "beatapi:category",
"@type": "xsd:string"
},
"tags": {
"@id": "beatapi:tags",
"@container": "@list"
},
"input": {
"@id": "beatapi:input"
},
"options": {
"@id": "beatapi:options"
},
"preview": {
"@id": "beatapi:preview"
},
"version": {
"@id": "beatapi:version",
"@type": "xsd:integer"
},
"EffectResponse": "beatapi:EffectResponse",
"EffectListResponse": "beatapi:EffectListResponse",
"File": "beatapi:File",
"url": {
"@id": "beatapi:url",
"@type": "@id"
},
"key": {
"@id": "beatapi:key",
"@type": "xsd:string"
},
"mime_type": {
"@id": "beatapi:mime_type",
"@type": "xsd:string"
},
"size_bytes": {
"@id": "beatapi:size_bytes",
"@type": "xsd:integer"
},
"purpose": {
"@id": "beatapi:purpose",
"@type": "xsd:string"
},
"WebhookEndpoint": "beatapi:WebhookEndpoint",
"events": {
"@id": "beatapi:events",
"@container": "@list"
},
"secret": {
"@id": "beatapi:secret",
"@type": "xsd:string"
},
"WebhookEvent": "beatapi:WebhookEvent",
"event": {
"@id": "beatapi:event",
"@type": "xsd:string"
},
"WorkflowList": "beatapi:WorkflowList",
"WorkflowListResponse": "beatapi:WorkflowListResponse",
"GenerationModel": "beatapi:GenerationModel",
"input_modes": {
"@id": "beatapi:input_modes",
"@container": "@list"
},
"GenerationModelList": "beatapi:GenerationModelList",
"GenerationModelListResponse": "beatapi:GenerationModelListResponse",
"QwenImage21Request": "beatapi:QwenImage21Request",
"aspect_ratio": {
"@id": "beatapi:aspect_ratio",
"@type": "xsd:string"
},
"background": {
"@id": "beatapi:background",
"@type": "xsd:string"
},
"enhance_prompt": {
"@id": "beatapi:enhance_prompt",
"@type": "xsd:boolean"
},
"images": {
"@id": "beatapi:images",
"@container": "@list"
},
"output_format": {
"@id": "beatapi:output_format",
"@type": "xsd:string"
},
"resolution": {
"@id": "beatapi:resolution",
"@type": "xsd:string"
},
"seed": {
"@id": "beatapi:seed",
"@type": "xsd:integer"
},
"NanoBananaImageRequest": "beatapi:NanoBananaImageRequest",
"NanoBanana2ImageRequest": "beatapi:NanoBanana2ImageRequest",
"NanoBanana21ImageRequest": "beatapi:NanoBanana21ImageRequest",
"NanoBanana2LiteImageRequest": "beatapi:NanoBanana2LiteImageRequest",
"NanoBananaProImageRequest": "beatapi:NanoBananaProImageRequest",
"GptImage2Request": "beatapi:GptImage2Request",
"size": {
"@id": "beatapi:size",
"@type": "xsd:string"
},
"GptImage25FlareRequest": "beatapi:GptImage25FlareRequest",
"GptImage25SunburstRequest": "beatapi:GptImage25SunburstRequest",
"Seedream5ProImageRequest": "beatapi:Seedream5ProImageRequest",
"Seedream5LiteImageRequest": "beatapi:Seedream5LiteImageRequest",
"GrokImagineImage20Request": "beatapi:GrokImagineImage20Request",
"MinimaxH3VideoRequest": "beatapi:MinimaxH3VideoRequest",
"reference_images": {
"@id": "beatapi:reference_images",
"@container": "@list"
},
"reference_videos": {
"@id": "beatapi:reference_videos",
"@container": "@list"
},
"reference_audios": {
"@id": "beatapi:reference_audios",
"@container": "@list"
},
"duration": {
"@id": "beatapi:duration",
"@type": "xsd:integer"
},
"MinimaxH3FastVideoRequest": "beatapi:MinimaxH3FastVideoRequest",
"MinimaxH3NormalVideoRequest": "beatapi:MinimaxH3NormalVideoRequest",
"GrokImagineVideo15Request": "beatapi:GrokImagineVideo15Request",
"Seedance2VideoRequest": "beatapi:Seedance2VideoRequest",
"generate_audio": {
"@id": "beatapi:generate_audio",
"@type": "xsd:boolean"
},
"Seedance2FastVideoRequest": "beatapi:Seedance2FastVideoRequest",
"Seedance2MiniVideoRequest": "beatapi:Seedance2MiniVideoRequest",
"Veo31TextOrFrameVideoRequest": "beatapi:Veo31TextOrFrameVideoRequest",
"quality": {
"@id": "beatapi:quality",
"@type": "xsd:string"
},
"watermark": {
"@id": "beatapi:watermark",
"@type": "xsd:string"
},
"enable_translation": {
"@id": "beatapi:enable_translation",
"@type": "xsd:boolean"
},
"Veo31ReferenceVideoRequest": "beatapi:Veo31ReferenceVideoRequest",
"Seedance25VideoRequest": "beatapi:Seedance25VideoRequest",
"task_type": {
"@id": "beatapi:task_type",
"@type": "xsd:string"
},
"KlingShot": "beatapi:KlingShot",
"KlingElement": "beatapi:KlingElement",
"element_input_urls": {
"@id": "beatapi:element_input_urls",
"@container": "@list"
},
"element_input_audio_urls": {
"@id": "beatapi:element_input_audio_urls",
"@container": "@list"
},
"start_time": {
"@id": "beatapi:start_time",
"@type": "xsd:integer"
},
"end_time": {
"@id": "beatapi:end_time",
"@type": "xsd:integer"
},
"Kling3VideoRequest": "beatapi:Kling3VideoRequest",
"sound": {
"@id": "beatapi:sound",
"@type": "xsd:boolean"
},
"multi_shots": {
"@id": "beatapi:multi_shots",
"@type": "xsd:boolean"
},
"multi_prompt": {
"@id": "beatapi:multi_prompt",
"@container": "@list"
},
"elements": {
"@id": "beatapi:elements",
"@container": "@list"
},
"KlingV4Element": "beatapi:KlingV4Element",
"tag": {
"@id": "beatapi:tag",
"@type": "xsd:string"
},
"element_input_video_urls": {
"@id": "beatapi:element_input_video_urls",
"@container": "@list"
},
"KlingV4VideoRequest": "beatapi:KlingV4VideoRequest",
"keep_original_sound": {
"@id": "beatapi:keep_original_sound",
"@type": "xsd:boolean"
},
"Kling26MotionControlVideoRequest": "beatapi:Kling26MotionControlVideoRequest",
"character_orientation": {
"@id": "beatapi:character_orientation",
"@type": "xsd:string"
},
"Kling3MotionControlVideoRequest": "beatapi:Kling3MotionControlVideoRequest",
"background_source": {
"@id": "beatapi:background_source",
"@type": "xsd:string"
},
"Wan30VideoRequest": "beatapi:Wan30VideoRequest",
"Wan30PrimeVideoRequest": "beatapi:Wan30PrimeVideoRequest",
"HappyHorse10VideoRequest": "beatapi:HappyHorse10VideoRequest",
"HappyHorse11VideoRequest": "beatapi:HappyHorse11VideoRequest",
"MinimaxH3MaxVideoRequest": "beatapi:MinimaxH3MaxVideoRequest",
"MinimaxH3MaxTurboVideoRequest": "beatapi:MinimaxH3MaxTurboVideoRequest",
"TaskResponse": "beatapi:TaskResponse",
"Usage": "beatapi:Usage",
"period": {
"@id": "beatapi:period",
"@type": "xsd:string"
},
"since": {
"@id": "beatapi:since",
"@type": "xsd:integer"
},
"until": {
"@id": "beatapi:until",
"@type": "xsd:integer"
},
"credit_balance": {
"@id": "beatapi:credit_balance",
"@type": "xsd:decimal"
},
"total_tasks": {
"@id": "beatapi:total_tasks",
"@type": "xsd:integer"
},
"concurrency": {
"@id": "beatapi:concurrency"
},
"by_workflow": {
"@id": "beatapi:by_workflow",
"@container": "@list"
},
"by_capability": {
"@id": "beatapi:by_capability",
"@container": "@list"
},
"by_model": {
"@id": "beatapi:by_model",
"@container": "@list"
},
"by_api_key": {
"@id": "beatapi:by_api_key",
"@container": "@list"
},
"realtime": {
"@id": "beatapi:realtime"
},
"UsageResponse": "beatapi:UsageResponse",
"UsageRecord": "beatapi:UsageRecord",
"api_key": {
"@id": "beatapi:api_key"
},
"currency": {
"@id": "beatapi:currency",
"@type": "xsd:string"
},
"UsageRecordResponse": "beatapi:UsageRecordResponse",
"UsageRecordListResponse": "beatapi:UsageRecordListResponse",
"Account": "beatapi:Account",
"username": {
"@id": "beatapi:username",
"@type": "xsd:string"
},
"display_name": {
"@id": "beatapi:display_name",
"@type": "xsd:string"
},
"email": {
"@id": "beatapi:email",
"@type": "xsd:string"
},
"AccountResponse": "beatapi:AccountResponse",
"NotificationSettings": "beatapi:NotificationSettings",
"threshold_credits": {
"@id": "beatapi:threshold_credits",
"@type": "xsd:decimal"
},
"effective_threshold_credits": {
"@id": "beatapi:effective_threshold_credits",
"@type": "xsd:decimal"
},
"default_threshold_credits": {
"@id": "beatapi:default_threshold_credits",
"@type": "xsd:decimal"
},
"notification_email": {
"@id": "beatapi:notification_email",
"@type": "xsd:string"
},
"account_email": {
"@id": "beatapi:account_email",
"@type": "xsd:string"
},
"NotificationSettingsResponse": "beatapi:NotificationSettingsResponse",
"NotificationSettingsUpdateRequest": "beatapi:NotificationSettingsUpdateRequest",
"Payment": "beatapi:Payment",
"order_no": {
"@id": "beatapi:order_no",
"@type": "xsd:string"
},
"amount_paid": {
"@id": "beatapi:amount_paid",
"@type": "xsd:decimal"
},
"credits": {
"@id": "beatapi:credits",
"@type": "xsd:decimal"
},
"payment_method": {
"@id": "beatapi:payment_method",
"@type": "xsd:string"
},
"paid_at": {
"@id": "beatapi:paid_at",
"@type": "xsd:integer"
},
"PaymentListResponse": "beatapi:PaymentListResponse",
"ApiKey": "beatapi:ApiKey",
"title": {
"@id": "beatapi:title",
"@type": "xsd:string"
},
"key_prefix": {
"@id": "beatapi:key_prefix",
"@type": "xsd:string"
},
"last_used_at": {
"@id": "beatapi:last_used_at",
"@type": "xsd:integer"
},
"expires_at": {
"@id": "beatapi:expires_at",
"@type": "xsd:integer"
},
"remaining_credits": {
"@id": "beatapi:remaining_credits",
"@type": "xsd:decimal"
},
"credits_used": {
"@id": "beatapi:credits_used",
"@type": "xsd:decimal"
},
"models": {
"@id": "beatapi:models",
"@container": "@list"
},
"allowed_ips": {
"@id": "beatapi:allowed_ips",
"@container": "@list"
},
"ApiKeyResponse": "beatapi:ApiKeyResponse",
"ApiKeyCreatedResponse": "beatapi:ApiKeyCreatedResponse",
"ApiKeyListResponse": "beatapi:ApiKeyListResponse",
"ApiKeyCreateRequest": "beatapi:ApiKeyCreateRequest",
"ApiKeyUpdateRequest": "beatapi:ApiKeyUpdateRequest",
"ApiKeyDeletedResponse": "beatapi:ApiKeyDeletedResponse",
"ApiKeySecretResponse": "beatapi:ApiKeySecretResponse",
"VideoAnalysisTaskCreateRequest": "beatapi:VideoAnalysisTaskCreateRequest",
"video_url": {
"@id": "beatapi:video_url",
"@type": "@id"
},
"analysis_depth": {
"@id": "beatapi:analysis_depth",
"@type": "xsd:string"
},
"max_output_tokens": {
"@id": "beatapi:max_output_tokens",
"@type": "xsd:integer"
},
"StandardMusicVideoTaskCreateRequest": "beatapi:StandardMusicVideoTaskCreateRequest",
"mv_tier": {
"@id": "beatapi:mv_tier",
"@type": "xsd:string"
},
"audio_url": {
"@id": "beatapi:audio_url",
"@type": "@id"
},
"language": {
"@id": "beatapi:language",
"@type": "xsd:string"
},
"style": {
"@id": "beatapi:style",
"@type": "xsd:string"
},
"lip_sync": {
"@id": "beatapi:lip_sync",
"@type": "xsd:boolean"
},
"lip_ref_url": {
"@id": "beatapi:lip_ref_url",
"@type": "@id"
},
"add_subtitle": {
"@id": "beatapi:add_subtitle",
"@type": "xsd:boolean"
},
"subtitle_color": {
"@id": "beatapi:subtitle_color",
"@type": "xsd:string"
},
"srt_url": {
"@id": "beatapi:srt_url",
"@type": "@id"
},
"compose_mode": {
"@id": "beatapi:compose_mode",
"@type": "xsd:string"
},
"PremiumMusicVideoTaskRequestBase": "beatapi:PremiumMusicVideoTaskRequestBase",
"mv_mode": {
"@id": "beatapi:mv_mode",
"@type": "xsd:string"
},
"EditMusicVideoShotRequest": "beatapi:EditMusicVideoShotRequest",
"RealtimeSession": "beatapi:RealtimeSession",
"max_duration_seconds": {
"@id": "beatapi:max_duration_seconds",
"@type": "xsd:integer"
},
"allowed_origins": {
"@id": "beatapi:allowed_origins",
"@container": "@list"
},
"connected_at": {
"@id": "beatapi:connected_at",
"@type": "xsd:dateTime"
},
"closed_at": {
"@id": "beatapi:closed_at",
"@type": "xsd:dateTime"
},
"RealtimeSessionCreateResponse": "beatapi:RealtimeSessionCreateResponse",
"RealtimeSessionResponse": "beatapi:RealtimeSessionResponse",
"FileResponse": "beatapi:FileResponse",
"WebhookEndpointList": "beatapi:WebhookEndpointList",
"WebhookEndpointListResponse": "beatapi:WebhookEndpointListResponse",
"WebhookEndpointResponse": "beatapi:WebhookEndpointResponse",
"DeleteResponse": "beatapi:DeleteResponse",
"CapabilityContract": "beatapi:CapabilityContract",
"reference": {
"@id": "beatapi:reference",
"@type": "xsd:string"
},
"kind": {
"@id": "beatapi:kind",
"@type": "xsd:string"
},
"readiness": {
"@id": "beatapi:readiness",
"@type": "xsd:string"
},
"categories": {
"@id": "beatapi:categories",
"@container": "@list"
},
"platforms": {
"@id": "beatapi:platforms",
"@container": "@list"
},
"entities": {
"@id": "beatapi:entities",
"@container": "@list"
},
"operations": {
"@id": "beatapi:operations",
"@container": "@list"
},
"input_schema": {
"@id": "beatapi:input_schema"
},
"output_schema": {
"@id": "beatapi:output_schema"
},
"schema_hash": {
"@id": "beatapi:schema_hash",
"@type": "xsd:string"
},
"pricing": {
"@id": "beatapi:pricing"
},
"pagination": {
"@id": "beatapi:pagination"
},
"limits": {
"@id": "beatapi:limits"
},
"errors": {
"@id": "beatapi:errors"
},
"documentation": {
"@id": "beatapi:documentation"
},
"execution": {
"@id": "beatapi:execution"
},
"versions": {
"@id": "beatapi:versions"
},
"validation": {
"@id": "beatapi:validation"
},
"CapabilitySearchRequest": "beatapi:CapabilitySearchRequest",
"query": {
"@id": "beatapi:query",
"@type": "xsd:string"
},
"platform": {
"@id": "beatapi:platform",
"@type": "xsd:string"
},
"limit": {
"@id": "beatapi:limit",
"@type": "xsd:integer"
},
"cursor": {
"@id": "beatapi:cursor",
"@type": "xsd:string"
},
"view": {
"@id": "beatapi:view",
"@type": "xsd:string"
},
"group_by": {
"@id": "beatapi:group_by",
"@type": "xsd:string"
},
"CapabilityCard": "beatapi:CapabilityCard",
"summary": {
"@id": "beatapi:summary",
"@type": "xsd:string"
},
"price": {
"@id": "beatapi:price",
"@type": "xsd:string"
},
"signature": {
"@id": "beatapi:signature",
"@type": "xsd:string"
},
"CapabilityGroup": "beatapi:CapabilityGroup",
"label": {
"@id": "beatapi:label",
"@type": "xsd:string"
},
"count": {
"@id": "beatapi:count",
"@type": "xsd:integer"
},
"examples": {
"@id": "beatapi:examples",
"@container": "@list"
},
"search": {
"@id": "beatapi:search"
},
"CapabilityNext": "beatapi:CapabilityNext",
"action": {
"@id": "beatapi:action",
"@type": "xsd:string"
},
"call": {
"@id": "beatapi:call"
},
"note": {
"@id": "beatapi:note",
"@type": "xsd:string"
},
"CapabilitySearchPage": "beatapi:CapabilitySearchPage",
"total": {
"@id": "beatapi:total",
"@type": "xsd:integer"
},
"next_cursor": {
"@id": "beatapi:next_cursor",
"@type": "xsd:string"
},
"understood": {
"@id": "beatapi:understood"
},
"recommended": {
"@id": "beatapi:recommended"
},
"groups": {
"@id": "beatapi:groups",
"@container": "@list"
},
"hints": {
"@id": "beatapi:hints",
"@container": "@list"
},
"next": {
"@id": "beatapi:next",
"@type": "@id"
},
"catalog_features": {
"@id": "beatapi:catalog_features",
"@container": "@list"
},
"CapabilityRunRequest": "beatapi:CapabilityRunRequest",
"operation": {
"@id": "beatapi:operation",
"@type": "xsd:string"
},
"max_items": {
"@id": "beatapi:max_items",
"@type": "xsd:integer"
},
"fields": {
"@id": "beatapi:fields",
"@container": "@list"
},
"idempotency_key": {
"@id": "beatapi:idempotency_key",
"@type": "xsd:string"
},
"CapabilityRunResult": "beatapi:CapabilityRunResult",
"output_text": {
"@id": "beatapi:output_text",
"@type": "xsd:string"
},
"items": {
"@id": "beatapi:items",
"@container": "@list"
},
"items_path": {
"@id": "beatapi:items_path",
"@type": "xsd:string"
},
"items_total": {
"@id": "beatapi:items_total",
"@type": "xsd:integer"
},
"items_shown": {
"@id": "beatapi:items_shown",
"@type": "xsd:integer"
},
"truncated": {
"@id": "beatapi:truncated",
"@type": "xsd:boolean"
},
"result_ref": {
"@id": "beatapi:result_ref"
},
"WebSearchRequest": "beatapi:WebSearchRequest",
"max_results": {
"@id": "beatapi:max_results",
"@type": "xsd:integer"
},
"time_range": {
"@id": "beatapi:time_range",
"@type": "xsd:string"
},
"include_domains": {
"@id": "beatapi:include_domains",
"@container": "@list"
},
"exclude_domains": {
"@id": "beatapi:exclude_domains",
"@container": "@list"
},
"country": {
"@id": "beatapi:country",
"@type": "xsd:string"
},
"WebSearchResult": "beatapi:WebSearchResult",
"position": {
"@id": "beatapi:position",
"@type": "xsd:integer"
},
"snippet": {
"@id": "beatapi:snippet",
"@type": "xsd:string"
},
"published_at": {
"@id": "beatapi:published_at",
"@type": "xsd:string"
},
"WebSearchResponse": "beatapi:WebSearchResponse",
"results": {
"@id": "beatapi:results",
"@container": "@list"
},
"answer_box": {
"@id": "beatapi:answer_box"
},
"related_searches": {
"@id": "beatapi:related_searches",
"@container": "@list"
},
"WebCallUsage": "beatapi:WebCallUsage",
"billing_unit": {
"@id": "beatapi:billing_unit",
"@type": "xsd:string"
},
"quantity": {
"@id": "beatapi:quantity",
"@type": "xsd:integer"
},
"price_usd": {
"@id": "beatapi:price_usd",
"@type": "xsd:string"
},
"price_version": {
"@id": "beatapi:price_version",
"@type": "xsd:string"
},
"WebReadRequest": "beatapi:WebReadRequest",
"urls": {
"@id": "beatapi:urls",
"@container": "@list"
},
"max_chars": {
"@id": "beatapi:max_chars",
"@type": "xsd:integer"
},
"WebReadResult": "beatapi:WebReadResult",
"content": {
"@id": "beatapi:content",
"@type": "xsd:string"
},
"WebReadFailure": "beatapi:WebReadFailure",
"reason": {
"@id": "beatapi:reason",
"@type": "xsd:string"
},
"WebReadResponse": "beatapi:WebReadResponse",
"failed": {
"@id": "beatapi:failed",
"@container": "@list"
},
"WebMapRequest": "beatapi:WebMapRequest",
"max_depth": {
"@id": "beatapi:max_depth",
"@type": "xsd:integer"
},
"include_external": {
"@id": "beatapi:include_external",
"@type": "xsd:boolean"
},
"select_paths": {
"@id": "beatapi:select_paths",
"@container": "@list"
},
"exclude_paths": {
"@id": "beatapi:exclude_paths",
"@container": "@list"
},
"WebMapResponse": "beatapi:WebMapResponse",
"WebResearchRequest": "beatapi:WebResearchRequest",
"include_x": {
"@id": "beatapi:include_x",
"@type": "xsd:boolean"
},
"WebResearchSource": "beatapi:WebResearchSource",
"author": {
"@id": "beatapi:author",
"@type": "xsd:string"
},
"read_status": {
"@id": "beatapi:read_status",
"@type": "xsd:string"
},
"WebResearchResponse": "beatapi:WebResearchResponse",
"research_notes": {
"@id": "beatapi:research_notes",
"@type": "xsd:string"
},
"sources": {
"@id": "beatapi:sources",
"@container": "@list"
},
"partial_reasons": {
"@id": "beatapi:partial_reasons",
"@container": "@list"
},
"x_search": {
"@id": "beatapi:x_search"
},
"Error": "beatapi:Error"
},
"@type": "schema:Dataset",
"schema:name": "BeatAPI API JSON-LD context",
"schema:description": "A JSON-LD @context for the objects BeatAPI'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-10-30) from openapi/beatapi-openapi.json.",
"dcterms:created": "2026-10-30",
"dcterms:source": [
"openapi/beatapi-openapi.json"
]
}