{ "openapi": "3.1.0", "info": { "title": "VideoCurrent API", "description": "Asynchronous MiniMax H3 video generation with private media and shared credits.", "version": "0.1.0" }, "paths": { "/health": { "get": { "tags": [ "system" ], "summary": "Health", "operationId": "health_health_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/v1/auth/email/request": { "post": { "tags": [ "authentication" ], "summary": "Request Email Code", "operationId": "request_email_code_v1_auth_email_request_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailRequest" } } }, "required": true }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/auth/email/verify": { "post": { "tags": [ "authentication" ], "summary": "Verify Email", "operationId": "verify_email_v1_auth_email_verify_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailVerify" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/auth/logout": { "post": { "tags": [ "authentication" ], "summary": "Logout", "operationId": "logout_v1_auth_logout_post", "responses": { "204": { "description": "Successful Response" } } } }, "/v1/auth/me": { "get": { "tags": [ "authentication" ], "summary": "Me", "operationId": "me_v1_auth_me_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-videocurrent-user", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Videocurrent-User" } }, { "name": "vc_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vc Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/assets": { "post": { "tags": [ "assets" ], "summary": "Create Asset", "operationId": "create_asset_v1_assets_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-videocurrent-user", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Videocurrent-User" } }, { "name": "vc_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vc Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/assets/{asset_id}/complete": { "post": { "tags": [ "assets" ], "summary": "Complete Asset", "operationId": "complete_asset_v1_assets__asset_id__complete_post", "parameters": [ { "name": "asset_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Asset Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-videocurrent-user", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Videocurrent-User" } }, { "name": "vc_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vc Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/videos": { "post": { "tags": [ "videos" ], "summary": "Create", "operationId": "create_v1_videos_post", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 255, "title": "Idempotency-Key" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-videocurrent-user", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Videocurrent-User" } }, { "name": "vc_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vc Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVideoRequest" } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VideoResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "videos" ], "summary": "List Videos", "operationId": "list_videos_v1_videos_get", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-videocurrent-user", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Videocurrent-User" } }, { "name": "vc_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vc Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VideoListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/videos/{video_id}": { "get": { "tags": [ "videos" ], "summary": "Get Video", "operationId": "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" } }, { "name": "x-videocurrent-user", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Videocurrent-User" } }, { "name": "vc_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vc Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VideoResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "videos" ], "summary": "Cancel", "operationId": "cancel_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" } }, { "name": "x-videocurrent-user", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Videocurrent-User" } }, { "name": "vc_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vc Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VideoResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/api-keys": { "post": { "tags": [ "developer" ], "summary": "Create Key", "operationId": "create_key_v1_api_keys_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-videocurrent-user", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Videocurrent-User" } }, { "name": "vc_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vc Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "developer" ], "summary": "List Keys", "operationId": "list_keys_v1_api_keys_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-videocurrent-user", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Videocurrent-User" } }, { "name": "vc_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vc Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/api-keys/{key_id}": { "delete": { "tags": [ "developer" ], "summary": "Revoke Key", "operationId": "revoke_key_v1_api_keys__key_id__delete", "parameters": [ { "name": "key_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Key Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-videocurrent-user", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Videocurrent-User" } }, { "name": "vc_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vc Session" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/webhooks": { "post": { "tags": [ "developer" ], "summary": "Create Webhook", "operationId": "create_webhook_v1_webhooks_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-videocurrent-user", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Videocurrent-User" } }, { "name": "vc_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vc Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "developer" ], "summary": "List Webhooks", "operationId": "list_webhooks_v1_webhooks_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-videocurrent-user", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Videocurrent-User" } }, { "name": "vc_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vc Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/webhooks/{endpoint_id}": { "delete": { "tags": [ "developer" ], "summary": "Revoke Webhook", "operationId": "revoke_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" } }, { "name": "x-videocurrent-user", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Videocurrent-User" } }, { "name": "vc_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vc Session" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/admin/users": { "get": { "tags": [ "admin" ], "summary": "List Users", "operationId": "list_users_v1_admin_users_get", "parameters": [ { "name": "query", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Query" } }, { "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" } }, { "name": "x-videocurrent-user", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Videocurrent-User" } }, { "name": "vc_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vc Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/admin/users/{user_id}/credits": { "get": { "tags": [ "admin" ], "summary": "User Credits", "operationId": "user_credits_v1_admin_users__user_id__credits_get", "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "User Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-videocurrent-user", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Videocurrent-User" } }, { "name": "vc_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vc Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/admin/users/{user_id}/credit-adjustments": { "post": { "tags": [ "admin" ], "summary": "Create Credit Adjustment", "operationId": "create_credit_adjustment_v1_admin_users__user_id__credit_adjustments_post", "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "User Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-videocurrent-user", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Videocurrent-User" } }, { "name": "vc_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vc Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditAdjustment" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/admin/shares/{share_id}": { "delete": { "tags": [ "admin" ], "summary": "Admin Revoke Share", "operationId": "admin_revoke_share_v1_admin_shares__share_id__delete", "parameters": [ { "name": "share_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Share Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-videocurrent-user", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Videocurrent-User" } }, { "name": "vc_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vc Session" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/admin/audit": { "get": { "tags": [ "admin" ], "summary": "Audit History", "operationId": "audit_history_v1_admin_audit_get", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-videocurrent-user", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Videocurrent-User" } }, { "name": "vc_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vc Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/admin/tasks/{task_id}/attempts": { "get": { "tags": [ "admin" ], "summary": "Task Attempts", "operationId": "task_attempts_v1_admin_tasks__task_id__attempts_get", "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Task Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-videocurrent-user", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Videocurrent-User" } }, { "name": "vc_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vc Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/admin/billing/orders": { "get": { "tags": [ "admin" ], "summary": "Billing Orders", "operationId": "billing_orders_v1_admin_billing_orders_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-videocurrent-user", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Videocurrent-User" } }, { "name": "vc_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vc Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/admin/billing/subscriptions": { "get": { "tags": [ "admin" ], "summary": "Billing Subscriptions", "operationId": "billing_subscriptions_v1_admin_billing_subscriptions_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-videocurrent-user", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Videocurrent-User" } }, { "name": "vc_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vc Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/admin/billing/refunds": { "get": { "tags": [ "admin" ], "summary": "Billing Refunds", "operationId": "billing_refunds_v1_admin_billing_refunds_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-videocurrent-user", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Videocurrent-User" } }, { "name": "vc_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vc Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/admin/shares": { "get": { "tags": [ "admin" ], "summary": "List Shares", "operationId": "list_shares_v1_admin_shares_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-videocurrent-user", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Videocurrent-User" } }, { "name": "vc_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vc Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/admin/workflows/{mode}": { "put": { "tags": [ "admin" ], "summary": "Update Workflow", "operationId": "update_workflow_v1_admin_workflows__mode__put", "parameters": [ { "name": "mode", "in": "path", "required": true, "schema": { "type": "string", "title": "Mode" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-videocurrent-user", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Videocurrent-User" } }, { "name": "vc_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vc Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/admin/prices/{mode}": { "post": { "tags": [ "admin" ], "summary": "Create Price", "operationId": "create_price_v1_admin_prices__mode__post", "parameters": [ { "name": "mode", "in": "path", "required": true, "schema": { "type": "string", "title": "Mode" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-videocurrent-user", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Videocurrent-User" } }, { "name": "vc_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vc Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PriceCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/admin/metrics": { "get": { "tags": [ "admin" ], "summary": "Metrics", "operationId": "metrics_v1_admin_metrics_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-videocurrent-user", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Videocurrent-User" } }, { "name": "vc_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vc Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/videos/{video_id}/shares": { "post": { "tags": [ "sharing" ], "summary": "Create Share", "operationId": "create_share_v1_videos__video_id__shares_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" } }, { "name": "x-videocurrent-user", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Videocurrent-User" } }, { "name": "vc_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vc Session" } } ], "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/shares": { "get": { "tags": [ "sharing" ], "summary": "List Shares", "operationId": "list_shares_v1_shares_get", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-videocurrent-user", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Videocurrent-User" } }, { "name": "vc_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vc Session" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/shares/{token}": { "get": { "tags": [ "sharing" ], "summary": "View Share", "operationId": "view_share_v1_shares__token__get", "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string", "title": "Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/shares/{share_id}": { "delete": { "tags": [ "sharing" ], "summary": "Revoke Share", "operationId": "revoke_share_v1_shares__share_id__delete", "parameters": [ { "name": "share_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Share Id" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-videocurrent-user", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Videocurrent-User" } }, { "name": "vc_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vc Session" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/billing/products": { "get": { "tags": [ "billing" ], "summary": "Products", "operationId": "products_v1_billing_products_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/v1/billing/checkout": { "post": { "tags": [ "billing" ], "summary": "Checkout", "operationId": "checkout_v1_billing_checkout_post", "parameters": [ { "name": "authorization", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } }, { "name": "x-videocurrent-user", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Videocurrent-User" } }, { "name": "vc_session", "in": "cookie", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vc Session" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckoutRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } } }, "components": { "schemas": { "ApiKeyCreate": { "properties": { "name": { "type": "string", "maxLength": 80, "minLength": 1, "title": "Name" } }, "type": "object", "required": [ "name" ], "title": "ApiKeyCreate" }, "AssetCreate": { "properties": { "filename": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Filename" }, "content_type": { "type": "string", "title": "Content Type" }, "size_bytes": { "type": "integer", "maximum": 15728640.0, "exclusiveMinimum": 0.0, "title": "Size Bytes" }, "sha256": { "type": "string", "pattern": "^[a-fA-F0-9]{64}$", "title": "Sha256" } }, "type": "object", "required": [ "filename", "content_type", "size_bytes", "sha256" ], "title": "AssetCreate" }, "CheckoutRequest": { "properties": { "sku": { "type": "string", "title": "Sku" } }, "type": "object", "required": [ "sku" ], "title": "CheckoutRequest" }, "CreateVideoRequest": { "properties": { "mode": { "type": "string", "enum": [ "text_to_video", "first_frame", "last_frame", "first_last_frame" ], "title": "Mode" }, "prompt": { "type": "string", "maxLength": 3000, "minLength": 3, "title": "Prompt" }, "first_frame_asset_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "First Frame Asset Id" }, "last_frame_asset_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Frame Asset Id" }, "options": { "type": "object", "title": "Options" } }, "type": "object", "required": [ "mode", "prompt" ], "title": "CreateVideoRequest" }, "CreditAdjustment": { "properties": { "credits": { "type": "integer", "maximum": 1000000.0, "minimum": -1000000.0, "title": "Credits" }, "reason": { "type": "string", "maxLength": 500, "minLength": 3, "title": "Reason" } }, "type": "object", "required": [ "credits", "reason" ], "title": "CreditAdjustment" }, "EmailRequest": { "properties": { "email": { "type": "string", "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$", "title": "Email" }, "turnstile_token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Turnstile Token" } }, "type": "object", "required": [ "email" ], "title": "EmailRequest" }, "EmailVerify": { "properties": { "challenge_id": { "type": "string", "title": "Challenge Id" }, "code": { "type": "string", "pattern": "^\\d{6}$", "title": "Code" } }, "type": "object", "required": [ "challenge_id", "code" ], "title": "EmailVerify" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "PriceCreate": { "properties": { "upstream_cost_usd": { "anyOf": [ { "type": "number", "exclusiveMinimum": 0.0 }, { "type": "string" } ], "title": "Upstream Cost Usd" } }, "type": "object", "required": [ "upstream_cost_usd" ], "title": "PriceCreate" }, "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" }, "VideoListResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/VideoResponse" }, "type": "array", "title": "Items" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "type": "object", "required": [ "items" ], "title": "VideoListResponse" }, "VideoResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "mode": { "type": "string", "enum": [ "text_to_video", "first_frame", "last_frame", "first_last_frame" ], "title": "Mode" }, "status": { "type": "string", "title": "Status" }, "prompt": { "type": "string", "title": "Prompt" }, "price_credits": { "type": "integer", "title": "Price Credits" }, "attempt_count": { "type": "integer", "title": "Attempt Count" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "completed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Completed At" }, "output_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Output Url" }, "error": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Error" } }, "type": "object", "required": [ "id", "mode", "status", "prompt", "price_credits", "attempt_count", "created_at" ], "title": "VideoResponse" }, "WebhookCreate": { "properties": { "url": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Url" } }, "type": "object", "required": [ "url" ], "title": "WebhookCreate" }, "WorkflowUpdate": { "properties": { "input_schema": { "type": "object", "title": "Input Schema" }, "enable": { "type": "boolean", "title": "Enable", "default": false }, "max_concurrency": { "type": "integer", "maximum": 50.0, "minimum": 1.0, "title": "Max Concurrency", "default": 1 } }, "type": "object", "required": [ "input_schema" ], "title": "WorkflowUpdate" } } } }