{"openapi": "3.0.3", "info": {"title": "wexioStream Creator API", "version": "1.0.0", "description": "Manage your videos, upload files from your computer, or import videos from public Google Drive or HTTP/HTTPS file links. Create your API key in Settings \u2192 API Access, then click Authorize and enter it. Requests use Authorization: Bearer <API_KEY>; never put your key in a URL. Results are in data; errors include a code, message and request_id. Choose a group below to see its endpoints. [Step-by-step upload examples and error help](/api/public/v1/docs?view=guide)."}, "servers": [{"url": "/api/public/v1"}], "tags": [{"name": "Account", "description": "Check your storage, upload limits and available video qualities."}, {"name": "Files", "description": "Find your videos, update titles, move files and retrieve watch or embed links."}, {"name": "Folders", "description": "Organize your videos into folders."}, {"name": "Direct uploads", "description": "Upload a file from your computer. Create an upload, send the file to its upload_url, then check its progress."}, {"name": "Remote uploads", "description": "Import public Google Drive or HTTP/HTTPS videos, check download progress, cancel a download or retry a failed one."}, {"name": "Covers", "description": "Add or remove your own video cover image."}, {"name": "Subtitles", "description": "Choose a language and manage WebVTT subtitles."}, {"name": "Statistics", "description": "View your daily qualified views and earnings."}], "externalDocs": {"description": "Step-by-step upload examples (text guide)", "url": "/api/public/v1/docs?view=guide"}, "paths": {"/account": {"get": {"tags": ["Account"], "summary": "Get your account and storage limits", "description": "Check used and remaining storage, the largest file you can upload, and available video qualities before uploading. All values apply to your account.", "security": [{"CreatorKey": []}], "parameters": [], "responses": {"200": {"description": "Your request completed. The result is in data.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Success"}}}}, "400": {"description": "Check the required fields and their values.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "401": {"description": "Your API key is missing, expired, revoked or invalid.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "403": {"description": "Your account or API key does not have access to this action.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "404": {"description": "This item was not found in your account.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "409": {"description": "This request conflicts with an earlier request or the item\u2019s current state.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "410": {"description": "The upload expired or the item from your original request was deleted.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "413": {"description": "The file is too large or your account has insufficient storage.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "429": {"description": "Request or upload limit reached. Wait before retrying; check Retry-After if provided.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "502": {"description": "The request could not be completed right now. Retry later with the same request key where required.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "503": {"description": "This feature is temporarily unavailable. Try again later.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}, "operationId": "get_account"}}, "/files": {"get": {"tags": ["Files"], "summary": "List your files", "description": "Find your videos by title, folder or preparation status. Use page and page_size to browse results. Each file includes a watch link and its current processing state.", "security": [{"CreatorKey": []}], "parameters": [{"name": "page", "in": "query", "schema": {"type": "integer", "minimum": 1, "default": 1}, "description": "Page number, starting at 1."}, {"name": "page_size", "in": "query", "schema": {"type": "integer", "minimum": 1, "maximum": 100, "default": 50}, "description": "Results per page, from 1 to 100."}, {"name": "q", "in": "query", "schema": {"type": "string"}, "description": "Search by part of the file title or folder name."}, {"name": "folder_id", "in": "query", "schema": {"type": "string"}, "description": "A folder ID from GET /folders. Pass an empty value to list unfiled videos; omit to include all folders."}, {"name": "encoding_status", "in": "query", "schema": {"type": "string", "enum": ["pending", "running", "fail", "success"]}, "description": "Filter by video preparation: queued, processing, failed or finished."}], "responses": {"200": {"description": "Your request completed. The result is in data.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Success"}}}}, "400": {"description": "Check the required fields and their values.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "401": {"description": "Your API key is missing, expired, revoked or invalid.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "403": {"description": "Your account or API key does not have access to this action.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "404": {"description": "This item was not found in your account.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "409": {"description": "This request conflicts with an earlier request or the item\u2019s current state.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "410": {"description": "The upload expired or the item from your original request was deleted.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "413": {"description": "The file is too large or your account has insufficient storage.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "429": {"description": "Request or upload limit reached. Wait before retrying; check Retry-After if provided.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "502": {"description": "The request could not be completed right now. Retry later with the same request key where required.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "503": {"description": "This feature is temporarily unavailable. Try again later.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}, "operationId": "get_files"}}, "/files/query": {"post": {"tags": ["Files"], "summary": "Look up several files", "description": "Send up to 100 file IDs in ids to retrieve their details in one request. An unavailable file is reported individually so other results can still be returned.", "security": [{"CreatorKey": []}], "parameters": [], "responses": {"200": {"description": "Your request completed. The result is in data.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Success"}}}}, "400": {"description": "Check the required fields and their values.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "401": {"description": "Your API key is missing, expired, revoked or invalid.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "403": {"description": "Your account or API key does not have access to this action.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "404": {"description": "This item was not found in your account.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "409": {"description": "This request conflicts with an earlier request or the item\u2019s current state.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "410": {"description": "The upload expired or the item from your original request was deleted.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "413": {"description": "The file is too large or your account has insufficient storage.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "429": {"description": "Request or upload limit reached. Wait before retrying; check Retry-After if provided.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "502": {"description": "The request could not be completed right now. Retry later with the same request key where required.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "503": {"description": "This feature is temporarily unavailable. Try again later.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}, "operationId": "post_files_query", "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "additionalProperties": false, "properties": {"ids": {"type": "array", "minItems": 1, "maxItems": 100, "items": {"type": "string"}, "description": "One to 100 file IDs returned by file listings or uploads. Unavailable IDs are reported individually."}}, "required": ["ids"]}}}}}}, "/files/{file_id}": {"get": {"tags": ["Files"], "summary": "Get a file and its watch link", "description": "Use the file_id returned by an upload or file listing. Check playback.ready before opening watch_url. embed_url is the embed-page link and can be null if embedding is unavailable.", "security": [{"CreatorKey": []}], "parameters": [{"name": "file_id", "in": "path", "required": true, "schema": {"type": "string"}, "description": "File ID returned by an upload or GET /files; not an upload or import ID.", "example": "example-file"}], "responses": {"200": {"description": "Your request completed. The result is in data.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Success"}, "example": {"data": {"id": "example-file", "upload_status": "completed", "upload_error_code": null, "encoding_status": "running", "encoding_progress": null, "publication_status": null, "playback": {"status": "processing", "ready": false}, "watch_url": "https://test.wexiostream.com/v/example-file", "embed_url": null}, "request_id": "040b0717-ac2f-4f35-a5fc-34ec389eaee7"}}}}, "400": {"description": "Check the required fields and their values.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "401": {"description": "Your API key is missing, expired, revoked or invalid.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "403": {"description": "Your account or API key does not have access to this action.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "404": {"description": "This item was not found in your account.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "409": {"description": "This request conflicts with an earlier request or the item\u2019s current state.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "410": {"description": "The upload expired or the item from your original request was deleted.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "413": {"description": "The file is too large or your account has insufficient storage.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "429": {"description": "Request or upload limit reached. Wait before retrying; check Retry-After if provided.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "502": {"description": "The request could not be completed right now. Retry later with the same request key where required.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "503": {"description": "This feature is temporarily unavailable. Try again later.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}, "operationId": "get_files_file_id"}, "patch": {"tags": ["Files"], "summary": "Rename or move a file", "description": "Send title to rename the video, folder_id to move it, or both. Use folder_id:null to remove it from its folder. Omitted fields stay unchanged.", "security": [{"CreatorKey": []}], "parameters": [{"name": "file_id", "in": "path", "required": true, "schema": {"type": "string"}, "description": "File ID returned by an upload or GET /files; not an upload or import ID.", "example": "example-file"}], "responses": {"200": {"description": "Your request completed. The result is in data.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Success"}}}}, "400": {"description": "Check the required fields and their values.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "401": {"description": "Your API key is missing, expired, revoked or invalid.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "403": {"description": "Your account or API key does not have access to this action.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "404": {"description": "This item was not found in your account.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "409": {"description": "This request conflicts with an earlier request or the item\u2019s current state.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "410": {"description": "The upload expired or the item from your original request was deleted.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "413": {"description": "The file is too large or your account has insufficient storage.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "429": {"description": "Request or upload limit reached. Wait before retrying; check Retry-After if provided.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "502": {"description": "The request could not be completed right now. Retry later with the same request key where required.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "503": {"description": "This feature is temporarily unavailable. Try again later.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}, "operationId": "patch_files_file_id", "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "additionalProperties": false, "properties": {"title": {"type": "string", "minLength": 1, "maxLength": 100, "description": "New video title, 1\u2013100 characters. Omit to keep the current title."}, "folder_id": {"type": "string", "format": "uuid", "nullable": true, "description": "ID returned by GET /folders. Use null to move the video to unfiled; omit to keep its current folder."}}}}}}}, "delete": {"tags": ["Files"], "summary": "Delete a file", "description": "Delete one of your files. It will no longer be available in your library or through its watch link. A 202 response means deletion has been accepted; storage cleanup may finish later.", "security": [{"CreatorKey": []}], "parameters": [{"name": "file_id", "in": "path", "required": true, "schema": {"type": "string"}, "description": "File ID returned by an upload or GET /files; not an upload or import ID.", "example": "example-file"}], "responses": {"200": {"description": "Your request completed. The result is in data.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Success"}}}}, "202": {"description": "Accepted. Check progress using the returned ID.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Success"}}}}, "400": {"description": "Check the required fields and their values.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "401": {"description": "Your API key is missing, expired, revoked or invalid.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "403": {"description": "Your account or API key does not have access to this action.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "404": {"description": "This item was not found in your account.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "409": {"description": "This request conflicts with an earlier request or the item\u2019s current state.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "410": {"description": "The upload expired or the item from your original request was deleted.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "413": {"description": "The file is too large or your account has insufficient storage.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "429": {"description": "Request or upload limit reached. Wait before retrying; check Retry-After if provided.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "502": {"description": "The request could not be completed right now. Retry later with the same request key where required.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "503": {"description": "This feature is temporarily unavailable. Try again later.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}, "operationId": "delete_files_file_id"}}, "/folders": {"get": {"tags": ["Folders"], "summary": "List your folders", "description": "Retrieve folder IDs and names. Use a returned ID as folder_id when uploading or moving a video.", "security": [{"CreatorKey": []}], "parameters": [{"name": "page", "in": "query", "schema": {"type": "integer", "minimum": 1, "default": 1}, "description": "Page number, starting at 1."}, {"name": "page_size", "in": "query", "schema": {"type": "integer", "minimum": 1, "maximum": 100, "default": 50}, "description": "Results per page, from 1 to 100."}, {"name": "q", "in": "query", "schema": {"type": "string"}, "description": "Search by part of the file title or folder name."}], "responses": {"200": {"description": "Your request completed. The result is in data.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Success"}}}}, "400": {"description": "Check the required fields and their values.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "401": {"description": "Your API key is missing, expired, revoked or invalid.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "403": {"description": "Your account or API key does not have access to this action.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "404": {"description": "This item was not found in your account.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "409": {"description": "This request conflicts with an earlier request or the item\u2019s current state.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "410": {"description": "The upload expired or the item from your original request was deleted.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "413": {"description": "The file is too large or your account has insufficient storage.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "429": {"description": "Request or upload limit reached. Wait before retrying; check Retry-After if provided.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "502": {"description": "The request could not be completed right now. Retry later with the same request key where required.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "503": {"description": "This feature is temporarily unavailable. Try again later.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}, "operationId": "get_folders"}, "post": {"tags": ["Folders"], "summary": "Create a folder", "description": "Choose a name of 1\u2013100 characters. Folder names must be unique in your account, regardless of letter case. Nested folders are not supported.", "security": [{"CreatorKey": []}], "parameters": [], "responses": {"201": {"description": "Created. Save the returned ID for later requests.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Success"}}}}, "400": {"description": "Check the required fields and their values.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "401": {"description": "Your API key is missing, expired, revoked or invalid.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "403": {"description": "Your account or API key does not have access to this action.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "404": {"description": "This item was not found in your account.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "409": {"description": "This request conflicts with an earlier request or the item\u2019s current state.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "410": {"description": "The upload expired or the item from your original request was deleted.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "413": {"description": "The file is too large or your account has insufficient storage.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "429": {"description": "Request or upload limit reached. Wait before retrying; check Retry-After if provided.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "502": {"description": "The request could not be completed right now. Retry later with the same request key where required.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "503": {"description": "This feature is temporarily unavailable. Try again later.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}, "operationId": "post_folders", "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "additionalProperties": false, "properties": {"name": {"type": "string", "minLength": 1, "maxLength": 100, "description": "Folder name, 1\u2013100 characters. Use a name you have not already used for another folder."}}, "required": ["name"]}}}}}}, "/folders/{folder_id}": {"patch": {"tags": ["Folders"], "summary": "Rename a folder", "description": "Send the new name for the folder. Its videos remain in the same folder.", "security": [{"CreatorKey": []}], "parameters": [{"name": "folder_id", "in": "path", "required": true, "schema": {"type": "string"}, "description": "Folder ID returned by GET /folders.", "example": "040b0717-ac2f-4f35-a5fc-34ec389eaee7"}], "responses": {"200": {"description": "Your request completed. The result is in data.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Success"}}}}, "400": {"description": "Check the required fields and their values.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "401": {"description": "Your API key is missing, expired, revoked or invalid.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "403": {"description": "Your account or API key does not have access to this action.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "404": {"description": "This item was not found in your account.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "409": {"description": "This request conflicts with an earlier request or the item\u2019s current state.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "410": {"description": "The upload expired or the item from your original request was deleted.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "413": {"description": "The file is too large or your account has insufficient storage.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "429": {"description": "Request or upload limit reached. Wait before retrying; check Retry-After if provided.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "502": {"description": "The request could not be completed right now. Retry later with the same request key where required.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "503": {"description": "This feature is temporarily unavailable. Try again later.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}, "operationId": "patch_folders_folder_id", "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "additionalProperties": false, "properties": {"name": {"type": "string", "minLength": 1, "maxLength": 100, "description": "Folder name, 1\u2013100 characters. Use a name you have not already used for another folder."}}, "required": ["name"]}}}}}, "delete": {"tags": ["Folders"], "summary": "Delete a folder", "description": "Remove the folder without deleting its videos. Those videos move to unfiled.", "security": [{"CreatorKey": []}], "parameters": [{"name": "folder_id", "in": "path", "required": true, "schema": {"type": "string"}, "description": "Folder ID returned by GET /folders.", "example": "040b0717-ac2f-4f35-a5fc-34ec389eaee7"}], "responses": {"200": {"description": "Your request completed. The result is in data.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Success"}}}}, "400": {"description": "Check the required fields and their values.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "401": {"description": "Your API key is missing, expired, revoked or invalid.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "403": {"description": "Your account or API key does not have access to this action.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "404": {"description": "This item was not found in your account.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "409": {"description": "This request conflicts with an earlier request or the item\u2019s current state.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "410": {"description": "The upload expired or the item from your original request was deleted.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "413": {"description": "The file is too large or your account has insufficient storage.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "429": {"description": "Request or upload limit reached. Wait before retrying; check Retry-After if provided.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "502": {"description": "The request could not be completed right now. Retry later with the same request key where required.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "503": {"description": "This feature is temporarily unavailable. Try again later.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}, "operationId": "delete_folders_folder_id"}}, "/uploads": {"get": {"tags": ["Direct uploads"], "summary": "List your uploads", "description": "Review upload IDs, their file IDs and current states. Use this list to find an interrupted upload before starting another one.", "security": [{"CreatorKey": []}], "parameters": [{"name": "page", "in": "query", "schema": {"type": "integer", "minimum": 1, "default": 1}, "description": "Page number, starting at 1."}, {"name": "page_size", "in": "query", "schema": {"type": "integer", "minimum": 1, "maximum": 100, "default": 50}, "description": "Results per page, from 1 to 100."}], "responses": {"200": {"description": "Your request completed. The result is in data.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Success"}}}}, "400": {"description": "Check the required fields and their values.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "401": {"description": "Your API key is missing, expired, revoked or invalid.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "403": {"description": "Your account or API key does not have access to this action.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "404": {"description": "This item was not found in your account.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "409": {"description": "This request conflicts with an earlier request or the item\u2019s current state.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "410": {"description": "The upload expired or the item from your original request was deleted.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "413": {"description": "The file is too large or your account has insufficient storage.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "429": {"description": "Request or upload limit reached. Wait before retrying; check Retry-After if provided.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "502": {"description": "The request could not be completed right now. Retry later with the same request key where required.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "503": {"description": "This feature is temporarily unavailable. Try again later.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}, "operationId": "get_uploads"}, "post": {"tags": ["Direct uploads"], "summary": "Start a file upload", "description": "Send the original filename and exact file size in bytes. Save the returned id, file_id and direct_upload values. Send your file to direct_upload.upload_url with X-Upload-Token using direct_upload.token. Choose numbered parts for resumable uploads, or send the whole file at once. The step-by-step guide shows both options. Reuse the same Idempotency-Key and body if the response is lost.", "security": [{"CreatorKey": []}], "parameters": [{"name": "Idempotency-Key", "in": "header", "required": true, "schema": {"type": "string", "format": "uuid"}, "description": "Choose a UUID for this file upload. Save it and reuse it with the same filename, size and options after a lost response. A changed request with the same key returns 409."}], "responses": {"201": {"description": "Created. Save the returned ID for later requests.", "content": {"application/json": {"schema": {"type": "object", "required": ["data", "request_id"], "properties": {"data": {"$ref": "#/components/schemas/UploadSession"}, "request_id": {"type": "string", "format": "uuid"}}}, "example": {"data": {"id": "040b0717-ac2f-4f35-a5fc-34ec389eaee7", "file_id": "example-file", "status": "created", "size_bytes": 140126631, "direct_upload": {"session_id": "us_example", "upload_url": "https://upload.example.com/upload/us_example", "token": "<upload-token>", "part_size_bytes": 8388608}}, "request_id": "ae17dfca-17be-489a-b654-63f4e3915365"}}}}, "400": {"description": "Check the required fields and their values.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "401": {"description": "Your API key is missing, expired, revoked or invalid.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "403": {"description": "Your account or API key does not have access to this action.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "404": {"description": "This item was not found in your account.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "409": {"description": "This request conflicts with an earlier request or the item\u2019s current state.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "410": {"description": "The upload expired or the item from your original request was deleted.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "413": {"description": "The file is too large or your account has insufficient storage.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "429": {"description": "Request or upload limit reached. Wait before retrying; check Retry-After if provided.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "502": {"description": "The request could not be completed right now. Retry later with the same request key where required.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "503": {"description": "This feature is temporarily unavailable. Try again later.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}, "operationId": "post_uploads", "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "additionalProperties": false, "properties": {"filename": {"type": "string", "description": "Original file name including its extension, for example clip.mp4. Do not include a directory path."}, "size_bytes": {"type": "integer", "minimum": 1, "description": "Exact size of the complete file in bytes. Read storage.max_file_bytes from GET /account for your limit."}, "folder_id": {"type": "string", "format": "uuid", "nullable": true, "description": "ID returned by GET /folders. Omit or use null to leave the video unfiled."}, "encoding_resolution": {"type": "integer", "enum": [360, 720, 1080], "description": "Choose a value from GET /account encoding_resolutions, such as 720. Omit to use your saved preference. Smaller videos are not enlarged."}}, "required": ["filename", "size_bytes"]}}}}}}, "/uploads/{upload_id}": {"get": {"tags": ["Direct uploads"], "summary": "Check an upload", "description": "Use the upload id returned by POST /uploads. completed means the file was received, not that it is ready to watch. Check GET /files/{file_id} until playback.ready is true.", "security": [{"CreatorKey": []}], "parameters": [{"name": "upload_id", "in": "path", "required": true, "schema": {"type": "string"}, "description": "The top-level id returned by POST /uploads. Do not use direct_upload.session_id here.", "example": "040b0717-ac2f-4f35-a5fc-34ec389eaee7"}], "responses": {"200": {"description": "Your request completed. The result is in data.", "content": {"application/json": {"schema": {"type": "object", "required": ["data", "request_id"], "properties": {"data": {"$ref": "#/components/schemas/UploadSession"}, "request_id": {"type": "string", "format": "uuid"}}}}}}, "400": {"description": "Check the required fields and their values.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "401": {"description": "Your API key is missing, expired, revoked or invalid.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "403": {"description": "Your account or API key does not have access to this action.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "404": {"description": "This item was not found in your account.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "409": {"description": "This request conflicts with an earlier request or the item\u2019s current state.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "410": {"description": "The upload expired or the item from your original request was deleted.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "413": {"description": "The file is too large or your account has insufficient storage.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "429": {"description": "Request or upload limit reached. Wait before retrying; check Retry-After if provided.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "502": {"description": "The request could not be completed right now. Retry later with the same request key where required.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "503": {"description": "This feature is temporarily unavailable. Try again later.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}, "operationId": "get_uploads_upload_id"}, "delete": {"tags": ["Direct uploads"], "summary": "Cancel an unfinished upload", "description": "Stop an upload you no longer want to finish. Do not cancel merely because a connection was interrupted; check its state and resume instead. This endpoint does not delete a finished video.", "security": [{"CreatorKey": []}], "parameters": [{"name": "upload_id", "in": "path", "required": true, "schema": {"type": "string"}, "description": "The top-level id returned by POST /uploads. Do not use direct_upload.session_id here.", "example": "040b0717-ac2f-4f35-a5fc-34ec389eaee7"}], "responses": {"200": {"description": "Your request completed. The result is in data.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Success"}}}}, "400": {"description": "Check the required fields and their values.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "401": {"description": "Your API key is missing, expired, revoked or invalid.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "403": {"description": "Your account or API key does not have access to this action.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "404": {"description": "This item was not found in your account.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "409": {"description": "This request conflicts with an earlier request or the item\u2019s current state.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "410": {"description": "The upload expired or the item from your original request was deleted.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "413": {"description": "The file is too large or your account has insufficient storage.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "429": {"description": "Request or upload limit reached. Wait before retrying; check Retry-After if provided.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "502": {"description": "The request could not be completed right now. Retry later with the same request key where required.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "503": {"description": "This feature is temporarily unavailable. Try again later.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}, "operationId": "delete_uploads_upload_id"}}, "/uploads/{upload_id}/ticket": {"post": {"tags": ["Direct uploads"], "summary": "Refresh an upload token", "description": "Request a fresh token when the token for an unfinished upload expires. Use the returned token in X-Upload-Token and keep the same upload address and file. Cancelled or expired uploads cannot be resumed.", "security": [{"CreatorKey": []}], "parameters": [{"name": "upload_id", "in": "path", "required": true, "schema": {"type": "string"}, "description": "The top-level id returned by POST /uploads. Do not use direct_upload.session_id here.", "example": "040b0717-ac2f-4f35-a5fc-34ec389eaee7"}], "responses": {"200": {"description": "Your request completed. The result is in data.", "content": {"application/json": {"schema": {"type": "object", "required": ["data", "request_id"], "properties": {"data": {"$ref": "#/components/schemas/UploadTicket"}, "request_id": {"type": "string", "format": "uuid"}}}}}}, "400": {"description": "Check the required fields and their values.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "401": {"description": "Your API key is missing, expired, revoked or invalid.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "403": {"description": "Your account or API key does not have access to this action.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "404": {"description": "This item was not found in your account.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "409": {"description": "This request conflicts with an earlier request or the item\u2019s current state.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "410": {"description": "The upload expired or the item from your original request was deleted.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "413": {"description": "The file is too large or your account has insufficient storage.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "429": {"description": "Request or upload limit reached. Wait before retrying; check Retry-After if provided.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "502": {"description": "The request could not be completed right now. Retry later with the same request key where required.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "503": {"description": "This feature is temporarily unavailable. Try again later.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}, "operationId": "post_uploads_upload_id_ticket"}}, "/remote-import-batches": {"post": {"tags": ["Remote uploads"], "summary": "Import videos from public links", "description": "Send public Google Drive or HTTP/HTTPS file links in items, mixed if needed. Omit provider to detect each link automatically. Each link must point to one video, not a folder. Preserve signed links exactly; source cookies or authorization headers cannot be supplied. Up to 20 videos per request by default. Set auto_encode:true to prepare the videos for watching. Save batch_id and each import_id; 202 means your request was accepted, not that downloading has finished. Uploads count toward your remaining storage. If the file size is not known yet, space may be temporarily reserved up to your per-file limit.", "security": [{"CreatorKey": []}], "parameters": [{"name": "Idempotency-Key", "in": "header", "required": true, "schema": {"type": "string"}, "description": "Choose a unique request key, 1\u2013128 UTF-8 bytes, for example my-import-001. Reuse it with the same request when retrying a lost response. A different request with the same key returns 409."}], "responses": {"202": {"description": "Accepted. Check progress using the returned ID.", "content": {"application/json": {"schema": {"type": "object", "required": ["data", "request_id"], "properties": {"data": {"$ref": "#/components/schemas/RemotePage"}, "request_id": {"type": "string", "format": "uuid"}}}}}}, "400": {"description": "Check the required fields and their values.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "401": {"description": "Your API key is missing, expired, revoked or invalid.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "403": {"description": "Your account or API key does not have access to this action.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "404": {"description": "This item was not found in your account.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "409": {"description": "This request conflicts with an earlier request or the item\u2019s current state.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "410": {"description": "The upload expired or the item from your original request was deleted.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "413": {"description": "The file is too large or your account has insufficient storage.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "429": {"description": "Request or upload limit reached. Wait before retrying; check Retry-After if provided.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "502": {"description": "The request could not be completed right now. Retry later with the same request key where required.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "503": {"description": "This feature is temporarily unavailable. Try again later.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}, "operationId": "post_remote-import-batches", "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "additionalProperties": false, "properties": {"items": {"type": "array", "minItems": 1, "maxItems": 20, "items": {"type": "object", "additionalProperties": false, "required": ["client_item_id", "url"], "properties": {"client_item_id": {"type": "string", "maxLength": 128, "description": "Your label for matching a result to its input, for example video-001. Use a different non-empty label for every item (at most 128 UTF-8 bytes)."}, "provider": {"type": "string", "enum": ["google_drive", "direct_url"], "description": "Optional. Omit to detect each link automatically. Use google_drive for drive.google.com links and direct_url for other HTTP/HTTPS file links."}, "url": {"type": "string", "format": "uri", "maxLength": 4096, "description": "Public Google Drive or HTTP/HTTPS link to one downloadable video. Preserve the full original link, including all signed query parameters and resourcekey. Public custom ports are allowed. No folders, private IP addresses, credentials or fragments; source cookies and authorization headers are not supported."}}}, "description": "One entry per video, up to 20 by default. Google Drive and direct file links can be mixed in one batch. Do not repeat a source in the same batch."}, "folder_id": {"type": "string", "format": "uuid", "nullable": true, "description": "ID returned by GET /folders. Omit or use null to leave the video unfiled."}, "auto_encode": {"type": "boolean", "default": false, "description": "Set true to prepare imported videos for watching. Default false saves the original without preparing playback."}, "encoding_resolution": {"type": "integer", "enum": [360, 720, 1080], "description": "Choose a value from GET /account encoding_resolutions, such as 720. Omit to use your saved preference. Smaller videos are not enlarged.", "nullable": true}}, "required": ["items"]}}}}}}, "/remote-import-batches/{batch_id}": {"get": {"tags": ["Remote uploads"], "summary": "Check an import batch", "description": "Review all imports submitted together. items contains the current page. counts and completed cover the entire batch, including items hidden by status or pagination. completed:true can include failed or cancelled items.", "security": [{"CreatorKey": []}], "parameters": [{"name": "batch_id", "in": "path", "required": true, "schema": {"type": "string"}, "description": "batch_id returned when you create an import batch (rib_...).", "example": "rib_22222222222222222222222222222222"}, {"name": "limit", "in": "query", "schema": {"type": "integer", "default": 20, "minimum": 1, "maximum": 100}, "description": "Results per page, from 1 to 100."}, {"name": "cursor", "in": "query", "schema": {"type": "string"}, "description": "For the next page, copy next_cursor from the previous result. Omit for the first page."}, {"name": "status", "in": "query", "schema": {"type": "string", "enum": ["queued", "resolving", "downloading", "probing", "cancelling", "retry_waiting", "succeeded", "failed", "cancelled"]}, "description": "Only show imports in this state. counts and completed still describe the full list or batch."}], "responses": {"200": {"description": "Your request completed. The result is in data.", "content": {"application/json": {"schema": {"type": "object", "required": ["data", "request_id"], "properties": {"data": {"$ref": "#/components/schemas/RemotePage"}, "request_id": {"type": "string", "format": "uuid"}}}}}}, "400": {"description": "Check the required fields and their values.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "401": {"description": "Your API key is missing, expired, revoked or invalid.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "403": {"description": "Your account or API key does not have access to this action.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "404": {"description": "This item was not found in your account.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "409": {"description": "This request conflicts with an earlier request or the item\u2019s current state.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "410": {"description": "The upload expired or the item from your original request was deleted.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "413": {"description": "The file is too large or your account has insufficient storage.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "429": {"description": "Request or upload limit reached. Wait before retrying; check Retry-After if provided.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "502": {"description": "The request could not be completed right now. Retry later with the same request key where required.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "503": {"description": "This feature is temporarily unavailable. Try again later.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}, "operationId": "get_remote-import-batches_batch_id"}}, "/remote-imports": {"get": {"tags": ["Remote uploads"], "summary": "List your remote uploads", "description": "Browse your import history. Optionally filter by batch_id or status. To get the next page, pass next_cursor back as cursor with the same filters.", "security": [{"CreatorKey": []}], "parameters": [{"name": "batch_id", "in": "query", "schema": {"type": "string"}, "description": "Only show items from this batch_id returned by import creation."}, {"name": "limit", "in": "query", "schema": {"type": "integer", "default": 20, "minimum": 1, "maximum": 100}, "description": "Results per page, from 1 to 100."}, {"name": "cursor", "in": "query", "schema": {"type": "string"}, "description": "For the next page, copy next_cursor from the previous result. Omit for the first page."}, {"name": "status", "in": "query", "schema": {"type": "string", "enum": ["queued", "resolving", "downloading", "probing", "cancelling", "retry_waiting", "succeeded", "failed", "cancelled"]}, "description": "Only show imports in this state. counts and completed still describe the full list or batch."}], "responses": {"200": {"description": "Your request completed. The result is in data.", "content": {"application/json": {"schema": {"type": "object", "required": ["data", "request_id"], "properties": {"data": {"$ref": "#/components/schemas/RemotePage"}, "request_id": {"type": "string", "format": "uuid"}}}}}}, "400": {"description": "Check the required fields and their values.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "401": {"description": "Your API key is missing, expired, revoked or invalid.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "403": {"description": "Your account or API key does not have access to this action.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "404": {"description": "This item was not found in your account.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "409": {"description": "This request conflicts with an earlier request or the item\u2019s current state.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "410": {"description": "The upload expired or the item from your original request was deleted.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "413": {"description": "The file is too large or your account has insufficient storage.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "429": {"description": "Request or upload limit reached. Wait before retrying; check Retry-After if provided.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "502": {"description": "The request could not be completed right now. Retry later with the same request key where required.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "503": {"description": "This feature is temporarily unavailable. Try again later.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}, "operationId": "get_remote-imports"}}, "/remote-imports/{import_id}": {"get": {"tags": ["Remote uploads"], "summary": "Check a remote upload", "description": "Use one import_id returned by batch creation. Download progress can be null when the file size is unknown. succeeded means the download finished. For a video prepared with auto_encode:true, follow file_id to GET /files/{file_id} and check playback.ready before watching.", "security": [{"CreatorKey": []}], "parameters": [{"name": "import_id", "in": "path", "required": true, "schema": {"type": "string"}, "description": "One import_id returned in the batch items (ri_...).", "example": "ri_11111111111111111111111111111111"}], "responses": {"200": {"description": "Your request completed. The result is in data.", "content": {"application/json": {"schema": {"type": "object", "required": ["data", "request_id"], "properties": {"data": {"$ref": "#/components/schemas/RemoteImport"}, "request_id": {"type": "string", "format": "uuid"}}}}}}, "400": {"description": "Check the required fields and their values.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "401": {"description": "Your API key is missing, expired, revoked or invalid.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "403": {"description": "Your account or API key does not have access to this action.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "404": {"description": "This item was not found in your account.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "409": {"description": "This request conflicts with an earlier request or the item\u2019s current state.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "410": {"description": "The upload expired or the item from your original request was deleted.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "413": {"description": "The file is too large or your account has insufficient storage.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "429": {"description": "Request or upload limit reached. Wait before retrying; check Retry-After if provided.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "502": {"description": "The request could not be completed right now. Retry later with the same request key where required.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "503": {"description": "This feature is temporarily unavailable. Try again later.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}, "operationId": "get_remote-imports_import_id"}}, "/remote-imports/{import_id}/cancel": {"post": {"tags": ["Remote uploads"], "summary": "Cancel a remote upload", "description": "Cancel one unfinished import using its import_id. Send no body, or {}. A 202 response acknowledges the request; inspect status and keep checking until a final result is confirmed. If the current attempt has not yet been sent for downloading, it can return cancelled immediately and release its reserved storage. If already sent, or receipt is uncertain, status remains cancelling and storage stays reserved until a final result for that same attempt is confirmed. There is no fixed deadline: 202 alone, waiting more than five minutes, or HTTP 404/409 does not prove cancellation or storage release. Check the task and GET /account. A finished download cannot be cancelled (409). Already failed or cancelled imports return their current state.", "security": [{"CreatorKey": []}], "parameters": [{"name": "import_id", "in": "path", "required": true, "schema": {"type": "string"}, "description": "One import_id returned in the batch items (ri_...).", "example": "ri_11111111111111111111111111111111"}], "responses": {"200": {"description": "Your request completed. The result is in data.", "content": {"application/json": {"schema": {"type": "object", "required": ["data", "request_id"], "properties": {"data": {"$ref": "#/components/schemas/RemoteImport"}, "request_id": {"type": "string", "format": "uuid"}}}}}}, "202": {"description": "Accepted. Check progress using the returned ID.", "content": {"application/json": {"schema": {"type": "object", "required": ["data", "request_id"], "properties": {"data": {"$ref": "#/components/schemas/RemoteImport"}, "request_id": {"type": "string", "format": "uuid"}}}}}}, "400": {"description": "Check the required fields and their values.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "401": {"description": "Your API key is missing, expired, revoked or invalid.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "403": {"description": "Your account or API key does not have access to this action.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "404": {"description": "This item was not found in your account.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "409": {"description": "This request conflicts with an earlier request or the item\u2019s current state.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "410": {"description": "The upload expired or the item from your original request was deleted.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "413": {"description": "The file is too large or your account has insufficient storage.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "429": {"description": "Request or upload limit reached. Wait before retrying; check Retry-After if provided.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "502": {"description": "The request could not be completed right now. Retry later with the same request key where required.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "503": {"description": "This feature is temporarily unavailable. Try again later.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}, "operationId": "post_remote-imports_import_id_cancel"}}, "/remote-imports/{import_id}/retry": {"post": {"tags": ["Remote uploads"], "summary": "Retry a failed remote upload", "description": "Retry a failed download after correcting the cause, for example access permission on the shared file. Send no body, or {}, and a new Idempotency-Key for this retry. The file_id stays the same and attempt increases. If this request is interrupted, reuse its key instead of starting another retry. The original source link is reused unchanged. If a signed link has expired, create a new batch with a fresh link instead. A cancelled, already downloaded or deleted file cannot be retried this way (409).", "security": [{"CreatorKey": []}], "parameters": [{"name": "import_id", "in": "path", "required": true, "schema": {"type": "string"}, "description": "One import_id returned in the batch items (ri_...).", "example": "ri_11111111111111111111111111111111"}, {"name": "Idempotency-Key", "in": "header", "required": true, "schema": {"type": "string"}, "description": "Choose a unique request key, 1\u2013128 UTF-8 bytes, for example my-import-001. Reuse it with the same request when retrying a lost response. A different request with the same key returns 409."}], "responses": {"202": {"description": "Accepted. Check progress using the returned ID.", "content": {"application/json": {"schema": {"type": "object", "required": ["data", "request_id"], "properties": {"data": {"$ref": "#/components/schemas/RemoteImport"}, "request_id": {"type": "string", "format": "uuid"}}}}}}, "400": {"description": "Check the required fields and their values.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "401": {"description": "Your API key is missing, expired, revoked or invalid.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "403": {"description": "Your account or API key does not have access to this action.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "404": {"description": "This item was not found in your account.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "409": {"description": "This request conflicts with an earlier request or the item\u2019s current state.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "410": {"description": "The upload expired or the item from your original request was deleted.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "413": {"description": "The file is too large or your account has insufficient storage.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "429": {"description": "Request or upload limit reached. Wait before retrying; check Retry-After if provided.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "502": {"description": "The request could not be completed right now. Retry later with the same request key where required.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "503": {"description": "This feature is temporarily unavailable. Try again later.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}, "operationId": "post_remote-imports_import_id_retry"}}, "/files/{file_id}/poster": {"post": {"tags": ["Covers"], "summary": "Upload a video cover", "description": "Send one image in the multipart file field to replace your custom cover. JPEG, PNG and WebP are accepted; the default limit is 10 MiB and 25 megapixels. The response includes poster_url and thumbnail_url. Use the newly returned addresses after every replacement; do not reuse a saved image address. If custom covers are unavailable (503 cover_distribution_unavailable), your previous cover stays unchanged.", "security": [{"CreatorKey": []}], "parameters": [{"name": "file_id", "in": "path", "required": true, "schema": {"type": "string"}, "description": "File ID returned by an upload or GET /files; not an upload or import ID.", "example": "example-file"}], "responses": {"200": {"description": "Your request completed. The result is in data.", "content": {"application/json": {"schema": {"type": "object", "required": ["data", "request_id"], "properties": {"data": {"$ref": "#/components/schemas/Cover"}, "request_id": {"type": "string", "format": "uuid"}}}}}}, "400": {"description": "Check the required fields and their values.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "401": {"description": "Your API key is missing, expired, revoked or invalid.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "403": {"description": "Your account or API key does not have access to this action.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "404": {"description": "This item was not found in your account.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "409": {"description": "This request conflicts with an earlier request or the item\u2019s current state.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "410": {"description": "The upload expired or the item from your original request was deleted.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "413": {"description": "The file is too large or your account has insufficient storage.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "429": {"description": "Request or upload limit reached. Wait before retrying; check Retry-After if provided.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "502": {"description": "The request could not be completed right now. Retry later with the same request key where required.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "503": {"description": "This feature is temporarily unavailable. Try again later.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}, "operationId": "post_files_file_id_poster", "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "additionalProperties": false, "properties": {"file": {"type": "string", "format": "binary", "description": "JPEG, PNG or WebP image. Default limit: 10 MiB and 25 megapixels. Replaces the current custom cover."}}, "required": ["file"]}}}}}, "delete": {"tags": ["Covers"], "summary": "Remove a custom cover", "description": "Remove the image you uploaded and return to the automatically generated video cover.", "security": [{"CreatorKey": []}], "parameters": [{"name": "file_id", "in": "path", "required": true, "schema": {"type": "string"}, "description": "File ID returned by an upload or GET /files; not an upload or import ID.", "example": "example-file"}], "responses": {"200": {"description": "Your request completed. The result is in data.", "content": {"application/json": {"schema": {"type": "object", "required": ["data", "request_id"], "properties": {"data": {"$ref": "#/components/schemas/Cover"}, "request_id": {"type": "string", "format": "uuid"}}}}}}, "400": {"description": "Check the required fields and their values.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "401": {"description": "Your API key is missing, expired, revoked or invalid.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "403": {"description": "Your account or API key does not have access to this action.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "404": {"description": "This item was not found in your account.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "409": {"description": "This request conflicts with an earlier request or the item\u2019s current state.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "410": {"description": "The upload expired or the item from your original request was deleted.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "413": {"description": "The file is too large or your account has insufficient storage.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "429": {"description": "Request or upload limit reached. Wait before retrying; check Retry-After if provided.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "502": {"description": "The request could not be completed right now. Retry later with the same request key where required.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "503": {"description": "This feature is temporarily unavailable. Try again later.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}, "operationId": "delete_files_file_id_poster"}}, "/languages": {"get": {"tags": ["Subtitles"], "summary": "List subtitle languages", "description": "Find the numeric language id for your subtitle. Send that value as language_id when adding or changing subtitles.", "security": [{"CreatorKey": []}], "parameters": [], "responses": {"200": {"description": "Your request completed. The result is in data.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Success"}}}}, "400": {"description": "Check the required fields and their values.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "401": {"description": "Your API key is missing, expired, revoked or invalid.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "403": {"description": "Your account or API key does not have access to this action.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "404": {"description": "This item was not found in your account.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "409": {"description": "This request conflicts with an earlier request or the item\u2019s current state.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "410": {"description": "The upload expired or the item from your original request was deleted.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "413": {"description": "The file is too large or your account has insufficient storage.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "429": {"description": "Request or upload limit reached. Wait before retrying; check Retry-After if provided.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "502": {"description": "The request could not be completed right now. Retry later with the same request key where required.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "503": {"description": "This feature is temporarily unavailable. Try again later.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}, "operationId": "get_languages"}}, "/files/{file_id}/subtitles": {"get": {"tags": ["Subtitles"], "summary": "List a video\u2019s subtitles", "description": "Get the subtitle IDs and languages for one of your videos. Use a returned subtitle_id when updating or removing a track.", "security": [{"CreatorKey": []}], "parameters": [{"name": "file_id", "in": "path", "required": true, "schema": {"type": "string"}, "description": "File ID returned by an upload or GET /files; not an upload or import ID.", "example": "example-file"}], "responses": {"200": {"description": "Your request completed. The result is in data.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Success"}}}}, "400": {"description": "Check the required fields and their values.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "401": {"description": "Your API key is missing, expired, revoked or invalid.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "403": {"description": "Your account or API key does not have access to this action.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "404": {"description": "This item was not found in your account.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "409": {"description": "This request conflicts with an earlier request or the item\u2019s current state.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "410": {"description": "The upload expired or the item from your original request was deleted.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "413": {"description": "The file is too large or your account has insufficient storage.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "429": {"description": "Request or upload limit reached. Wait before retrying; check Retry-After if provided.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "502": {"description": "The request could not be completed right now. Retry later with the same request key where required.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "503": {"description": "This feature is temporarily unavailable. Try again later.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}, "operationId": "get_files_file_id_subtitles"}, "post": {"tags": ["Subtitles"], "summary": "Add subtitles to a video", "description": "Send language_id and either a UTF-8 .vtt file or WebVTT text in content. Do not send both. A video can have one subtitle per language. If it already exists, update that track instead.", "security": [{"CreatorKey": []}], "parameters": [{"name": "file_id", "in": "path", "required": true, "schema": {"type": "string"}, "description": "File ID returned by an upload or GET /files; not an upload or import ID.", "example": "example-file"}], "responses": {"201": {"description": "Created. Save the returned ID for later requests.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Success"}}}}, "400": {"description": "Check the required fields and their values.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "401": {"description": "Your API key is missing, expired, revoked or invalid.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "403": {"description": "Your account or API key does not have access to this action.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "404": {"description": "This item was not found in your account.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "409": {"description": "This request conflicts with an earlier request or the item\u2019s current state.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "410": {"description": "The upload expired or the item from your original request was deleted.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "413": {"description": "The file is too large or your account has insufficient storage.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "429": {"description": "Request or upload limit reached. Wait before retrying; check Retry-After if provided.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "502": {"description": "The request could not be completed right now. Retry later with the same request key where required.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "503": {"description": "This feature is temporarily unavailable. Try again later.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}, "operationId": "post_files_file_id_subtitles", "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "additionalProperties": false, "properties": {"language_id": {"type": "integer", "description": "Numeric language ID returned by GET /languages. Each video can have one subtitle per language."}, "file": {"type": "string", "format": "binary", "description": "UTF-8 WebVTT (.vtt) file. Send either file or content, never both. Upload limits depend on your account; keep the complete request under 1 MiB for compatibility."}, "content": {"type": "string", "description": "WebVTT text beginning with WEBVTT, as an alternative to uploading a file. Do not send both content and file."}}, "required": ["language_id"]}}, "application/json": {"schema": {"type": "object", "additionalProperties": false, "properties": {"language_id": {"type": "integer", "description": "Numeric language ID returned by GET /languages. Each video can have one subtitle per language."}, "content": {"type": "string", "description": "WebVTT text beginning with WEBVTT, as an alternative to uploading a file. Do not send both content and file."}}, "required": ["language_id"]}}}}}}, "/files/{file_id}/subtitles/{subtitle_id}": {"patch": {"tags": ["Subtitles"], "summary": "Update a subtitle track", "description": "Send a replacement file or content, a different language_id, or both. Only supplied fields change. To replace the text, provide either file or content, never both.", "security": [{"CreatorKey": []}], "parameters": [{"name": "file_id", "in": "path", "required": true, "schema": {"type": "string"}, "description": "File ID returned by an upload or GET /files; not an upload or import ID.", "example": "example-file"}, {"name": "subtitle_id", "in": "path", "required": true, "schema": {"type": "integer"}, "description": "Numeric subtitle ID returned by this video\u2019s subtitle list.", "example": 1}], "responses": {"200": {"description": "Your request completed. The result is in data.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Success"}}}}, "400": {"description": "Check the required fields and their values.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "401": {"description": "Your API key is missing, expired, revoked or invalid.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "403": {"description": "Your account or API key does not have access to this action.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "404": {"description": "This item was not found in your account.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "409": {"description": "This request conflicts with an earlier request or the item\u2019s current state.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "410": {"description": "The upload expired or the item from your original request was deleted.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "413": {"description": "The file is too large or your account has insufficient storage.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "429": {"description": "Request or upload limit reached. Wait before retrying; check Retry-After if provided.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "502": {"description": "The request could not be completed right now. Retry later with the same request key where required.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "503": {"description": "This feature is temporarily unavailable. Try again later.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}, "operationId": "patch_files_file_id_subtitles_subtitle_id", "requestBody": {"required": true, "content": {"multipart/form-data": {"schema": {"type": "object", "additionalProperties": false, "properties": {"language_id": {"type": "integer", "description": "Numeric language ID returned by GET /languages. Each video can have one subtitle per language."}, "file": {"type": "string", "format": "binary", "description": "UTF-8 WebVTT (.vtt) file. Send either file or content, never both. Upload limits depend on your account; keep the complete request under 1 MiB for compatibility."}, "content": {"type": "string", "description": "WebVTT text beginning with WEBVTT, as an alternative to uploading a file. Do not send both content and file."}}}}, "application/json": {"schema": {"type": "object", "additionalProperties": false, "properties": {"language_id": {"type": "integer", "description": "Numeric language ID returned by GET /languages. Each video can have one subtitle per language."}, "content": {"type": "string", "description": "WebVTT text beginning with WEBVTT, as an alternative to uploading a file. Do not send both content and file."}}}}}}}, "delete": {"tags": ["Subtitles"], "summary": "Delete a subtitle track", "description": "Remove this track from the video. Use the subtitle_id returned by the subtitle list.", "security": [{"CreatorKey": []}], "parameters": [{"name": "file_id", "in": "path", "required": true, "schema": {"type": "string"}, "description": "File ID returned by an upload or GET /files; not an upload or import ID.", "example": "example-file"}, {"name": "subtitle_id", "in": "path", "required": true, "schema": {"type": "integer"}, "description": "Numeric subtitle ID returned by this video\u2019s subtitle list.", "example": 1}], "responses": {"200": {"description": "Your request completed. The result is in data.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Success"}}}}, "400": {"description": "Check the required fields and their values.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "401": {"description": "Your API key is missing, expired, revoked or invalid.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "403": {"description": "Your account or API key does not have access to this action.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "404": {"description": "This item was not found in your account.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "409": {"description": "This request conflicts with an earlier request or the item\u2019s current state.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "410": {"description": "The upload expired or the item from your original request was deleted.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "413": {"description": "The file is too large or your account has insufficient storage.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "429": {"description": "Request or upload limit reached. Wait before retrying; check Retry-After if provided.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "502": {"description": "The request could not be completed right now. Retry later with the same request key where required.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "503": {"description": "This feature is temporarily unavailable. Try again later.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}, "operationId": "delete_files_file_id_subtitles_subtitle_id"}}, "/stats": {"get": {"tags": ["Statistics"], "summary": "Get your views and earnings", "description": "Choose from and to dates in YYYY-MM-DD format. Dates use UTC; the default range is the last 30 days and the maximum is 365 days. qualified_views counts qualified views, eligible_views counts views credited for earnings, and amount is a decimal string in USD. If your account has no statistics access, the response is 403 statistics_disabled. Check capabilities.statistics in GET /account.", "security": [{"CreatorKey": []}], "parameters": [{"name": "from", "in": "query", "schema": {"type": "string", "format": "date"}, "description": "First UTC date to include, for example 2026-11-01."}, {"name": "to", "in": "query", "schema": {"type": "string", "format": "date"}, "description": "Last UTC date to include, for example 2026-11-09. Must not precede from."}], "responses": {"200": {"description": "Your request completed. The result is in data.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Success"}}}}, "400": {"description": "Check the required fields and their values.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "401": {"description": "Your API key is missing, expired, revoked or invalid.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "403": {"description": "Your account or API key does not have access to this action.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "404": {"description": "This item was not found in your account.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "409": {"description": "This request conflicts with an earlier request or the item\u2019s current state.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "410": {"description": "The upload expired or the item from your original request was deleted.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "413": {"description": "The file is too large or your account has insufficient storage.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "429": {"description": "Request or upload limit reached. Wait before retrying; check Retry-After if provided.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "502": {"description": "The request could not be completed right now. Retry later with the same request key where required.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}, "503": {"description": "This feature is temporarily unavailable. Try again later.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Error"}}}}}, "operationId": "get_stats"}}}, "components": {"schemas": {"Cover": {"type": "object", "required": ["poster_url", "thumbnail_url"], "properties": {"poster_url": {"type": "string", "format": "uri", "nullable": true, "description": "Current full cover address. Use this new address after replacing or removing your custom cover; null when no cover is available."}, "thumbnail_url": {"type": "string", "format": "uri", "nullable": true, "description": "Current smaller image for file listings; null when no thumbnail is available."}}}, "DirectUpload": {"type": "object", "required": ["session_id", "upload_url", "token", "part_size_bytes"], "properties": {"session_id": {"type": "string", "description": "Upload reference returned for this transfer. Use the top-level id in /uploads/{upload_id}."}, "upload_url": {"type": "string", "format": "uri", "description": "Upload address for this file. Use it exactly as returned, then append /parts/1, /complete or /file as shown in the guide."}, "token": {"type": "string", "description": "Send this value in X-Upload-Token when transferring this file. No Bearer prefix. Keep it private."}, "upload_token": {"type": "string", "description": "Same value as token; you only need to use one of them."}, "token_expires_at": {"type": "string", "format": "date-time"}, "session_expires_at": {"type": "string", "format": "date-time"}, "part_size_bytes": {"type": "integer", "minimum": 1, "description": "Recommended chunk size, not the total file length."}, "max_size_bytes": {"type": "integer", "description": "Upload size limit in bytes. Also check your account limit and remaining storage."}}}, "UploadSession": {"type": "object", "required": ["id", "file_id", "status", "size_bytes"], "properties": {"id": {"type": "string", "format": "uuid", "description": "Upload ID to use in /uploads/{upload_id}, its /ticket endpoint and cancellation requests."}, "gateway_session_id": {"type": "string", "description": "Additional upload reference. Use id, not this value, in /uploads/{upload_id}."}, "file_id": {"type": "string", "nullable": true, "description": "File ID to use in /files/{file_id} and when retrieving your watch link."}, "status": {"type": "string", "description": "Upload state. completed means the file was received; check /files/{file_id} for playback readiness."}, "size_bytes": {"type": "integer", "minimum": 0}, "expires_at": {"type": "string", "format": "date-time"}, "error_code": {"type": "string", "nullable": true}, "direct_upload": {"$ref": "#/components/schemas/DirectUpload"}}}, "UploadTicket": {"type": "object", "required": ["token", "token_expires_at"], "properties": {"token": {"type": "string", "description": "Replacement X-Upload-Token; same session."}, "token_expires_at": {"type": "string", "format": "date-time"}}}, "RemoteImport": {"type": "object", "required": ["import_id", "batch_id", "attempt", "status", "file_id", "source_ready", "source_archived"], "properties": {"import_id": {"type": "string", "pattern": "^ri_[0-9a-f]{32}$"}, "batch_id": {"type": "string", "pattern": "^rib_[0-9a-f]{32}$"}, "client_item_id": {"type": "string"}, "attempt": {"type": "integer", "minimum": 1, "description": "Number of download attempts, starting at 1. Increases when you retry a failed import."}, "status": {"type": "string", "enum": ["queued", "resolving", "downloading", "probing", "cancelling", "retry_waiting", "succeeded", "failed", "cancelled"]}, "file_id": {"type": "string", "nullable": true, "description": "File ID to use in /files/{file_id}. null if you have deleted the file."}, "filename": {"type": "string", "description": "Initially unknown; updates when the actual file name is available. A title you set yourself is kept."}, "downloaded_bytes": {"type": "integer", "minimum": 0}, "total_bytes": {"type": "integer", "minimum": 0, "nullable": true}, "progress_percent": {"type": "number", "minimum": 0, "maximum": 100, "nullable": true, "description": "Download only; null when exact total is unknown."}, "source_ready": {"type": "boolean", "description": "The original file has finished downloading. Check the file details for playback readiness."}, "source_archived": {"type": "boolean", "description": "The downloaded original has been saved to your account storage. No action is needed."}, "auto_encode": {"type": "boolean", "description": "Set true to prepare imported videos for watching. Default false saves the original without preparing playback."}, "encoding_resolution": {"type": "integer", "enum": [360, 720, 1080], "description": "Choose a value from GET /account encoding_resolutions, such as 720. Omit to use your saved preference. Smaller videos are not enlarged.", "nullable": true}, "encoding_status": {"type": "string", "description": "Video preparation state. not_requested means auto_encode was false."}, "publication_status": {"type": "string", "description": "Playback preparation: not_requested, pending or published. Check playback.ready on the file before opening it."}, "error": {"type": "string", "nullable": true, "description": "Reason the import could not complete. null when there is no error."}, "created_at": {"type": "string", "format": "date-time"}, "updated_at": {"type": "string", "format": "date-time"}}}, "RemotePage": {"type": "object", "required": ["items", "counts", "completed", "next_cursor"], "properties": {"batch_id": {"type": "string", "description": "Batch ID for the selected batch."}, "items": {"type": "array", "items": {"$ref": "#/components/schemas/RemoteImport"}}, "counts": {"type": "object", "additionalProperties": {"type": "integer"}, "description": "Number of tasks in each state for the full batch or list, including items outside the current page."}, "completed": {"type": "boolean", "description": "true when no downloads are still running. Some items may have failed or been cancelled; inspect their results."}, "next_cursor": {"type": "string", "description": "Empty string ends pagination; pass unchanged within the same query."}}}, "Success": {"type": "object", "required": ["data", "request_id"], "properties": {"data": {"type": "object", "description": "The requested item or list of items."}, "request_id": {"type": "string", "format": "uuid", "description": "Reference to include when contacting support."}}}, "Error": {"type": "object", "required": ["error", "request_id"], "properties": {"error": {"type": "object", "required": ["code", "message"], "properties": {"code": {"type": "string", "description": "Error code your client can use to decide what to do next."}, "message": {"type": "string", "description": "Explanation of the error."}, "details": {}}}, "request_id": {"type": "string", "format": "uuid", "description": "Reference to include when contacting support."}}}}, "securitySchemes": {"CreatorKey": {"type": "http", "scheme": "bearer", "bearerFormat": "Your API key from Settings \u2192 API Access"}}}}