{"openapi":"3.1.0","info":{"title":"vewo Business API","description":"Upload video from your backend, receive signed webhooks when it can play, and show private video to one viewer with a view token. Guide: https://vewo.io/docs","version":"1"},"servers":[{"url":"https://api.vewo.io"}],"paths":{"/v1/me":{"get":{"tags":["business-api"],"summary":"Check a key and see the workspace's limits","description":"Who this key belongs to and what the workspace is holding.\n\nExists mostly so an integrator can verify a key works before writing anything that matters,\nwhich is the first thing anyone does with a new API.","operationId":"api_me_v1_me_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Api Me V1 Me Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/videos":{"post":{"tags":["business-api"],"summary":"Create a video and get where to upload it","description":"Begin an upload. Send Idempotency-Key to make a retry return the first response.","operationId":"api_create_video_v1_videos_post","parameters":[{"name":"idempotency-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_api_create_video_v1_videos_post"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Api Create Video V1 Videos Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["business-api"],"summary":"List videos in the workspace","operationId":"api_list_videos_v1_videos_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Cursor"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Api List Videos V1 Videos Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/videos/{video_id}/upload/parts":{"get":{"tags":["business-api"],"summary":"List which parts of a multipart upload arrived","description":"Which parts S3 already holds, so an interrupted upload sends only what is missing.","operationId":"api_uploaded_parts_v1_videos__video_id__upload_parts_get","parameters":[{"name":"video_id","in":"path","required":true,"schema":{"type":"string","title":"Video Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Api Uploaded Parts V1 Videos  Video Id  Upload Parts Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["business-api"],"summary":"Get fresh URLs for some parts","description":"Fresh URLs for some parts, for an upload that outlasted the first set.","operationId":"api_sign_parts_v1_videos__video_id__upload_parts_post","parameters":[{"name":"video_id","in":"path","required":true,"schema":{"type":"string","title":"Video Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_api_sign_parts_v1_videos__video_id__upload_parts_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Api Sign Parts V1 Videos  Video Id  Upload Parts Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/videos/{video_id}/upload/complete":{"post":{"tags":["business-api"],"summary":"Finish a multipart upload","description":"Assemble the parts. S3 is asked what it holds; the client does not have to send ETags.\n\nRefused while any part is missing or the wrong size, so a short file never starts transcoding\nand the client is told exactly which parts to send again.","operationId":"api_complete_upload_v1_videos__video_id__upload_complete_post","parameters":[{"name":"video_id","in":"path","required":true,"schema":{"type":"string","title":"Video Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Api Complete Upload V1 Videos  Video Id  Upload Complete Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/videos/{video_id}":{"get":{"tags":["business-api"],"summary":"Get one video","operationId":"api_get_video_v1_videos__video_id__get","parameters":[{"name":"video_id","in":"path","required":true,"schema":{"type":"string","title":"Video Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Api Get Video V1 Videos  Video Id  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["business-api"],"summary":"Change a video's title or visibility","operationId":"api_update_video_v1_videos__video_id__patch","parameters":[{"name":"video_id","in":"path","required":true,"schema":{"type":"string","title":"Video Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_api_update_video_v1_videos__video_id__patch"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Api Update Video V1 Videos  Video Id  Patch"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["business-api"],"summary":"Delete a video","operationId":"api_delete_video_v1_videos__video_id__delete","parameters":[{"name":"video_id","in":"path","required":true,"schema":{"type":"string","title":"Video Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/videos/{video_id}/view-token":{"post":{"tags":["business-api"],"summary":"Mint a view token for one viewer","description":"Mint a token that lets one viewer watch one private video for a limited time.\n\nThis is how a company keeps video private and still shows it to the right person. Their backend\ndecides who is entitled — a paying subscriber, an enrolled student, an employee — then calls this\nand hands the token to that viewer's browser. vewo never needs to know who their users are, which\nis the only design that works when the customer owns the user relationship.\n\nScoped to one video, so a token cannot be replayed against another, and signed with a\nper-workspace key so rotating that key revokes every outstanding token at once.","operationId":"api_mint_view_token_v1_videos__video_id__view_token_post","parameters":[{"name":"video_id","in":"path","required":true,"schema":{"type":"string","title":"Video Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_api_mint_view_token_v1_videos__video_id__view_token_post"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Api Mint View Token V1 Videos  Video Id  View Token Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/videos/{video_id}/analytics":{"get":{"tags":["business-api"],"summary":"Get a video's analytics","description":"Per-video analytics, the same numbers the dashboard shows.\n\nOffered over the API because a company wants these in its own reporting, and a figure it can\nonly read on somebody else's web page is not usable data.","operationId":"api_video_analytics_v1_videos__video_id__analytics_get","parameters":[{"name":"video_id","in":"path","required":true,"schema":{"type":"string","title":"Video Id"}},{"name":"days","in":"query","required":false,"schema":{"type":"integer","maximum":365,"minimum":1,"default":30,"title":"Days"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Api Video Analytics V1 Videos  Video Id  Analytics Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/webhooks":{"get":{"tags":["business-api"],"summary":"List webhook endpoints","operationId":"api_list_webhooks_v1_webhooks_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Api List Webhooks V1 Webhooks Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["business-api"],"summary":"Create a webhook endpoint","description":"Register an endpoint for this workspace. The signing secret is returned once, here.","operationId":"api_create_webhook_v1_webhooks_post","parameters":[{"name":"idempotency-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idempotency-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_api_create_webhook_v1_webhooks_post"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Api Create Webhook V1 Webhooks Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/webhooks/{endpoint_id}":{"get":{"tags":["business-api"],"summary":"Get a webhook endpoint","operationId":"api_get_webhook_v1_webhooks__endpoint_id__get","parameters":[{"name":"endpoint_id","in":"path","required":true,"schema":{"type":"string","title":"Endpoint Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Api Get Webhook V1 Webhooks  Endpoint Id  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["business-api"],"summary":"Change a webhook endpoint","operationId":"api_update_webhook_v1_webhooks__endpoint_id__patch","parameters":[{"name":"endpoint_id","in":"path","required":true,"schema":{"type":"string","title":"Endpoint Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_api_update_webhook_v1_webhooks__endpoint_id__patch"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Api Update Webhook V1 Webhooks  Endpoint Id  Patch"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["business-api"],"summary":"Delete a webhook endpoint","operationId":"api_delete_webhook_v1_webhooks__endpoint_id__delete","parameters":[{"name":"endpoint_id","in":"path","required":true,"schema":{"type":"string","title":"Endpoint Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/webhooks/{endpoint_id}/rotate-secret":{"post":{"tags":["business-api"],"summary":"Rotate an endpoint's signing secret","operationId":"api_rotate_webhook_secret_v1_webhooks__endpoint_id__rotate_secret_post","parameters":[{"name":"endpoint_id","in":"path","required":true,"schema":{"type":"string","title":"Endpoint Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Api Rotate Webhook Secret V1 Webhooks  Endpoint Id  Rotate Secret Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/webhooks/{endpoint_id}/test":{"post":{"tags":["business-api"],"summary":"Send a signed test delivery","description":"Send a signed test event now and return what the endpoint answered.","operationId":"api_test_webhook_v1_webhooks__endpoint_id__test_post","parameters":[{"name":"endpoint_id","in":"path","required":true,"schema":{"type":"string","title":"Endpoint Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Api Test Webhook V1 Webhooks  Endpoint Id  Test Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/webhooks/{endpoint_id}/deliveries":{"get":{"tags":["business-api"],"summary":"List recent deliveries to an endpoint","operationId":"api_webhook_deliveries_v1_webhooks__endpoint_id__deliveries_get","parameters":[{"name":"endpoint_id","in":"path","required":true,"schema":{"type":"string","title":"Endpoint Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Api Webhook Deliveries V1 Webhooks  Endpoint Id  Deliveries Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_api_create_video_v1_videos_post":{"properties":{"title":{"type":"string","title":"Title","default":""},"size_bytes":{"type":"integer","title":"Size Bytes"},"visibility":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Visibility"},"content_type":{"type":"string","title":"Content Type","default":"video/mp4"},"multipart":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Multipart"}},"type":"object","required":["size_bytes"],"title":"Body_api_create_video_v1_videos_post"},"Body_api_create_webhook_v1_webhooks_post":{"properties":{"url":{"type":"string","title":"Url"},"events":{"items":{"type":"string"},"type":"array","title":"Events","default":[]},"name":{"type":"string","title":"Name","default":""}},"type":"object","required":["url"],"title":"Body_api_create_webhook_v1_webhooks_post"},"Body_api_mint_view_token_v1_videos__video_id__view_token_post":{"properties":{"expires_in":{"type":"integer","title":"Expires In","default":3600}},"type":"object","title":"Body_api_mint_view_token_v1_videos__video_id__view_token_post"},"Body_api_sign_parts_v1_videos__video_id__upload_parts_post":{"properties":{"part_numbers":{"items":{"type":"integer"},"type":"array","title":"Part Numbers"}},"type":"object","required":["part_numbers"],"title":"Body_api_sign_parts_v1_videos__video_id__upload_parts_post"},"Body_api_update_video_v1_videos__video_id__patch":{"properties":{"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"visibility":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Visibility"}},"type":"object","title":"Body_api_update_video_v1_videos__video_id__patch"},"Body_api_update_webhook_v1_webhooks__endpoint_id__patch":{"properties":{"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"},"events":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Events"},"enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Enabled"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},"type":"object","title":"Body_api_update_webhook_v1_webhooks__endpoint_id__patch"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer","description":"vewo_sk_... from the workspace"}}},"security":[{"apiKey":[]}]}