/** * This file was auto-generated by openapi-typescript. * Do not make direct changes to the file. */ export interface paths { "/api/ably/token": { /** Get Token */ get: operations["studio_api_ably_api_get_token"]; }; "/api/active_listeners/{clip_id}": { /** * Get Clip Active Listeners * @description Get count of users currently listening to a specific song */ get: operations["studio_api_bots_api_get_clip_active_listeners"]; }; "/api/ads/user": { /** * Create Or Update Ads User * @description Create or update an AdsUser record for the authenticated user */ post: operations["studio_api_growth_ads_api_create_or_update_ads_user"]; }; "/api/ads/user/": { /** * Create Or Update Ads User * @description Create or update an AdsUser record for the authenticated user */ post: operations["studio_api_growth_ads_api_create_or_update_ads_user"]; }; "/api/analytics/user-event": { /** * Get User Analytics Data * @description Get user tracking event data to determine whether to publish GA4 / Branch event */ get: operations["studio_api_analytics_api_get_user_analytics_data"]; }; "/api/analytics/user-event/": { /** * Get User Analytics Data * @description Get user tracking event data to determine whether to publish GA4 / Branch event */ get: operations["studio_api_analytics_api_get_user_analytics_data"]; }; "/api/app_version_update": { /** Get Version Updates */ post: operations["studio_api_app_version_update_api_get_version_updates"]; }; "/api/app_version_update/": { /** Get Version Updates */ post: operations["studio_api_app_version_update_api_get_version_updates"]; }; "/api/banner/update": { /** Update Status */ post: operations["studio_api_banner_api_update_status"]; }; "/api/billing/accept-sub-coupon": { /** * Accept Sub Coupon * @description Accept a discount coupon for the user's subscription. * * Note: This endpoint applies the coupon to the user's Stripe subscription, * but the discount is only actually redeemed/applied when the subscription * renews on its next billing cycle. */ post: operations["studio_api_bots_billing_api_accept_sub_coupon"]; }; "/api/billing/accept-sub-coupon/": { /** * Accept Sub Coupon * @description Accept a discount coupon for the user's subscription. * * Note: This endpoint applies the coupon to the user's Stripe subscription, * but the discount is only actually redeemed/applied when the subscription * renews on its next billing cycle. */ post: operations["studio_api_bots_billing_api_accept_sub_coupon"]; }; "/api/billing/add-credits": { /** * Add Credits * @description Add credits to a user account. Staff only. */ post: operations["studio_api_bots_billing_api_add_credits"]; }; "/api/billing/add-credits/": { /** * Add Credits * @description Add credits to a user account. Staff only. */ post: operations["studio_api_bots_billing_api_add_credits"]; }; "/api/billing/cancel-sub": { /** Cancel Subscription */ post: operations["studio_api_bots_billing_api_cancel_subscription"]; }; "/api/billing/cancel-sub/": { /** Cancel Subscription */ post: operations["studio_api_bots_billing_api_cancel_subscription"]; }; "/api/billing/cancel-sub/undo": { /** Cancel Subscription Undo */ post: operations["studio_api_bots_billing_api_cancel_subscription_undo"]; }; "/api/billing/cancel-sub/undo/": { /** Cancel Subscription Undo */ post: operations["studio_api_bots_billing_api_cancel_subscription_undo"]; }; "/api/billing/change-plan": { /** Change Plan */ post: operations["studio_api_bots_billing_api_change_plan"]; }; "/api/billing/change-plan/": { /** Change Plan */ post: operations["studio_api_bots_billing_api_change_plan"]; }; "/api/billing/change-plan/preview": { /** Change Plan Preview */ post: operations["studio_api_bots_billing_api_change_plan_preview"]; }; "/api/billing/change-plan/preview/": { /** Change Plan Preview */ post: operations["studio_api_bots_billing_api_change_plan_preview"]; }; "/api/billing/clips/{clip_id}/download": { /** * Log Clip Download * @description Log a clip download to the ClipDownloadHistory table */ post: operations["studio_api_bots_billing_api_log_clip_download"]; }; "/api/billing/clips/{clip_id}/download/": { /** * Log Clip Download * @description Log a clip download to the ClipDownloadHistory table */ post: operations["studio_api_bots_billing_api_log_clip_download"]; }; "/api/billing/create-portal": { /** Create Portal Session */ post: operations["studio_api_bots_billing_api_create_portal_session"]; }; "/api/billing/create-portal/": { /** Create Portal Session */ post: operations["studio_api_bots_billing_api_create_portal_session"]; }; "/api/billing/create-session": { /** Create Checkout Session */ post: operations["studio_api_bots_billing_api_create_checkout_session"]; }; "/api/billing/create-session/": { /** Create Checkout Session */ post: operations["studio_api_bots_billing_api_create_checkout_session"]; }; "/api/billing/credits": { /** Get Credits Remaining */ get: operations["studio_api_bots_billing_api_get_credits_remaining"]; }; "/api/billing/credits/": { /** Get Credits Remaining */ get: operations["studio_api_bots_billing_api_get_credits_remaining"]; }; "/api/billing/default-currency": { /** * Get Default Currency * @description Return the default currency for the user based on their location. */ get: operations["studio_api_bots_billing_api_get_default_currency"]; }; "/api/billing/default-currency/": { /** * Get Default Currency * @description Return the default currency for the user based on their location. */ get: operations["studio_api_bots_billing_api_get_default_currency"]; }; "/api/billing/download-usage": { /** * Get Download Usage * @description Get the user's current month download usage and limits, optionally check specific clip ownership */ get: operations["studio_api_bots_billing_api_get_download_usage"]; }; "/api/billing/download-usage/": { /** * Get Download Usage * @description Get the user's current month download usage and limits, optionally check specific clip ownership */ get: operations["studio_api_bots_billing_api_get_download_usage"]; }; "/api/billing/edu/info": { /** Get Edu Info */ get: operations["studio_api_bots_billing_edu_api_get_edu_info"]; }; "/api/billing/eligible-discounts": { /** * Get Eligible Discounts Endpoint * @description Get eligible discount coupons by plan and subscription period. */ get: operations["studio_api_bots_billing_api_get_eligible_discounts_endpoint"]; }; "/api/billing/get-churn-survey-options": { /** Get Churn Survey Options */ get: operations["studio_api_bots_billing_api_get_churn_survey_options"]; }; "/api/billing/get-churn-survey-options/": { /** Get Churn Survey Options */ get: operations["studio_api_bots_billing_api_get_churn_survey_options"]; }; "/api/billing/get-discount-offer": { /** * Get Discount Offer * @description Get the subscription retention offer (panic offer) for when a user tries to unsubscribe. * * This endpoint returns a discount offer that can be presented to users when they attempt * to cancel their subscription, in an effort to retain them as paying customers. */ get: operations["studio_api_bots_billing_api_get_discount_offer"]; }; "/api/billing/get-discount-offer/": { /** * Get Discount Offer * @description Get the subscription retention offer (panic offer) for when a user tries to unsubscribe. * * This endpoint returns a discount offer that can be presented to users when they attempt * to cancel their subscription, in an effort to retain them as paying customers. */ get: operations["studio_api_bots_billing_api_get_discount_offer"]; }; "/api/billing/info": { /** Get Subscription Info */ get: operations["studio_api_bots_billing_api_get_subscription_info"]; }; "/api/billing/info/": { /** Get Subscription Info */ get: operations["studio_api_bots_billing_api_get_subscription_info"]; }; "/api/billing/purchase-commercial-rights": { /** Purchase Commercial Rights Api */ post: operations["studio_api_bots_billing_api_purchase_commercial_rights_api"]; }; "/api/billing/purchase-commercial-rights/": { /** Purchase Commercial Rights Api */ post: operations["studio_api_bots_billing_api_purchase_commercial_rights_api"]; }; "/api/billing/purchase-credits": { /** Purchase Credits */ post: operations["studio_api_bots_billing_api_purchase_credits"]; }; "/api/billing/purchase-credits/": { /** Purchase Credits */ post: operations["studio_api_bots_billing_api_purchase_credits"]; }; "/api/billing/purchase-credits/{item_id}": { /** Purchase Credits Status */ get: operations["studio_api_bots_billing_api_purchase_credits_status"]; }; "/api/billing/purchase-credits/{item_id}/": { /** Purchase Credits Status */ get: operations["studio_api_bots_billing_api_purchase_credits_status"]; }; "/api/billing/purchase-info/{purchase_id}": { /** Get Purchase Info Status */ get: operations["studio_api_bots_billing_api_get_purchase_info_status"]; }; "/api/billing/purchase-info/{purchase_id}/": { /** Get Purchase Info Status */ get: operations["studio_api_bots_billing_api_get_purchase_info_status"]; }; "/api/billing/submit-survey": { /** Submit Survey */ post: operations["studio_api_bots_billing_api_submit_survey"]; }; "/api/billing/submit-survey/": { /** Submit Survey */ post: operations["studio_api_bots_billing_api_submit_survey"]; }; "/api/billing/sync-sub": { /** Sync Subscription Info */ post: operations["studio_api_bots_billing_api_sync_subscription_info"]; }; "/api/billing/sync-sub/": { /** Sync Subscription Info */ post: operations["studio_api_bots_billing_api_sync_subscription_info"]; }; "/api/billing/tax-info": { /** * Get Tax Info * @description Returns the tax rate that the user is subject to for Stripe subscriptions. * Only works for users with active_subscription_platform = 'stripe' and active subscriptions. */ get: operations["studio_api_bots_billing_api_get_tax_info"]; }; "/api/billing/tax-info/": { /** * Get Tax Info * @description Returns the tax rate that the user is subject to for Stripe subscriptions. * Only works for users with active_subscription_platform = 'stripe' and active subscriptions. */ get: operations["studio_api_bots_billing_api_get_tax_info"]; }; "/api/billing/usage-plan-config": { /** * Get Usage Plan Config * @description Returns the usage plan configuration which only includes the plans that the user is eligible for. */ get: operations["studio_api_bots_billing_api_get_usage_plan_config"]; }; "/api/billing/usage-plan-config/": { /** * Get Usage Plan Config * @description Returns the usage plan configuration which only includes the plans that the user is eligible for. */ get: operations["studio_api_bots_billing_api_get_usage_plan_config"]; }; "/api/billing/usage-plan-descriptions": { /** * Get Usage Plan Descriptions * @description Return the web usage plan descriptions for the current user. */ get: operations["studio_api_bots_billing_api_get_usage_plan_descriptions"]; }; "/api/billing/usage-plan-descriptions/": { /** * Get Usage Plan Descriptions * @description Return the web usage plan descriptions for the current user. */ get: operations["studio_api_bots_billing_api_get_usage_plan_descriptions"]; }; "/api/billing/usage-plan-faq": { /** * Get Usage Plan Faq * @description Return the web usage plan FAQ for the current user. */ get: operations["studio_api_bots_billing_api_get_usage_plan_faq"]; }; "/api/billing/usage-plan-faq/": { /** * Get Usage Plan Faq * @description Return the web usage plan FAQ for the current user. */ get: operations["studio_api_bots_billing_api_get_usage_plan_faq"]; }; "/api/billing/usage-plan-web-table-comparison": { /** Get Usage Plan Table Comparison */ get: operations["studio_api_bots_billing_api_get_usage_plan_table_comparison"]; }; "/api/billing/usage-plan-web-table-comparison/": { /** Get Usage Plan Table Comparison */ get: operations["studio_api_bots_billing_api_get_usage_plan_table_comparison"]; }; "/api/billing/usage-plans": { /** Get Usage Plans */ get: operations["studio_api_bots_billing_api_get_usage_plans"]; }; "/api/billing/usage-plans/": { /** Get Usage Plans */ get: operations["studio_api_bots_billing_api_get_usage_plans"]; }; "/api/billing/web-subscription-flag": { /** Get Web Subscription Feature Flag */ get: operations["studio_api_bots_billing_api_get_web_subscription_feature_flag"]; }; "/api/billing/web-subscription-flag/": { /** Get Web Subscription Feature Flag */ get: operations["studio_api_bots_billing_api_get_web_subscription_feature_flag"]; }; "/api/c/check": { /** Check Captcha */ post: operations["studio_api_captcha_api_check_captcha"]; }; "/api/challenge/progress": { /** Get User Challenges Progress */ get: operations["studio_api_challenge_api_get_user_challenges_progress"]; }; "/api/chat/flag_chat": { /** Flag Chat */ post: operations["studio_api_chat_api_flag_chat"]; }; "/api/chat/history": { /** Get Chats */ get: operations["studio_api_chat_api_get_chats"]; }; "/api/chat/post": { /** Post Chat */ post: operations["studio_api_chat_api_post_chat"]; }; "/api/clip/{clip_id}": { /** Get Clip 2 */ get: operations["studio_api_bots_api_get_clip_2"]; }; "/api/clip/{clip_id}/": { /** Get Clip 2 */ get: operations["studio_api_bots_api_get_clip_2"]; }; "/api/clip/{clip_id}/stems": { /** Get Stems */ get: operations["studio_api_bots_api_get_stems"]; }; "/api/clip/{clip_id}/stems/": { /** Get Stems */ get: operations["studio_api_bots_api_get_stems"]; }; "/api/clip/{clip_id}/stems/pages": { /** Get Stem Pages */ get: operations["studio_api_bots_api_get_stem_pages"]; }; "/api/clip/{clip_id}/stems/pages/": { /** Get Stem Pages */ get: operations["studio_api_bots_api_get_stem_pages"]; }; "/api/clips/adjust-speed": { /** * Adjust Speed * @description Adjust the speed of a clip. * * Args: * data: Contains clip_id, speed_multiplier, and keep_pitch */ post: operations["studio_api_clips_api_adjust_speed"]; }; "/api/clips/adjust-speed/": { /** * Adjust Speed * @description Adjust the speed of a clip. * * Args: * data: Contains clip_id, speed_multiplier, and keep_pitch */ post: operations["studio_api_clips_api_adjust_speed"]; }; "/api/clips/aligned_clip_siblings": { /** * Get Aligned Clip Siblings * @description Find all clips owned by the current user that have matching ClipAlignment data to the given clip. * Returns an empty list if no ClipAlignment exists for the given clip. */ get: operations["studio_api_clips_api_get_aligned_clip_siblings"]; }; "/api/clips/aligned_clips": { /** Get Aligned Clips */ get: operations["studio_api_clips_api_get_aligned_clips"]; }; "/api/clips/autoplay": { /** Autoplay */ post: operations["studio_api_clips_api_autoplay"]; }; "/api/clips/autoplay/": { /** Autoplay */ post: operations["studio_api_clips_api_autoplay"]; }; "/api/clips/children": { /** * Get Children * @description find child clips for the given clip ID */ get: operations["studio_api_clips_api_get_children"]; }; "/api/clips/children/": { /** * Get Children * @description find child clips for the given clip ID */ get: operations["studio_api_clips_api_get_children"]; }; "/api/clips/clip_prompts/": { /** Get Clip Prompts */ get: operations["studio_api_clips_api_get_clip_prompts"]; }; "/api/clips/delete": { /** * Delete Clips * @description Handle the deletion of clips specified by their IDs. * * This endpoint accepts a POST request with a JSON body containing a list * of clip IDs. It will then move these clips to a designated 'deleted' folder * on S3, effectively marking them as deleted in the system. * * Args: * request (HttpRequest): The HTTP request object containing the JSON payload * with a list of clip IDs under the key 'clip_ids'. * * Returns: * HttpResponse: An HTTP response with status 204 (No Content) if the clips * are successfully marked as deleted. This status indicates that the action * was successful, but there is no content to return in the response body. */ post: operations["studio_api_clips_api_delete_clips"]; }; "/api/clips/delete/": { /** * Delete Clips * @description Handle the deletion of clips specified by their IDs. * * This endpoint accepts a POST request with a JSON body containing a list * of clip IDs. It will then move these clips to a designated 'deleted' folder * on S3, effectively marking them as deleted in the system. * * Args: * request (HttpRequest): The HTTP request object containing the JSON payload * with a list of clip IDs under the key 'clip_ids'. * * Returns: * HttpResponse: An HTTP response with status 204 (No Content) if the clips * are successfully marked as deleted. This status indicates that the action * was successful, but there is no content to return in the response body. */ post: operations["studio_api_clips_api_delete_clips"]; }; "/api/clips/direct_children": { /** * Get Direct Children * @description Get immediate children of the given clip ID with pagination. */ get: operations["studio_api_clips_api_get_direct_children"]; }; "/api/clips/direct_children/": { /** * Get Direct Children * @description Get immediate children of the given clip ID with pagination. */ get: operations["studio_api_clips_api_get_direct_children"]; }; "/api/clips/direct_children_by_user": { /** * Get Direct Children By User * @description Get immediate children of the given clip ID grouped by user with pagination. */ get: operations["studio_api_clips_api_get_direct_children_by_user"]; }; "/api/clips/direct_children_by_user/": { /** * Get Direct Children By User * @description Get immediate children of the given clip ID grouped by user with pagination. */ get: operations["studio_api_clips_api_get_direct_children_by_user"]; }; "/api/clips/direct_children_count": { /** * Get Direct Children Count * @description Get count of immediate children for the given clip ID. */ get: operations["studio_api_clips_api_get_direct_children_count"]; }; "/api/clips/direct_children_count/": { /** * Get Direct Children Count * @description Get count of immediate children for the given clip ID. */ get: operations["studio_api_clips_api_get_direct_children_count"]; }; "/api/clips/get_similar": { /** * Get Similar Endpoint * @description find similar public songs to the given clip ids. */ get: operations["studio_api_clips_api_get_similar_endpoint"]; }; "/api/clips/get_similar/": { /** * Get Similar Endpoint * @description find similar public songs to the given clip ids. */ get: operations["studio_api_clips_api_get_similar_endpoint"]; }; "/api/clips/get_songs_by_ids": { /** Retrieve Songs By Ids */ get: operations["studio_api_clips_api_retrieve_songs_by_ids"]; }; "/api/clips/parent": { /** * Get Parent Clip * @description Get the parent clip for a given clip ID using the ClipParent table. */ get: operations["studio_api_clips_api_get_parent_clip"]; }; "/api/clips/parent/": { /** * Get Parent Clip * @description Get the parent clip for a given clip ID using the ClipParent table. */ get: operations["studio_api_clips_api_get_parent_clip"]; }; "/api/clips/preview_clips/{styles}": { /** Get Preview Clips For Styles */ get: operations["studio_api_clips_api_get_preview_clips_for_styles"]; }; "/api/clips/set_all_remix_permissions": { /** * Set All Remix Permissions * @description Set remix permissions for all public clips owned by the requesting user. * * This endpoint efficiently updates the remix permission setting for all of a user's public clips. * It will add or update the can_remix field for all clips regardless of the value being set. * * Args: * request: The HTTP request. * can_remix: Boolean indicating whether to allow remixes. * batch_size: Number of clips to process in each batch (default: 100). * * Returns: * Dict with count of updated clips and status. */ post: operations["studio_api_clips_api_set_all_remix_permissions"]; }; "/api/clips/set_all_remix_permissions/": { /** * Set All Remix Permissions * @description Set remix permissions for all public clips owned by the requesting user. * * This endpoint efficiently updates the remix permission setting for all of a user's public clips. * It will add or update the can_remix field for all clips regardless of the value being set. * * Args: * request: The HTTP request. * can_remix: Boolean indicating whether to allow remixes. * batch_size: Number of clips to process in each batch (default: 100). * * Returns: * Dict with count of updated clips and status. */ post: operations["studio_api_clips_api_set_all_remix_permissions"]; }; "/api/clips/trashed_v2": { /** Get Trashed Clips V2 */ get: operations["studio_api_clips_api_get_trashed_clips_v2"]; }; "/api/clips/trashed_v2/": { /** Get Trashed Clips V2 */ get: operations["studio_api_clips_api_get_trashed_clips_v2"]; }; "/api/clips/update_similar": { /** Update Similar */ post: operations["studio_api_clips_api_update_similar"]; }; "/api/clips/update_similar/": { /** Update Similar */ post: operations["studio_api_clips_api_update_similar"]; }; "/api/clips/user_remixes_for_clip": { /** * Get User Remixes For Clip * @description Get all remixes by a specific user for a given clip. */ get: operations["studio_api_clips_api_get_user_remixes_for_clip"]; }; "/api/clips/user_remixes_for_clip/": { /** * Get User Remixes For Clip * @description Get all remixes by a specific user for a given clip. */ get: operations["studio_api_clips_api_get_user_remixes_for_clip"]; }; "/api/clips/{clip_id}/commercial_rights_eligible": { /** * Check Commercial Rights Eligibility * @description Check if a clip is eligible for commercial rights purchase. * * Returns whether the clip can have commercial rights purchased for it. * Commercial rights are only available for clips that are not remixes * of someone else's work. * * Args: * request: The HTTP request. * clip_id: The ID of the clip to check. * * Returns: * dict: {"eligible": bool} indicating if commercial rights can be purchased */ get: operations["studio_api_clips_api_check_commercial_rights_eligibility"]; }; "/api/clips/{clip_id}/commercial_rights_eligible/": { /** * Check Commercial Rights Eligibility * @description Check if a clip is eligible for commercial rights purchase. * * Returns whether the clip can have commercial rights purchased for it. * Commercial rights are only available for clips that are not remixes * of someone else's work. * * Args: * request: The HTTP request. * clip_id: The ID of the clip to check. * * Returns: * dict: {"eligible": bool} indicating if commercial rights can be purchased */ get: operations["studio_api_clips_api_check_commercial_rights_eligibility"]; }; "/api/clips/{clip_id}/mux": { /** * Mux Clip Video Audio * @description Download and mux video and audio for a clip, returning the muxed file. * * This endpoint downloads the video and audio files for a clip, muxes them together * using ffmpeg, and returns the muxed file for download. * * Args: * request: The HTTP request. * clip_id: The ID of the clip to mux. * * Returns: * HttpResponse: The muxed video file as a downloadable response. */ get: operations["studio_api_clips_api_mux_clip_video_audio"]; }; "/api/clips/{clip_id}/mux/": { /** * Mux Clip Video Audio * @description Download and mux video and audio for a clip, returning the muxed file. * * This endpoint downloads the video and audio files for a clip, muxes them together * using ffmpeg, and returns the muxed file for download. * * Args: * request: The HTTP request. * clip_id: The ID of the clip to mux. * * Returns: * HttpResponse: The muxed video file as a downloadable response. */ get: operations["studio_api_clips_api_mux_clip_video_audio"]; }; "/api/clips/{clip_id}/project": { /** Get Clip Project */ get: operations["studio_api_clips_api_get_clip_project"]; }; "/api/clips/{clip_id}/set_remix_type": { /** * Set Remix Type * @description Set the remix type for a clip. * * Args: * request: The HTTP request. * clip_id: The ID of the clip to update. * data: A dictionary containing 'remix' string field. * * Returns: * HttpResponse: 204 No Content on success. */ post: operations["studio_api_clips_api_set_remix_type"]; }; "/api/clips/{clip_id}/set_remix_type/": { /** * Set Remix Type * @description Set the remix type for a clip. * * Args: * request: The HTTP request. * clip_id: The ID of the clip to update. * data: A dictionary containing 'remix' string field. * * Returns: * HttpResponse: 204 No Content on success. */ post: operations["studio_api_clips_api_set_remix_type"]; }; "/api/clips/{clip_id}/toggle_remixes": { /** * Toggle Remixes * @description Toggle whether remixes are allowed for a clip. */ post: operations["studio_api_clips_api_toggle_remixes"]; }; "/api/clips/{clip_id}/toggle_remixes/": { /** * Toggle Remixes * @description Toggle whether remixes are allowed for a clip. */ post: operations["studio_api_clips_api_toggle_remixes"]; }; "/api/clips/{clip_id}/toggle_show_remixes": { /** * Toggle Show Remixes * @description Toggle whether remixes are shown for a user's own clip. */ post: operations["studio_api_clips_api_toggle_show_remixes"]; }; "/api/comment/block-user": { /** * Post Block User * @description Block a user from commenting on requesting user's songs */ post: operations["studio_api_bots_comment_api_post_block_user"]; }; "/api/comment/block-user/": { /** * Post Block User * @description Block a user from commenting on requesting user's songs */ post: operations["studio_api_bots_comment_api_post_block_user"]; }; "/api/comment/unblock-user": { /** * Post Unblock User * @description Unblock a user from commenting on requesting user's songs */ post: operations["studio_api_bots_comment_api_post_unblock_user"]; }; "/api/comment/unblock-user/": { /** * Post Unblock User * @description Unblock a user from commenting on requesting user's songs */ post: operations["studio_api_bots_comment_api_post_unblock_user"]; }; "/api/comment/user/{identifier}": { /** * Get Clip Comments By User * @description Get paginated clip comments by user with cursor-based pagination. */ get: operations["studio_api_bots_comment_api_get_clip_comments_by_user"]; /** * Delete Clip Comments By User * @description Delete all clip comments for a user. */ delete: operations["studio_api_bots_comment_api_delete_clip_comments_by_user"]; }; "/api/comment/{comment_id}": { /** * Delete Comment * @description Delete a comment. Users can only delete their own comments. */ delete: operations["studio_api_bots_comment_api_delete_comment"]; }; "/api/comment/{comment_id}/": { /** * Delete Comment * @description Delete a comment. Users can only delete their own comments. */ delete: operations["studio_api_bots_comment_api_delete_comment"]; }; "/api/comment/{comment_id}/reaction": { /** * Post Comment Reaction * @description Post a reaction to a comment. */ post: operations["studio_api_bots_comment_api_post_comment_reaction"]; }; "/api/comment/{comment_id}/reaction/": { /** * Post Comment Reaction * @description Post a reaction to a comment. */ post: operations["studio_api_bots_comment_api_post_comment_reaction"]; }; "/api/comment/{comment_id}/replies": { /** * Get Comment Replies * @description Get the replies to a comment. */ get: operations["studio_api_bots_comment_api_get_comment_replies"]; }; "/api/comment/{comment_id}/replies/": { /** * Get Comment Replies * @description Get the replies to a comment. */ get: operations["studio_api_bots_comment_api_get_comment_replies"]; }; "/api/comment/{comment_id}/report": { /** * Post Comment Report * @description Report a comment. */ post: operations["studio_api_bots_comment_api_post_comment_report"]; }; "/api/comment/{comment_id}/report/": { /** * Post Comment Report * @description Report a comment. */ post: operations["studio_api_bots_comment_api_post_comment_report"]; }; "/api/contests/": { /** Get All Contests */ get: operations["studio_api_contests_api_get_all_contests"]; }; "/api/contests/contest/{contest_identifier}/info": { /** Get Contest Info Endpoint */ get: operations["studio_api_contests_api_get_contest_info_endpoint"]; /** Set Contest Info */ put: operations["studio_api_contests_api_set_contest_info"]; }; "/api/contests/contest/{contest_identifier}/info/": { /** Get Contest Info Endpoint */ get: operations["studio_api_contests_api_get_contest_info_endpoint"]; /** Set Contest Info */ put: operations["studio_api_contests_api_set_contest_info"]; }; "/api/contests/contest/{contest_id}": { /** Get Contest */ get: operations["studio_api_contests_api_get_contest"]; /** Remove Contest */ delete: operations["studio_api_contests_api_remove_contest"]; }; "/api/contests/contest/{contest_id}/": { /** Get Contest */ get: operations["studio_api_contests_api_get_contest"]; /** Remove Contest */ delete: operations["studio_api_contests_api_remove_contest"]; }; "/api/contests/contest_clips": { /** Get Contest Clips */ get: operations["studio_api_contests_api_get_contest_clips"]; }; "/api/contests/contest_clips/": { /** Get Contest Clips */ get: operations["studio_api_contests_api_get_contest_clips"]; }; "/api/contests/create_contest": { /** Create Contest */ post: operations["studio_api_contests_api_create_contest"]; }; "/api/contests/create_contest/": { /** Create Contest */ post: operations["studio_api_contests_api_create_contest"]; }; "/api/contests/is_contest_clip/{clip_id}": { /** Is Contest Clip */ get: operations["studio_api_contests_api_is_contest_clip"]; }; "/api/contests/is_contest_clip/{clip_id}/": { /** Is Contest Clip */ get: operations["studio_api_contests_api_is_contest_clip"]; }; "/api/contests/landing/{contest_identifier}": { /** Get Contest Landing Page */ get: operations["studio_api_contests_api_get_contest_landing_page"]; }; "/api/contests/landing/{contest_identifier}/": { /** Get Contest Landing Page */ get: operations["studio_api_contests_api_get_contest_landing_page"]; }; "/api/contests/random_contest_clips/{contest_id}": { /** Get Random Contest Clips */ get: operations["studio_api_contests_api_get_random_contest_clips"]; }; "/api/contests/random_contest_clips/{contest_id}/": { /** Get Random Contest Clips */ get: operations["studio_api_contests_api_get_random_contest_clips"]; }; "/api/contests/submit_contest_clip/{clip_id}/{contest_id}": { /** Submit Contest Clip */ post: operations["studio_api_contests_api_submit_contest_clip"]; }; "/api/contests/submit_contest_clip/{clip_id}/{contest_id}/": { /** Submit Contest Clip */ post: operations["studio_api_contests_api_submit_contest_clip"]; }; "/api/contests/top_k_contest_clips/{contest_id}/{k}": { /** Get Top K Contest Clips */ get: operations["studio_api_contests_api_get_top_k_contest_clips"]; }; "/api/contests/top_k_contest_clips/{contest_id}/{k}/": { /** Get Top K Contest Clips */ get: operations["studio_api_contests_api_get_top_k_contest_clips"]; }; "/api/contests/votes": { /** Get All Votes */ get: operations["studio_api_contests_api_get_all_votes"]; }; "/api/contests/votes/": { /** Get All Votes */ get: operations["studio_api_contests_api_get_all_votes"]; }; "/api/contests/votes/place_vote": { /** Place Vote */ post: operations["studio_api_contests_api_place_vote"]; }; "/api/contests/votes/place_vote/": { /** Place Vote */ post: operations["studio_api_contests_api_place_vote"]; }; "/api/count_reacted_beta_gens": { /** * Count Reacted Beta Gens * @description Count the number of completed clips created by the current user that are marked as beta * and how many of those have user reactions */ get: operations["studio_api_bots_api_count_reacted_beta_gens"]; }; "/api/count_reacted_beta_gens/": { /** * Count Reacted Beta Gens * @description Count the number of completed clips created by the current user that are marked as beta * and how many of those have user reactions */ get: operations["studio_api_bots_api_count_reacted_beta_gens"]; }; "/api/discover": { /** * Discover Feed * @description Get homepage sections with timeout */ post: operations["studio_api_discover_api_discover_feed"]; }; "/api/discover/": { /** * Discover Feed * @description Get homepage sections with timeout */ post: operations["studio_api_discover_api_discover_feed"]; }; "/api/discover/sections/{section_name}": { /** * Get Discover Sections * @description api get request for 'Discover' section of Homepage */ get: operations["studio_api_discover_api_get_discover_sections"]; }; "/api/discover/sections/{section_name}/": { /** * Get Discover Sections * @description api get request for 'Discover' section of Homepage */ get: operations["studio_api_discover_api_get_discover_sections"]; }; "/api/discover/shortcuts_songs": { /** * Get Shortcuts * @description api get request for 'Discover' section of shortcuts * based on the shortcut_type and shortcut_context, we will return the appropriate playlist to play music on platform */ get: operations["studio_api_discover_api_get_shortcuts"]; }; "/api/dm/direct/create": { /** * Create Direct Thread * @description Create a DM thread by providing a recipient handle. */ post: operations["studio_api_dm_api_create_direct_thread"]; }; "/api/dm/group/create": { /** * Create Group * @description Create a group by providing a list of user ids. */ post: operations["studio_api_dm_api_create_group"]; }; "/api/dm/group/{group_id}/add": { /** * Add Group Members * @description Add members to a group. */ post: operations["studio_api_dm_api_add_group_members"]; }; "/api/dm/group/{group_id}/remove": { /** * Remove Group Members * @description Remove members from a group. */ post: operations["studio_api_dm_api_remove_group_members"]; }; "/api/dm/send": { /** * Send Message * @description Send a message to another user or a group. */ post: operations["studio_api_dm_api_send_message"]; }; "/api/dm/thread/{thread_id}/info": { /** * Get Thread * @description Get a thread information such as users, group notes, etc. */ get: operations["studio_api_dm_api_get_thread"]; }; "/api/dm/thread/{thread_id}/messages": { /** * Get Thread Messages * @description Get messages in a thread from the last 3 days. */ get: operations["studio_api_dm_api_get_thread_messages"]; }; "/api/dm/thread/{thread_id}/read": { /** * Mark Thread Read * @description Mark all messages in a thread as read. */ post: operations["studio_api_dm_api_mark_thread_read"]; }; "/api/dm/threads": { /** * Get Paginated Threads * @description Get list of threads with thread name (user name or group name) and number of unread messages. */ get: operations["studio_api_dm_api_get_paginated_threads"]; }; "/api/edit/action/{action_clip_id}": { /** Get Action Status */ get: operations["studio_api_bots_editing_api_get_action_status"]; }; "/api/edit/action/{action_clip_id}/": { /** Get Action Status */ get: operations["studio_api_bots_editing_api_get_action_status"]; }; "/api/edit/crop/{clip_id}": { /** Crop Clip */ post: operations["studio_api_bots_editing_api_crop_clip"]; }; "/api/edit/crop/{clip_id}/": { /** Crop Clip */ post: operations["studio_api_bots_editing_api_crop_clip"]; }; "/api/edit/fade/{clip_id}": { /** Fade Clip */ post: operations["studio_api_bots_editing_api_fade_clip"]; }; "/api/edit/fade/{clip_id}/": { /** Fade Clip */ post: operations["studio_api_bots_editing_api_fade_clip"]; }; "/api/edit/speed/{clip_id}": { /** Change Clip Speed */ post: operations["studio_api_bots_editing_api_change_clip_speed"]; }; "/api/edit/speed/{clip_id}/": { /** Change Clip Speed */ post: operations["studio_api_bots_editing_api_change_clip_speed"]; }; "/api/edit/stems/{clip_id}": { /** Stem Clip */ post: operations["studio_api_bots_editing_api_stem_clip"]; }; "/api/edit/stems/{clip_id}/": { /** Stem Clip */ post: operations["studio_api_bots_editing_api_stem_clip"]; }; "/api/feed": { /** Get Feed */ get: operations["studio_api_bots_api_get_feed"]; }; "/api/feed/": { /** Get Feed */ get: operations["studio_api_bots_api_get_feed"]; }; "/api/feed/v2": { /** Get Feed V2 */ get: operations["studio_api_bots_api_get_feed_v2"]; }; "/api/feed/v2/": { /** Get Feed V2 */ get: operations["studio_api_bots_api_get_feed_v2"]; }; "/api/feed/v3": { /** Get Feed V3 */ post: operations["studio_api_bots_api_get_feed_v3"]; }; "/api/feed/v3/offset": { /** * Get Feed V3 Offset * @description Get clip ID at a specific offset for a given set of filters. * Returns the clip_id at the lesser of the given offset and the total number of results. * Uses database-level OFFSET/LIMIT for optimal performance. */ post: operations["studio_api_bots_api_get_feed_v3_offset"]; }; "/api/feedback": { /** Write */ post: operations["studio_api_feedback_api_write"]; }; "/api/feedback/": { /** Write */ post: operations["studio_api_feedback_api_write"]; }; "/api/gen/bulk_increment_play_counts/v2": { /** Bulk Increment Play Counts With Spec */ post: operations["studio_api_bots_gen_api_bulk_increment_play_counts_with_spec"]; }; "/api/gen/increment_action_counts": { /** * Increment Action Counts * @description Increment action count for multiple clips */ post: operations["studio_api_bots_gen_api_increment_action_counts"]; }; "/api/gen/increment_action_counts/": { /** * Increment Action Counts * @description Increment action count for multiple clips */ post: operations["studio_api_bots_gen_api_increment_action_counts"]; }; "/api/gen/prompt_image": { /** Prompt Image */ post: operations["studio_api_bots_gen_api_prompt_image"]; }; "/api/gen/prompt_image/": { /** Prompt Image */ post: operations["studio_api_bots_gen_api_prompt_image"]; }; "/api/gen/trash": { /** * Trash Gen * @description Move or remove a generated clip from trash. * * Args: * request (HttpRequest): The HTTP request object. * spec (TrashSpec): An object containing trash specifications. * * Returns: * TrashSchema: An object indicating the trash (deleted) status of the clip. */ post: operations["studio_api_bots_gen_api_trash_gen"]; }; "/api/gen/trash/": { /** * Trash Gen * @description Move or remove a generated clip from trash. * * Args: * request (HttpRequest): The HTTP request object. * spec (TrashSpec): An object containing trash specifications. * * Returns: * TrashSchema: An object indicating the trash (deleted) status of the clip. */ post: operations["studio_api_bots_gen_api_trash_gen"]; }; "/api/gen/{clip_id}/aligned_lyrics": { /** Get Aligned Lyrics */ get: operations["studio_api_bots_gen_api_get_aligned_lyrics"]; }; "/api/gen/{clip_id}/aligned_lyrics/": { /** Get Aligned Lyrics */ get: operations["studio_api_bots_gen_api_get_aligned_lyrics"]; }; "/api/gen/{clip_id}/aligned_lyrics/v2": { /** Get Aligned Lyrics V2 */ get: operations["studio_api_bots_gen_api_get_aligned_lyrics_v2"]; /** Regenerate Aligned Lyrics */ post: operations["studio_api_bots_gen_api_regenerate_aligned_lyrics"]; }; "/api/gen/{clip_id}/aligned_lyrics/v2/": { /** Get Aligned Lyrics V2 */ get: operations["studio_api_bots_gen_api_get_aligned_lyrics_v2"]; /** Regenerate Aligned Lyrics */ post: operations["studio_api_bots_gen_api_regenerate_aligned_lyrics"]; }; "/api/gen/{clip_id}/aligned_lyrics/v3": { /** Get Lyrics Alignment V3 */ get: operations["studio_api_bots_gen_api_get_lyrics_alignment_v3"]; /** Do Aligned Lyrics V3 */ post: operations["studio_api_bots_gen_api_do_aligned_lyrics_v3"]; }; "/api/gen/{clip_id}/aligned_lyrics/v3/": { /** Get Lyrics Alignment V3 */ get: operations["studio_api_bots_gen_api_get_lyrics_alignment_v3"]; /** Do Aligned Lyrics V3 */ post: operations["studio_api_bots_gen_api_do_aligned_lyrics_v3"]; }; "/api/gen/{clip_id}/comment": { /** * Post Comment * @description Add a comment to a clip. */ post: operations["studio_api_bots_gen_api_post_comment"]; }; "/api/gen/{clip_id}/comment/": { /** * Post Comment * @description Add a comment to a clip. */ post: operations["studio_api_bots_gen_api_post_comment"]; }; "/api/gen/{clip_id}/comments": { /** * Get Comments * @description Get comments for a clip. */ get: operations["studio_api_bots_gen_api_get_comments"]; }; "/api/gen/{clip_id}/comments/": { /** * Get Comments * @description Get comments for a clip. */ get: operations["studio_api_bots_gen_api_get_comments"]; }; "/api/gen/{clip_id}/comments/count": { /** * Get Comment Count * @description Get the count of comments for a clip. */ get: operations["studio_api_bots_gen_api_get_comment_count"]; }; "/api/gen/{clip_id}/comments/count/": { /** * Get Comment Count * @description Get the count of comments for a clip. */ get: operations["studio_api_bots_gen_api_get_comment_count"]; }; "/api/gen/{clip_id}/convert_opus": { /** Generate Opus File */ post: operations["studio_api_bots_gen_api_generate_opus_file"]; }; "/api/gen/{clip_id}/convert_opus/": { /** Generate Opus File */ post: operations["studio_api_bots_gen_api_generate_opus_file"]; }; "/api/gen/{clip_id}/convert_wav": { /** Generate Wav File */ post: operations["studio_api_bots_gen_api_generate_wav_file"]; }; "/api/gen/{clip_id}/convert_wav/": { /** Generate Wav File */ post: operations["studio_api_bots_gen_api_generate_wav_file"]; }; "/api/gen/{clip_id}/downbeats": { /** Get Cached Value */ get: operations["studio_api_bots_gen_api_get_audio_feature_downbeats_v1"]; }; "/api/gen/{clip_id}/downbeats/": { /** Get Cached Value */ get: operations["studio_api_bots_gen_api_get_audio_feature_downbeats_v1"]; }; "/api/gen/{clip_id}/downbeats_streaming/v2": { /** Downbeats Streaming V2 */ post: operations["studio_api_bots_gen_api_downbeats_streaming_v2"]; }; "/api/gen/{clip_id}/instruments": { /** Get Cached Value */ get: operations["studio_api_bots_gen_api_get_audio_feature_instruments_v1"]; }; "/api/gen/{clip_id}/instruments/": { /** Get Cached Value */ get: operations["studio_api_bots_gen_api_get_audio_feature_instruments_v1"]; }; "/api/gen/{clip_id}/key": { /** Get Cached Value */ get: operations["studio_api_bots_gen_api_get_audio_feature_key_v1"]; }; "/api/gen/{clip_id}/key/": { /** Get Cached Value */ get: operations["studio_api_bots_gen_api_get_audio_feature_key_v1"]; }; "/api/gen/{clip_id}/midi": { /** Get Cached Value */ get: operations["studio_api_bots_gen_api_get_midi_transcription_v1"]; }; "/api/gen/{clip_id}/midi/": { /** Get Cached Value */ get: operations["studio_api_bots_gen_api_get_midi_transcription_v1"]; }; "/api/gen/{clip_id}/opus_file": { /** Get Clip Opus File */ get: operations["studio_api_bots_gen_api_get_clip_opus_file"]; }; "/api/gen/{clip_id}/opus_file/": { /** Get Clip Opus File */ get: operations["studio_api_bots_gen_api_get_clip_opus_file"]; }; "/api/gen/{clip_id}/time-sync-comments": { /** * Get Time Sync Comments * @description Get time-synchronized comments for a clip. */ get: operations["studio_api_bots_gen_api_get_time_sync_comments"]; }; "/api/gen/{clip_id}/time-sync-comments/": { /** * Get Time Sync Comments * @description Get time-synchronized comments for a clip. */ get: operations["studio_api_bots_gen_api_get_time_sync_comments"]; }; "/api/gen/{clip_id}/toggle_comments": { /** * Toggle Comments * @description Set allow_comments on a GeneratedClip. User must own clip. */ post: operations["studio_api_bots_gen_api_toggle_comments"]; }; "/api/gen/{clip_id}/toggle_comments/": { /** * Toggle Comments * @description Set allow_comments on a GeneratedClip. User must own clip. */ post: operations["studio_api_bots_gen_api_toggle_comments"]; }; "/api/gen/{clip_id}/warmup-audio-features": { /** * Precalculate Audio Features * @description Pre-calculate audio features (keys, downbeats, waveform aggregates) for a clip to reduce latency. * This endpoint is idempotent and will not trigger extra calculations if data already exists. */ post: operations["studio_api_bots_gen_api_precalculate_audio_features"]; }; "/api/gen/{clip_id}/warmup-audio-features/": { /** * Precalculate Audio Features * @description Pre-calculate audio features (keys, downbeats, waveform aggregates) for a clip to reduce latency. * This endpoint is idempotent and will not trigger extra calculations if data already exists. */ post: operations["studio_api_bots_gen_api_precalculate_audio_features"]; }; "/api/gen/{clip_id}/wav_file": { /** Get Clip Wav File */ get: operations["studio_api_bots_gen_api_get_clip_wav_file"]; }; "/api/gen/{clip_id}/wav_file/": { /** Get Clip Wav File */ get: operations["studio_api_bots_gen_api_get_clip_wav_file"]; }; "/api/gen/{clip_id}/waveform-aggregates": { /** * Get Waveform Aggregates * @description Get the waveform aggregates for a clip. */ get: operations["studio_api_bots_gen_api_get_waveform_aggregates"]; }; "/api/gen/{clip_id}/waveform-aggregates/": { /** * Get Waveform Aggregates * @description Get the waveform aggregates for a clip. */ get: operations["studio_api_bots_gen_api_get_waveform_aggregates"]; }; "/api/gen/{gen_id}/increment_action_count": { /** * Increment Action Count * @description Increment action count */ post: operations["studio_api_bots_gen_api_increment_action_count"]; }; "/api/gen/{gen_id}/increment_action_count/": { /** * Increment Action Count * @description Increment action count */ post: operations["studio_api_bots_gen_api_increment_action_count"]; }; "/api/gen/{gen_id}/increment_play_count": { /** * Increment Play Count * @description Increment play count on UserReaction (and associated Generatedclip). */ post: operations["studio_api_bots_gen_api_increment_play_count"]; }; "/api/gen/{gen_id}/increment_play_count/": { /** * Increment Play Count * @description Increment play count on UserReaction (and associated Generatedclip). */ post: operations["studio_api_bots_gen_api_increment_play_count"]; }; "/api/gen/{gen_id}/increment_play_count/v2": { /** Increment Play Count With Spec */ post: operations["studio_api_bots_gen_api_increment_play_count_with_spec"]; }; "/api/gen/{gen_id}/increment_skip_count": { /** * Increment Skip Count * @description Increment skip count on UserReaction (and associated Generatedclip). */ post: operations["studio_api_bots_gen_api_increment_skip_count"]; }; "/api/gen/{gen_id}/increment_skip_count/": { /** * Increment Skip Count * @description Increment skip count on UserReaction (and associated Generatedclip). */ post: operations["studio_api_bots_gen_api_increment_skip_count"]; }; "/api/gen/{gen_id}/like": { /** Like Gen */ post: operations["studio_api_bots_gen_api_like_gen"]; }; "/api/gen/{gen_id}/like/": { /** Like Gen */ post: operations["studio_api_bots_gen_api_like_gen"]; }; "/api/gen/{gen_id}/set_artist_clip_id": { /** * Set Artist Clip Id * @description Set artist_clip_id in the metadata of a GeneratedClip. User must own clip. */ post: operations["studio_api_bots_gen_api_set_artist_clip_id"]; }; "/api/gen/{gen_id}/set_artist_clip_id/": { /** * Set Artist Clip Id * @description Set artist_clip_id in the metadata of a GeneratedClip. User must own clip. */ post: operations["studio_api_bots_gen_api_set_artist_clip_id"]; }; "/api/gen/{gen_id}/set_clip_prompt": { /** * Set Clip Prompt * @description Set the metadata of a GeneratedClip. User must own clip. */ post: operations["studio_api_bots_gen_api_set_clip_prompt"]; }; "/api/gen/{gen_id}/set_clip_prompt/": { /** * Set Clip Prompt * @description Set the metadata of a GeneratedClip. User must own clip. */ post: operations["studio_api_bots_gen_api_set_clip_prompt"]; }; "/api/gen/{gen_id}/set_configurations": { /** * Set Configurations * @description Set configurations in the metadata of a GeneratedClip. User must own clip. */ post: operations["studio_api_bots_gen_api_set_configurations"]; }; "/api/gen/{gen_id}/set_configurations/": { /** * Set Configurations * @description Set configurations in the metadata of a GeneratedClip. User must own clip. */ post: operations["studio_api_bots_gen_api_set_configurations"]; }; "/api/gen/{gen_id}/set_cover_clip_id": { /** * Set Cover Clip Id * @description Set cover_clip_id in the metadata of a GeneratedClip. User must own clip. */ post: operations["studio_api_bots_gen_api_set_cover_clip_id"]; }; "/api/gen/{gen_id}/set_cover_clip_id/": { /** * Set Cover Clip Id * @description Set cover_clip_id in the metadata of a GeneratedClip. User must own clip. */ post: operations["studio_api_bots_gen_api_set_cover_clip_id"]; }; "/api/gen/{gen_id}/set_display_tags": { /** * Set Display Tags * @description Set the displayed tags of a GeneratedClip. User must own clip. */ post: operations["studio_api_bots_gen_api_set_display_tags"]; }; "/api/gen/{gen_id}/set_metadata": { /** * Set Metadata * @description Set the metadata of a GeneratedClip. User must own clip. */ post: operations["studio_api_bots_gen_api_set_metadata"]; }; "/api/gen/{gen_id}/set_metadata/": { /** * Set Metadata * @description Set the metadata of a GeneratedClip. User must own clip. */ post: operations["studio_api_bots_gen_api_set_metadata"]; }; "/api/gen/{gen_id}/set_video_cover": { /** * Set Video Cover * @description Set video cover in the metadata of a GeneratedClip. User must own clip. */ post: operations["studio_api_bots_gen_api_set_video_cover"]; }; "/api/gen/{gen_id}/set_visibility": { /** * Set Visibility * @description Set is_public visibility on a GeneratedClip. User must own clip. */ post: operations["studio_api_bots_gen_api_set_visibility"]; }; "/api/gen/{gen_id}/set_visibility/": { /** * Set Visibility * @description Set is_public visibility on a GeneratedClip. User must own clip. */ post: operations["studio_api_bots_gen_api_set_visibility"]; }; "/api/gen/{gen_id}/share_asset": { /** * Share Asset * @description Generate a sharable asset for a song. */ post: operations["studio_api_bots_gen_api_share_asset"]; }; "/api/gen/{gen_id}/share_asset/": { /** * Share Asset * @description Generate a sharable asset for a song. */ post: operations["studio_api_bots_gen_api_share_asset"]; }; "/api/gen/{gen_id}/share_asset/{asset_id}": { /** * Get Share Asset * @description Get the status of a share asset. */ get: operations["studio_api_bots_gen_api_get_share_asset"]; }; "/api/gen/{gen_id}/share_asset/{asset_id}/": { /** * Get Share Asset * @description Get the status of a share asset. */ get: operations["studio_api_bots_gen_api_get_share_asset"]; }; "/api/gen/{gen_id}/unlock-preview": { /** Unlock Preview */ post: operations["studio_api_bots_gen_api_unlock_preview"]; }; "/api/gen/{gen_id}/update_feedback_state": { /** * Update Feedback State * @description Update feedback state on UserReaction. */ post: operations["studio_api_bots_gen_api_update_feedback_state"]; }; "/api/gen/{gen_id}/update_feedback_state/": { /** * Update Feedback State * @description Update feedback state on UserReaction. */ post: operations["studio_api_bots_gen_api_update_feedback_state"]; }; "/api/gen/{gen_id}/update_flag_state": { /** * Update Flag State * @description Update flag state on UserReaction (and associated Generatedclip). */ post: operations["studio_api_bots_gen_api_update_flag_state"]; }; "/api/gen/{gen_id}/update_flag_state/": { /** * Update Flag State * @description Update flag state on UserReaction (and associated Generatedclip). */ post: operations["studio_api_bots_gen_api_update_flag_state"]; }; "/api/gen/{gen_id}/update_reaction_type": { /** * Update Reaction Type * @description Update reaction type on UserReaction (and associated GeneratedClip). */ post: operations["studio_api_bots_gen_api_update_reaction_type"]; }; "/api/gen/{gen_id}/update_reaction_type/": { /** * Update Reaction Type * @description Update reaction type on UserReaction (and associated GeneratedClip). */ post: operations["studio_api_bots_gen_api_update_reaction_type"]; }; "/api/generate/check-lyrics-copyright-infringement": { /** Check Lyrics Copyright Infringement */ post: operations["studio_api_bots_generate_api_check_lyrics_copyright_infringement"]; }; "/api/generate/check-lyrics-copyright-infringement/": { /** Check Lyrics Copyright Infringement */ post: operations["studio_api_bots_generate_api_check_lyrics_copyright_infringement"]; }; "/api/generate/clip/{clip_id}": { /** Get Clip */ get: operations["studio_api_bots_generate_api_get_clip"]; }; "/api/generate/clip/{clip_id}/": { /** Get Clip */ get: operations["studio_api_bots_generate_api_get_clip"]; }; "/api/generate/concat": { /** Concat Generations */ post: operations["studio_api_bots_generate_api_concat_generations"]; }; "/api/generate/concat/": { /** Concat Generations */ post: operations["studio_api_bots_generate_api_concat_generations"]; }; "/api/generate/concat/v2": { /** Concat Generations V2 */ post: operations["studio_api_bots_generate_api_concat_generations_v2"]; }; "/api/generate/concat/v2/": { /** Concat Generations V2 */ post: operations["studio_api_bots_generate_api_concat_generations_v2"]; }; "/api/generate/downsample-tags": { /** Downsample Prompt */ post: operations["studio_api_bots_generate_api_downsample_prompt"]; }; "/api/generate/downsample-tags/": { /** Downsample Prompt */ post: operations["studio_api_bots_generate_api_downsample_prompt"]; }; "/api/generate/existing-lyrics-by-id/{lyrics_id}": { /** Get Existing Lyrics By Id */ get: operations["studio_api_bots_generate_api_get_existing_lyrics_by_id"]; }; "/api/generate/existing-lyrics-by-id/{lyrics_id}/": { /** Get Existing Lyrics By Id */ get: operations["studio_api_bots_generate_api_get_existing_lyrics_by_id"]; }; "/api/generate/get_recommend_styles": { /** Get Recommend Styles */ get: operations["studio_api_bots_generate_api_get_recommend_styles"]; }; "/api/generate/get_recommend_styles/": { /** Get Recommend Styles */ get: operations["studio_api_bots_generate_api_get_recommend_styles"]; }; "/api/generate/lyrics": { /** Run Lyrics Generation */ post: operations["studio_api_bots_generate_api_run_lyrics_generation"]; }; "/api/generate/lyrics-infill": { /** Run Lyrics Infill */ post: operations["studio_api_bots_generate_api_run_lyrics_infill"]; }; "/api/generate/lyrics-infill/": { /** Run Lyrics Infill */ post: operations["studio_api_bots_generate_api_run_lyrics_infill"]; }; "/api/generate/lyrics-infill/redo": { /** Run Lyrics Infill Redo */ post: operations["studio_api_bots_generate_api_run_lyrics_infill_redo"]; }; "/api/generate/lyrics-infill/redo/": { /** Run Lyrics Infill Redo */ post: operations["studio_api_bots_generate_api_run_lyrics_infill_redo"]; }; "/api/generate/lyrics-infill/undo": { /** Run Lyrics Infill Undo */ post: operations["studio_api_bots_generate_api_run_lyrics_infill_undo"]; }; "/api/generate/lyrics-infill/undo/": { /** Run Lyrics Infill Undo */ post: operations["studio_api_bots_generate_api_run_lyrics_infill_undo"]; }; "/api/generate/lyrics-pair": { /** Run Lyrics Pair Generation */ post: operations["studio_api_bots_generate_api_run_lyrics_pair_generation"]; }; "/api/generate/lyrics-pair/": { /** Run Lyrics Pair Generation */ post: operations["studio_api_bots_generate_api_run_lyrics_pair_generation"]; }; "/api/generate/lyrics-pair/rate": { /** Rate Lyrics Pair */ post: operations["studio_api_bots_generate_api_rate_lyrics_pair"]; }; "/api/generate/lyrics-pair/rate/": { /** Rate Lyrics Pair */ post: operations["studio_api_bots_generate_api_rate_lyrics_pair"]; }; "/api/generate/lyrics/": { /** Run Lyrics Generation */ post: operations["studio_api_bots_generate_api_run_lyrics_generation"]; }; "/api/generate/lyrics/{lyrics_id}": { /** Get Lyrics Generation */ get: operations["studio_api_bots_generate_api_get_lyrics_generation"]; }; "/api/generate/lyrics/{lyrics_id}/": { /** Get Lyrics Generation */ get: operations["studio_api_bots_generate_api_get_lyrics_generation"]; }; "/api/generate/matrix": { /** Get Advanced Gen Params */ get: operations["studio_api_bots_generate_api_get_advanced_gen_params"]; }; "/api/generate/merge": { /** Merge Generations */ post: operations["studio_api_bots_generate_api_merge_generations"]; }; "/api/generate/merge/": { /** Merge Generations */ post: operations["studio_api_bots_generate_api_merge_generations"]; }; "/api/generate/requests": { /** Get Gen Requests */ get: operations["studio_api_bots_generate_api_get_gen_requests"]; }; "/api/generate/requests/": { /** Get Gen Requests */ get: operations["studio_api_bots_generate_api_get_gen_requests"]; }; "/api/generate/upsample": { /** Run Upsample */ post: operations["studio_api_bots_generate_api_run_upsample"]; }; "/api/generate/upsample-tags": { /** Upsample Tags */ post: operations["studio_api_bots_generate_api_upsample_tags"]; }; "/api/generate/upsample-tags/": { /** Upsample Tags */ post: operations["studio_api_bots_generate_api_upsample_tags"]; }; "/api/generate/upsample/": { /** Run Upsample */ post: operations["studio_api_bots_generate_api_run_upsample"]; }; "/api/generate/v2": { /** * Run Generation V2 * @description The entrypoint for older web clients and also mobile */ post: operations["studio_api_bots_generate_api_run_generation_v2"]; }; "/api/generate/v2-web": { /** * Run Generation V2 Web * @description The entrypoint for newer web clients */ post: operations["studio_api_bots_generate_api_run_generation_v2_web"]; }; "/api/generate/v2-web/": { /** * Run Generation V2 Web * @description The entrypoint for newer web clients */ post: operations["studio_api_bots_generate_api_run_generation_v2_web"]; }; "/api/generate/v2/": { /** * Run Generation V2 * @description The entrypoint for older web clients and also mobile */ post: operations["studio_api_bots_generate_api_run_generation_v2"]; }; "/api/generate/{clip_id}/describe": { /** Describe Upload */ post: operations["studio_api_bots_generate_api_describe_upload"]; }; "/api/generate/{clip_id}/describe/": { /** Describe Upload */ post: operations["studio_api_bots_generate_api_describe_upload"]; }; "/api/generate/{clip_id}/generate_sample_pack": { /** Generate Sample Pack */ post: operations["studio_api_bots_generate_api_generate_sample_pack"]; }; "/api/invite": { /** * Create Invite Session * @description Create an InviteHistory record for an invited user and their inviter. */ post: operations["studio_api_bots_invite_api_create_invite_session"]; }; "/api/invite/": { /** * Create Invite Session * @description Create an InviteHistory record for an invited user and their inviter. */ post: operations["studio_api_bots_invite_api_create_invite_session"]; }; "/api/invite/ios/promo_code": { /** * Redeem Promo Code * @description Redeem the promo code for the request user. * We use lower case promo codes in the db. * If successful, the user can log in, whether or not the promo code was used. */ post: operations["studio_api_bots_invite_ios_api_redeem_promo_code"]; }; "/api/invite/ios/promo_code/": { /** * Redeem Promo Code * @description Redeem the promo code for the request user. * We use lower case promo codes in the db. * If successful, the user can log in, whether or not the promo code was used. */ post: operations["studio_api_bots_invite_ios_api_redeem_promo_code"]; }; "/api/invite/ios/promo_code/{promo_code}": { /** * Get Inviter Data From Promo Code * @description Get the inviter handle and avatar image URL from the promo code * We use lower case promo codes in the db. */ get: operations["studio_api_bots_invite_ios_api_get_inviter_data_from_promo_code"]; }; "/api/invite/ios/promo_code/{promo_code}/": { /** * Get Inviter Data From Promo Code * @description Get the inviter handle and avatar image URL from the promo code * We use lower case promo codes in the db. */ get: operations["studio_api_bots_invite_ios_api_get_inviter_data_from_promo_code"]; }; "/api/invite/ios/promo_code_status": { /** * Get Promo Code Status * @description Get the number of redemptions left of the user's promo code. * We use lower case promo codes in the db. */ get: operations["studio_api_bots_invite_ios_api_get_promo_code_status"]; }; "/api/invite/ios/promo_code_status/": { /** * Get Promo Code Status * @description Get the number of redemptions left of the user's promo code. * We use lower case promo codes in the db. */ get: operations["studio_api_bots_invite_ios_api_get_promo_code_status"]; }; "/api/invite/ios/waitlist": { /** * Waitlist * @description Return True if the user is already on the waitlist or has just been added to the waitlist * as a result of this call (ie. no promo code exists for them yet). * Return False otherwise. */ post: operations["studio_api_bots_invite_ios_api_waitlist"]; }; "/api/invite/ios/waitlist/": { /** * Waitlist * @description Return True if the user is already on the waitlist or has just been added to the waitlist * as a result of this call (ie. no promo code exists for them yet). * Return False otherwise. */ post: operations["studio_api_bots_invite_ios_api_waitlist"]; }; "/api/invite/summary": { /** Get Summary */ get: operations["studio_api_bots_invite_api_get_summary"]; }; "/api/invite/summary/": { /** Get Summary */ get: operations["studio_api_bots_invite_api_get_summary"]; }; "/api/ip-address": { /** Get Ip Address */ get: operations["studio_api_bots_api_get_ip_address"]; }; "/api/list_beta_gens": { /** * List Beta Gens * @description Fetch and return a list of clips created by the current user that are marked as beta */ post: operations["studio_api_bots_api_list_beta_gens"]; }; "/api/list_beta_gens/": { /** * List Beta Gens * @description Fetch and return a list of clips created by the current user that are marked as beta */ post: operations["studio_api_bots_api_list_beta_gens"]; }; "/api/living_radio/{station_id}/ably-client-id": { /** Get Authed Ably Client Id */ get: operations["studio_api_living_radio_api_get_authed_ably_client_id"]; }; "/api/living_radio/{station_id}/ably-token": { /** Get Authed Ably Token */ get: operations["studio_api_living_radio_api_get_authed_ably_token"]; }; "/api/living_radio/{station_id}/anonymous-ably-token": { /** Get Anonymous Ably Token */ get: operations["studio_api_living_radio_api_get_anonymous_ably_token"]; }; "/api/living_radio/{station_id}/chat": { /** Send Chat Message */ post: operations["studio_api_living_radio_api_send_chat_message"]; }; "/api/living_radio/{station_id}/listener-count": { /** * Get Listener Count * @description Get the current listener count for a station using Ably's occupancy API. * This returns the actual number of connections to the chat channel. */ get: operations["studio_api_living_radio_api_get_listener_count"]; }; "/api/living_radio/{station_id}/listener-count/": { /** * Get Listener Count * @description Get the current listener count for a station using Ably's occupancy API. * This returns the actual number of connections to the chat channel. */ get: operations["studio_api_living_radio_api_get_listener_count"]; }; "/api/living_radio/{station_id}/song-list": { /** Get Station Id Song List */ get: operations["studio_api_living_radio_api_get_station_id_song_list"]; }; "/api/living_radio/{station_id}/song-list/": { /** Get Station Id Song List */ get: operations["studio_api_living_radio_api_get_station_id_song_list"]; }; "/api/living_radio/{station_id}/vote": { /** Vote For Style */ post: operations["studio_api_living_radio_api_vote_for_style"]; }; "/api/living_radio/{station_id}/vote-status": { /** Get Station Id Vote Status */ get: operations["studio_api_living_radio_api_get_station_id_vote_status"]; }; "/api/living_radio/{station_id}/vote-status/": { /** Get Station Id Vote Status */ get: operations["studio_api_living_radio_api_get_station_id_vote_status"]; }; "/api/living_radio/{station_id}/vote/": { /** Vote For Style */ post: operations["studio_api_living_radio_api_vote_for_style"]; }; "/api/moderation/ack-copyright-warning": { /** Acknowledge Warning */ post: operations["studio_api_moderation_api_acknowledge_warning"]; }; "/api/moderation/ack-copyright-warning/": { /** Acknowledge Warning */ post: operations["studio_api_moderation_api_acknowledge_warning"]; }; "/api/moderation/add-copyright-lyrics": { /** Add Copyright Lyrics */ post: operations["studio_api_moderation_api_add_copyright_lyrics"]; }; "/api/moderation/add-copyright-lyrics/": { /** Add Copyright Lyrics */ post: operations["studio_api_moderation_api_add_copyright_lyrics"]; }; "/api/moderation/delete-copyright-lyrics/{doc_id}": { /** Delete Copyright Lyrics */ delete: operations["studio_api_moderation_api_delete_copyright_lyrics"]; }; "/api/moderation/delete-copyright-lyrics/{doc_id}/": { /** Delete Copyright Lyrics */ delete: operations["studio_api_moderation_api_delete_copyright_lyrics"]; }; "/api/moderation/hive-moderation": { /** * Deprecated Hive Moderation * @deprecated * @description DEPRECATED: This endpoint has been moved to /moderation/hive/. * Please use the new endpoint instead. */ get: operations["studio_api_moderation_api_deprecated_hive_moderation"]; }; "/api/moderation/hive-moderation/": { /** * Deprecated Hive Moderation * @deprecated * @description DEPRECATED: This endpoint has been moved to /moderation/hive/. * Please use the new endpoint instead. */ get: operations["studio_api_moderation_api_deprecated_hive_moderation"]; }; "/api/moderation/hive-moderation/hook/{hook_id}": { /** * Deprecated Hive Moderation Hook * @deprecated * @description DEPRECATED: This endpoint has been moved to /moderation/hive/hook/{hook_id}. * Please use the new endpoint instead. */ get: operations["studio_api_moderation_api_deprecated_hive_moderation_hook"]; }; "/api/moderation/hive-moderation/hook/{hook_id}/": { /** * Deprecated Hive Moderation Hook * @deprecated * @description DEPRECATED: This endpoint has been moved to /moderation/hive/hook/{hook_id}. * Please use the new endpoint instead. */ get: operations["studio_api_moderation_api_deprecated_hive_moderation_hook"]; }; "/api/moderation/hive/": { /** Hive Moderation */ get: operations["studio_api_moderation_hive_moderation_api_hive_moderation"]; }; "/api/moderation/hive/hook/{hook_id}": { /** Hive Moderation Hook */ get: operations["studio_api_moderation_hive_moderation_api_hive_moderation_hook"]; }; "/api/moderation/hive/hook/{hook_id}/": { /** Hive Moderation Hook */ get: operations["studio_api_moderation_hive_moderation_api_hive_moderation_hook"]; }; "/api/moderation/hive/video-upload/{video_upload_id}": { /** * Get Video Upload Moderation Results * @description Get moderation results for a specific video upload ID */ get: operations["studio_api_moderation_hive_moderation_api_get_video_upload_moderation_results"]; }; "/api/moderation/hive/video-upload/{video_upload_id}/": { /** * Get Video Upload Moderation Results * @description Get moderation results for a specific video upload ID */ get: operations["studio_api_moderation_hive_moderation_api_get_video_upload_moderation_results"]; }; "/api/moderation/update-copyright-lyrics/{doc_id}": { /** Update Copyright Lyrics */ post: operations["studio_api_moderation_api_update_copyright_lyrics"]; }; "/api/moderation/update-copyright-lyrics/{doc_id}/": { /** Update Copyright Lyrics */ post: operations["studio_api_moderation_api_update_copyright_lyrics"]; }; "/api/music_player/playbar_state": { /** Get Playbar State */ get: operations["studio_api_music_player_api_get_playbar_state"]; /** Upsert Playbar State */ post: operations["studio_api_music_player_api_upsert_playbar_state"]; }; "/api/notification": { /** * Get Notifications * @description fetch the notifications. */ get: operations["studio_api_bots_notification_api_get_notifications"]; }; "/api/notification/": { /** * Get Notifications * @description fetch the notifications. */ get: operations["studio_api_bots_notification_api_get_notifications"]; }; "/api/notification/read": { /** * Mark Notifications As Read * @description Mark notifications as read. */ post: operations["studio_api_bots_notification_api_mark_notifications_as_read"]; }; "/api/notification/read/": { /** * Mark Notifications As Read * @description Mark notifications as read. */ post: operations["studio_api_bots_notification_api_mark_notifications_as_read"]; }; "/api/notification/suppress": { /** * Mark Notifications As Not Interested * @description Mark notifications as not showing up any more. */ post: operations["studio_api_bots_notification_api_mark_notifications_as_not_interested"]; }; "/api/notification/suppress/": { /** * Mark Notifications As Not Interested * @description Mark notifications as not showing up any more. */ post: operations["studio_api_bots_notification_api_mark_notifications_as_not_interested"]; }; "/api/notification/v2": { /** * Get Notifications V2 * @description fetch the notifications. */ get: operations["studio_api_bots_notification_api_get_notifications_v2"]; }; "/api/notification/v2/": { /** * Get Notifications V2 * @description fetch the notifications. */ get: operations["studio_api_bots_notification_api_get_notifications_v2"]; }; "/api/notification/v2/read": { /** * Mark Notifications As Read V2 * @description Mark notifications as read. */ post: operations["studio_api_bots_notification_api_mark_notifications_as_read_v2"]; }; "/api/notification/v2/read/": { /** * Mark Notifications As Read V2 * @description Mark notifications as read. */ post: operations["studio_api_bots_notification_api_mark_notifications_as_read_v2"]; }; "/api/oembed": { /** Get Oembed */ get: operations["studio_api_bots_oembed_api_get_oembed"]; }; "/api/oembed/enable-for-clip": { /** Enable Oembed For Clip */ get: operations["studio_api_bots_oembed_api_enable_oembed_for_clip"]; }; "/api/orpheus/sessions/user/{uid}": { /** * Get User Sessions * @description Get Orpheus chat sessions for a specific user (staff only). * * Returns the latest 200 sessions sorted by updated_at (newest first). * * Args: * uid: User ID to fetch sessions for * * Returns: * ListSessionResponse with up to 200 sessions */ get: operations["studio_api_bots_orpheus_api_get_user_sessions"]; }; "/api/orpheus/stream-chat": { /** * Stream Orpheus Chat * @description Orpheus backend entrypoint */ post: operations["studio_api_bots_orpheus_api_stream_orpheus_chat"]; }; "/api/orpheus/stream-chat/": { /** * Stream Orpheus Chat * @description Orpheus backend entrypoint */ post: operations["studio_api_bots_orpheus_api_stream_orpheus_chat"]; }; "/api/orpheus/stream-lyrics": { /** * Stream Lyrics * @description Orpheus backend entrypoint */ post: operations["studio_api_bots_orpheus_api_stream_lyrics"]; }; "/api/orpheus/stream-lyrics/": { /** * Stream Lyrics * @description Orpheus backend entrypoint */ post: operations["studio_api_bots_orpheus_api_stream_lyrics"]; }; "/api/persona/create": { /** Create Persona */ post: operations["studio_api_bots_persona_api_create_persona"]; }; "/api/persona/create/": { /** Create Persona */ post: operations["studio_api_bots_persona_api_create_persona"]; }; "/api/persona/edit-persona/{persona_id}": { /** Edit Persona */ put: operations["studio_api_bots_persona_api_edit_persona"]; }; "/api/persona/edit-persona/{persona_id}/": { /** Edit Persona */ put: operations["studio_api_bots_persona_api_edit_persona"]; }; "/api/persona/follow/{persona_id}": { /** * Follow Persona * @description Follow/unfollow a persona. */ post: operations["studio_api_bots_persona_api_follow_persona"]; }; "/api/persona/follow/{persona_id}/": { /** * Follow Persona * @description Follow/unfollow a persona. */ post: operations["studio_api_bots_persona_api_follow_persona"]; }; "/api/persona/get-followed-personas": { /** Get Followed Personas */ get: operations["studio_api_bots_persona_api_get_followed_personas"]; }; "/api/persona/get-followed-personas/": { /** Get Followed Personas */ get: operations["studio_api_bots_persona_api_get_followed_personas"]; }; "/api/persona/get-loved-personas": { /** Get Loved Personas */ get: operations["studio_api_bots_persona_api_get_loved_personas"]; }; "/api/persona/get-loved-personas/": { /** Get Loved Personas */ get: operations["studio_api_bots_persona_api_get_loved_personas"]; }; "/api/persona/get-persona-paginated/{persona_id}": { /** Get Persona Paginated */ get: operations["studio_api_bots_persona_api_get_persona_paginated"]; }; "/api/persona/get-persona-paginated/{persona_id}/": { /** Get Persona Paginated */ get: operations["studio_api_bots_persona_api_get_persona_paginated"]; }; "/api/persona/get-persona/{persona_id}": { /** Get Persona */ get: operations["studio_api_bots_persona_api_get_persona"]; }; "/api/persona/get-persona/{persona_id}/": { /** Get Persona */ get: operations["studio_api_bots_persona_api_get_persona"]; }; "/api/persona/get-personas": { /** Get Personas By User */ get: operations["studio_api_bots_persona_api_get_personas_by_user"]; }; "/api/persona/get-personas/": { /** Get Personas By User */ get: operations["studio_api_bots_persona_api_get_personas_by_user"]; }; "/api/persona/get-suno-personas": { /** Get Suno Personas */ get: operations["studio_api_bots_persona_api_get_suno_personas"]; }; "/api/persona/get-suno-personas/": { /** Get Suno Personas */ get: operations["studio_api_bots_persona_api_get_suno_personas"]; }; "/api/persona/get-trashed-personas": { /** Get Trashed Personas */ get: operations["studio_api_bots_persona_api_get_trashed_personas"]; }; "/api/persona/get-trashed-personas/": { /** Get Trashed Personas */ get: operations["studio_api_bots_persona_api_get_trashed_personas"]; }; "/api/persona/set_visibility/{persona_id}": { /** Set Persona Visibility */ put: operations["studio_api_bots_persona_api_set_persona_visibility"]; }; "/api/persona/set_visibility/{persona_id}/": { /** Set Persona Visibility */ put: operations["studio_api_bots_persona_api_set_persona_visibility"]; }; "/api/persona/trash-persona/{persona_id}": { /** Trash Persona */ put: operations["studio_api_bots_persona_api_trash_persona"]; }; "/api/persona/trash-persona/{persona_id}/": { /** Trash Persona */ put: operations["studio_api_bots_persona_api_trash_persona"]; }; "/api/persona/{persona_id}/love_status": { /** Get Persona Love Status */ get: operations["studio_api_bots_persona_api_get_persona_love_status"]; }; "/api/persona/{persona_id}/love_status/": { /** Get Persona Love Status */ get: operations["studio_api_bots_persona_api_get_persona_love_status"]; }; "/api/persona/{persona_id}/metadata": { /** Get Persona Metadata */ get: operations["studio_api_bots_persona_api_get_persona_metadata"]; }; "/api/persona/{persona_id}/metadata/": { /** Get Persona Metadata */ get: operations["studio_api_bots_persona_api_get_persona_metadata"]; }; "/api/persona/{persona_id}/toggle_love": { /** * Toggle Persona Love * @description Toggle love status on UserPersonaReaction. */ post: operations["studio_api_bots_persona_api_toggle_persona_love"]; }; "/api/persona/{persona_id}/toggle_love/": { /** * Toggle Persona Love * @description Toggle love status on UserPersonaReaction. */ post: operations["studio_api_bots_persona_api_toggle_persona_love"]; }; "/api/playlist/create": { /** Create Playlist */ post: operations["studio_api_bots_playlist_api_create_playlist"]; }; "/api/playlist/create/": { /** Create Playlist */ post: operations["studio_api_bots_playlist_api_create_playlist"]; }; "/api/playlist/liked_playlist": { /** Get User Liked Playlists */ get: operations["studio_api_bots_playlist_api_get_user_liked_playlists"]; }; "/api/playlist/liked_playlist/": { /** Get User Liked Playlists */ get: operations["studio_api_bots_playlist_api_get_user_liked_playlists"]; }; "/api/playlist/me": { /** * Get User Playlists * @description Get user's library of owned playlists. */ get: operations["studio_api_bots_playlist_api_get_user_playlists"]; }; "/api/playlist/me/": { /** * Get User Playlists * @description Get user's library of owned playlists. */ get: operations["studio_api_bots_playlist_api_get_user_playlists"]; }; "/api/playlist/me/clip_status": { /** Get User Playlists And Target Clip Status */ get: operations["studio_api_bots_playlist_api_get_user_playlists_and_target_clip_status"]; }; "/api/playlist/set_metadata": { /** Set Playlist Metadata */ post: operations["studio_api_bots_playlist_api_set_playlist_metadata"]; }; "/api/playlist/set_metadata/": { /** Set Playlist Metadata */ post: operations["studio_api_bots_playlist_api_set_playlist_metadata"]; }; "/api/playlist/trash": { /** Trash Playlist */ post: operations["studio_api_bots_playlist_api_trash_playlist"]; }; "/api/playlist/trash/": { /** Trash Playlist */ post: operations["studio_api_bots_playlist_api_trash_playlist"]; }; "/api/playlist/update_clips": { /** Update Playlist Clips */ post: operations["studio_api_bots_playlist_api_update_playlist_clips"]; }; "/api/playlist/update_clips/": { /** Update Playlist Clips */ post: operations["studio_api_bots_playlist_api_update_playlist_clips"]; }; "/api/playlist/{playlist_id}": { /** * Get Playlist * @description Get a playlist by ID. */ get: operations["studio_api_bots_playlist_api_get_playlist"]; }; "/api/playlist/{playlist_id}/": { /** * Get Playlist * @description Get a playlist by ID. */ get: operations["studio_api_bots_playlist_api_get_playlist"]; }; "/api/playlist/{playlist_id}/embedding": { /** * Get Playlist Embedding * @description Calculate vector for a playlist based on top 3 clips and store it in PlaylistAnalytics table */ get: operations["studio_api_bots_playlist_api_get_playlist_embedding"]; }; "/api/playlist/{playlist_id}/embedding/": { /** * Get Playlist Embedding * @description Calculate vector for a playlist based on top 3 clips and store it in PlaylistAnalytics table */ get: operations["studio_api_bots_playlist_api_get_playlist_embedding"]; }; "/api/playlist/{playlist_id}/regenerate": { /** * Regenerate Playlist * @description This api is very dangerous and should be used with caution. It will regenerate all the clips in the playlist. * Will limit the usage of api in staging only. If you want to promote this to production, please reach out to Jinhui. */ post: operations["studio_api_bots_playlist_api_regenerate_playlist"]; }; "/api/playlist/{playlist_id}/regenerate/": { /** * Regenerate Playlist * @description This api is very dangerous and should be used with caution. It will regenerate all the clips in the playlist. * Will limit the usage of api in staging only. If you want to promote this to production, please reach out to Jinhui. */ post: operations["studio_api_bots_playlist_api_regenerate_playlist"]; }; "/api/playlist_reaction/{playlist_id}/increment_play_count": { /** * Increment Play Count * @description Increment play count on UserPlaylistReaction (and associated Playlist). */ post: operations["studio_api_bots_playlist_reaction_api_increment_play_count"]; }; "/api/playlist_reaction/{playlist_id}/increment_play_count/": { /** * Increment Play Count * @description Increment play count on UserPlaylistReaction (and associated Playlist). */ post: operations["studio_api_bots_playlist_reaction_api_increment_play_count"]; }; "/api/playlist_reaction/{playlist_id}/set_visibility": { /** * Set Visibility * @description Set is_public visibility on a Playlist. User must own playlist. */ post: operations["studio_api_bots_playlist_reaction_api_set_visibility"]; }; "/api/playlist_reaction/{playlist_id}/set_visibility/": { /** * Set Visibility * @description Set is_public visibility on a Playlist. User must own playlist. */ post: operations["studio_api_bots_playlist_reaction_api_set_visibility"]; }; "/api/playlist_reaction/{playlist_id}/update_flag_state": { /** * Update Flag State * @description Update flag state on UserReaction (and associated Playlisteratedplaylist). */ post: operations["studio_api_bots_playlist_reaction_api_update_flag_state"]; }; "/api/playlist_reaction/{playlist_id}/update_flag_state/": { /** * Update Flag State * @description Update flag state on UserReaction (and associated Playlisteratedplaylist). */ post: operations["studio_api_bots_playlist_reaction_api_update_flag_state"]; }; "/api/playlist_reaction/{playlist_id}/update_reaction_type": { /** * Update Reaction Type * @description Update reaction type on UserPlaylistReaction (and associated Playlist). */ post: operations["studio_api_bots_playlist_reaction_api_update_reaction_type"]; }; "/api/playlist_reaction/{playlist_id}/update_reaction_type/": { /** * Update Reaction Type * @description Update reaction type on UserPlaylistReaction (and associated Playlist). */ post: operations["studio_api_bots_playlist_reaction_api_update_reaction_type"]; }; "/api/preferences/bulk-upsert-tasks": { /** Bulk Upsert Label Maker Tasks */ post: operations["studio_api_preferences_api_bulk_upsert_label_maker_tasks"]; }; "/api/preferences/clear-tasks/{project_id}": { /** Clear Label Maker Tasks */ delete: operations["studio_api_preferences_api_clear_label_maker_tasks"]; }; "/api/preferences/projects": { /** List Label Maker Projects */ get: operations["studio_api_preferences_api_list_label_maker_projects"]; }; "/api/preferences/skip-task/{task_id}": { /** Skip Label Maker Task */ post: operations["studio_api_preferences_api_skip_label_maker_task"]; }; "/api/preferences/submit": { /** Submit User Annotation */ post: operations["studio_api_preferences_api_submit_user_annotation"]; }; "/api/preferences/submit/": { /** Submit User Annotation */ post: operations["studio_api_preferences_api_submit_user_annotation"]; }; "/api/preferences/summary": { /** Get User Preference Summary */ get: operations["studio_api_preferences_api_get_user_preference_summary"]; }; "/api/preferences/tasks": { /** Get Next Label Maker Task */ get: operations["studio_api_preferences_api_get_next_label_maker_task"]; }; "/api/preferences/tasks/": { /** Get Next Label Maker Task */ get: operations["studio_api_preferences_api_get_next_label_maker_task"]; }; "/api/preferences/upsert-project": { /** Upsert Label Maker Project */ post: operations["studio_api_preferences_api_upsert_label_maker_project"]; }; "/api/prober/cache-check": { /** Cache Check */ get: operations["studio_api_prober_api_cache_check"]; }; "/api/prober/db-check": { /** Db Check */ get: operations["studio_api_prober_api_db_check"]; }; "/api/prober/migration-check": { /** Migration Check */ get: operations["studio_api_prober_api_migration_check"]; }; "/api/profiles": { /** Update Artist Profile */ post: operations["studio_api_bots_profiles_api_update_artist_profile"]; /** Patch Artist Profile */ patch: operations["studio_api_bots_profiles_api_patch_artist_profile"]; }; "/api/profiles/": { /** Update Artist Profile */ post: operations["studio_api_bots_profiles_api_update_artist_profile"]; /** Patch Artist Profile */ patch: operations["studio_api_bots_profiles_api_patch_artist_profile"]; }; "/api/profiles/block": { /** Block User */ post: operations["studio_api_bots_profiles_api_block_user"]; }; "/api/profiles/blocked_users": { /** List Blocked Users */ get: operations["studio_api_bots_profiles_api_list_blocked_users"]; }; "/api/profiles/callback/backfill-creator-common-tags": { /** Backfill Creator Common Tags */ post: operations["studio_api_bots_profiles_api_backfill_creator_common_tags"]; }; "/api/profiles/check-handle-availability/{handle}": { /** Check Display Name Availability */ get: operations["studio_api_bots_profiles_api_check_display_name_availability"]; }; "/api/profiles/flag": { /** Flag Artist Profile */ post: operations["studio_api_bots_profiles_api_flag_artist_profile"]; }; "/api/profiles/flag/": { /** Flag Artist Profile */ post: operations["studio_api_bots_profiles_api_flag_artist_profile"]; }; "/api/profiles/follow": { /** Follow Artist Profile */ post: operations["studio_api_bots_profiles_api_follow_artist_profile"]; }; "/api/profiles/follow/": { /** Follow Artist Profile */ post: operations["studio_api_bots_profiles_api_follow_artist_profile"]; }; "/api/profiles/followers": { /** Get Profiles Followers */ get: operations["studio_api_bots_profiles_api_get_profiles_followers"]; }; "/api/profiles/followers/": { /** Get Profiles Followers */ get: operations["studio_api_bots_profiles_api_get_profiles_followers"]; }; "/api/profiles/following": { /** Get Profiles Following */ get: operations["studio_api_bots_profiles_api_get_profiles_following"]; }; "/api/profiles/following/": { /** Get Profiles Following */ get: operations["studio_api_bots_profiles_api_get_profiles_following"]; }; "/api/profiles/info": { /** * Update Artist Profile Info * @description Update artist profile information in DynamoDB. * * Updates the artist profile fields stored in DynamoDB. */ put: operations["studio_api_bots_profiles_api_update_artist_profile_info"]; }; "/api/profiles/listen-history": { /** * Get Current User Listen History * @description Get the current authenticated user's listen history. * cursor: str | None - the cursor to paginate the listen history, defaults to None * limit: int - the number of clips to return */ get: operations["studio_api_bots_profiles_api_get_current_user_listen_history"]; }; "/api/profiles/pin-clip/{clip_id}": { /** Pin Clip */ post: operations["studio_api_bots_profiles_api_pin_clip"]; }; "/api/profiles/pinned-clips": { /** * Get Pinned Clips * @description Get all clips pinned by the current user. */ get: operations["studio_api_bots_profiles_api_get_pinned_clips"]; }; "/api/profiles/pinned-clips/": { /** * Get Pinned Clips * @description Get all clips pinned by the current user. */ get: operations["studio_api_bots_profiles_api_get_pinned_clips"]; }; "/api/profiles/top_clips": { /** Get User Top Clips */ get: operations["studio_api_bots_profiles_api_get_user_top_clips"]; }; "/api/profiles/top_clips/": { /** Get User Top Clips */ get: operations["studio_api_bots_profiles_api_get_user_top_clips"]; }; "/api/profiles/{handle}": { /** Get Artist Profile */ get: operations["studio_api_bots_profiles_api_get_artist_profile"]; }; "/api/profiles/{handle}/": { /** Get Artist Profile */ get: operations["studio_api_bots_profiles_api_get_artist_profile"]; }; "/api/profiles/{handle}/followers": { /** Get Profiles Followers By Handle */ get: operations["studio_api_bots_profiles_api_get_profiles_followers_by_handle"]; }; "/api/profiles/{handle}/followers/": { /** Get Profiles Followers By Handle */ get: operations["studio_api_bots_profiles_api_get_profiles_followers_by_handle"]; }; "/api/profiles/{handle}/following": { /** Get Profiles Following By Handle */ get: operations["studio_api_bots_profiles_api_get_profiles_following_by_handle"]; }; "/api/profiles/{handle}/following/": { /** Get Profiles Following By Handle */ get: operations["studio_api_bots_profiles_api_get_profiles_following_by_handle"]; }; "/api/profiles/{handle}/info": { /** * Get Artist Profile Info * @description Get artist profile information from DynamoDB. * * Returns the additional profile fields stored in DynamoDB. */ get: operations["studio_api_bots_profiles_api_get_artist_profile_info"]; }; "/api/profiles/{handle}/listen-history": { /** * Get Use Listen History * @description Get the user's listen history. * handle: str - the handle of the user * cursor: str | None - the cursor to paginate the listen history, defaults to None * limit: int - the number of clips to return */ get: operations["studio_api_bots_profiles_api_get_use_listen_history"]; }; "/api/profiles/{handle}/listen-history/": { /** * Get Use Listen History * @description Get the user's listen history. * handle: str - the handle of the user * cursor: str | None - the cursor to paginate the listen history, defaults to None * limit: int - the number of clips to return */ get: operations["studio_api_bots_profiles_api_get_use_listen_history"]; }; "/api/profiles/{handle}/recent_clips": { /** Get Artist Recent Clips */ get: operations["studio_api_bots_profiles_api_get_artist_recent_clips"]; }; "/api/profiles/{handle}/recent_clips/": { /** Get Artist Recent Clips */ get: operations["studio_api_bots_profiles_api_get_artist_recent_clips"]; }; "/api/profiles/{handle}/remixes-inspired": { /** * Get Remixes Inspired * @description Get remixes inspired by a user's public clips. * This returns public clips that have the user's public clips as non-owned parents. */ get: operations["studio_api_bots_profiles_api_get_remixes_inspired"]; }; "/api/profiles/{handle}/remixes-inspired-count": { /** * Get Remixes Inspired Count * @description Get the count of remixes inspired by a user's public clips. */ get: operations["studio_api_bots_profiles_api_get_remixes_inspired_count"]; }; "/api/profiles/{handle}/remixes-inspired-count/": { /** * Get Remixes Inspired Count * @description Get the count of remixes inspired by a user's public clips. */ get: operations["studio_api_bots_profiles_api_get_remixes_inspired_count"]; }; "/api/profiles/{handle}/remixes-inspired/": { /** * Get Remixes Inspired * @description Get remixes inspired by a user's public clips. * This returns public clips that have the user's public clips as non-owned parents. */ get: operations["studio_api_bots_profiles_api_get_remixes_inspired"]; }; "/api/profiles/{user_id}/create-tags": { /** Get Common Create Tags */ get: operations["studio_api_bots_profiles_api_get_common_create_tags"]; }; "/api/project": { /** Create Project */ post: operations["studio_api_bots_project_api_create_project"]; }; "/api/project/invites": { /** Get Invites */ get: operations["studio_api_bots_project_api_get_invites"]; }; "/api/project/invites/{invite_id}": { /** Respond To Invite */ put: operations["studio_api_bots_project_api_respond_to_invite"]; }; "/api/project/me": { /** * Get User Projects * @description Get user's library of owned projects. */ get: operations["studio_api_bots_project_api_get_user_projects"]; }; "/api/project/trash": { /** Trash Project */ post: operations["studio_api_bots_project_api_trash_project"]; }; "/api/project/{project_id}": { /** * Get Project * @description Get a project by ID. */ get: operations["studio_api_bots_project_api_get_project"]; }; "/api/project/{project_id}/ably-client-id": { /** Get Authed Ably Client Id */ get: operations["studio_api_bots_project_api_get_authed_ably_client_id"]; }; "/api/project/{project_id}/ably-token": { /** Get Authed Ably Token */ get: operations["studio_api_bots_project_api_get_authed_ably_token"]; }; "/api/project/{project_id}/ably-update": { /** Send Ably Update Project */ post: operations["studio_api_bots_project_api_send_ably_update_project"]; }; "/api/project/{project_id}/clips": { /** Update Project Clips */ post: operations["studio_api_bots_project_api_update_project_clips"]; }; "/api/project/{project_id}/collaborators": { /** Get Project Collaborators */ get: operations["studio_api_bots_project_api_get_project_collaborators"]; /** Remove Project Collaborator */ delete: operations["studio_api_bots_project_api_remove_project_collaborator"]; }; "/api/project/{project_id}/collaborators/me": { /** Remove Self From Project */ delete: operations["studio_api_bots_project_api_remove_self_from_project"]; }; "/api/project/{project_id}/invite": { /** Send Invite To Project */ post: operations["studio_api_bots_project_api_send_invite_to_project"]; }; "/api/project/{project_id}/metadata": { /** Set Project Metadata */ post: operations["studio_api_bots_project_api_set_project_metadata"]; }; "/api/project/{project_id}/pinned-clips": { /** * Get Project Pinned Clips * @description Get a project by ID. */ get: operations["studio_api_bots_project_api_get_project_pinned_clips"]; }; "/api/project/{project_id}/search": { /** * Search Project Clips * @description Search clips within a specific project using Elasticsearch */ get: operations["studio_api_bots_project_api_search_project_clips"]; }; "/api/prompts/": { /** Create Or Update Saved Prompt */ post: operations["studio_api_bots_prompts_api_create_or_update_saved_prompt"]; }; "/api/prompts/delete/": { /** Delete Saved Prompt */ post: operations["studio_api_bots_prompts_api_delete_saved_prompt"]; }; "/api/radio/tags": { /** Get Radio Tags */ get: operations["studio_api_bots_api_get_radio_tags"]; }; "/api/radio/tags/": { /** Get Radio Tags */ get: operations["studio_api_bots_api_get_radio_tags"]; }; "/api/radio/{tag}": { /** Get Radio */ get: operations["studio_api_bots_api_get_radio"]; }; "/api/radio/{tag}/": { /** Get Radio */ get: operations["studio_api_bots_api_get_radio"]; }; "/api/recommend/feedback/song/{clip_id}": { /** Update Song Feedback */ post: operations["studio_api_recommendations_api_update_song_feedback"]; /** Remove Song Feedback */ delete: operations["studio_api_recommendations_api_remove_song_feedback"]; }; "/api/recommend/hide-creator": { /** * Hide Creator * @description Hide or unhide a creator from recommendations. */ post: operations["studio_api_recommendations_api_hide_creator"]; }; "/api/recommend/similar-creators": { /** * Similar Creators * @description Get similar creators for a given user */ post: operations["studio_api_recommendations_api_similar_creators"]; }; "/api/recs": { /** Get Recommendations Endpoint */ get: operations["studio_api_bots_recommendation_api_get_recommendations_endpoint"]; }; "/api/recs/": { /** Get Recommendations Endpoint */ get: operations["studio_api_bots_recommendation_api_get_recommendations_endpoint"]; }; "/api/refresh_recommend_styles": { /** Refresh Recommend Styles */ post: operations["studio_api_bots_api_refresh_recommend_styles"]; }; "/api/refresh_recommend_styles/": { /** Refresh Recommend Styles */ post: operations["studio_api_bots_api_refresh_recommend_styles"]; }; "/api/render-status-check": { /** Get Status */ get: operations["studio_api_bots_api_get_status"]; }; "/api/search": { /** Search */ post: operations["studio_api_search_api_search"]; }; "/api/search/": { /** Search */ post: operations["studio_api_search_api_search"]; }; "/api/search/hashtag_suggestions": { /** Search Hashtag Suggestions */ post: operations["studio_api_search_api_search_hashtag_suggestions"]; }; "/api/search/hashtag_trending": { /** Search Trending Hashtags */ post: operations["studio_api_search_api_search_trending_hashtags"]; }; "/api/search/is_this_us": { /** Is This Us */ post: operations["studio_api_search_api_is_this_us"]; }; "/api/search/is_this_us/": { /** Is This Us */ post: operations["studio_api_search_api_is_this_us"]; }; "/api/search/update_clip_embedding_v2": { /** Update Clip Embedding V2 */ post: operations["studio_api_search_api_update_clip_embedding_v2"]; }; "/api/search/update_clip_embedding_v2/": { /** Update Clip Embedding V2 */ post: operations["studio_api_search_api_update_clip_embedding_v2"]; }; "/api/search/update_lyrics_embedding": { /** * Update Lyrics Embedding * @description Callback for the lyrics embedding update. */ post: operations["studio_api_search_api_update_lyrics_embedding"]; }; "/api/search/update_text_embedding": { /** Update Text Embedding */ post: operations["studio_api_search_api_update_text_embedding"]; }; "/api/search/update_text_embedding/": { /** Update Text Embedding */ post: operations["studio_api_search_api_update_text_embedding"]; }; "/api/search/users": { /** Search Users */ post: operations["studio_api_search_api_search_users"]; }; "/api/session": { /** Get Me */ get: operations["studio_api_bots_api_get_me"]; }; "/api/session/": { /** Get Me */ get: operations["studio_api_bots_api_get_me"]; }; "/api/share/attribute": { /** * Attribute User To Share * @description Create share attribution record linking a user to the share that led to it */ post: operations["studio_api_growth_share_api_attribute_user_to_share"]; }; "/api/share/attribute/": { /** * Attribute User To Share * @description Create share attribution record linking a user to the share that led to it */ post: operations["studio_api_growth_share_api_attribute_user_to_share"]; }; "/api/share/code/{share_id}": { /** * Get Share Details * @description Get details about a share by its ID */ get: operations["studio_api_growth_share_api_get_share_details"]; }; "/api/share/link": { /** * Get Share Link * @description Create a share link record */ post: operations["studio_api_growth_share_api_get_share_link"]; /** * Update Share Link * @description Update a share link record */ patch: operations["studio_api_growth_share_api_update_share_link"]; }; "/api/share/link/": { /** * Get Share Link * @description Create a share link record */ post: operations["studio_api_growth_share_api_get_share_link"]; /** * Update Share Link * @description Update a share link record */ patch: operations["studio_api_growth_share_api_update_share_link"]; }; "/api/signout": { /** Signout */ post: operations["studio_api_bots_api_signout"]; }; "/api/signout/": { /** Signout */ post: operations["studio_api_bots_api_signout"]; }; "/api/social/following-clip-feed": { /** Folllowing Feed */ post: operations["studio_api_social_api_folllowing_feed"]; }; "/api/social/following-clip-feed/": { /** Folllowing Feed */ post: operations["studio_api_social_api_folllowing_feed"]; }; "/api/social/following-feed": { /** Get Following Feed Items */ post: operations["studio_api_social_api_get_following_feed_items"]; }; "/api/social/following-feed/": { /** Get Following Feed Items */ post: operations["studio_api_social_api_get_following_feed_items"]; }; "/api/social/recommend-users": { /** * Recommend Users * @description api post request for 'Recommend Users' section of Homepage * Post request have more controls on inputs with nested data structure. * returns: list of SimpleProfileInfoSchemas (can be empty) of each user to be displayed. * users must be initialized in User model to be pulled. */ post: operations["studio_api_social_api_recommend_users"]; }; "/api/social/recommend-users/": { /** * Recommend Users * @description api post request for 'Recommend Users' section of Homepage * Post request have more controls on inputs with nested data structure. * returns: list of SimpleProfileInfoSchemas (can be empty) of each user to be displayed. * users must be initialized in User model to be pulled. */ post: operations["studio_api_social_api_recommend_users"]; }; "/api/songify/beta/create-video": { /** Create Songify Video */ post: operations["studio_api_songify_api_create_songify_video"]; }; "/api/songify/beta/delete-video": { /** Delete Songify Video */ delete: operations["studio_api_songify_api_delete_songify_video"]; }; "/api/songify/beta/update-video": { /** Update Songify Video */ patch: operations["studio_api_songify_api_update_songify_video"]; }; "/api/songify/create": { /** * Create Songify Generation * @description v2 endpoint for creating a songify generation (v1 endpoint is in the modal stub itself) */ post: operations["studio_api_songify_api_create_songify_generation"]; }; "/api/songify/{songify_id}": { /** Get Songify Status */ get: operations["studio_api_songify_api_get_songify_status"]; /** Set Songify Status */ patch: operations["studio_api_songify_api_set_songify_status"]; }; "/api/statsig/autocomplete": { /** Resolve Autocomplete */ post: operations["studio_api_bots_statsig_api_resolve_autocomplete"]; }; "/api/statsig/experiment/": { /** Resolve Experiment */ post: operations["studio_api_bots_statsig_api_resolve_experiment"]; }; "/api/statsig/id": { /** Resolve Id */ post: operations["studio_api_bots_statsig_api_resolve_id"]; }; "/api/studio/access-invitations": { /** * Get Access Invitations * @description Get paginated list of studio invitation codes. * Staff users see all invitations, regular users see only their own. */ get: operations["studio_api_bots_studio_api_get_access_invitations"]; }; "/api/studio/access-status": { /** Get Access Status */ get: operations["studio_api_bots_studio_api_get_access_status"]; }; "/api/studio/access-summary": { /** * Get Access Summary * @description Get summary statistics for studio access. Staff only. */ get: operations["studio_api_bots_studio_api_get_access_summary"]; }; "/api/studio/bulk-admit-users": { /** * Bulk Admit Users * @description Bulk admit users to studio. */ post: operations["studio_api_bots_studio_api_bulk_admit_users"]; }; "/api/studio/code": { /** * Get Code * @description Get a Studio invitation code. */ get: operations["studio_api_bots_studio_api_get_code"]; }; "/api/studio/create-or-load-project-for-clip/{clip_id}": { /** * Create Or Load Studio Project For Clip * @description Create a new Studio project for the current user, with the given clip as the first clip in the project. * * Args: * clip_id: The ID of the clip to create the project for */ post: operations["studio_api_bots_studio_api_create_or_load_studio_project_for_clip"]; }; "/api/studio/create-project": { /** * Create Studio Project * @description Create a new Studio project for the current user. * * Args: * title: The title of the project */ post: operations["studio_api_bots_studio_api_create_studio_project"]; }; "/api/studio/join-waitlist": { /** * Join Waitlist * @description Join the Studio waitlist. */ post: operations["studio_api_bots_studio_api_join_waitlist"]; }; "/api/studio/list-projects": { /** * List Projects * @description Get a list of StudioProjects owned by the current user. * * Args: * cursor: Optional cursor for pagination * limit: Number of items to return per page (default: 20) * name: Optional filter by project name * archived: Optional filter by archived status (default: False) */ get: operations["studio_api_bots_studio_api_list_projects"]; }; "/api/studio/list-projects/": { /** * List Projects * @description Get a list of StudioProjects owned by the current user. * * Args: * cursor: Optional cursor for pagination * limit: Number of items to return per page (default: 20) * name: Optional filter by project name * archived: Optional filter by archived status (default: False) */ get: operations["studio_api_bots_studio_api_list_projects"]; }; "/api/studio/project/{project_id}": { /** * Get Studio Project By Id * @description Get a single StudioProject by ID. * * Args: * project_id: The ID of the project to retrieve */ get: operations["studio_api_bots_studio_api_get_studio_project_by_id"]; }; "/api/studio/project/{project_id}/archive": { /** * Archive Studio Project * @description Archive a Studio project. * * Args: * project_id: The ID of the project to archive */ post: operations["studio_api_bots_studio_api_archive_studio_project"]; }; "/api/studio/project/{project_id}/archive/": { /** * Archive Studio Project * @description Archive a Studio project. * * Args: * project_id: The ID of the project to archive */ post: operations["studio_api_bots_studio_api_archive_studio_project"]; }; "/api/studio/project/{project_id}/unarchive": { /** * Unarchive Studio Project * @description Unarchive a Studio project. * * Args: * project_id: The ID of the project to unarchive */ post: operations["studio_api_bots_studio_api_unarchive_studio_project"]; }; "/api/studio/project/{project_id}/unarchive/": { /** * Unarchive Studio Project * @description Unarchive a Studio project. * * Args: * project_id: The ID of the project to unarchive */ post: operations["studio_api_bots_studio_api_unarchive_studio_project"]; }; "/api/studio/project_revision/{revision_id}": { /** * Get Studio Project Revision * @description Get a single StudioProjectVersion by ID with hybrid payload reading. */ get: operations["studio_api_bots_studio_api_get_studio_project_revision"]; }; "/api/studio/project_revision/{revision_id}/clone": { /** * Clone Studio Project * @description Clone another user's studio project. * * Args: * project_id: The ID of the project to clone * data: Contains optional title for the cloned project */ post: operations["studio_api_bots_studio_api_clone_studio_project"]; }; "/api/studio/redeem-code": { /** * Redeem Code * @description Redeem a Studio invitation code. */ post: operations["studio_api_bots_studio_api_redeem_code"]; }; "/api/studio/render-state": { /** * Render State * @description Render a project state to generate a clip. * * Args: * data: Contains state, start_beats, and end_beats to render */ post: operations["studio_api_bots_studio_api_render_state"]; }; "/api/studio/render-state/": { /** * Render State * @description Render a project state to generate a clip. * * Args: * data: Contains state, start_beats, and end_beats to render */ post: operations["studio_api_bots_studio_api_render_state"]; }; "/api/studio/save-project": { /** * Save Studio Project * @description Save a new version of a Studio project with DynamoDB payload migration. * * Args: * data: Contains project_id and state to save */ post: operations["studio_api_bots_studio_api_save_studio_project"]; }; "/api/studio/sudo-delete-codes": { /** * Delete Codes * @description Delete a Studio invitation code for a batch of users. */ delete: operations["studio_api_bots_studio_api_delete_codes"]; }; "/api/studio/sudo-generate-codes": { /** * Generate Codes * @description Generate a Studio invitation code for a batch of users. */ post: operations["studio_api_bots_studio_api_generate_codes"]; }; "/api/studio/verify-code": { /** * Verify Code * @description Verify a Studio invitation code. */ get: operations["studio_api_bots_studio_api_verify_code"]; }; "/api/studio/waitlist-status": { /** * Get Waitlist Status * @description Check if the user is in the Studio waitlist and get waitlist information. */ get: operations["studio_api_bots_studio_api_get_waitlist_status"]; }; "/api/studio/{project_id}/version/{version_id}": { /** Get Version State */ get: operations["studio_api_bots_studio_api_get_version_state"]; }; "/api/studio/{project_id}/versions": { /** * Get Studio Project Versions * @description Get the versions for a Studio project. */ get: operations["studio_api_bots_studio_api_get_studio_project_versions"]; }; "/api/sunoverse/embed-genres": { /** Embed Genre */ get: operations["studio_api_sunoverse_api_embed_genre"]; }; "/api/sunoverse/embed-my-songs": { /** Embed My Songs */ get: operations["studio_api_sunoverse_api_embed_my_songs"]; }; "/api/survey/admin/survey-questions": { /** * Get Survey Questions * @description Get survey questions - all, by group, or by ID (Staff only) */ get: operations["studio_api_survey_api_get_survey_questions"]; /** * Create Survey Question * @description Create a new survey question (Staff only) */ post: operations["studio_api_survey_api_create_survey_question"]; /** * Update Survey Question * @description Update question text, options, group, or type (Staff only) */ patch: operations["studio_api_survey_api_update_survey_question"]; }; "/api/survey/survey-questions/{group_id}": { /** * Get Public Survey Questions * @description Returns an array of active questions for this group */ get: operations["studio_api_survey_api_get_public_survey_questions"]; }; "/api/survey/survey-responses": { /** * Create Survey Response * @description Submit a user's answer */ post: operations["studio_api_survey_api_create_survey_response"]; }; "/api/survey/survey-responses/bulk": { /** * Create Bulk Survey Responses * @description Submit multiple survey responses at once */ post: operations["studio_api_survey_api_create_bulk_survey_responses"]; }; "/api/survey/survey-responses/{response_id}": { /** * Delete Survey Response * @description Allow users to revoke their answers (Only for their own user_id) */ delete: operations["studio_api_survey_api_delete_survey_response"]; /** * Update Survey Response * @description Update an existing response */ patch: operations["studio_api_survey_api_update_survey_response"]; }; "/api/tags/recommend": { /** Recommend Tags */ post: operations["studio_api_tag_recommendations_api_recommend_tags"]; }; "/api/trending": { /** * Get Trending Playlist Endpoint * @description api get request for Homepage * Returns: PlaylistSchema of global trending playlist (id hardcoded in constants.py) */ get: operations["studio_api_bots_api_get_trending_playlist_endpoint"]; }; "/api/trending/": { /** * Get Trending Playlist Endpoint * @description api get request for Homepage * Returns: PlaylistSchema of global trending playlist (id hardcoded in constants.py) */ get: operations["studio_api_bots_api_get_trending_playlist_endpoint"]; }; "/api/trending/en": { /** * Get Trending En Playlist Endpoint * @description api get request for English-language trending playlist * Returns: PlaylistSchema of global EN trending playlist (id hardcoded in constants.py) */ get: operations["studio_api_bots_api_get_trending_en_playlist_endpoint"]; }; "/api/trending/en/": { /** * Get Trending En Playlist Endpoint * @description api get request for English-language trending playlist * Returns: PlaylistSchema of global EN trending playlist (id hardcoded in constants.py) */ get: operations["studio_api_bots_api_get_trending_en_playlist_endpoint"]; }; "/api/trending/en/v2": { /** * Get Trending Playlist En V2 Endpoint * @description Returns: PlaylistSchema of trending v2 EN playlist */ get: operations["studio_api_bots_api_get_trending_playlist_en_v2_endpoint"]; }; "/api/trending/en/v2/": { /** * Get Trending Playlist En V2 Endpoint * @description Returns: PlaylistSchema of trending v2 EN playlist */ get: operations["studio_api_bots_api_get_trending_playlist_en_v2_endpoint"]; }; "/api/trending/metaplaylist": { /** * Get Trending Metaplaylist Endpoint * @description api get request for trending metaplaylist * Returns: list of PlaylistSchemas of trending playlists */ get: operations["studio_api_bots_api_get_trending_metaplaylist_endpoint"]; }; "/api/trending/metaplaylist/": { /** * Get Trending Metaplaylist Endpoint * @description api get request for trending metaplaylist * Returns: list of PlaylistSchemas of trending playlists */ get: operations["studio_api_bots_api_get_trending_metaplaylist_endpoint"]; }; "/api/trending/new": { /** * Get New Playlist Endpoint * @description api get request for New playlist * Returns: PlaylistSchema of global New playlist (id hardcoded in constants.py) */ get: operations["studio_api_bots_api_get_new_playlist_endpoint"]; }; "/api/trending/new/": { /** * Get New Playlist Endpoint * @description api get request for New playlist * Returns: PlaylistSchema of global New playlist (id hardcoded in constants.py) */ get: operations["studio_api_bots_api_get_new_playlist_endpoint"]; }; "/api/trending/top/{period}": { /** * Get Top Playlist Endpoint * @description api get request for Top playlist * Returns: PlaylistSchema of a global Top playlist (weekly, monthly, yearly or alltime). */ get: operations["studio_api_bots_api_get_top_playlist_endpoint"]; }; "/api/trending/top/{period}/": { /** * Get Top Playlist Endpoint * @description api get request for Top playlist * Returns: PlaylistSchema of a global Top playlist (weekly, monthly, yearly or alltime). */ get: operations["studio_api_bots_api_get_top_playlist_endpoint"]; }; "/api/trending/v2": { /** * Get Trending Playlist V2 Endpoint * @description Returns: PlaylistSchema of trending v2 ALL playlist */ get: operations["studio_api_bots_api_get_trending_playlist_v2_endpoint"]; }; "/api/trending/v2/": { /** * Get Trending Playlist V2 Endpoint * @description Returns: PlaylistSchema of trending v2 ALL playlist */ get: operations["studio_api_bots_api_get_trending_playlist_v2_endpoint"]; }; "/api/update_user_config": { /** Update User Config */ post: operations["studio_api_bots_api_update_user_config"]; }; "/api/uploads/audio": { /** Start Audio Upload */ post: operations["studio_api_bots_uploads_api_start_audio_upload"]; }; "/api/uploads/audio/": { /** Start Audio Upload */ post: operations["studio_api_bots_uploads_api_start_audio_upload"]; }; "/api/uploads/audio/{upload_id}": { /** Get Audio Upload Status */ get: operations["studio_api_bots_uploads_api_get_audio_upload_status"]; }; "/api/uploads/audio/{upload_id}/": { /** Get Audio Upload Status */ get: operations["studio_api_bots_uploads_api_get_audio_upload_status"]; }; "/api/uploads/audio/{upload_id}/initialize-clip": { /** Initialize Upload Clip */ post: operations["studio_api_bots_uploads_api_initialize_upload_clip"]; }; "/api/uploads/audio/{upload_id}/initialize-clip/": { /** Initialize Upload Clip */ post: operations["studio_api_bots_uploads_api_initialize_upload_clip"]; }; "/api/uploads/audio/{upload_id}/initialize-stem-mix-clip": { /** Initialize Stem Mix Upload Clip */ post: operations["studio_api_bots_uploads_api_initialize_stem_mix_upload_clip"]; }; "/api/uploads/audio/{upload_id}/upload-finish": { /** Finish S3 Upload Audio */ post: operations["studio_api_bots_uploads_api_finish_s3_upload_audio"]; }; "/api/uploads/audio/{upload_id}/upload-finish/": { /** Finish S3 Upload Audio */ post: operations["studio_api_bots_uploads_api_finish_s3_upload_audio"]; }; "/api/uploads/image": { /** Start Image Upload */ post: operations["studio_api_bots_uploads_api_start_image_upload"]; }; "/api/uploads/image/": { /** Start Image Upload */ post: operations["studio_api_bots_uploads_api_start_image_upload"]; }; "/api/uploads/video": { /** Start Video Upload */ post: operations["studio_api_bots_uploads_api_start_video_upload"]; }; "/api/uploads/video-output/{upload_id}": { /** Process Video Output */ post: operations["studio_api_bots_uploads_api_process_video_output"]; }; "/api/uploads/video-output/{upload_id}/": { /** Process Video Output */ post: operations["studio_api_bots_uploads_api_process_video_output"]; }; "/api/uploads/video/": { /** Start Video Upload */ post: operations["studio_api_bots_uploads_api_start_video_upload"]; }; "/api/uploads/video/{upload_id}": { /** Get Video Upload Status */ get: operations["studio_api_bots_uploads_api_get_video_upload_status"]; }; "/api/uploads/video/{upload_id}/": { /** Get Video Upload Status */ get: operations["studio_api_bots_uploads_api_get_video_upload_status"]; }; "/api/uploads/video/{upload_id}/initialize-clip": { /** Initialize Upload Clip */ post: operations["studio_api_bots_uploads_api_initialize_upload_clip"]; }; "/api/uploads/video/{upload_id}/initialize-clip/": { /** Initialize Upload Clip */ post: operations["studio_api_bots_uploads_api_initialize_upload_clip"]; }; "/api/uploads/video/{upload_id}/upload-finish": { /** Finish S3 Upload Video */ post: operations["studio_api_bots_uploads_api_finish_s3_upload_video"]; }; "/api/uploads/video/{upload_id}/upload-finish/": { /** Finish S3 Upload Video */ post: operations["studio_api_bots_uploads_api_finish_s3_upload_video"]; }; "/api/user/accept_custom_mode_tos": { /** * Accept Custom Mode Tos * @description Accept TOS for custom mode lyrics. */ post: operations["studio_api_bots_user_api_accept_custom_mode_tos"]; }; "/api/user/accept_custom_mode_tos/": { /** * Accept Custom Mode Tos * @description Accept TOS for custom mode lyrics. */ post: operations["studio_api_bots_user_api_accept_custom_mode_tos"]; }; "/api/user/accept_timbaland_terms": { /** * Accept Timbaland Terms * @description Accept Timbaland terms for the user. */ post: operations["studio_api_bots_user_api_accept_timbaland_terms"]; }; "/api/user/accept_timbaland_terms/": { /** * Accept Timbaland Terms * @description Accept Timbaland terms for the user. */ post: operations["studio_api_bots_user_api_accept_timbaland_terms"]; }; "/api/user/create_session_id": { /** * Create Session Id * @description Create a session id for the user. * * If a session id is already created, return the cached session id and extend the session length to 15 mins. */ post: operations["studio_api_bots_user_api_create_session_id"]; }; "/api/user/create_session_id/": { /** * Create Session Id * @description Create a session id for the user. * * If a session id is already created, return the cached session id and extend the session length to 15 mins. */ post: operations["studio_api_bots_user_api_create_session_id"]; }; "/api/user/delete-account": { /** * Delete User Account * @description Delete the logged-in user's account. */ post: operations["studio_api_bots_user_api_delete_user_account"]; }; "/api/user/delete-account/": { /** * Delete User Account * @description Delete the logged-in user's account. */ post: operations["studio_api_bots_user_api_delete_user_account"]; }; "/api/user/delete_phone_number": { /** Delete Phone Number */ post: operations["studio_api_bots_user_api_delete_phone_number"]; }; "/api/user/delete_phone_number/": { /** Delete Phone Number */ post: operations["studio_api_bots_user_api_delete_phone_number"]; }; "/api/user/extend_session_id": { /** Extend Session Id */ post: operations["studio_api_bots_user_api_extend_session_id"]; }; "/api/user/extend_session_id/": { /** Extend Session Id */ post: operations["studio_api_bots_user_api_extend_session_id"]; }; "/api/user/find_existing_user_by_phone": { /** Find Existing User By Phone */ post: operations["studio_api_bots_user_api_find_existing_user_by_phone"]; }; "/api/user/find_existing_user_by_phone/": { /** Find Existing User By Phone */ post: operations["studio_api_bots_user_api_find_existing_user_by_phone"]; }; "/api/user/get-creator-info/{creator_id}": { /** * Get Creator Info * @description the logged-in user's account. */ get: operations["studio_api_bots_user_api_get_creator_info"]; }; "/api/user/get_user_session_id": { /** Get User Session Id */ get: operations["studio_api_bots_user_api_get_user_session_id"]; }; "/api/user/get_user_session_id/": { /** Get User Session Id */ get: operations["studio_api_bots_user_api_get_user_session_id"]; }; "/api/user/me": { /** * Get User Profile * @description Get the current user's personal profile, including birthday, email, phone number, etc. * * This endpoint is only available for authenticated users. */ get: operations["studio_api_bots_user_api_get_user_profile"]; }; "/api/user/me/": { /** * Get User Profile * @description Get the current user's personal profile, including birthday, email, phone number, etc. * * This endpoint is only available for authenticated users. */ get: operations["studio_api_bots_user_api_get_user_profile"]; }; "/api/user/record_session_id": { /** Record Session Id */ post: operations["studio_api_bots_user_api_record_session_id"]; }; "/api/user/record_session_id/": { /** Record Session Id */ post: operations["studio_api_bots_user_api_record_session_id"]; }; "/api/user/update_phone_number": { /** Update Phone Number */ post: operations["studio_api_bots_user_api_update_phone_number"]; }; "/api/user/update_phone_number/": { /** Update Phone Number */ post: operations["studio_api_bots_user_api_update_phone_number"]; }; "/api/user/update_user_config": { /** Update User Config */ post: operations["studio_api_bots_user_api_update_user_config"]; }; "/api/user/update_user_config/": { /** Update User Config */ post: operations["studio_api_bots_user_api_update_user_config"]; }; "/api/user/user_config": { /** User Config */ post: operations["studio_api_bots_user_api_user_config"]; }; "/api/user/user_config/": { /** User Config */ post: operations["studio_api_bots_user_api_user_config"]; }; "/api/user_actions/action_check": { /** * Action Check * @description Action check whether we need to add captcha check */ post: operations["studio_api_user_actions_api_action_check"]; }; "/api/user_actions/action_check/": { /** * Action Check * @description Action check whether we need to add captcha check */ post: operations["studio_api_user_actions_api_action_check"]; }; "/api/user_actions/user_check": { /** Is Bot Check */ post: operations["studio_api_user_actions_api_is_bot_check"]; }; "/api/user_actions/user_check/": { /** Is Bot Check */ post: operations["studio_api_user_actions_api_is_bot_check"]; }; "/api/user_config": { /** Get User Config */ get: operations["studio_api_bots_api_get_user_config"]; }; "/api/users/merge_accounts": { /** Merge Accounts View */ post: operations["studio_api_bots_api_merge_accounts_view"]; }; "/api/users/merge_accounts/": { /** Merge Accounts View */ post: operations["studio_api_bots_api_merge_accounts_view"]; }; "/api/v2/external/clips": { /** Get Clips External */ get: operations["studio_api_bots_external_api_get_clips_external"]; }; "/api/v2/external/clips-v2": { /** * Get Clips External Auth * @description Retrieve clips by IDs using external authentication. */ get: operations["studio_api_bots_external_api_get_clips_external_auth"]; }; "/api/v2/external/clips-v2/": { /** * Get Clips External Auth * @description Retrieve clips by IDs using external authentication. */ get: operations["studio_api_bots_external_api_get_clips_external_auth"]; }; "/api/v2/external/clips/": { /** Get Clips External */ get: operations["studio_api_bots_external_api_get_clips_external"]; }; "/api/v2/external/clips/{clip_id}/aligned-lyrics": { /** * Get Aligned Lyrics External * @description Get aligned lyrics for a clip via external API. */ get: operations["studio_api_bots_external_api_get_aligned_lyrics_external"]; }; "/api/v2/external/clips/{clip_id}/aligned-lyrics/": { /** * Get Aligned Lyrics External * @description Get aligned lyrics for a clip via external API. */ get: operations["studio_api_bots_external_api_get_aligned_lyrics_external"]; }; "/api/v2/external/generate": { /** Run Generation Integration */ post: operations["studio_api_bots_external_api_run_generation_integration"]; }; "/api/v2/external/generate-v2": { /** Generate External */ post: operations["studio_api_bots_external_api_generate_external"]; }; "/api/v2/external/generate-v2/": { /** Generate External */ post: operations["studio_api_bots_external_api_generate_external"]; }; "/api/v2/external/generate/": { /** Run Generation Integration */ post: operations["studio_api_bots_external_api_run_generation_integration"]; }; "/api/v2/external/generate/lyrics": { /** * Generate Anonymous Lyrics * @description Generate lyrics from a prompt with Cloudflare Turnstile verification. */ post: operations["studio_api_bots_external_api_generate_anonymous_lyrics"]; }; "/api/v2/external/hackmit/clips": { /** * Get Clips Hackmit * @description Get clips for HackMIT participants. */ get: operations["studio_api_bots_hackmit_api_get_clips_hackmit"]; }; "/api/v2/external/hackmit/clips/": { /** * Get Clips Hackmit * @description Get clips for HackMIT participants. */ get: operations["studio_api_bots_hackmit_api_get_clips_hackmit"]; }; "/api/v2/external/hackmit/generate": { /** * Generate Hackmit * @description Generate music for HackMIT participants. * Automatically uses chirp-auk-turbo model and tracks usage. */ post: operations["studio_api_bots_hackmit_api_generate_hackmit"]; }; "/api/v2/external/hackmit/generate/": { /** * Generate Hackmit * @description Generate music for HackMIT participants. * Automatically uses chirp-auk-turbo model and tracks usage. */ post: operations["studio_api_bots_hackmit_api_generate_hackmit"]; }; "/api/v2/external/hackmit/stem": { /** * Generate Stems Hackmit * @description Generate stems for HackMIT participants. * Uses chirp-stem model for stem generation. */ post: operations["studio_api_bots_hackmit_api_generate_stems_hackmit"]; }; "/api/v2/external/hackmit/stem/": { /** * Generate Stems Hackmit * @description Generate stems for HackMIT participants. * Uses chirp-stem model for stem generation. */ post: operations["studio_api_bots_hackmit_api_generate_stems_hackmit"]; }; "/api/v2/external/lyrics": { /** * Get Lyrics External * @description Get lyrics for a clip in WebVTT format. */ get: operations["studio_api_bots_external_api_get_lyrics_external"]; }; "/api/v2/external/oauth/alexa-user-info": { /** * Get Alexa User Info Via Oauth * @description Get Alxa-specific user information through OAuth. */ get: operations["studio_api_bots_external_api_get_alexa_user_info_via_oauth"]; }; "/api/v2/external/oauth/alexa/skill-account-linked": { /** * Alexa Skill Account Linked * @description Handles the Alexa skill account linking event and self-healing requests. * * This endpoint is called by the Alexa skill Lambda function when: * 1. A user links their Suno account to their Alexa account * 2. Alexa performs self-healing to ensure catalogs are synchronized * * If previous_sync_token is provided, this is a self-healing request. */ post: operations["studio_api_bots_external_api_alexa_skill_account_linked"]; }; "/api/v2/external/oauth/alexa/song-created": { /** * Alexa Song Created * @description Handles notification of a newly created song that needs to be added to the Alexa catalog. * * This endpoint is called by the Lambda function after a song is successfully created * to update the user's Alexa music catalog with the new song. * * If no AlexaUserInfo record exists, it will create one if alexa_user_id is provided. */ post: operations["studio_api_bots_external_api_alexa_song_created"]; }; "/api/v2/external/oauth/authorize": { /** * Oauth Authorize * @description OAuth 2.0 authorization endpoint redirecting to frontend for authentication. */ get: operations["studio_api_bots_external_api_oauth_authorize"]; }; "/api/v2/external/oauth/authorize/": { /** * Oauth Authorize * @description OAuth 2.0 authorization endpoint redirecting to frontend for authentication. */ get: operations["studio_api_bots_external_api_oauth_authorize"]; }; "/api/v2/external/oauth/authorize/confirm": { /** * Oauth Authorize Confirm * @description Confirms OAuth authorization after user authentication. */ post: operations["studio_api_bots_external_api_oauth_authorize_confirm"]; }; "/api/v2/external/oauth/client-info": { /** * Get Oauth Client Info * @description Get information about an OAuth client application by client_id. */ get: operations["studio_api_bots_external_api_get_oauth_client_info"]; }; "/api/v2/external/oauth/clips": { /** * Get Clips Via Oauth * @description Retrieve clips by IDs through OAuth with the 'read_music' scope. */ get: operations["studio_api_bots_external_api_get_clips_via_oauth"]; }; "/api/v2/external/oauth/clips/": { /** * Get Clips Via Oauth * @description Retrieve clips by IDs through OAuth with the 'read_music' scope. */ get: operations["studio_api_bots_external_api_get_clips_via_oauth"]; }; "/api/v2/external/oauth/generate": { /** * Generate Via Oauth * @description Generate a song through OAuth with the 'generate_music' scope. */ post: operations["studio_api_bots_external_api_generate_via_oauth"]; }; "/api/v2/external/oauth/generate-code": { /** * Generate Authorization Code * @description Generate an authorization code after user authenticates with Clerk. */ post: operations["studio_api_bots_external_api_generate_authorization_code"]; }; "/api/v2/external/oauth/search": { /** * Search User Library Via Oauth * @description Search the user's library via OAuth with the 'read_music' scope. */ post: operations["studio_api_bots_external_api_search_user_library_via_oauth"]; }; "/api/v2/external/oauth/search-user-clips": { /** * Search User Clips Via Oauth * @description Retrieve clips by various criteria through OAuth with the 'read_music' scope. * * Supports three filter modes: * 1. N most recent songs (default) * 2. N songs newer than a specific song (after_id) * 3. N songs older than a specific song (before_id) */ get: operations["studio_api_bots_external_api_search_user_clips_via_oauth"]; }; "/api/v2/external/oauth/user-info": { /** * Get User Info Via Oauth * @description Get user profile and subscription details through OAuth. */ get: operations["studio_api_bots_external_api_get_user_info_via_oauth"]; }; "/api/v2/external/stem": { /** Run Stem Integration */ post: operations["studio_api_bots_external_api_run_stem_integration"]; }; "/api/v2/external/stem/": { /** Run Stem Integration */ post: operations["studio_api_bots_external_api_run_stem_integration"]; }; "/api/v2/external/uploads/audio": { /** Start Audio Upload */ post: operations["studio_api_bots_external_api_start_audio_upload"]; }; "/api/v2/external/uploads/audio/": { /** Start Audio Upload */ post: operations["studio_api_bots_external_api_start_audio_upload"]; }; "/api/v2/external/uploads/audio/{upload_id}": { /** Get Audio Upload Status */ get: operations["studio_api_bots_external_api_get_audio_upload_status"]; }; "/api/v2/external/uploads/audio/{upload_id}/": { /** Get Audio Upload Status */ get: operations["studio_api_bots_external_api_get_audio_upload_status"]; }; "/api/v2/external/uploads/audio/{upload_id}/initialize-clip": { /** Initialize Audio Upload Clip */ post: operations["studio_api_bots_external_api_initialize_audio_upload_clip"]; }; "/api/v2/external/uploads/audio/{upload_id}/initialize-clip/": { /** Initialize Audio Upload Clip */ post: operations["studio_api_bots_external_api_initialize_audio_upload_clip"]; }; "/api/v2/external/uploads/audio/{upload_id}/upload-finish": { /** Finish Processing Audio Upload */ post: operations["studio_api_bots_external_api_finish_processing_audio_upload"]; }; "/api/v2/external/uploads/audio/{upload_id}/upload-finish/": { /** Finish Processing Audio Upload */ post: operations["studio_api_bots_external_api_finish_processing_audio_upload"]; }; "/api/v2/external/verify_external_token": { /** Verify External Token */ get: operations["studio_api_bots_external_api_verify_external_token"]; }; "/api/video/generate/{clip_id}": { /** Generate Video */ post: operations["studio_api_video_api_generate_video"]; }; "/api/video/generate/{clip_id}/": { /** Generate Video */ post: operations["studio_api_video_api_generate_video"]; }; "/api/video/generate/{clip_id}/status": { /** Get Video Status */ get: operations["studio_api_video_api_get_video_status"]; }; "/api/video/generate/{clip_id}/status/": { /** Get Video Status */ get: operations["studio_api_video_api_get_video_status"]; }; "/api/video/hooks/admin/batch": { /** * Batch Admin Hooks * @description Batch fetch hooks for admin visualization and ranking analysis. * Staff-only endpoint that returns fully hydrated hooks including test hooks and flagged content. */ post: operations["studio_api_video_hooks_admin_api_batch_admin_hooks"]; }; "/api/video/hooks/admin/reprocess-hook": { /** * Reprocess Hook * @description Set the current user's video cover hook perm in Redis. * Staff-only endpoint that sets the video cover hook perm for the current user. */ post: operations["studio_api_video_hooks_admin_api_reprocess_hook"]; }; "/api/video/hooks/admin/reset_moderation": { /** * Reset Moderation * @description Set the current user's video cover hook perm in Redis. * Staff-only endpoint that sets the video cover hook perm for the current user. */ post: operations["studio_api_video_hooks_admin_api_reset_moderation"]; }; "/api/video/hooks/admin/watch_history/inspect": { /** * Inspect Watch History * @description Inspect the current user's Hooks watch history from Redis. * Staff-only endpoint that returns the list of watched hook IDs. */ get: operations["studio_api_video_hooks_admin_api_inspect_watch_history"]; }; "/api/video/hooks/admin/watch_history/reset": { /** * Reset Watch History * @description Reset the current user's Hooks watch history in Redis. * Staff-only endpoint that clears all watched hook records. * Requires confirmation flag to prevent accidental resets. */ post: operations["studio_api_video_hooks_admin_api_reset_watch_history"]; }; "/api/video/hooks/admin/{hook_id}/add_quality_label": { /** Add Quality Label */ post: operations["studio_api_video_hooks_admin_api_add_quality_label"]; }; "/api/video/hooks/admin/{hook_id}/remove_quality_label": { /** Remove Quality Label */ post: operations["studio_api_video_hooks_admin_api_remove_quality_label"]; }; "/api/video/hooks/comments/{comment_id}": { /** * Delete Comment * @description Delete a comment. Users can only delete their own comments. */ delete: operations["studio_api_video_hooks_comments_api_delete_comment"]; }; "/api/video/hooks/comments/{comment_id}/": { /** * Delete Comment * @description Delete a comment. Users can only delete their own comments. */ delete: operations["studio_api_video_hooks_comments_api_delete_comment"]; }; "/api/video/hooks/comments/{comment_id}/reaction": { /** * Post Comment Reaction * @description Post a reaction to a comment. */ post: operations["studio_api_video_hooks_comments_api_post_comment_reaction"]; }; "/api/video/hooks/comments/{comment_id}/reaction/": { /** * Post Comment Reaction * @description Post a reaction to a comment. */ post: operations["studio_api_video_hooks_comments_api_post_comment_reaction"]; }; "/api/video/hooks/comments/{comment_id}/replies": { /** * Get Comment Replies * @description Get the replies to a comment. */ get: operations["studio_api_video_hooks_comments_api_get_comment_replies"]; }; "/api/video/hooks/comments/{comment_id}/replies/": { /** * Get Comment Replies * @description Get the replies to a comment. */ get: operations["studio_api_video_hooks_comments_api_get_comment_replies"]; }; "/api/video/hooks/comments/{comment_id}/report": { /** * Post Comment Report * @description Report a comment. */ post: operations["studio_api_video_hooks_comments_api_post_comment_report"]; }; "/api/video/hooks/comments/{comment_id}/report/": { /** * Post Comment Report * @description Report a comment. */ post: operations["studio_api_video_hooks_comments_api_post_comment_report"]; }; "/api/video/hooks/comments/{hook_id}/comment": { /** Post Comment */ post: operations["studio_api_video_hooks_comments_api_post_comment"]; }; "/api/video/hooks/comments/{hook_id}/comment/": { /** Post Comment */ post: operations["studio_api_video_hooks_comments_api_post_comment"]; }; "/api/video/hooks/comments/{hook_id}/comments": { /** * Get Comments * @description Get comments for a clip. */ get: operations["studio_api_video_hooks_comments_api_get_comments"]; }; "/api/video/hooks/comments/{hook_id}/comments/": { /** * Get Comments * @description Get comments for a clip. */ get: operations["studio_api_video_hooks_comments_api_get_comments"]; }; "/api/video/hooks/comments/{hook_id}/comments/count": { /** * Get Comment Count * @description Get the count of comments for a clip. */ get: operations["studio_api_video_hooks_comments_api_get_comment_count"]; }; "/api/video/hooks/comments/{hook_id}/comments/count/": { /** * Get Comment Count * @description Get the count of comments for a clip. */ get: operations["studio_api_video_hooks_comments_api_get_comment_count"]; }; "/api/video/hooks/comments/{hook_id}/time-sync-comments": { /** * Get Time Sync Comments * @description Get time-synchronized comments for a clip. */ get: operations["studio_api_video_hooks_comments_api_get_time_sync_comments"]; }; "/api/video/hooks/comments/{hook_id}/time-sync-comments/": { /** * Get Time Sync Comments * @description Get time-synchronized comments for a clip. */ get: operations["studio_api_video_hooks_comments_api_get_time_sync_comments"]; }; "/api/video/hooks/comments/{hook_id}/toggle-comments": { /** Toggle Comments */ post: operations["studio_api_video_hooks_comments_api_toggle_comments"]; }; "/api/video/hooks/comments/{hook_id}/toggle-comments/": { /** Toggle Comments */ post: operations["studio_api_video_hooks_comments_api_toggle_comments"]; }; "/api/video/hooks/create": { /** Create Hook */ post: operations["studio_api_video_hooks_api_create_hook"]; }; "/api/video/hooks/creator_label": { /** * Add Hook Creator Label * @description Add a label to a hook creator. */ post: operations["studio_api_video_hooks_api_add_hook_creator_label"]; }; "/api/video/hooks/delete/{hook_id}": { /** Delete Video Hook */ post: operations["studio_api_video_hooks_api_delete_video_hook"]; }; "/api/video/hooks/feed": { /** Fetch Video Hook Feed */ post: operations["studio_api_video_hooks_api_fetch_video_hook_feed"]; }; "/api/video/hooks/feed/admin": { /** Fetch Video Hook Admin Feed */ post: operations["studio_api_video_hooks_api_fetch_video_hook_admin_feed"]; }; "/api/video/hooks/feed/diagnostic": { /** Fetch Video Hook Feed Diagnostic */ post: operations["studio_api_video_hooks_api_fetch_video_hook_feed_diagnostic"]; }; "/api/video/hooks/fetch_hook_lyrics": { /** Fetch Hook Lyrics */ post: operations["studio_api_video_hooks_api_fetch_hook_lyrics"]; }; "/api/video/hooks/from_clip/{clip_id}/hooks": { /** Get Video Hooks From Clip */ get: operations["studio_api_video_hooks_api_get_video_hooks_from_clip"]; }; "/api/video/hooks/me": { /** Get User Video Hooks */ get: operations["studio_api_video_hooks_api_get_user_video_hooks"]; }; "/api/video/hooks/me/liked": { /** * Get User Liked Hooks * @description Get hooks that the user has liked, sorted by most recently liked. */ get: operations["studio_api_video_hooks_api_get_user_liked_hooks"]; }; "/api/video/hooks/me/liked/v2": { /** * Get User Liked Hooks V2 * @description Get hooks that the user has liked, sorted by most recently liked. Returns wrapped response. */ get: operations["studio_api_video_hooks_api_get_user_liked_hooks_v2"]; }; "/api/video/hooks/remove_creator_label": { /** * Remove Hook Creator Label * @description Remove a label from a hook creator. */ post: operations["studio_api_video_hooks_api_remove_hook_creator_label"]; }; "/api/video/hooks/set_video_cover_hook_perm/": { /** Set Video Cover Hook Perm */ post: operations["studio_api_video_hooks_api_set_video_cover_hook_perm"]; }; "/api/video/hooks/should_show_video_cover_hook_notification": { /** Should Show Video Cover Hook Notification */ get: operations["studio_api_video_hooks_api_should_show_video_cover_hook_notification"]; }; "/api/video/hooks/suggested_clips": { /** Suggested Clips */ get: operations["studio_api_video_hooks_api_suggested_clips"]; }; "/api/video/hooks/tab_carousel": { /** Tab Carousel */ post: operations["studio_api_video_hooks_api_tab_carousel"]; }; "/api/video/hooks/user_hooks": { /** Get User Video Hooks V2 */ get: operations["studio_api_video_hooks_api_get_user_video_hooks_v2"]; }; "/api/video/hooks/watched": { /** Update Video Hook Watch History */ post: operations["studio_api_video_hooks_api_update_video_hook_watch_history"]; }; "/api/video/hooks/{hook_id}": { /** Get Video Hook */ get: operations["studio_api_video_hooks_api_get_video_hook"]; }; "/api/video/hooks/{hook_id}/download": { /** Get Hook Download Url */ get: operations["studio_api_video_hooks_api_get_hook_download_url"]; }; "/api/video/hooks/{hook_id}/download/": { /** Get Hook Download Url */ get: operations["studio_api_video_hooks_api_get_hook_download_url"]; }; "/api/video/hooks/{hook_id}/flag": { /** Flag Hook */ post: operations["studio_api_video_hooks_api_flag_hook"]; }; "/api/video/hooks/{hook_id}/reaction": { /** Set Hook Reaction */ post: operations["studio_api_video_hooks_api_set_hook_reaction"]; }; "/api/video/hooks/{hook_id}/report": { /** Report Hook */ post: operations["studio_api_video_hooks_api_report_hook"]; }; "/api/video/hooks/{hook_id}/share": { /** Share Hook */ post: operations["studio_api_video_hooks_api_share_hook"]; }; "/api/video/hooks/{hook_id}/toggle_test": { /** Toggle Test */ post: operations["studio_api_video_hooks_api_toggle_test"]; }; "/api/video/hooks/{hook_id}/update_metadata": { /** Update Hook Metadata */ post: operations["studio_api_video_hooks_api_update_hook_metadata"]; }; "/api/video/internal-generate": { /** Internal Generate Video */ post: operations["studio_api_video_api_internal_generate_video"]; }; "/api/video/internal-generate/": { /** Internal Generate Video */ post: operations["studio_api_video_api_internal_generate_video"]; }; "/api/video/internal-generate/{clip_id}/type/{video_type}/status": { /** Get Internal Video Status */ get: operations["studio_api_video_api_get_internal_video_status"]; }; "/api/video/internal-generate/{clip_id}/type/{video_type}/status/": { /** Get Internal Video Status */ get: operations["studio_api_video_api_get_internal_video_status"]; }; "/api/video/short/{video_id}": { /** Get Video Short */ get: operations["studio_api_video_api_get_video_short"]; }; "/api/video/short/{video_id}/set_visibility": { /** Set Video Visibility */ post: operations["studio_api_video_api_set_video_visibility"]; }; "/api/video/sprite": { /** Get Video Sprite */ get: operations["studio_api_video_api_get_video_sprite"]; }; "/api/video_gen/generate_scene_script": { /** Generate Scene Script */ post: operations["studio_api_video_gen_api_generate_scene_script"]; }; "/api/video_gen/generate_video": { /** Generate Video */ post: operations["studio_api_video_gen_api_generate_video"]; }; "/api/video_gen/generate_video_cover": { /** Generate Video Cover */ post: operations["studio_api_video_gen_api_generate_video_cover"]; }; "/api/video_gen/generate_video_cover_prompt": { /** Generate Video Cover Prompt */ post: operations["studio_api_video_gen_api_generate_video_cover_prompt"]; }; "/api/video_gen/get_ai_video_cover": { /** Get Ai Video Cover */ get: operations["studio_api_video_gen_api_get_ai_video_cover"]; }; "/api/video_gen/higgsfield/custom_reference": { /** * Create Custom Reference * @description Create a custom reference for text2image generation */ post: operations["studio_api_video_gen_higgsfield_api_create_custom_reference"]; }; "/api/video_gen/higgsfield/custom_reference/{reference_id}": { /** * Get Custom Reference * @description Get details of a custom reference */ get: operations["studio_api_video_gen_higgsfield_api_get_custom_reference"]; }; "/api/video_gen/higgsfield/finished_hf_gen": { /** * Finished Hf Gen * @description Finished higgsfield gen */ post: operations["studio_api_video_gen_higgsfield_api_finished_hf_gen"]; }; "/api/video_gen/higgsfield/generate_image": { /** * Generate Image * @description Start soul image generation for a video workspace */ post: operations["studio_api_video_gen_higgsfield_api_generate_image"]; }; "/api/video_gen/higgsfield/images": { /** * Get Images * @description Get generated images for a video workspace */ get: operations["studio_api_video_gen_higgsfield_api_get_images"]; }; "/api/video_gen/higgsfield/soul": { /** * Create Soul Image * @description Create a text-to-image soul job */ post: operations["studio_api_video_gen_higgsfield_api_create_soul_image"]; }; "/api/video_gen/higgsfield/soul-styles": { /** * Get Soul Styles * @description Get available soul styles for text2image generation */ get: operations["studio_api_video_gen_higgsfield_api_get_soul_styles"]; }; "/api/video_gen/higgsfield/start_concatenation": { /** * Start Concatenation * @description Start video concatenation for a workspace */ post: operations["studio_api_video_gen_higgsfield_api_start_concatenation"]; }; "/api/video_gen/higgsfield/start_soul_images": { /** * Start Soul Images * @description Start soul image generation for a video workspace */ post: operations["studio_api_video_gen_higgsfield_api_start_soul_images"]; }; "/api/video_gen/higgsfield/start_video_generation": { /** Start Video Generation */ post: operations["studio_api_video_gen_higgsfield_api_start_video_generation"]; }; "/api/video_gen/higgsfield/videos": { /** * Get Videos * @description Get generated videos for a video workspace */ get: operations["studio_api_video_gen_higgsfield_api_get_videos"]; }; "/api/video_gen/minimax/track_task_status": { /** Track Task Status */ post: operations["studio_api_video_gen_minimax_api_track_task_status"]; }; "/api/video_gen/update_video_status": { /** Update Video Status */ post: operations["studio_api_video_gen_api_update_video_status"]; }; "/api/video_gen/video_workspace": { /** Get Video Workspace */ get: operations["studio_api_video_gen_api_get_video_workspace"]; }; "/api/video_gen/videos": { /** Get Video Status */ get: operations["studio_api_video_gen_api_get_video_status"]; }; } export type webhooks = Record; export interface components { schemas: { /** APIErrorSchema */ APIErrorSchema: { /** Detail */ detail?: string | null; /** * Error Type * @enum {string|null} */ error_type?: "rate_limit" | "forbidden" | "song_not_found" | "comment_too_long" | "comment_duplicate" | "comment_no_permission" | "comments_disabled" | "comment_moderated" | "comment_not_found" | "entity_not_found" | "profiles_malformed_birth_date" | "profiles_invalid_secondary_email" | null; }; /** AblyClientIdResponse */ AblyClientIdResponse: { /** Client Id */ client_id: string; }; /** AblyTokenResponse */ AblyTokenResponse: { /** Token */ token: string; }; /** AcceptSubCouponResponse */ AcceptSubCouponResponse: { /** Success */ success: boolean; }; /** AcceptSubCouponSpec */ AcceptSubCouponSpec: { /** Coupon Id */ coupon_id: string; }; /** ActionSpec */ ActionSpec: { /** Action */ action: string; /** Share Id */ share_id?: string | null; /** Share Platform */ share_platform?: string | null; }; /** ActiveListenersResponse */ ActiveListenersResponse: { /** Active Listeners */ active_listeners: number; }; /** AddCopyrightLyricsSpec */ AddCopyrightLyricsSpec: { /** Lyrics */ lyrics: string; }; /** AddCreditsResponse */ AddCreditsResponse: { /** Message */ message: string; /** New Balance */ new_balance: number; /** Ok */ ok: boolean; }; /** AddCreditsSpec */ AddCreditsSpec: { /** * Credit Amount * @default 1000 */ credit_amount?: number; /** * User Id * Format: uuid */ user_id: string; }; /** AddGroupMembersRequest */ AddGroupMembersRequest: { /** Member Handles */ member_handles: string[]; }; /** AddGroupMembersResponse */ AddGroupMembersResponse: { /** Added Count */ added_count: number; /** New Participant Count */ new_participant_count: number; /** Success */ success: boolean; }; /** AddHookCreatorLabelResponse */ AddHookCreatorLabelResponse: { /** Success */ success: boolean; }; /** AddHookCreatorLabelSpec */ AddHookCreatorLabelSpec: { /** * Creator User Id * @default 0 */ creator_user_id?: number; /** * Creator User Uuid * @default */ creator_user_uuid?: string; label: components["schemas"]["HookCreatorLabel"]; }; /** AddHookQualityLabelRequest */ AddHookQualityLabelRequest: { /** * Label * @default */ label?: string; }; /** AddHookQualityLabelResponse */ AddHookQualityLabelResponse: { /** Success */ success: boolean; }; /** AdjustSpeedRequest */ AdjustSpeedRequest: { /** Clip Id */ clip_id: string; /** * Keep Pitch * @default false */ keep_pitch?: boolean; /** * Speed Multiplier * @default 1 */ speed_multiplier?: number; /** * Title * @default */ title?: string; }; /** AdsUserRequest */ AdsUserRequest: { /** Idfa */ idfa: string; }; /** AdsUserResponse */ AdsUserResponse: { /** Message */ message?: string | null; /** Success */ success: boolean; }; /** AggregatedStudioProjectVersion */ AggregatedStudioProjectVersion: { /** * Hour * Format: date-time */ hour: string; /** Versions */ versions: components["schemas"]["StudioProjectVersion"][]; }; /** * AlexaUserInfoSchema * @description Schema for Alexa-specific user information for playlist sync. */ AlexaUserInfoSchema: { /** Alexa Api Endpoint */ alexa_api_endpoint: string; /** Alexa Latest Sync Token */ alexa_latest_sync_token?: string | null; /** Alexa User Id */ alexa_user_id: string; /** * Updated At * Format: date-time */ updated_at: string; /** User Id */ user_id?: number | null; }; /** AlignedClipSchema */ AlignedClipSchema: { clip: components["schemas"]["GeneratedClipSchema"]; /** Clip End Seconds */ clip_end_seconds?: number | null; /** Clip Start Seconds */ clip_start_seconds?: number | null; /** Future Clip Id */ future_clip_id?: string | null; /** Future Start Seconds */ future_start_seconds?: number | null; /** History Clip Id */ history_clip_id?: string | null; /** History End Seconds */ history_end_seconds?: number | null; }; /** AlignedClipsResponseSchema */ AlignedClipsResponseSchema: { /** Alignments */ alignments: components["schemas"]["AlignedClipSchema"][]; }; /** AlignedLyricSchema */ AlignedLyricSchema: { /** End S */ end_s: number; /** Section */ section: string; /** Start S */ start_s: number; /** Text */ text: string; /** Words */ words: components["schemas"]["WordOutputSchema"][]; }; /** AlignedLyricsSchema */ AlignedLyricsSchema: { /** Data */ data: unknown; }; /** AlignedLyricsV2Schema */ AlignedLyricsV2Schema: { /** Aligned Lyrics */ aligned_lyrics?: components["schemas"]["AlignedLyricSchema"][] | null; /** Aligned Words */ aligned_words: components["schemas"]["AlignedWordSchema"][]; /** Hoot Cer */ hoot_cer?: number | null; /** Is Streamed */ is_streamed: boolean; /** Waveform Data */ waveform_data?: number[] | null; }; /** AlignedLyricsV3Schema */ AlignedLyricsV3Schema: { /** Alignment */ alignment?: components["schemas"]["AlignedWordSchema"][] | null; /** Error Message */ error_message?: string | null; /** Final */ final?: boolean | null; /** * State * @enum {string} */ state: "running" | "error" | "complete" | "streaming"; }; /** AlignedLyricsV3Spec */ AlignedLyricsV3Spec: { /** * Enable Augmentation * @default true */ enable_augmentation?: boolean; /** Lyrics */ lyrics?: string | null; }; /** AlignedWordSchema */ AlignedWordSchema: { /** End S */ end_s: number; /** P Align */ p_align: number; /** Start S */ start_s: number; /** Success */ success: boolean; /** Word */ word: string; }; /** AllContestsResponse */ AllContestsResponse: { /** Contests */ contests: components["schemas"]["ContestSchema"][]; }; /** * AnonymousLyricsGenerationSpec * @description Schema for generating lyrics from a prompt. */ AnonymousLyricsGenerationSpec: { /** Prompt */ prompt: string; /** Token */ token: string; }; /** * AnonymousLyricsResponseSchema * @description Schema for lyrics generation response with simplified fields. */ AnonymousLyricsResponseSchema: { /** * Genre Tags * @default [] */ genre_tags?: string[]; /** Lyrics */ lyrics: string; /** Title */ title: string; }; /** AppVersionUpdateRequest */ AppVersionUpdateRequest: { /** App Name */ app_name: string; /** * Current Version * @default */ current_version?: string; /** Platform */ platform: string; }; /** AppVersionUpdateResponse */ AppVersionUpdateResponse: { /** App Name */ app_name: string; /** Force Version */ force_version?: string | null; /** Latest Version */ latest_version?: string | null; /** Platform */ platform: string; /** Version */ version?: string | null; /** Warn Version */ warn_version?: string | null; }; /** ArtistClipIdSpec */ ArtistClipIdSpec: { /** Artist Clip Id */ artist_clip_id: string; }; /** * ArtistProfileInfoSchema * @description Schema for artist profile information stored in DynamoDB. */ ArtistProfileInfoSchema: { /** Cover Photo Position */ cover_photo_position?: string | null; /** Cover Photo Url */ cover_photo_url?: string | null; /** Instagram Link */ instagram_link?: string | null; /** Location */ location?: string | null; /** Section Order */ section_order?: string[] | null; /** Soundcloud Link */ soundcloud_link?: string | null; /** Spotify Link */ spotify_link?: string | null; /** User Inputted Genres */ user_inputted_genres?: string[] | null; /** X Link */ x_link?: string | null; /** Youtube Link */ youtube_link?: string | null; }; /** AudioDescriptionResponse */ AudioDescriptionResponse: { /** Clip Id */ clip_id: string; /** Description */ description: { [key: string]: unknown; }; }; /** AudioMetadataSchema */ AudioMetadataSchema: { audio_snippet?: components["schemas"]["AudioSnippetSchema"]; }; /** AudioSnippetSchema */ AudioSnippetSchema: { /** End Timestamp */ end_timestamp: number; /** Start Timestamp */ start_timestamp: number; /** Title */ title: string; }; /** * AuraColorSet * @enum {integer} */ AuraColorSet: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11; /** AuraSettings */ AuraSettings: { color_set: components["schemas"]["AuraColorSet"]; frame_shape: components["schemas"]["FrameShape"]; mask_style: components["schemas"]["MaskStyle"]; overlay_color: components["schemas"]["OverlayColor"]; style: components["schemas"]["AuraStyle"]; text_placement: components["schemas"]["TextPlacement"]; }; /** * AuraStyle * @enum {integer} */ AuraStyle: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15; /** AutoCompleteResults */ AutoCompleteResults: { /** Results */ results: { [key: string]: unknown; }[]; }; /** AutoplayRequest */ AutoplayRequest: { /** Clip Id */ clip_id: string; /** Clips In Queue */ clips_in_queue?: components["schemas"]["QueueClip"][] | null; /** Page Size */ page_size?: number | null; /** Playlist Id */ playlist_id: string; /** Query */ query: string; }; /** AutoplayResponse */ AutoplayResponse: { /** Clips */ clips: components["schemas"]["GeneratedClipSchema"][]; }; /** BadgeSchema */ BadgeSchema: { dark: components["schemas"]["BadgeThemeData"]; /** Display Name */ display_name: string; light: components["schemas"]["BadgeThemeData"]; }; /** BadgeThemeData */ BadgeThemeData: { /** Background Color */ background_color?: string | null; /** Border Color */ border_color?: string | null; /** Text Color */ text_color: string; }; /** * BadgeType * @enum {string} */ BadgeType: "pro" | "beta"; /** BannerCollapsedContentSchema */ BannerCollapsedContentSchema: { /** * @default { * "color": null, * "key": null, * "text": "" * } */ subtitle_text?: components["schemas"]["LocalStringSchema"]; /** * @default { * "color": null, * "key": null, * "text": "" * } */ title_text?: components["schemas"]["LocalStringSchema"]; }; /** BannerCtaSchema */ BannerCtaSchema: { /** * Action * @default play */ action?: string; /** Background Color */ background_color?: string | null; /** Icon */ icon?: string | null; /** * Icon Name * @default */ icon_name?: string; /** * Icon Size * @default XSmall * @enum {string} */ icon_size?: "XSmall" | "Small" | "Medium" | "Large"; /** * @default { * "color": null, * "key": null, * "text": "" * } */ text?: components["schemas"]["LocalStringSchema"]; /** Url */ url?: string | null; }; /** BannerGraphicCardSchema */ BannerGraphicCardSchema: { /** Background Image */ background_image?: string | null; /** Background Mp4 */ background_mp4?: string | null; /** * Text Background Color * @default */ text_background_color?: string; /** * @default { * "color": null, * "key": null, * "text": "" * } */ text_subtitle?: components["schemas"]["LocalStringSchema"]; /** * @default { * "color": null, * "key": null, * "text": "" * } */ text_title?: components["schemas"]["LocalStringSchema"]; /** * Type * @default graphic_card * @enum {string} */ type?: "graphic_card"; /** * Url * @default */ url?: string; }; /** BannerMobileAppGraphicSchema */ BannerMobileAppGraphicSchema: { /** Campaign Name */ campaign_name?: string | null; /** Card Height */ card_height?: number | null; /** * Countries * @default [] */ countries?: string[]; /** * End Time * Format: date-time */ end_time?: string | null; /** Hero Background Img Url */ hero_background_img_url?: string | null; /** * Id * @default */ id?: string; primary_cta?: components["schemas"]["BannerCtaSchema"]; secondary_cta?: components["schemas"]["BannerCtaSchema"]; /** * Start Time * Format: date-time */ start_time?: string | null; /** * @default { * "color": null, * "key": null, * "text": "" * } */ subtitle_text?: components["schemas"]["LocalStringSchema"]; tag?: components["schemas"]["BannerTagSchema"]; /** Template Id */ template_id?: string | null; /** * @default { * "color": null, * "key": null, * "text": "" * } */ title_text?: components["schemas"]["LocalStringSchema"]; /** * Type * @default ios * @enum {string} */ type?: "ios" | "android"; /** * Visible * @default false */ visible?: boolean; }; /** BannerSectionSchema */ BannerSectionSchema: { /** Description */ description?: string | null; /** Id */ id: string; /** Items */ items: (components["schemas"]["BannerMobileAppGraphicSchema"] | components["schemas"]["BannerWebGraphicSchema"])[]; /** Link */ link?: string | null; /** Mobile Link */ mobile_link?: string | null; /** Options */ options?: string[] | null; /** Secondary Options */ secondary_options?: string[] | null; /** Secondary Selected Option */ secondary_selected_option?: string | null; /** Section Name */ section_name?: string | null; /** * Section Type * @default banner * @enum {string} */ section_type?: "banner"; /** Selected Option */ selected_option?: string | null; /** Style Type */ style_type?: string | null; /** Title */ title: string; }; /** BannerSongCardSchema */ BannerSongCardSchema: { /** * Song Id * @default */ song_id?: string; /** * Type * @default song_card * @enum {string} */ type?: "song_card"; }; /** BannerTagSchema */ BannerTagSchema: { /** * Color * @default */ color?: string; /** * @default { * "color": null, * "key": null, * "text": "" * } */ text?: components["schemas"]["LocalStringSchema"]; }; /** BannerUpdateRequest */ BannerUpdateRequest: { /** Message */ message: string; /** Status */ status: string; }; /** BannerWebGraphicSchema */ BannerWebGraphicSchema: { /** Campaign Name */ campaign_name?: string | null; collapsed_content?: components["schemas"]["BannerCollapsedContentSchema"]; /** * Countries * @default [] */ countries?: string[]; /** * End Time * Format: date-time */ end_time?: string | null; /** Hero Background Alignment */ hero_background_alignment?: string | null; /** Hero Background Alignment Mobile */ hero_background_alignment_mobile?: string | null; /** Hero Background Color */ hero_background_color?: string | null; /** Hero Background Img Url */ hero_background_img_url?: string | null; /** Hero Background Img Url Mobile */ hero_background_img_url_mobile?: string | null; /** Hero Background Overlay */ hero_background_overlay?: string | null; /** Hero Background Overlay Mobile */ hero_background_overlay_mobile?: string | null; /** Hero Background Video Url */ hero_background_video_url?: string | null; /** Hero Background Video Url Mobile */ hero_background_video_url_mobile?: string | null; /** * Id * @default */ id?: string; primary_cta?: components["schemas"]["BannerCtaSchema"]; secondary_cta?: components["schemas"]["BannerCtaSchema"]; /** * Start Time * Format: date-time */ start_time?: string | null; /** * @default { * "color": null, * "key": null, * "text": "" * } */ subtitle_text?: components["schemas"]["LocalStringSchema"]; tag?: components["schemas"]["BannerTagSchema"]; /** Template Id */ template_id?: string | null; /** Tiles */ tiles?: (components["schemas"]["BannerSongCardSchema"] | components["schemas"]["BannerGraphicCardSchema"])[]; /** * @default { * "color": null, * "key": null, * "text": "" * } */ title_text?: components["schemas"]["LocalStringSchema"]; /** * Type * @default web * @enum {string} */ type?: "web" | "mobile-web"; /** * Visible * @default false */ visible?: boolean; }; /** * BaseSearchResult * @description The BaseSearchResult is the interface for the search result */ BaseSearchResult: { /** * From Index * @default 0 */ from_index?: number; /** * Page Size * @default 0 */ page_size?: number; /** Result */ result: (components["schemas"]["GeneratedClipSchema"] | components["schemas"]["PlaylistSchema"] | components["schemas"]["SimpleProfileInfoSchema"] | components["schemas"]["GenreSchema"] | components["schemas"]["PersonaSchema"])[]; /** * Total Hits * @default 0 */ total_hits?: number; }; /** BatchAdminHooksRequest */ BatchAdminHooksRequest: { /** Hook Ids */ hook_ids: string[]; }; /** BatchAdminHooksResponse */ BatchAdminHooksResponse: { /** Hooks */ hooks: components["schemas"]["VideoHookSchema"][]; }; /** BlockUserSpec */ BlockUserSpec: { /** Handle */ handle: string; /** Source */ source?: string | null; /** * Unblock * @default false */ unblock?: boolean; }; /** BulkAdmitUsersSchema */ BulkAdmitUsersSchema: { /** Admitted Users */ admitted_users: string[]; /** Already Had Access Users */ already_had_access_users: string[]; /** Failed To Admit Users */ failed_to_admit_users: string[]; }; /** BulkAdmitUsersSpec */ BulkAdmitUsersSpec: { /** Handles */ handles: string[]; }; /** BulkCreateSurveyResponseSpec */ BulkCreateSurveyResponseSpec: { /** Responses */ responses: components["schemas"]["CreateSurveyResponseSpec"][]; }; /** BulkPlayCountSpec */ BulkPlayCountSpec: { /** Gen Ids */ gen_ids: string[]; /** * Sample Factor * @default 1 */ sample_factor?: number; }; /** BulkUpsertLabelMakerTasksSpec */ BulkUpsertLabelMakerTasksSpec: { /** * Project Id * Format: uuid */ project_id: string; /** Review Items List */ review_items_list: { [key: string]: unknown; }[][]; }; /** * CaptchaType * @enum {string} */ CaptchaType: "generation"; /** ChangeClipSpeedSpec */ ChangeClipSpeedSpec: { /** Change Speed End Time */ change_speed_end_time?: number | null; /** Change Speed Start Time */ change_speed_start_time?: number | null; /** Edit Session Id */ edit_session_id?: string | null; /** Project Id */ project_id?: string | null; /** Speed Factor */ speed_factor?: number | null; /** * Tempo Only * @default false */ tempo_only?: boolean; }; /** ChatMessage */ ChatMessage: { /** Channel Id */ channel_id?: string | null; /** Channel Type */ channel_type?: string | null; /** Chat Id */ chat_id?: string | null; /** Chat Text */ chat_text?: string | null; /** * Created At * Format: date-time */ created_at?: string | null; /** Id */ id?: string | null; /** Is Flagged */ is_flagged?: boolean | null; /** Moderation Reasons */ moderation_reasons?: string | null; /** Moderation Status */ moderation_status?: string | null; /** User Avatar Url */ user_avatar_url?: string | null; /** User Name */ user_name?: string | null; }; /** ChatMessageRequest */ ChatMessageRequest: { /** Message */ message: string; }; /** ChatMessageResponse */ ChatMessageResponse: Record; /** ChatRoomResponse */ ChatRoomResponse: { /** Channel Id */ channel_id?: string | null; /** Channel Type */ channel_type?: string | null; /** Messages */ messages?: components["schemas"]["ChatMessage"][] | null; }; /** CheckCaptchaRequest */ CheckCaptchaRequest: { ctype: components["schemas"]["CaptchaType"]; }; /** CheckCaptchaResponse */ CheckCaptchaResponse: { /** Required */ required: boolean; }; /** CheckHandleAvailabilityResponse */ CheckHandleAvailabilityResponse: { /** Available */ available: boolean; }; /** CheckLyricsCopyrightInfringementRequest */ CheckLyricsCopyrightInfringementRequest: { /** Lyrics */ lyrics: string; /** Threshold */ threshold?: number | null; /** * Version * @default minhash */ version?: string; }; /** CheckLyricsCopyrightInfringementResponse */ CheckLyricsCopyrightInfringementResponse: { details?: components["schemas"]["SimilarityCheckResponse"]; /** Is Copyright Infringement */ is_copyright_infringement: boolean; }; /** * CheckoutSessionSchemaResponse * @description Schema for checkout session response when creating a Stripe checkout session. */ CheckoutSessionSchemaResponse: { /** Url */ url: string; }; /** * CheckoutSource * @enum {string} */ CheckoutSource: "accountPage" | "upsellModal" | "pricingPage" | "splashPage" | "commercialRightsModal"; /** ChildClipSchema */ ChildClipSchema: { clip: components["schemas"]["GeneratedClipSchema"]; /** Extend Offset */ extend_offset?: number | null; /** Index */ index: number; /** Parent Ids */ parent_ids: string[]; /** Relationship */ relationship: string; /** Total Duration */ total_duration?: number | null; }; /** ChildClipsSchema */ ChildClipsSchema: { /** Child Clips */ child_clips: components["schemas"]["ChildClipSchema"][]; /** Root Clips */ root_clips: components["schemas"]["GeneratedClipSchema"][]; }; /** * ChurnReason * @enum {string} */ ChurnReason: "not_used_enough" | "expectations_not_met" | "missing_features" | "better_alternative" | "price_too_high" | "taking_a_break" | "technical_issues" | "billing_issues" | "needed_temporarily" | "other"; /** ChurnSurveyOption */ ChurnSurveyOption: { /** Label */ label: string; value: components["schemas"]["ChurnReason"]; }; /** ChurnSurveyOptionsResponse */ ChurnSurveyOptionsResponse: { /** Options */ options: components["schemas"]["ChurnSurveyOption"][]; }; /** ClipConfigurationsSpec */ ClipConfigurationsSpec: { /** Configurations */ configurations: { [key: string]: number | string | boolean; }; }; /** ClipDownloadResponse */ ClipDownloadResponse: { /** Ok */ ok: boolean; }; /** ClipMetadataSchema */ ClipMetadataSchema: { /** Caption */ caption?: string | null; caption_mentions?: components["schemas"]["MentionsContainer"]; /** * Id * Format: uuid */ id: string; /** Image S3 Id */ image_s3_id?: string | null; /** Image Url */ image_url?: string | null; /** Opt Out Video Cover Hook */ opt_out_video_cover_hook?: boolean | null; /** Preview Url */ preview_url?: string | null; /** Prompt */ prompt?: string | null; /** Title */ title: string; /** Video Cover Url */ video_cover_url?: string | null; /** Video Is Stale */ video_is_stale: boolean; }; /** ClipMetadataSpec */ ClipMetadataSpec: { /** Caption */ caption?: string | null; caption_mentions?: components["schemas"]["MentionsContainer"]; /** Create Video Hook */ create_video_hook?: boolean | null; /** Image S3 Id */ image_s3_id?: string | null; /** Image Url */ image_url?: string | null; /** Is Audio Upload Tos Accepted */ is_audio_upload_tos_accepted?: boolean | null; /** Lyrics */ lyrics?: string | null; /** Opt Out Video Cover Hook */ opt_out_video_cover_hook?: boolean | null; /** Remove Image Cover */ remove_image_cover?: boolean | null; /** Remove Video Cover */ remove_video_cover?: boolean | null; /** Title */ title?: string | null; /** Video Cover Upload Id */ video_cover_upload_id?: string | null; }; /** ClipOffsetResponse */ ClipOffsetResponse: { /** Clip Id */ clip_id: string | null; /** Offset */ offset: number; }; /** ClipOwnershipSchema */ ClipOwnershipSchema: { /** Ownership Reason */ ownership_reason: string; }; /** ClipPromptSchema */ ClipPromptSchema: { /** Clip Id */ clip_id?: string | null; /** Clip Image Url */ clip_image_url?: string | null; /** * Created At * Format: date-time */ created_at: string; /** Gpt Description Prompt */ gpt_description_prompt?: string | null; /** Is Saved Prompt */ is_saved_prompt?: boolean | null; /** Lyrics */ lyrics?: string | null; /** Negative Tags */ negative_tags?: string | null; /** Saved Prompt Id */ saved_prompt_id?: string | null; sliders?: components["schemas"]["ControlSlidersSchema"]; /** Tags */ tags?: string | null; /** Title */ title?: string | null; /** * Updated At * Format: date-time */ updated_at: string; }; /** ClipPromptsSchema */ ClipPromptsSchema: { /** Prompts */ prompts: components["schemas"]["ClipPromptSchema"][]; }; /** ClipRemixPermissionDefaults */ ClipRemixPermissionDefaults: { /** * Extend From * @description Default timestamp (in seconds) from which to start extending the clip */ extend_from?: number | null; }; /** ClipVisibilitySpec */ ClipVisibilitySpec: { /** Is Public */ is_public: boolean; /** Submit To Contest */ submit_to_contest?: boolean | null; }; /** CloneProjectSchema */ CloneProjectSchema: { /** Title */ title?: string | null; }; /** CollaboratorSchema */ CollaboratorSchema: { /** User Avatar Url */ user_avatar_url?: string | null; /** User Display Name */ user_display_name?: string | null; /** User Handle */ user_handle?: string | null; /** * User Id * Format: uuid */ user_id: string; /** * User Invite Status * @enum {string} */ user_invite_status: "accepted" | "pending"; }; /** CommentBlockRequest */ CommentBlockRequest: { /** Handle */ handle: string; /** Reason */ reason?: string | null; }; /** * CommentEntityType * @enum {string} */ CommentEntityType: "clip" | "hook"; /** CommentReactionRequest */ CommentReactionRequest: { entity_type?: components["schemas"]["CommentEntityType"]; /** * Reaction * @enum {string|null} */ reaction?: "LIKE" | "DISLIKE" | null; }; /** CommentSchema */ CommentSchema: { /** Clip Id */ clip_id?: string | null; /** Content */ content: string; /** * Created At * Format: date-time */ created_at: string; entity_type?: components["schemas"]["CommentEntityType"]; /** Hook Id */ hook_id?: string | null; /** Id */ id: string; /** Num Likes */ num_likes: number; /** Num Replies */ num_replies?: number | null; /** Parent Id */ parent_id?: string | null; /** Reaction Type */ reaction_type?: string | null; /** Replies */ replies?: components["schemas"]["ReplySchema"][] | null; /** Reply Continuation Token */ reply_continuation_token?: string | null; /** Track Timestamp */ track_timestamp?: number | null; /** User Avatar Url */ user_avatar_url: string; /** User Comments Blocked */ user_comments_blocked?: boolean | null; /** User Display Name */ user_display_name: string; /** User Handle */ user_handle: string; /** User Id */ user_id: string; /** User Mentions */ user_mentions?: components["schemas"]["Mention"][] | null; }; /** CommercialRightsEligibilityResponse */ CommercialRightsEligibilityResponse: { /** Eligible */ eligible: boolean; }; /** CommercialRightsPurchaseSchemaResponse */ CommercialRightsPurchaseSchemaResponse: { /** Checkout Url */ checkout_url: string; /** Ok */ ok: boolean; }; /** CommercialRightsPurchaseSpec */ CommercialRightsPurchaseSpec: { /** * Clip Id * Format: uuid */ clip_id: string; }; /** CommunityPersonasSectionSchema */ CommunityPersonasSectionSchema: { /** Description */ description?: string | null; /** Id */ id: string; /** Items */ items: components["schemas"]["PersonaSchema"][]; /** Link */ link?: string | null; /** Mobile Link */ mobile_link?: string | null; /** Options */ options?: string[] | null; /** Secondary Options */ secondary_options?: string[] | null; /** Secondary Selected Option */ secondary_selected_option?: string | null; /** Section Name */ section_name?: string | null; /** * Section Type * @default persona_list * @enum {string} */ section_type?: "persona_list"; /** Selected Option */ selected_option?: string | null; /** Style Type */ style_type?: string | null; /** Title */ title: string; }; /** ContestClipResponse */ ContestClipResponse: { /** Clip */ clip?: unknown[] | null; /** Clip Id */ clip_id: string; clip_type?: components["schemas"]["ContestClipType"]; /** Contest Id */ contest_id: string; /** Is Submitted */ is_submitted: boolean; }; /** * ContestClipType * @enum {string} */ ContestClipType: "master" | "stem"; /** * ContestDiscoverSchema * @description Contest schema with selected base clip for discover section */ ContestDiscoverSchema: { /** Base Clip Ids */ base_clip_ids: string[]; /** Can Download Remixes */ can_download_remixes: boolean; /** Contest Banner */ contest_banner?: string | null; /** Contest Banner Mobile */ contest_banner_mobile?: string | null; /** Contest Category */ contest_category?: string | null; contest_clip?: components["schemas"]["GeneratedClipSchema"]; contest_visibility_level?: components["schemas"]["ContestVisibility"]; /** Description */ description: string; /** * End Time * Format: date-time */ end_time: string | null; /** Id */ id: string; /** * Judging End * Format: date-time */ judging_end?: string | null; /** * Judging Start * Format: date-time */ judging_start?: string | null; /** Name */ name: string; /** Slug */ slug?: string | null; /** * Start Time * Format: date-time */ start_time: string | null; /** Submissions Playlist Id */ submissions_playlist_id?: string | null; submissions_visibility_level?: components["schemas"]["ContestVisibility"]; /** Type */ type: string; /** * Winners Announced Date * Format: date-time */ winners_announced_date?: string | null; /** Winners Playlist Id */ winners_playlist_id?: string | null; }; /** ContestInfoSchema */ ContestInfoSchema: { /** Faq Questions */ faq_questions?: components["schemas"]["FAQItemSchema"][] | null; /** Hero Background Image */ hero_background_image?: string | null; /** Hero Background Image Mobile */ hero_background_image_mobile?: string | null; /** Hero Background Image Video */ hero_background_image_video?: string | null; /** Hero Background Image Video Mobile */ hero_background_image_video_mobile?: string | null; /** Hero Description */ hero_description?: string | null; /** Hero Title */ hero_title?: string | null; /** Landing Page Sections Visibility */ landing_page_sections_visibility?: { [key: string]: components["schemas"]["ContestVisibility"]; } | null; /** Remix Cta Deadline Text */ remix_cta_deadline_text?: string | null; /** Remix Cta Headline Text */ remix_cta_headline_text?: string | null; /** Remix Cta Remix Label */ remix_cta_remix_label?: string | null; /** Remix Cta Subheader Text */ remix_cta_subheader_text?: string | null; /** Video Highlight Headline Text */ video_highlight_headline_text?: string | null; /** Video Highlight Subheader Text */ video_highlight_subheader_text?: string | null; /** Video Highlight Video */ video_highlight_video?: string | null; /** Video Highlight Video Mobile */ video_highlight_video_mobile?: string | null; }; /** ContestLandingPageResponse */ ContestLandingPageResponse: { contest: components["schemas"]["ContestSchema"]; contest_clip?: components["schemas"]["GeneratedClipSchema"]; /** Contest Hub Enabled */ contest_hub_enabled?: boolean | null; contest_info?: components["schemas"]["ContestInfoSchema"]; }; /** * ContestListSectionSchema * @description Schema for contest list sections */ ContestListSectionSchema: { /** Description */ description?: string | null; /** Id */ id: string; /** Items */ items: components["schemas"]["ContestDiscoverSchema"][]; /** Link */ link?: string | null; /** Mobile Link */ mobile_link?: string | null; /** Options */ options?: string[] | null; /** Secondary Options */ secondary_options?: string[] | null; /** Secondary Selected Option */ secondary_selected_option?: string | null; /** Section Name */ section_name?: string | null; /** * Section Type * @default contest_list * @enum {string} */ section_type?: "contest_list"; /** Selected Option */ selected_option?: string | null; /** Style Type */ style_type?: string | null; /** Title */ title: string; }; /** ContestSchema */ ContestSchema: { /** Base Clip Ids */ base_clip_ids: string[]; /** Can Download Remixes */ can_download_remixes: boolean; /** Contest Banner */ contest_banner?: string | null; /** Contest Banner Mobile */ contest_banner_mobile?: string | null; /** Contest Category */ contest_category?: string | null; contest_visibility_level?: components["schemas"]["ContestVisibility"]; /** Description */ description: string; /** * End Time * Format: date-time */ end_time: string | null; /** Id */ id: string; /** * Judging End * Format: date-time */ judging_end?: string | null; /** * Judging Start * Format: date-time */ judging_start?: string | null; /** Name */ name: string; /** Slug */ slug?: string | null; /** * Start Time * Format: date-time */ start_time: string | null; /** Submissions Playlist Id */ submissions_playlist_id?: string | null; submissions_visibility_level?: components["schemas"]["ContestVisibility"]; /** Type */ type: string; /** * Winners Announced Date * Format: date-time */ winners_announced_date?: string | null; /** Winners Playlist Id */ winners_playlist_id?: string | null; }; /** * ContestSection * @enum {string} */ ContestSection: "hero" | "remix_cta" | "submissions" | "video_highlight" | "faq"; /** * ContestVisibility * @enum {string} */ ContestVisibility: "everyone" | "staff" | "none"; /** ControlSlidersSchema */ ControlSlidersSchema: { /** Audio Weight */ audio_weight?: number | null; /** Style Weight */ style_weight?: number | null; /** Weirdness Constraint */ weirdness_constraint?: number | null; }; /** CoverClipIdSpec */ CoverClipIdSpec: { /** Cover Clip Id */ cover_clip_id: string; }; /** CreateContestSpec */ CreateContestSpec: { /** * Base Clip Ids * @default [] */ base_clip_ids?: string[]; /** * Can Download Remixes * @default false */ can_download_remixes?: boolean; /** Contest Banner */ contest_banner?: string | null; /** Contest Banner Mobile */ contest_banner_mobile?: string | null; /** Contest Category */ contest_category?: string | null; contest_visibility_level?: components["schemas"]["ContestVisibility"]; /** Description */ description: string; /** * End Time * Format: date-time */ end_time?: string | null; /** * Judging End * Format: date-time */ judging_end?: string | null; /** * Judging Start * Format: date-time */ judging_start?: string | null; /** Name */ name: string; /** Slug */ slug?: string | null; /** * Start Time * Format: date-time */ start_time?: string | null; submissions_visibility_level?: components["schemas"]["ContestVisibility"]; /** Type */ type: string; /** * Winners Announced Date * Format: date-time */ winners_announced_date?: string | null; }; /** CreateCustomReferenceRequest */ CreateCustomReferenceRequest: { /** Input Images */ input_images: string[]; /** Name */ name: string; }; /** CreateCustomReferenceResponse */ CreateCustomReferenceResponse: { /** Created At */ created_at: string; /** Id */ id: string; /** Name */ name: string; /** Status */ status: string; }; /** CreateDMRequest */ CreateDMRequest: { /** Recipient Handle */ recipient_handle: string; }; /** CreateDMResponse */ CreateDMResponse: { /** * Created At * Format: date-time */ created_at: string; /** Thread Id */ thread_id: string; }; /** CreateGroupRequest */ CreateGroupRequest: { /** Member Handles */ member_handles: string[]; /** Name */ name: string; }; /** CreateGroupResponse */ CreateGroupResponse: { /** * Created At * Format: date-time */ created_at: string; /** Group Name */ group_name: string; /** Participant Count */ participant_count: number; /** Thread Id */ thread_id: string; }; /** CreatePersonaSpec */ CreatePersonaSpec: { /** Clips */ clips?: string[] | null; /** Description */ description?: string | null; /** Image S3 Id */ image_s3_id?: string | null; /** * Is Public * @default false */ is_public?: boolean; /** * Is Suno Persona * @default false */ is_suno_persona?: boolean; /** Name */ name?: string | null; /** Root Clip Id */ root_clip_id: string; }; /** CreateSessionIdSchema */ CreateSessionIdSchema: { /** * Session Id * Format: uuid */ session_id: string; /** Session Length */ session_length: number; }; /** CreateSessionIdSpec */ CreateSessionIdSpec: { /** Session Properties */ session_properties: string; session_type: components["schemas"]["SessionType"]; }; /** CreateSoulImageRequest */ CreateSoulImageRequest: { /** Custom Reference Id */ custom_reference_id?: string | null; /** Custom Reference Strength */ custom_reference_strength?: number | null; /** Enhance Prompt */ enhance_prompt?: boolean | null; /** Image Reference */ image_reference?: { [key: string]: string; } | null; /** Prompt */ prompt: string; /** Quality */ quality?: string | null; /** Seed */ seed?: number | null; /** Style Id */ style_id?: string | null; /** Style Strength */ style_strength?: number | null; /** Width And Height */ width_and_height?: string | null; }; /** CreateSurveyQuestionSpec */ CreateSurveyQuestionSpec: { /** Group Id */ group_id: string; /** * Is Active * @default true */ is_active?: boolean; /** * Is Required * @default false */ is_required?: boolean; /** Options */ options?: string[] | null; /** * Order * @default 0 */ order?: number; /** Prompt */ prompt: string; type: components["schemas"]["QuestionType"]; }; /** CreateSurveyResponseSpec */ CreateSurveyResponseSpec: { /** * Question Id * Format: uuid */ question_id: string; /** Response */ response: string[]; }; /** CreditPackSchema */ CreditPackSchema: { /** Amount */ amount: number; /** * Id * Format: uuid */ id?: string | null; /** Price Usd */ price_usd: number; }; /** CreditPurchaseSchemaResponse */ CreditPurchaseSchemaResponse: { /** Id */ id: string; /** Ok */ ok: boolean; }; /** CreditsRemainingResponse */ CreditsRemainingResponse: { /** Running Jobs Cost */ running_jobs_cost: number; /** Total Credits Left */ total_credits_left: number; }; /** CropClipSpec */ CropClipSpec: { /** Crop End S */ crop_end_s: number; /** Crop Start S */ crop_start_s: number; /** Edit Session Id */ edit_session_id?: string | null; /** Is Crop Remove */ is_crop_remove: boolean; /** Project Id */ project_id?: string | null; }; /** * DefaultCurrencySchemaResponse * @description Schema for default currency response based on user location. */ DefaultCurrencySchemaResponse: { /** Currency */ currency: string; }; /** DeleteAccountSpec */ DeleteAccountSpec: { /** * Cancel * @default false */ cancel?: boolean; /** Confirm Delete */ confirm_delete?: string | null; /** Email */ email?: string | null; /** * Force Immediate * @default false */ force_immediate?: boolean; /** Phone Number */ phone_number?: string | null; }; /** * DeleteClipReason * @enum {string} */ DeleteClipReason: "copyright_infringement" | "hate_violence" | "sexual_content" | "other"; /** DeleteCommentRequest */ DeleteCommentRequest: { entity_type?: components["schemas"]["CommentEntityType"]; }; /** DeleteCommentResponse */ DeleteCommentResponse: { /** Id */ id: string; /** * Status * @enum {string} */ status: "deleted"; }; /** DeleteHookResponse */ DeleteHookResponse: { /** Id */ id: string; /** Success */ success: boolean; }; /** DeleteSavedPromptSpec */ DeleteSavedPromptSpec: { /** Id */ id: string; }; /** DeletedClipsSchema */ DeletedClipsSchema: { /** Attribute To */ attribute_to?: string | null; /** Ids */ ids: string[]; reason?: components["schemas"]["DeleteClipReason"]; }; /** DirectChildrenByUserSchema */ DirectChildrenByUserSchema: { /** Continuation Token */ continuation_token?: string | null; /** Current Page */ current_page: number; /** Total Count */ total_count: number; /** Total Users */ total_users: number; /** User Groups */ user_groups: components["schemas"]["UserGroupSchema"][]; }; /** DirectChildrenCountSchema */ DirectChildrenCountSchema: { /** Count */ count: number; }; /** DirectChildrenSchema */ DirectChildrenSchema: { /** Children */ children: components["schemas"]["GeneratedClipSchema"][]; /** Current Page */ current_page: number; }; /** * DiscountDetails * @description Schema for discount details. */ DiscountDetails: { /** Amount Off */ amount_off?: number | null; /** Coupon Id */ coupon_id: string; /** Duration Months */ duration_months: number; /** Percent Off */ percent_off?: number | null; }; /** * DiscountOfferWithRedemptionSchema * @description Schema for discount offer that includes redemption status */ DiscountOfferWithRedemptionSchema: { /** * Accepted At * Format: date-time */ accepted_at?: string | null; /** Amount Off */ amount_off?: number | null; /** Duration Months */ duration_months: number; /** * Is Accepted * @default false */ is_accepted?: boolean; /** Percent Off */ percent_off?: number | null; /** * Redeemed At * Format: date-time */ redeemed_at?: string | null; /** Stripe Coupon Id */ stripe_coupon_id: string; }; /** * DiscoverReq * @description DiscoverReq is a schema for the request body of the discover endpoint. * The schema is used to get the sections for the mobile/web homepage. * You specify the start index and the page size to get the sections. * If you need to get a specific section, then you set section_name which is the name of the section. * and set start_index to 0 and page_size to 1. */ DiscoverReq: { /** Disable Shuffle */ disable_shuffle?: boolean | null; /** * Language * @default en */ language?: string; /** * Page * @default 0 */ page?: number; /** * Page Size * @default 3 */ page_size?: number; /** * Platform * @default web * @enum {string} */ platform?: "mobile" | "web"; /** * Product * @enum {string|null} */ product?: "archive" | null; /** Secondary Section Content */ secondary_section_content?: string | null; /** Section Content */ section_content?: string | null; /** Section Name */ section_name?: string | null; /** Section Size */ section_size?: number | null; /** * Start Index * @default 0 */ start_index?: number; }; /** DiscoverResp */ DiscoverResp: { /** Page */ page: number; /** Page Size */ page_size: number; /** * Sections * @default [] */ sections?: (components["schemas"]["BannerSectionSchema"] | components["schemas"]["PlaylistSectionSchema"] | components["schemas"]["PlaylistListSectionSchema"] | components["schemas"]["StyleListSectionSchema"] | components["schemas"]["UserListSectionSchema"] | components["schemas"]["CommunityPersonasSectionSchema"] | components["schemas"]["FeaturedFeedSectionSchema"] | components["schemas"]["ShortcutSectionSchema"] | components["schemas"]["PromoSectionSchema"] | components["schemas"]["HooksSectionSchema"] | components["schemas"]["ContestListSectionSchema"])[]; /** Start Index */ start_index: number; /** Total Sections */ total_sections: number; }; /** DisplayTagsSpec */ DisplayTagsSpec: { /** Display Tags */ display_tags?: string | null; }; /** DownbeatsSchema */ DownbeatsSchema: { /** Downbeats */ downbeats?: number[][] | null; /** Error Message */ error_message?: string | null; /** Final */ final?: boolean | null; /** Onsets */ onsets?: number[] | null; /** Raw Downbeats */ raw_downbeats?: number[][] | null; /** Raw Onset Downbeats */ raw_onset_downbeats?: number[][] | null; /** Raw Onsets */ raw_onsets?: number[] | null; /** Seconds Missing From Start */ seconds_missing_from_start?: number | null; /** * State * @enum {string} */ state: "running" | "error" | "complete" | "streaming"; }; /** DownloadUsageResponse */ DownloadUsageResponse: { /** * Clip Owned By User * @default false */ clip_owned_by_user?: boolean; /** Downloads Limit */ downloads_limit: number; /** Downloads Remaining */ downloads_remaining: number; /** Downloads Used */ downloads_used: number; /** Has Unlimited Downloads */ has_unlimited_downloads: boolean; }; /** * DownloadVideoStatus * @enum {string} */ DownloadVideoStatus: "processing" | "ready" | "error"; /** DownsampleTagsRequest */ DownsampleTagsRequest: { /** Original Tags */ original_tags: string; }; /** EditActionRequestSchema */ EditActionRequestSchema: { /** Action Clip Id */ action_clip_id: string; }; /** EditActionStatusSchema */ EditActionStatusSchema: { /** Status */ status: string; }; /** EditPersonaSpec */ EditPersonaSpec: { /** Description */ description?: string | null; /** Image S3 Id */ image_s3_id?: string | null; /** Name */ name?: string | null; /** Persona Id */ persona_id: string; }; /** EduInfoResponse */ EduInfoResponse: { /** Has Valid School Email */ has_valid_school_email: boolean; }; /** * EligibleDiscountsResponse * @description Schema for eligible discounts response. */ EligibleDiscountsResponse: { /** * Eligible Discounts * @description Map of plan_key to subscription_period_type to discount details */ eligible_discounts: { [key: string]: { [key: string]: components["schemas"]["DiscountDetails"]; }; }; }; /** ExistingLyricsByIDResponse */ ExistingLyricsByIDResponse: { /** Lyrics */ lyrics?: string | null; }; /** ExtendSessionIdSchema */ ExtendSessionIdSchema: { /** Is Extended */ is_extended: boolean; /** * Session Id * Format: uuid */ session_id: string; /** Session Length */ session_length: number; }; /** ExtendSessionIdSpec */ ExtendSessionIdSpec: { /** * Session Id * Format: uuid */ session_id: string; }; /** * ExternalAlignedLyricsV2Schema * @description External version of aligned lyrics v2 schema. */ ExternalAlignedLyricsV2Schema: { /** Aligned Lyrics */ aligned_lyrics?: components["schemas"]["AlignedLyricSchema"][] | null; /** Aligned Words */ aligned_words: components["schemas"]["AlignedWordSchema"][]; /** Is Streamed */ is_streamed: boolean; }; /** ExternalClipSchema */ ExternalClipSchema: { /** Audio Url */ audio_url?: string | null; /** * Created At * Format: date-time */ created_at?: string | null; /** * Id * Format: uuid */ id: string; /** Image Large Url */ image_large_url?: string | null; /** Image Url */ image_url?: string | null; metadata: components["schemas"]["ExternalGenMetadataSchema"]; /** * Request Id * Format: uuid */ request_id?: string | null; /** Status */ status: string | null; /** Title */ title: string | null; /** Video Url */ video_url?: string | null; }; /** ExternalFilters */ ExternalFilters: { /** Ids */ ids?: string | null; /** * Page * @default 0 */ page?: number; }; /** * ExternalGenMetadataSchema * @description Selected fields from GeneratedClip.metadata. */ ExternalGenMetadataSchema: { /** Duration */ duration?: number | null; /** Error Message */ error_message?: string | null; /** Error Type */ error_type?: string | null; /** Gpt Description Prompt */ gpt_description_prompt?: string | null; /** Prompt */ prompt?: string | null; /** Tags */ tags?: string | null; /** * Type * @default gen */ type?: string; }; /** ExternalGenerationSpec */ ExternalGenerationSpec: { /** Cover Clip Id */ cover_clip_id?: string | null; /** Early Callback */ early_callback?: boolean | null; /** Extra */ extra?: { [key: string]: unknown; } | null; /** Make Instrumental */ make_instrumental?: boolean | null; /** Metadata */ metadata?: { [key: string]: unknown; } | null; /** Model */ model?: string | null; /** Negative Tags */ negative_tags?: string | null; /** Prompt */ prompt?: string | null; /** Rate Limit Key */ rate_limit_key?: string | null; /** Tags */ tags?: string | null; /** Temp Semantic */ temp_semantic?: number | null; /** Topic */ topic?: string | null; }; /** ExternalModelTypeSchema */ ExternalModelTypeSchema: { /** * Badges * @default [] */ badges?: components["schemas"]["BadgeType"][]; /** Can Use */ can_use?: boolean | null; /** Capabilities */ capabilities?: unknown[] | null; /** Description */ description: string; /** External Key */ external_key: string; /** * Id * Format: uuid */ id?: string | null; /** Is Default Free Model */ is_default_free_model?: boolean | null; /** Is Default Model */ is_default_model?: boolean | null; /** Major Version */ major_version: number; max_lengths?: components["schemas"]["ModelTypeMaxLengths"]; /** Model Subtype */ model_subtype?: string | null; /** Name */ name: string; }; /** ExternalRemasterModelTypeSchema */ ExternalRemasterModelTypeSchema: { /** External Key */ external_key: string; /** * Is Default Model * @default false */ is_default_model?: boolean; /** Name */ name: string; }; /** ExternalStemsSpec */ ExternalStemsSpec: { /** Clip Id */ clip_id: string; /** Stem Tasks */ stem_tasks: string[]; /** Stem Type Cfg Scales */ stem_type_cfg_scales: number[]; /** Stem Type Ids */ stem_type_ids: number[]; }; /** * ExternalUserInfoSchema * @description Schema for user profile and subscription info returned by the OAuth endpoint. */ ExternalUserInfoSchema: { /** Avatar Url */ avatar_url?: string | null; /** Display Name */ display_name: string; /** Email */ email: string; /** Handle */ handle: string; /** Is Subscriber */ is_subscriber: boolean; /** Monthly Limit */ monthly_limit: number; /** Monthly Usage */ monthly_usage: number; /** Plan Level */ plan_level?: string | null; /** Plan Name */ plan_name?: string | null; /** Plan Period */ plan_period?: string | null; /** Subscription Platform */ subscription_platform?: string | null; /** Subscription Status */ subscription_status?: string | null; /** Total Credits Remaining */ total_credits_remaining: number; /** User Id */ user_id: string; }; /** FAQItemSchema */ FAQItemSchema: { /** Answer */ answer: string; /** Question */ question: string; }; /** FadeClipSpec */ FadeClipSpec: { /** Edit Session Id */ edit_session_id?: string | null; /** * Fade Out Shape * @enum {string|null} */ fade_out_shape?: "q" | "t" | "l" | null; /** Fade Out Time */ fade_out_time?: number | null; /** Project Id */ project_id?: string | null; }; /** FaqItem */ FaqItem: { /** Answer */ answer: string; /** Question */ question: string; }; /** FeatureDescription */ FeatureDescription: { /** Text */ text: string; /** Type */ type: string; }; /** * FeatureName * @enum {string} */ FeatureName: "v4" | "cover" | "persona" | "edit_mode" | "can_buy_credit_top_ups" | "commercial_rights" | "generate_song_image" | "generate_song_video" | "get_stems" | "negative_tags" | "long_uploads" | "convert_audio" | "remaster" | "auk" | "studio" | "variation_remaster" | "playlist_condition"; /** FeatureSchema */ FeatureSchema: { name: components["schemas"]["FeatureName"]; }; /** FeaturedFeedSchema */ FeaturedFeedSchema: { /** Feed Metadata */ feed_metadata?: components["schemas"]["TrendingMetadataSchema"] | null; feed_metadata_type?: components["schemas"]["FeedMetadataType"]; /** * Id * @default */ id?: string; item_type: components["schemas"]["FeedItemEntityType"]; /** * Items * @default [] */ items?: (components["schemas"]["GeneratedClipSchema"] | components["schemas"]["PlaylistMetadataSchema"] | components["schemas"]["StyleItemSchema"] | components["schemas"]["PersonaSchema"] | components["schemas"]["SimpleProfileInfoSchema"] | components["schemas"]["FollowingFeedItemSchema"])[]; /** * Link * @default */ link?: string; /** * Mobile Link * @default */ mobile_link?: string; /** * Title * @default */ title?: string; }; /** FeaturedFeedSectionSchema */ FeaturedFeedSectionSchema: { /** Description */ description?: string | null; /** Id */ id: string; /** Items */ items: components["schemas"]["FeaturedFeedSchema"][]; /** Link */ link?: string | null; /** Mobile Link */ mobile_link?: string | null; /** Options */ options?: string[] | null; /** Secondary Options */ secondary_options?: string[] | null; /** Secondary Selected Option */ secondary_selected_option?: string | null; /** Section Name */ section_name?: string | null; /** * Section Type * @default featured_feed * @enum {string} */ section_type?: "featured_feed"; /** Selected Option */ selected_option?: string | null; /** Style Type */ style_type?: string | null; /** Title */ title: string; }; /** * FeedActivityType * @enum {string} */ FeedActivityType: "publish_song" | "comment_song" | "like_song" | "remix_song" | "publish_hook" | "suggest_creator"; /** * FeedItemEntityType * @enum {string} */ FeedItemEntityType: "song_schema" | "playlist_schema" | "style_schema" | "persona_schema" | "simple_profile_schema" | "following_feed_item_schema"; /** * FeedMetadataType * @enum {string} */ FeedMetadataType: "trending_metadata"; /** FeedOffsetRequestSpec */ FeedOffsetRequestSpec: { /** * Filters * @default {} */ filters?: { [key: string]: unknown; }; /** Offset */ offset: number; }; /** FeedSchema */ FeedSchema: { /** Clips */ clips: components["schemas"]["GeneratedClipSchema"][]; /** Current Page */ current_page: number; /** Num Total Results */ num_total_results: number; }; /** * FeedTypeEnum * @enum {string} */ FeedTypeEnum: "default"; /** FeedV3RequestSpec */ FeedV3RequestSpec: { /** Cursor */ cursor?: string | null; /** * Filters * @default {} */ filters?: { [key: string]: unknown; }; /** * Limit * @default 20 */ limit?: number; }; /** FeedV3ResponseSchema */ FeedV3ResponseSchema: { /** Clips */ clips: components["schemas"]["GeneratedClipSchema"][]; /** * Has More * @default false */ has_more?: boolean; /** Next Cursor */ next_cursor?: string | null; }; /** * FeedbackOption * @enum {integer} */ FeedbackOption: 0 | 1; /** * FeedbackReason * @enum {string} */ FeedbackReason: "artist" | "other"; /** FeedbackRequestSchema */ FeedbackRequestSchema: { /** Browser */ browser: string; /** Email */ email: string; /** Feedback */ feedback: string; feedbackOption: components["schemas"]["FeedbackOption"]; /** Link */ link: string; /** Medialink */ mediaLink: string; platform: components["schemas"]["Platform"]; /** Rating */ rating: number; /** Stepstoreproduce */ stepsToReproduce: string; }; /** FeedbackResponseSchema */ FeedbackResponseSchema: { /** Status */ status: string; }; /** FeedbackSpec */ FeedbackSpec: { /** Feedback Reason */ feedback_reason: string | null; }; /** * FeedbackType * @enum {string} */ FeedbackType: "not_interested" | "creator_not_interested"; /** Filters */ Filters: { /** Add Preset Clips */ add_preset_clips?: boolean | null; /** Categories */ categories?: string[] | null; /** Continuation Token */ continuation_token?: string | null; /** * From Index * @default 0 */ from_index?: number; /** Hide Disliked */ hide_disliked?: boolean | null; /** Hide Gen Stems */ hide_gen_stems?: boolean | null; /** Hide Studio Clips */ hide_studio_clips?: boolean | null; /** Ids */ ids?: string | null; /** Is Cover */ is_cover?: boolean | null; /** Is Extend */ is_extend?: boolean | null; /** Is Full Song */ is_full_song?: boolean | null; /** Is Gen Stem */ is_gen_stem?: boolean | null; /** Is Infill */ is_infill?: boolean | null; /** Is Liked */ is_liked?: boolean | null; /** Is Not Disliked */ is_not_disliked?: boolean | null; /** Is Persona */ is_persona?: boolean | null; /** Is Public */ is_public?: boolean | null; /** Is Scene */ is_scene?: boolean | null; /** Is Suno Short */ is_suno_short?: boolean | null; /** Is Trashed */ is_trashed?: boolean | null; /** Is Upsample */ is_upsample?: boolean | null; /** Is Video To Song */ is_video_to_song?: boolean | null; /** * Page * @default 0 */ page?: number; /** * Page Size * @default 20 */ page_size?: number; /** Query */ query?: string | null; /** Status */ status?: string | null; }; /** FindExistingUserByPhoneReq */ FindExistingUserByPhoneReq: { /** * Not Following * @default true */ not_following?: boolean; /** * Phones * @default [] */ phones?: string[]; }; /** FindExistingUserByPhoneResp */ FindExistingUserByPhoneResp: { /** * User Profiles * @default [] */ user_profiles?: components["schemas"]["UserMobileProfileSchema"][]; }; /** FinishUploadSpec */ FinishUploadSpec: { /** Clip Id */ clip_id?: string | null; /** Fail Task On Moderation */ fail_task_on_moderation?: boolean | null; /** Is Video Cover */ is_video_cover?: boolean | null; /** Require Video Sprite */ require_video_sprite?: boolean | null; /** Upload Filename */ upload_filename: string; /** Upload Type */ upload_type: string; video_upload_type?: components["schemas"]["VideoUploadType"]; }; /** FlagArtistProfileSpec */ FlagArtistProfileSpec: { /** Handle */ handle: string; /** Unflag */ unflag: boolean | null; }; /** FlagChatRequest */ FlagChatRequest: { /** Channel Id */ channel_id?: string | null; /** Channel Type */ channel_type?: string | null; /** Chat Id */ chat_id?: string | null; /** Reason */ reason?: string | null; }; /** FlagChatResponse */ FlagChatResponse: Record; /** FlagHookRequest */ FlagHookRequest: { staff_review_status?: components["schemas"]["HookStaffReviewStatus"]; }; /** FlagHookResponse */ FlagHookResponse: { /** Hook Id */ hook_id: string; /** Success */ success: boolean; }; /** * FlagSpec * @description Represent an update to a UserReaction.flagged state */ FlagSpec: { /** Flagged */ flagged: boolean; /** Flagged Reason */ flagged_reason: string | null; /** Flagged Reason Details */ flagged_reason_details?: ({ [key: string]: number | string | boolean; }) | null; }; /** FollowArtistProfileSpec */ FollowArtistProfileSpec: { /** Handle */ handle: string; recommendation_metadata?: components["schemas"]["RecommendationMetadataSchema"]; /** Unfollow */ unfollow: boolean | null; }; /** FollowingFeedItemSchema */ FollowingFeedItemSchema: { activity_type: components["schemas"]["FeedActivityType"]; clip_schema?: components["schemas"]["GeneratedClipSchema"]; comment_schema?: components["schemas"]["CommentSchema"]; /** * Entity Type * @default following_feed_item_schema * @enum {string} */ entity_type?: "following_feed_item_schema"; /** * Feed Timestamp * Format: date-time */ feed_timestamp: string; followed_user_profile?: components["schemas"]["SimpleProfileInfoSchema"]; persona_schema?: components["schemas"]["PersonaSchema"]; profile_schema?: components["schemas"]["SimpleProfileInfoSchema"]; }; /** * FollowingFeedRankingMethod * @enum {string} */ FollowingFeedRankingMethod: "default" | "chronological"; /** FollowingFeedRequest */ FollowingFeedRequest: { feed_type?: components["schemas"]["FeedTypeEnum"]; item_type?: components["schemas"]["ItemTypeEnum"]; /** Page Size */ page_size?: number | null; /** Start Index */ start_index?: number | null; }; /** FollowingFeedRequestSchema */ FollowingFeedRequestSchema: { /** * Page Size * @default 20 */ page_size?: number; /** @default default */ ranking_method?: components["schemas"]["FollowingFeedRankingMethod"]; /** @default all */ result_type?: components["schemas"]["FollowingFeedResultType"]; /** * Start Feed Timestamp * Format: date-time */ start_feed_timestamp?: string | null; }; /** FollowingFeedResponse */ FollowingFeedResponse: { feed_type: components["schemas"]["FeedTypeEnum"]; item_type: components["schemas"]["ItemTypeEnum"]; /** * Items * @default [] */ items?: (components["schemas"]["GeneratedClipSchema"] | components["schemas"]["PlaylistSchema"])[]; /** * Page Size * @default 0 */ page_size?: number; /** * Start Index * @default 0 */ start_index?: number; /** * User Handle * @default */ user_handle?: string; }; /** FollowingFeedResponseSchema */ FollowingFeedResponseSchema: { /** * First Item Timestamp * Format: date-time */ first_item_timestamp: string | null; /** * Items * @default [] */ items?: components["schemas"]["FollowingFeedItemSchema"][]; /** * Last Item Timestamp * Format: date-time */ last_item_timestamp: string | null; /** * Page Size * @default 0 */ page_size?: number; }; /** * FollowingFeedResultType * @enum {string} */ FollowingFeedResultType: "all" | "published_songs" | "social_activity"; /** * FrameShape * @enum {integer} */ FrameShape: 1 | 2; /** GenConcatSpec */ GenConcatSpec: { /** Clip Id */ clip_id: string; /** Edit Session Id */ edit_session_id?: string | null; /** Is Infill */ is_infill?: boolean | null; /** Project Id */ project_id?: string | null; }; /** GenLyricsRequestId */ GenLyricsRequestId: { /** Id */ id: string; }; /** GenLyricsRequestIds */ GenLyricsRequestIds: { /** * Lyrics A Id * Format: uuid */ lyrics_a_id: string; /** * Lyrics B Id * Format: uuid */ lyrics_b_id: string; /** * Lyrics Request Id * Format: uuid */ lyrics_request_id: string; }; /** GenLyricsSchema */ GenLyricsSchema: { /** Error Message */ error_message: string; /** Status */ status: string; /** Tags */ tags?: string[] | null; /** Text */ text: string; /** Title */ title: string; }; /** GenLyricsSpec */ GenLyricsSpec: { /** Create Session Token */ create_session_token?: string | null; /** * Gen Type * @default full */ gen_type?: string; /** * Lyrics Model * @default default */ lyrics_model?: string; /** * Make Instrumental * @default false */ make_instrumental?: boolean; /** * Prompt * @default */ prompt?: string; /** Tags */ tags?: string | null; }; /** * GenMetadataSchema * @description Selected fields from GeneratedClip.metadata. */ GenMetadataSchema: { /** Artist Clip Id */ artist_clip_id?: string | null; /** Avg Bpm */ avg_bpm?: number | null; /** Can Publish With Vocal */ can_publish_with_vocal?: boolean | null; /** Can Remix */ can_remix?: boolean | null; /** Complement Of Id */ complement_of_id?: string | null; /** Concat History */ concat_history?: ((string | { [key: string]: unknown; })[]) | null; /** Configurations */ configurations?: ({ [key: string]: number | string | boolean; }) | null; /** Contest Ids */ contest_ids?: string[] | null; /** Continue At */ continue_at?: number | null; control_sliders?: components["schemas"]["ControlSlidersSchema"]; /** Control Tags */ control_tags?: string | null; /** Cover Clip Id */ cover_clip_id?: string | null; /** Duration */ duration?: number | null; /** Edit Session Id */ edit_session_id?: string | null; /** Edited Clip Id */ edited_clip_id?: string | null; /** Error Message */ error_message?: string | null; /** Error Type */ error_type?: string | null; /** Existing Stems */ existing_stems?: string[] | null; /** Free Quota Category */ free_quota_category?: string | null; /** Gpt Description Prompt */ gpt_description_prompt?: string | null; /** Has Stem */ has_stem?: boolean | null; /** Has Vocal */ has_vocal?: boolean | null; /** History */ history?: ((string | { [key: string]: unknown; })[]) | null; /** Image To Song Image Ids */ image_to_song_image_ids?: string[] | null; /** Image To Song Image Urls */ image_to_song_image_urls?: string[] | null; /** Infill */ infill?: boolean | null; /** Infill Lyrics */ infill_lyrics?: string | null; /** Is Audio Upload Tos Accepted */ is_audio_upload_tos_accepted?: boolean | null; /** Is Image To Song */ is_image_to_song?: boolean | null; /** Is Loudness Under Threshold */ is_loudness_under_threshold?: boolean | null; /** Is Remix */ is_remix?: boolean | null; /** Is Suno Short */ is_suno_short?: boolean | null; /** Key */ key?: string | null; /** Lyrics Updated */ lyrics_updated?: boolean | null; /** Max Bpm */ max_bpm?: number | null; /** Min Bpm */ min_bpm?: number | null; model_badges?: components["schemas"]["ModelBadgesSchema"]; /** Negative Tags */ negative_tags?: string | null; /** Normalize Volume */ normalize_volume?: boolean | null; /** Opt Out Video Cover Hook */ opt_out_video_cover_hook?: boolean | null; /** Overpainting Clip Id */ overpainting_clip_id?: string | null; /** Override Future Clip Id */ override_future_clip_id?: string | null; /** Override Future Start Seconds */ override_future_start_seconds?: number | null; /** Override History Clip Id */ override_history_clip_id?: string | null; /** Override History End Seconds */ override_history_end_seconds?: number | null; /** Persona Id */ persona_id?: string | null; /** Playlist Id */ playlist_id?: string | null; /** Priority */ priority?: number | null; /** Prompt */ prompt?: string | null; /** Refund Credits */ refund_credits?: boolean | null; /** Remix */ remix?: string | null; /** Show Remix */ show_remix?: boolean | null; /** Speed Clip Id */ speed_clip_id?: string | null; /** Stem From Id */ stem_from_id?: string | null; /** Stem Task */ stem_task?: string | null; /** Stem Type Group Name */ stem_type_group_name?: string | null; /** Stem Type Id */ stem_type_id?: number | null; /** Stream */ stream?: boolean | null; /** Styles Lyrics Clip Id */ styles_lyrics_clip_id?: string | null; /** Tags */ tags?: string | null; /** * Task * @enum {string|null} */ task?: "extend" | "upload_extend" | "infill" | "fixed_infill" | "infill_intro" | "infill_outro" | "cover_infill" | "cover_extend" | "artist_infill" | "artist_consistency" | "cover" | "image_to_song" | "video_to_song" | "concat" | "concat_infilling" | "upsample" | "twitter_to_song" | "artist_cover" | "vox_cover" | "artist_extend" | "artist_cover_extend" | "vox" | "stem" | "gen_stem" | "generate" | "multi_artist_consistency" | "playlist_condition" | "underpainting" | "overpainting" | "stem_condition" | "cover_stem_condition" | "artist_stem_condition" | "stem_infill" | "stem_condition_infill" | "vox_playlist_condition" | "" | null; /** * Type * @default gen */ type?: string; /** Underpainting Clip Id */ underpainting_clip_id?: string | null; /** Upsample Clip Id */ upsample_clip_id?: string | null; /** Uses Latest Model */ uses_latest_model?: boolean | null; /** * Variation Category * @enum {string|null} */ variation_category?: "subtle" | "normal" | "high" | null; /** Video Is Stale */ video_is_stale?: boolean | null; /** Video To Song Video Output Url */ video_to_song_video_output_url?: string | null; /** Video To Song Video Upload Id */ video_to_song_video_upload_id?: string | null; /** Video To Song Video Upload Url */ video_to_song_video_upload_url?: string | null; /** Video Upload Height */ video_upload_height?: number | null; /** Video Upload Width */ video_upload_width?: number | null; }; /** GenParamsSpec */ GenParamsSpec: { /** Artist Clip Id */ artist_clip_id?: string | null; /** Artist Clip Ids */ artist_clip_ids?: string[] | null; /** Artist End S */ artist_end_s?: number | null; /** Artist Start S */ artist_start_s?: number | null; /** * Batch Size * @default 2 */ batch_size?: number; /** Continue At */ continue_at?: number | null; /** Continue Clip Id */ continue_clip_id?: string | null; /** Continued Aligned Prompt */ continued_aligned_prompt?: string | null; /** Cover Clip Id */ cover_clip_id?: string | null; /** Cover End S */ cover_end_s?: number | null; /** Cover Image S3 Id */ cover_image_s3_id?: string | null; /** Cover Start S */ cover_start_s?: number | null; /** * Creation Source * @enum {string|null} */ creation_source?: "studio" | "radio" | "live-radio" | null; /** Duration */ duration?: number | null; /** Edit Session Id */ edit_session_id?: string | null; /** * Generation Type * @default TEXT * @enum {string} */ generation_type?: "TEXT" | "AUDIO" | "IMAGE" | "VIDEO" | "TWITTER"; /** Gpt Description Prompt */ gpt_description_prompt?: string | null; /** Gpt Lang */ gpt_lang?: string | null; /** Gpt Prompt */ gpt_prompt?: string | null; /** Include Future S */ include_future_s?: number | null; /** Include History */ include_history?: boolean | null; /** Include History S */ include_history_s?: number | null; /** Infill Context End S */ infill_context_end_s?: number | null; /** Infill Context Start S */ infill_context_start_s?: number | null; /** Infill Dur S */ infill_dur_s?: number | null; /** Infill End S */ infill_end_s?: number | null; /** Infill Lyrics */ infill_lyrics?: string | null; /** Infill Start S */ infill_start_s?: number | null; /** * Is Regenerate * @default false */ is_regenerate?: boolean; /** Is Remix */ is_remix?: boolean | null; /** * Make Instrumental * @default false */ make_instrumental?: boolean; /** * Metadata * @default {} */ metadata?: unknown; /** Model */ model?: string | null; /** * Model Name * @default chirp-v1-xl */ model_name?: string; /** Mv */ mv?: string | null; /** Negative Tags */ negative_tags?: string | null; /** Overpainting Clip Id */ overpainting_clip_id?: string | null; /** Overpainting End S */ overpainting_end_s?: number | null; /** Overpainting Start S */ overpainting_start_s?: number | null; /** * Override Fields * @default [] */ override_fields?: ("prompt" | "tags")[]; /** Override Future Clip Id */ override_future_clip_id?: string | null; /** Override Future Start Seconds */ override_future_start_seconds?: number | null; /** Override History Clip Id */ override_history_clip_id?: string | null; /** Override History End Seconds */ override_history_end_seconds?: number | null; /** Persona Id */ persona_id?: string | null; /** Persona Ids */ persona_ids?: string[] | null; /** Playlist Clip Ends */ playlist_clip_ends?: ((number | null)[]) | null; /** Playlist Clip Ids */ playlist_clip_ids?: string[] | null; /** Playlist Clip Starts */ playlist_clip_starts?: ((number | null)[]) | null; /** Playlist Id */ playlist_id?: string | null; /** Project Id */ project_id?: string | null; /** Prompt */ prompt: string; /** Stem Condition Clip Id */ stem_condition_clip_id?: string | null; /** Stem Condition End S */ stem_condition_end_s?: number | null; /** Stem Condition Start S */ stem_condition_start_s?: number | null; /** Stem Control Tags */ stem_control_tags?: string | null; /** Stem Task */ stem_task?: string | null; /** Stem Type Group Name */ stem_type_group_name?: string | null; /** Stem Type Id */ stem_type_id?: number | null; /** * Stream * @default false */ stream?: boolean; /** Styles Lyrics Clip Id */ styles_lyrics_clip_id?: string | null; /** Tags */ tags?: string | null; /** * Task * @enum {string|null} */ task?: "extend" | "upload_extend" | "infill" | "fixed_infill" | "infill_intro" | "infill_outro" | "cover_infill" | "cover_extend" | "artist_infill" | "artist_consistency" | "cover" | "image_to_song" | "video_to_song" | "concat" | "concat_infilling" | "upsample" | "twitter_to_song" | "artist_cover" | "vox_cover" | "artist_extend" | "artist_cover_extend" | "vox" | "stem" | "gen_stem" | "generate" | "multi_artist_consistency" | "playlist_condition" | "underpainting" | "overpainting" | "stem_condition" | "cover_stem_condition" | "artist_stem_condition" | "stem_infill" | "stem_condition_infill" | "vox_playlist_condition" | "" | null; /** * Title * @default */ title?: string; /** Titles */ titles?: string[] | null; /** Token */ token?: string | null; /** Underpainting Clip Id */ underpainting_clip_id?: string | null; /** Underpainting End S */ underpainting_end_s?: number | null; /** Underpainting Start S */ underpainting_start_s?: number | null; /** Use Personalization */ use_personalization?: boolean | null; /** User Uploaded Image Ids */ user_uploaded_image_ids?: string[] | null; /** User Uploaded Images B64 */ user_uploaded_images_b64?: string[] | null; /** User Uploaded Video Id */ user_uploaded_video_id?: string | null; /** Voice */ voice?: string | null; /** Voice Id */ voice_id?: string | null; }; /** GenerateSceneScriptRequest */ GenerateSceneScriptRequest: { /** Clip Id */ clip_id: string; /** * Regenerate * @default false */ regenerate?: boolean; /** Video Workspace Id */ video_workspace_id?: string | null; }; /** GenerateVideoCoverPromptRequest */ GenerateVideoCoverPromptRequest: { /** Clip Id */ clip_id: string; /** Image Url */ image_url?: string | null; /** Prompt */ prompt?: string | null; }; /** GenerateVideoCoverPromptResponse */ GenerateVideoCoverPromptResponse: { /** Video Prompt */ video_prompt: string; }; /** GenerateVideoCoverRequest */ GenerateVideoCoverRequest: { /** Clip Id */ clip_id: string; /** * Gen Type * @default image_2_video * @enum {string} */ gen_type?: "image_2_video" | "text_2_video"; /** Image Url */ image_url?: string | null; /** Prompt */ prompt?: string | null; /** * Resolution * @enum {string|null} */ resolution?: "512P" | "768P" | "1080P" | null; }; /** GenerateVideoCoverResponse */ GenerateVideoCoverResponse: { /** * Status * @enum {string} */ status: "success" | "error"; /** Task Id */ task_id: string; }; /** GenerateVideoRequest */ GenerateVideoRequest: { /** * Action Type * @default generate_video * @enum {string} */ action_type?: "generate_script" | "generate_video" | "generate_image"; /** Clip Id */ clip_id: string; /** Custom Reference Id */ custom_reference_id?: string | null; /** Image Url */ image_url?: string | null; /** * Platform * @default higgsfield * @enum {string} */ platform?: "higgsfield" | "minimax"; /** Prompt */ prompt?: string | null; /** * Type * @default short_video * @enum {string} */ type?: "short_video" | "soul_video"; }; /** GenerateVideoResponse */ GenerateVideoResponse: { /** Clip Id */ clip_id: string; /** * Status * @enum {string} */ status: "success" | "error"; /** Video Workspace Id */ video_workspace_id: string; }; /** GeneratedClipSchema */ GeneratedClipSchema: { /** Allow Comments */ allow_comments?: boolean | null; /** Allowed Remix Actions */ allowed_remix_actions?: components["schemas"]["RemixAction"][] | null; audioMetadata?: components["schemas"]["AudioMetadataSchema"]; /** Audio Url */ audio_url?: string | null; /** Avatar Image Url */ avatar_image_url?: string | null; /** Caption */ caption?: string | null; caption_mentions?: components["schemas"]["MentionsContainer"]; /** Comment Count */ comment_count?: number | null; /** * Created At * Format: date-time */ created_at: string; /** Display Name */ display_name?: string | null; /** Display Tags */ display_tags?: string | null; /** * Download Disabled Reason * @enum {string|null} */ download_disabled_reason?: "remix_contest" | null; /** * Entity Type * @default song_schema * @enum {string} */ entity_type?: "song_schema"; /** Explicit */ explicit?: boolean | null; /** Flag Count */ flag_count?: number | null; /** Handle */ handle?: string | null; /** * Has Hook * @default false */ has_hook?: boolean; /** Hook Preview Thumbnail Url */ hook_preview_thumbnail_url?: string | null; /** * Id * Format: uuid */ id: string; /** Image Large Url */ image_large_url?: string | null; /** Image Url */ image_url?: string | null; /** Is Contest Base Clip */ is_contest_base_clip?: boolean | null; /** Is Contest Clip */ is_contest_clip?: boolean | null; /** Is Following Creator */ is_following_creator?: boolean | null; /** Is Handle Updated */ is_handle_updated: boolean; /** Is Liked */ is_liked: boolean; /** Is Pinned */ is_pinned?: boolean | null; /** Is Public */ is_public?: boolean | null; /** Is Trashed */ is_trashed: boolean; /** Major Model Version */ major_model_version: string; metadata: components["schemas"]["GenMetadataSchema"]; /** Model Name */ model_name: string; ownership?: components["schemas"]["ClipOwnershipSchema"]; persona?: components["schemas"]["SimplePersonaSchema"]; /** * Play Count * @default 0 */ play_count?: number; /** Preview Seconds */ preview_seconds?: number | null; /** Preview Url */ preview_url?: string | null; project?: components["schemas"]["SimpleProjectSchema"]; reaction?: components["schemas"]["UserReactionSchema"]; remix_defaults?: components["schemas"]["ClipRemixPermissionDefaults"]; /** Remix Restriction Reason */ remix_restriction_reason?: string | null; /** * Status * @default complete */ status?: string; /** * Title * @default */ title?: string; /** * Upvote Count * @default 0 */ upvote_count?: number; /** User Id */ user_id?: string | null; /** Video Cover Streaming Urls */ video_cover_streaming_urls?: { [key: string]: string; } | null; /** Video Cover Url */ video_cover_url?: string | null; /** Video Url */ video_url?: string | null; }; /** GenerationRequestSchema */ GenerationRequestSchema: { /** * Batch Size * @default 1 */ batch_size?: number; /** Clips */ clips: components["schemas"]["GeneratedClipSchema"][]; /** * Created At * Format: date-time */ created_at: string; /** * Id * Format: uuid */ id: string; /** Major Model Version */ major_model_version: string; metadata: components["schemas"]["GenMetadataSchema"]; /** * Status * @default complete */ status?: string; }; /** GenerationRequestSimpleSchema */ GenerationRequestSimpleSchema: { /** * Batch Size * @default 1 */ batch_size?: number; /** * Created At * Format: date-time */ created_at: string; /** * Id * Format: uuid */ id: string; /** Major Model Version */ major_model_version: string; metadata: components["schemas"]["GenMetadataSchema"]; /** * Status * @default complete */ status?: string; }; /** GenericModerationErrorSchema */ GenericModerationErrorSchema: { /** Moderation Error Message */ moderation_error_message: string; }; /** GenericToggleCommentsResponse */ GenericToggleCommentsResponse: { /** Can Comment */ can_comment: boolean; /** Entity Id */ entity_id: string; }; /** GenreSchema */ GenreSchema: { /** * Entity Type * @default genre_schema * @enum {string} */ entity_type?: "genre_schema"; /** Genre */ genre: string; /** Image */ image?: string | null; }; /** GetCommentCountResponse */ GetCommentCountResponse: { /** Count */ count: number; }; /** GetCommentRepliesResponse */ GetCommentRepliesResponse: { /** Replies */ replies?: components["schemas"]["ReplySchema"][] | null; /** Reply Continuation Token */ reply_continuation_token?: string | null; /** Total Count */ total_count?: number | null; }; /** GetCommentsResponse */ GetCommentsResponse: { /** * Allow Comment * @default true */ allow_comment?: boolean; /** Disable Reason */ disable_reason?: string | null; /** Next Cursor */ next_cursor?: string | null; /** Results */ results: components["schemas"]["CommentSchema"][]; /** * Total Count * @default 0 */ total_count?: number; }; /** GetCommonCreateTagsResponse */ GetCommonCreateTagsResponse: { /** Create Tags */ create_tags: string[]; }; /** GetDiscountOfferResponse */ GetDiscountOfferResponse: { discount_offer: components["schemas"]["DiscountOfferWithRedemptionSchema"]; }; /** GetSongsByIdsSchema */ GetSongsByIdsSchema: { /** Clips */ clips: components["schemas"]["GeneratedClipSchema"][]; }; /** GetThreadMessagesResponse */ GetThreadMessagesResponse: { /** Has More */ has_more: boolean; /** Messages */ messages: components["schemas"]["MessageSchema"][]; /** Thread Id */ thread_id: string; }; /** GetThreadResponse */ GetThreadResponse: { thread: components["schemas"]["ThreadDetailSchema"]; }; /** GetUserConfigRequestSpec */ GetUserConfigRequestSpec: Record; /** GetUserMeResponse */ GetUserMeResponse: { /** Avatar Image Url */ avatar_image_url?: string | null; /** Birthday */ birthday?: string | null; /** Display Name */ display_name?: string | null; /** Email */ email?: string | null; /** Handle */ handle?: string | null; /** * Is Handle Updated * @default false */ is_handle_updated?: boolean; /** Phone Number */ phone_number?: string | null; /** Secondary Email */ secondary_email?: string | null; /** User Id */ user_id?: string | null; }; /** GetUserSessionIdSchema */ GetUserSessionIdSchema: { /** Session Id */ session_id: string; }; /** GetUserVideoHooksResponse */ GetUserVideoHooksResponse: { /** Items */ items: components["schemas"]["VideoHookSchema"][]; /** Page Size */ page_size: number; /** Start Index */ start_index: number; }; /** GetVideoCoverResponse */ GetVideoCoverResponse: { /** Status */ status: string; /** Task Id */ task_id: string; /** Video Url */ video_url?: string | null; }; /** GetVideoHooksFromClipResponse */ GetVideoHooksFromClipResponse: { /** Items */ items: components["schemas"]["VideoHookSchema"][]; /** Page Size */ page_size: number; /** Start Index */ start_index: number; }; /** GetVideosResponse */ GetVideosResponse: { /** Video Urls */ video_urls: string[]; }; /** * HackMITStemsSpec * @description Simplified stem spec for HackMIT - only clip_id required. */ HackMITStemsSpec: { /** Clip Id */ clip_id: string; }; /** HashtagSchema */ HashtagSchema: { /** Count */ count: number; /** Hashtag */ hashtag: string; }; /** HashtagSearchRequest */ HashtagSearchRequest: { /** Term */ term: string; }; /** HashtagSearchResult */ HashtagSearchResult: { /** Hashtags */ hashtags: components["schemas"]["HashtagSchema"][]; }; /** * HideCreatorContentType * @enum {string} */ HideCreatorContentType: "HOOK" | "CLIP"; /** HideCreatorResponse */ HideCreatorResponse: { /** Success */ success: boolean; }; /** HideCreatorSpec */ HideCreatorSpec: { content_type: components["schemas"]["HideCreatorContentType"]; recommendation_metadata?: components["schemas"]["RecommendationMetadataSchema"]; /** * Unhide * @default false */ unhide?: boolean; /** User Handle */ user_handle: string; }; /** HiveModerationResponseSchema */ HiveModerationResponseSchema: { /** * Created At * Format: date-time */ created_at: string; /** * Id * Format: uuid */ id: string; /** Response */ response: { [key: string]: unknown; }; /** * Updated At * Format: date-time */ updated_at: string; /** * Video Upload Id * Format: uuid */ video_upload_id: string; }; /** * HookCreatorLabel * @enum {string} */ HookCreatorLabel: "champion" | "ambassador"; /** HookDownloadResponse */ HookDownloadResponse: { /** Download Url */ download_url?: string | null; /** Expires In */ expires_in?: number | null; status: components["schemas"]["DownloadVideoStatus"]; }; /** * HookInteractionType * @enum {string} */ HookInteractionType: "like_double_tap" | "like_single_tap" | "undo_like_double_tap" | "undo_like_single_tap"; /** HookLyricsRequest */ HookLyricsRequest: { /** Hook Ids */ hook_ids: string[]; }; /** HookLyricsResponse */ HookLyricsResponse: { /** Hook Lyrics */ hook_lyrics: { [key: string]: components["schemas"]["AlignedLyricSchema"][]; }; }; /** HookPublishSchema */ HookPublishSchema: { /** * Allow Comments * @default true */ allow_comments?: boolean; /** * Caption * @default */ caption?: string; /** * Is Public * @default true */ is_public?: boolean; /** * Ping To Profile * @default false */ ping_to_profile?: boolean; /** * Show Lyrics * @default true */ show_lyrics?: boolean; /** * Title * @default */ title?: string; }; /** HookReactionRequest */ HookReactionRequest: { action: components["schemas"]["ReactionAction"]; recommendation_metadata?: components["schemas"]["RecommendationMetadata"]; }; /** HookReactionResponse */ HookReactionResponse: { /** Current User Disliked */ current_user_disliked: boolean; /** Current User Liked */ current_user_liked: boolean; /** Hook Id */ hook_id: string; /** Like Count */ like_count: number; /** Success */ success: boolean; }; /** HookReportRequest */ HookReportRequest: { recommendation_metadata?: components["schemas"]["RecommendationMetadata"]; /** Report Reason */ report_reason?: string | null; report_type?: components["schemas"]["HookReportType"]; }; /** HookReportResponse */ HookReportResponse: { /** Hook Id */ hook_id: string; /** Success */ success: boolean; }; /** * HookReportType * @enum {string} */ HookReportType: "inappropriate" | "spam" | "self_promotion" | "intellectual_property" | "other"; /** * HookStaffReviewStatus * @enum {integer} */ HookStaffReviewStatus: 0 | 1 | 2; /** HooksSectionSchema */ HooksSectionSchema: { /** Description */ description?: string | null; /** Id */ id: string; /** Items */ items: components["schemas"]["VideoHookSchema"][]; /** Link */ link?: string | null; /** Mobile Link */ mobile_link?: string | null; /** Options */ options?: string[] | null; /** Secondary Options */ secondary_options?: string[] | null; /** Secondary Selected Option */ secondary_selected_option?: string | null; /** Section Name */ section_name?: string | null; /** * Section Type * @default hooks * @enum {string} */ section_type?: "hooks"; /** Selected Option */ selected_option?: string | null; /** Style Type */ style_type?: string | null; /** Title */ title: string; }; /** ImagePromptSpec */ ImagePromptSpec: { /** Prompt */ prompt: string; }; /** InfillLyricsResult */ InfillLyricsResult: { /** Generated Lyrics */ generated_lyrics: string; /** * Lyrics Id * Format: uuid */ lyrics_id: string; /** * Lyrics Request Id * Format: uuid */ lyrics_request_id: string; }; /** InfillLyricsSpec */ InfillLyricsSpec: { /** * Context Lyrics Edit * @default */ context_lyrics_edit?: string; /** * Context Lyrics Prefix * @default */ context_lyrics_prefix?: string; /** * Context Lyrics Suffix * @default */ context_lyrics_suffix?: string; /** Create Session Token */ create_session_token?: string | null; /** * Lyrics Model * @default default */ lyrics_model?: string; /** * Prompt * @default */ prompt?: string; /** * Title * @default */ title?: string; }; /** InfillLyricsUndoRedoSpec */ InfillLyricsUndoRedoSpec: { /** * Lyrics Id * Format: uuid */ lyrics_id: string; }; /** InitializeClipSpec */ InitializeClipSpec: { /** Downbeats */ downbeats?: number[][] | null; }; /** InspectWatchHistoryResponse */ InspectWatchHistoryResponse: { /** Count */ count: number; /** Hook Ids */ hook_ids: string[]; /** Message */ message?: string | null; /** Success */ success: boolean; }; /** InstrumentsSchema */ InstrumentsSchema: { /** Error Message */ error_message?: string | null; /** Final */ final?: boolean | null; /** Groups */ groups?: string[] | null; /** Instruments */ instruments?: string[] | null; /** * State * @enum {string} */ state: "running" | "error" | "complete" | "streaming"; }; /** IntRangeSchema */ IntRangeSchema: { /** Max */ max: number; /** Min */ min: number; }; /** InviteHistorySchema */ InviteHistorySchema: { /** * Monthly Referral Limit * @default 5 */ monthly_referral_limit?: number; /** * Profiles * @default [] */ profiles?: components["schemas"]["SimpleProfileInfoSchema"][]; /** * Referral Count Current Month * @default 0 */ referral_count_current_month?: number; /** * Total Reward Current Month * @default 0 */ total_reward_current_month?: number; }; /** InviteSchema */ InviteSchema: { /** Error Msg */ error_msg?: string | null; /** * Potential Reward * @default false */ potential_reward?: boolean; /** * Potential Reward Amount * @default 0 */ potential_reward_amount?: number; }; /** InviteSpec */ InviteSpec: { /** Inviter Handle */ inviter_handle: string; }; /** IosInviteDataResponse */ IosInviteDataResponse: { /** Can Log In To Ios */ can_log_in_to_ios: boolean | null; /** Error Msg */ error_msg?: string | null; /** Inviter Handle */ inviter_handle?: string | null; /** Promo Code Url */ promo_code_url?: string | null; /** Redemptions Left */ redemptions_left?: number | null; }; /** IosInviterDataResponse */ IosInviterDataResponse: { /** Avatar Image Url */ avatar_image_url?: string | null; /** Error Msg */ error_msg?: string | null; /** Handle */ handle?: string | null; }; /** IosWaitlistResponse */ IosWaitlistResponse: { /** Is Waitlisted */ is_waitlisted: boolean; }; /** IpAddressResponse */ IpAddressResponse: { /** Ip Address */ ip_address: string; /** Request Headers */ request_headers: { [key: string]: string; }; }; /** * ItemTypeEnum * @enum {string} */ ItemTypeEnum: "clip" | "playlist" | "user" | "persona" | "hook"; /** KeySchema */ KeySchema: { /** Error Message */ error_message?: string | null; /** Final */ final?: boolean | null; /** Key */ key?: string | null; /** * State * @enum {string} */ state: "running" | "error" | "complete" | "streaming"; }; /** LikeSpec */ LikeSpec: { /** Like */ like: boolean; }; /** ListBetaGensSpec */ ListBetaGensSpec: { /** Cursor */ cursor?: string | null; /** * Limit * @default 10 */ limit?: number; /** * Show Disliked * @default false */ show_disliked?: boolean; /** * Show Liked * @default true */ show_liked?: boolean; /** * Show Unrated * @default true */ show_unrated?: boolean; }; /** * ListSessionResponse * @description Response schema for listing Orpheus sessions (max 200, sorted by updated_at desc) */ ListSessionResponse: { /** Sessions */ sessions: components["schemas"]["SessionSchema"][]; }; /** ListenHistoryResponse */ ListenHistoryResponse: { /** History */ history: components["schemas"]["ListenHistorySchema"][]; /** Next Cursor */ next_cursor?: string | null; }; /** ListenHistorySchema */ ListenHistorySchema: { /** Content */ content: components["schemas"]["GeneratedClipSchema"] | components["schemas"]["PlaylistSchema"]; /** Listened At */ listened_at: string; }; /** ListenerCountResponse */ ListenerCountResponse: { /** Listener Count */ listener_count: number; }; /** LocalStringSchema */ LocalStringSchema: { /** Color */ color?: string | null; /** Key */ key?: string | null; /** * Text * @default */ text?: string; }; /** LoggedInSessionResponse */ LoggedInSessionResponse: { /** * Configs * @default {} */ configs?: { [key: string]: unknown; }; /** Flags */ flags: { [key: string]: unknown; }; /** Models */ models: components["schemas"]["ExternalModelTypeSchema"][]; /** Roles */ roles: { [key: string]: unknown; }; statsig_custom_properties?: components["schemas"]["StatsigCustomProperties"]; user: components["schemas"]["LoggedInSessionUser"]; }; /** LoggedInSessionUser */ LoggedInSessionUser: { /** Avatar Image Url */ avatar_image_url: string | null; /** Clerk Id */ clerk_id: string | null; /** Display Name */ display_name: string | null; /** Email */ email: string; /** Handle */ handle: string | null; /** * Id * Format: uuid */ id: string | null; ios_invite_data: components["schemas"]["IosInviteDataResponse"]; /** Is Handle Updated */ is_handle_updated: boolean | null; /** Phone Number */ phone_number: string | null; /** Profile Description */ profile_description: string | null; /** Username */ username: string; }; /** LoggedOutResponse */ LoggedOutResponse: { /** Is Logged Out */ is_logged_out: boolean; }; /** * LyricDisplay * @enum {string} */ LyricDisplay: "bottom_left_line" | "bottom_left_word" | "centered_line" | "centered_word"; /** LyricsPairRatingSpec */ LyricsPairRatingSpec: { /** * Lyrics Request Id * Format: uuid */ lyrics_request_id: string; /** * Preferred Lyrics Id * Format: uuid */ preferred_lyrics_id: string | null; }; /** LyricsSearchRequest */ LyricsSearchRequest: { /** Created Before */ created_before?: string | null; /** Lyrics */ lyrics: string; }; /** LyricsSimilaritySpec */ LyricsSimilaritySpec: { /** Lyrics Id */ lyrics_id: string; /** Matched Tokens */ matched_tokens: string[]; /** Similarity Score */ similarity_score: number; }; /** MarkThreadReadResponse */ MarkThreadReadResponse: { /** Success */ success: boolean; }; /** * MaskStyle * @enum {integer} */ MaskStyle: 1 | 2 | 3 | 4; /** MatrixParam */ MatrixParam: { /** Field Name */ field_name: string; /** Max */ max?: number | null; /** Min */ min?: number | null; /** * Type * @enum {string} */ type: "float" | "int"; }; /** MatrixResponse */ MatrixResponse: { /** Diffusion Params */ diffusion_params: components["schemas"]["MatrixParam"][]; /** Params */ params: components["schemas"]["MatrixParam"][]; }; /** Mention */ Mention: { /** Display Name */ display_name?: string | null; /** End */ end: number; /** Handle */ handle: string; /** Start */ start: number; }; /** MentionsContainer */ MentionsContainer: { /** User Mentions */ user_mentions?: components["schemas"]["Mention"][] | null; }; /** MergeAccountsSpec */ MergeAccountsSpec: { /** Source User Id */ source_user_id: string; /** Target User Id */ target_user_id: string; }; /** MergeSpec */ MergeSpec: { /** Clip Ids */ clip_ids: string[]; }; /** MessageSchema */ MessageSchema: { /** Content */ content: string; /** * Created At * Format: date-time */ created_at: string; /** Id */ id: string; /** Is Read */ is_read: boolean; /** Message Type */ message_type: string; /** * Read At * Format: date-time */ read_at?: string | null; /** Sender Uid */ sender_uid: string; }; /** * MetadataEditErrorSchema * @description Represent an error arising from editing a title. */ MetadataEditErrorSchema: { /** * Error Type * @enum {string} */ error_type: "title_too_long" | "prompt_too_long" | "text_moderation_error" | "caption_moderation_error" | "image_moderation_error" | "image_upload_error" | "caption_too_long" | "video_cover_error" | "display_tags_moderation_error"; /** * Id * Format: uuid */ id: string; /** Moderation Error Message */ moderation_error_message?: string | null; }; /** MidiInstrumentSchema */ MidiInstrumentSchema: { /** Name */ name: string; /** Notes */ notes: components["schemas"]["MidiNoteSchema"][]; }; /** MidiNoteSchema */ MidiNoteSchema: { /** End */ end: number; /** Pitch */ pitch: number; /** Start */ start: number; /** Velocity */ velocity: number; }; /** MidiSchema */ MidiSchema: { /** Error Message */ error_message?: string | null; /** Final */ final?: boolean | null; /** Instruments */ instruments?: components["schemas"]["MidiInstrumentSchema"][] | null; /** * State * @enum {string} */ state: "running" | "error" | "complete" | "streaming"; }; /** MiniClipOrPlaylistSchema */ MiniClipOrPlaylistSchema: { /** * Id * Format: uuid */ id: string; /** Image Url */ image_url: string | null; /** Title */ title: string; /** * Type * @default clip * @enum {string} */ type?: "clip" | "playlist" | "url"; /** Url */ url?: string | null; }; /** MiniPersonaSchema */ MiniPersonaSchema: { /** * Id * Format: uuid */ id: string; /** Image Url */ image_url?: string | null; /** Name */ name: string; /** * Type * @default persona * @enum {string} */ type?: "persona"; }; /** MiniProfileSchema */ MiniProfileSchema: { /** Avatar Image Url */ avatar_image_url: string | null; /** Display Name */ display_name: string; /** Handle */ handle: string; /** * Is Following * @default false */ is_following?: boolean; }; /** MiniProfileV2Schema */ MiniProfileV2Schema: { /** Avatar Image Url */ avatar_image_url: string | null; /** Display Name */ display_name: string; /** Handle */ handle?: string | null; /** * Is Following * @default false */ is_following?: boolean; /** * Type * @default user * @enum {string} */ type?: "user" | "system"; }; /** * ModelBadgesSchema * @description Combined schema for both songcard and songrow model badges. */ ModelBadgesSchema: { songcard?: components["schemas"]["BadgeSchema"]; songrow?: components["schemas"]["BadgeSchema"]; }; /** ModelTypeMaxLengths */ ModelTypeMaxLengths: { /** Gpt Description Prompt */ gpt_description_prompt: number; /** Negative Tags */ negative_tags: number; /** Prompt */ prompt: number; /** Tags */ tags: number; /** Title */ title: number; }; /** ModifyArtistProfileSpec */ ModifyArtistProfileSpec: { /** Birth Date */ birth_date?: string | null; /** Secondary Email */ secondary_email?: string | null; }; /** MultiGenActionSpec */ MultiGenActionSpec: { /** Action */ action: string; /** Gen Ids */ gen_ids: string[]; /** Share Id */ share_id?: string | null; /** Share Platform */ share_platform?: string | null; }; /** NextLabelMakerTaskResponseSpec */ NextLabelMakerTaskResponseSpec: { project?: components["schemas"]["ProjectSpec"]; /** Review Items */ review_items?: components["schemas"]["ReviewItemSpec"][] | null; /** * Task Id * Format: uuid */ task_id?: string | null; }; /** NotificationAnnouncementSchema */ NotificationAnnouncementSchema: { /** * Created At * Format: date-time */ created_at: string; /** * Id * Format: uuid */ id: string; /** * Is Read * @default false */ is_read?: boolean; /** Message */ message: string; /** * Notification Type * @default announcement * @enum {string} */ notification_type?: "announcement"; react_content?: components["schemas"]["MiniClipOrPlaylistSchema"]; }; /** NotificationFollowSchema */ NotificationFollowSchema: { /** * Created At * Format: date-time */ created_at: string; /** * Id * Format: uuid */ id: string; /** * Is Read * @default false */ is_read?: boolean; /** * Notification Type * @default follow * @enum {string} */ notification_type?: "follow" | "unfollow"; /** * Total Users * @default -1 */ total_users?: number; /** User Profiles */ user_profiles: components["schemas"]["MiniProfileSchema"][]; }; /** NotificationPersonaSchema */ NotificationPersonaSchema: { /** * Created At * Format: date-time */ created_at: string; /** * Id * Format: uuid */ id: string; /** * Is Read * @default false */ is_read?: boolean; /** * Notification Type * @default persona_follow * @enum {string} */ notification_type?: "persona_follow" | "persona_favorite" | "persona_used"; react_content: components["schemas"]["MiniPersonaSchema"]; /** * Total Users * @default -1 */ total_users?: number; /** User Profiles */ user_profiles: components["schemas"]["MiniProfileSchema"][]; }; /** NotificationReactSchema */ NotificationReactSchema: { /** * Created At * Format: date-time */ created_at: string; /** * Id * Format: uuid */ id: string; /** * Is Read * @default false */ is_read?: boolean; /** * Notification Type * @default clip_like * @enum {string} */ notification_type?: "clip_like" | "clip_unlike" | "scene_like" | "scene_unlike" | "playlist_like" | "playlist_unlike" | "code_redeem"; react_content: components["schemas"]["MiniClipOrPlaylistSchema"]; /** * Total Users * @default -1 */ total_users?: number; /** User Profiles */ user_profiles: components["schemas"]["MiniProfileSchema"][]; }; /** * NotificationV2Schema * @description Schema for notifications that are sent to the client. * * Fields: * - id: The ID of the notification. * - priority: The priority of the notification. * 0 is the highest priority, i.e. system announcement as banner. * 2 is the default priority for notifications that don't require CTAs. * - updated_at: The timestamp of the notification. * - expires_at: The timestamp of the notification that determines the expiration of the notification. * - is_read: Whether the notification has been read. * - notification_type: The type of the notification. * - user_profiles: The profiles of the users that are mentioned in the notification. * - total_users: The total number of users that are mentioned in the notification. * - content_id: The ID of the content that is mentioned in the notification. * - content_title: The title of the content that is mentioned in the notification. * - content_image_url: The image URL of the content that is mentioned in the notification. * - content_message: The message of the content that is mentioned in the notification. * - redirect_url: The URL to redirect to when the notification is clicked. */ NotificationV2Schema: { /** * Content Ancillary Id * Format: uuid */ content_ancillary_id?: string | null; /** * Content Id * Format: uuid */ content_id?: string | null; /** Content Image Url */ content_image_url?: string | null; /** Content Message */ content_message?: string | null; /** Content Title */ content_title?: string | null; /** * Expires At * Format: date-time */ expires_at?: string | null; /** * Id * Format: uuid */ id: string; /** * Is Read * @default false */ is_read?: boolean; /** * Notification Type * @default clip_like * @enum {string} */ notification_type?: "clip_like" | "scene_like" | "clip_create_followee" | "playlist_like" | "code_redeem" | "persona_favorite" | "persona_follow" | "persona_used" | "announcement" | "follow" | "invite" | "invite_accepted" | "clip_comment" | "scene_comment" | "playlist_comment" | "comment_like" | "comment_reply" | "comment_mention" | "caption_mention" | "clip_remix" | "delete" | "default" | "hook_like" | "hook_comment" | "hook_comment_reply" | "hook_created" | "hook_comment_like" | "hook_comment_mention" | "video_cover_hook_like" | "video_cover_hook_comment" | "video_cover_hook_comment_reply" | "video_cover_hook_comment_like" | "video_cover_hook_comment_mention"; /** * Priority * @default 2 */ priority?: number; /** Redirect Url */ redirect_url?: string | null; /** * Total Users * @default -1 */ total_users?: number; /** * Updated At * Format: date-time */ updated_at: string; /** * User Profiles * @default [] */ user_profiles?: components["schemas"]["MiniProfileV2Schema"][]; }; /** * OAuthClientInfoSchema * @description Schema for returning OAuth client application information. */ OAuthClientInfoSchema: { /** Client Id */ client_id: string; /** Name */ name: string; }; /** * OAuthCodeRequestSchema * @description Schema for OAuth authorization code generation request. */ OAuthCodeRequestSchema: { /** Client Id */ client_id: string; /** Redirect Uri */ redirect_uri: string; /** Scope */ scope?: string | null; /** State */ state: string; }; /** * OAuthRedirectResponseSchema * @description Schema for OAuth redirect response. */ OAuthRedirectResponseSchema: { /** Redirect Url */ redirect_url: string; }; /** OEmbedEnableResponse */ OEmbedEnableResponse: { /** * Enabled * @default false */ enabled?: boolean; }; /** OEmbedResponse */ OEmbedResponse: { /** Height */ height: number; /** Html */ html: string; /** Iframe Url */ iframe_url: string; /** Provider Name */ provider_name: string; /** Provider Url */ provider_url: string; /** Title */ title: string; /** Type */ type: string; /** Version */ version: string; /** Width */ width: number; }; /** OpusFileSchema */ OpusFileSchema: { /** Opus File Url */ opus_file_url?: string | null; }; /** OrpheusChatSpec */ OrpheusChatSpec: { /** Message */ message: string; /** Message Id */ message_id: string; /** Session Id */ session_id: string; /** Tool Call Id */ tool_call_id?: string | null; }; /** OrpheusLyricsSpec */ OrpheusLyricsSpec: { /** Prompt */ prompt: string; /** Session Id */ session_id: string; /** Tool Call Id */ tool_call_id: string; }; /** * OverlayColor * @enum {integer} */ OverlayColor: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18; /** PaginatedContestClipResponse */ PaginatedContestClipResponse: { /** Clips */ clips: components["schemas"]["ContestClipResponse"][]; /** Has Next */ has_next: boolean; /** Has Previous */ has_previous: boolean; /** Page */ page: number; /** Page Size */ page_size: number; /** Total Count */ total_count: number; }; /** PaginatedPersonaResponseSchema */ PaginatedPersonaResponseSchema: { /** Current Page */ current_page: number; /** * Is Following * @default false */ is_following?: boolean; persona: components["schemas"]["PersonaResponseSchema"]; /** Total Results */ total_results: number; }; /** PaginatedThreadsResponse */ PaginatedThreadsResponse: { /** Has More */ has_more: boolean; /** Threads */ threads: components["schemas"]["ThreadSummarySchema"][]; }; /** PaginatedVotesResponse */ PaginatedVotesResponse: { /** Has Next */ has_next: boolean; /** Has Previous */ has_previous: boolean; /** Page */ page: number; /** Page Size */ page_size: number; /** Total Count */ total_count: number; /** Votes */ votes: components["schemas"]["VoteSchema"][]; }; /** ParentClipSchema */ ParentClipSchema: { /** * Id * Format: uuid */ id?: string | null; /** Image Url */ image_url?: string | null; /** * Is Public * @default false */ is_public?: boolean; /** Title */ title?: string | null; /** User Avatar Image Url */ user_avatar_image_url?: string | null; /** User Display Name */ user_display_name?: string | null; /** User Handle */ user_handle?: string | null; }; /** PersonaClipSchema */ PersonaClipSchema: { clip: components["schemas"]["GeneratedClipSchema"]; /** Id */ id?: number | null; }; /** PersonaMetadataResponseSchema */ PersonaMetadataResponseSchema: { clip: components["schemas"]["GeneratedClipSchema"]; /** Description */ description: string; /** Id */ id: string; /** Image S3 Id */ image_s3_id: string | null; /** * Is Owned * @default false */ is_owned?: boolean; /** * Is Public * @default false */ is_public?: boolean; /** Is Suno Persona */ is_suno_persona: boolean; /** * Is Trashed * @default false */ is_trashed?: boolean; /** Name */ name: string; /** Root Clip Id */ root_clip_id: string; /** User Display Name */ user_display_name: string; /** User Handle */ user_handle: string; /** User Image Url */ user_image_url: string; }; /** PersonaResponseSchema */ PersonaResponseSchema: { clip: components["schemas"]["GeneratedClipSchema"]; /** Clip Count */ clip_count?: number | null; /** Description */ description: string; /** Id */ id: string; /** Image S3 Id */ image_s3_id: string | null; /** * Is Loved * @default false */ is_loved?: boolean; /** * Is Owned * @default false */ is_owned?: boolean; /** * Is Public * @default false */ is_public?: boolean; /** * Is Public Approved * @default false */ is_public_approved?: boolean; /** Is Suno Persona */ is_suno_persona: boolean; /** * Is Trashed * @default false */ is_trashed?: boolean; /** Name */ name: string; /** * Persona Clips * @default [] */ persona_clips?: components["schemas"]["PersonaClipSchema"][]; /** Root Clip Id */ root_clip_id: string; /** * Upvote Count * @default 0 */ upvote_count?: number; /** User Display Name */ user_display_name: string; /** User Handle */ user_handle: string; /** User Image Url */ user_image_url: string; }; /** PersonaSchema */ PersonaSchema: { clip: components["schemas"]["PersonaClipSchema"]; /** * Clip Count * @default 0 */ clip_count?: number; /** * Description * @default */ description?: string; /** * Entity Type * @default persona_schema * @enum {string} */ entity_type?: "persona_schema"; /** Id */ id: string; /** Image S3 Id */ image_s3_id: string | null; /** Image Url */ image_url?: string | null; /** * Is Loved * @default false */ is_loved?: boolean; /** Is Owned */ is_owned: boolean; /** Is Public */ is_public: boolean; /** Is Public Approved */ is_public_approved: boolean; /** Is Suno Persona */ is_suno_persona: boolean; /** Is Trashed */ is_trashed: boolean; /** Name */ name: string; /** * Root Clip Id * @default */ root_clip_id?: string; /** * User Display Name * @default */ user_display_name?: string; /** * User Handle * @default */ user_handle?: string; /** * User Image Url * @default */ user_image_url?: string; }; /** PersonasResponseSchema */ PersonasResponseSchema: { /** Continuation Token */ continuation_token?: string | null; /** * Current Page * @default 1 */ current_page?: number; /** * Personas * @default [] */ personas?: components["schemas"]["PersonaMetadataResponseSchema"][]; /** * Total Results * @default 0 */ total_results?: number; }; /** PinClipSpec */ PinClipSpec: { /** Max Pins */ max_pins?: number | null; /** Submit To Contest */ submit_to_contest?: boolean | null; }; /** PinnedClipsSchema */ PinnedClipsSchema: { /** Pinned Clips */ pinned_clips: components["schemas"]["GeneratedClipSchema"][]; }; /** PlaceVoteSpec */ PlaceVoteSpec: { /** Swap Vote */ swap_vote: boolean; /** Vote Id */ vote_id: string; }; /** PlanChangePreviewSchemaResponse */ PlanChangePreviewSchemaResponse: { /** Items */ items: unknown[]; /** * Period End * Format: date-time */ period_end: string | null; proration: components["schemas"]["ProrationSchema"]; /** Subtotal */ subtotal: number; }; /** PlanChangeSchemaResponse */ PlanChangeSchemaResponse: { /** Error */ error?: string | null; /** Id */ id: string | null; /** Ok */ ok: boolean; }; /** PlanChangeSpec */ PlanChangeSpec: { /** * Immediate * @default false */ immediate?: boolean; /** Level */ level?: number | null; /** Period */ period: string; /** Plan Key */ plan_key?: string | null; }; /** PlanCreateSpec */ PlanCreateSpec: { checkout_source?: components["schemas"]["CheckoutSource"]; /** Clip Id */ clip_id?: string | null; /** * Currency * @default USD */ currency?: string; /** Current Upsell Feature */ current_upsell_feature?: string | null; /** Level */ level?: number | null; /** Period */ period?: string | null; /** Plan Key */ plan_key?: string | null; /** Sprout Affiliate Id */ sprout_affiliate_id?: string | null; }; /** * Platform * @enum {string} */ Platform: "ios" | "android" | "web" | "mobile_web"; /** PlayCountSpec */ PlayCountSpec: { /** * Sample Factor * @default 1 */ sample_factor?: number; }; /** PlaybarStateResponse */ PlaybarStateResponse: { /** Action Time */ action_time: string | null; /** Context Id */ context_id: string | null; /** Context Type */ context_type: string | null; /** Device Context */ device_context: string | null; /** Device Id */ device_id: string | null; /** Device Type */ device_type: string | null; /** Playbar State */ playbar_state: string | null; /** Playlist Context */ playlist_context: string | null; repeat_state: components["schemas"]["RepeatState"]; /** Song Ids In Queue */ song_ids_in_queue: string[] | null; /** Song Index */ song_index: number | null; /** Song Play Time */ song_play_time: number | null; /** Volume */ volume: number | null; }; /** PlaylistClipSchema */ PlaylistClipSchema: { clip: components["schemas"]["GeneratedClipSchema"]; /** Relative Index */ relative_index: number; }; /** PlaylistCreateSpec */ PlaylistCreateSpec: { /** Creation Source */ creation_source?: string | null; /** Description */ description?: string | null; /** Image Url */ image_url?: string | null; /** Is Public */ is_public?: boolean | null; /** Name */ name?: string | null; }; /** PlaylistEmbeddingSchema */ PlaylistEmbeddingSchema: { /** Created */ created: boolean; /** Ditto Vector */ ditto_vector: number[]; /** * Id * Format: uuid */ id?: string | null; /** * Playlist Id * Format: uuid */ playlist_id: string; }; /** PlaylistItemSchema */ PlaylistItemSchema: { aura_settings?: components["schemas"]["AuraSettings"]; /** Current Page */ current_page: number; /** Description */ description?: string | null; /** Dislike Count */ dislike_count?: number | null; /** * Entity Type * @default playlist_schema * @enum {string} */ entity_type?: "playlist_schema"; /** Flag Count */ flag_count?: number | null; /** Id */ id: string; /** Image Url */ image_url?: string | null; /** Is Discover Playlist */ is_discover_playlist?: boolean | null; /** * Is Owned * @default false */ is_owned?: boolean; /** Is Public */ is_public: boolean; /** Is Trashed */ is_trashed: boolean; /** Name */ name?: string | null; /** Num Total Results */ num_total_results: number; /** Play Count */ play_count?: number | null; /** Playlist Clips */ playlist_clips: components["schemas"]["PlaylistClipSchema"][]; /** Reaction */ reaction?: string | null; /** Skip Count */ skip_count?: number | null; /** Song Count */ song_count?: number | null; /** Upvote Count */ upvote_count?: number | null; /** User Avatar Image Url */ user_avatar_image_url: string | null; /** User Display Name */ user_display_name: string | null; /** User Handle */ user_handle: string | null; }; /** PlaylistListSectionSchema */ PlaylistListSectionSchema: { /** Description */ description?: string | null; /** Id */ id: string; /** Items */ items: components["schemas"]["PlaylistItemSchema"][]; /** Link */ link?: string | null; /** Mobile Link */ mobile_link?: string | null; /** Options */ options?: string[] | null; /** Secondary Options */ secondary_options?: string[] | null; /** Secondary Selected Option */ secondary_selected_option?: string | null; /** Section Name */ section_name?: string | null; /** * Section Type * @default playlist_list * @enum {string} */ section_type?: "playlist_list"; /** Selected Option */ selected_option?: string | null; /** * Style Type * @default normal * @enum {string} */ style_type?: "normal" | "featured" | "mini"; /** Title */ title: string; }; /** PlaylistMetadataSchema */ PlaylistMetadataSchema: { /** Current Page */ current_page: number; /** Description */ description?: string | null; /** Dislike Count */ dislike_count?: number | null; /** * Entity Type * @default playlist_schema * @enum {string} */ entity_type?: "playlist_schema"; /** Flag Count */ flag_count?: number | null; /** Id */ id: string; /** Image Url */ image_url?: string | null; /** Is Discover Playlist */ is_discover_playlist?: boolean | null; /** * Is Owned * @default false */ is_owned?: boolean; /** Is Public */ is_public: boolean; /** Is Trashed */ is_trashed: boolean; /** Name */ name?: string | null; /** Num Total Results */ num_total_results: number; /** Play Count */ play_count?: number | null; /** Playlist Clips */ playlist_clips: components["schemas"]["PlaylistClipSchema"][]; /** Reaction */ reaction?: string | null; /** Skip Count */ skip_count?: number | null; /** Song Count */ song_count?: number | null; /** Upvote Count */ upvote_count?: number | null; /** User Avatar Image Url */ user_avatar_image_url: string | null; /** User Display Name */ user_display_name: string | null; /** User Handle */ user_handle: string | null; }; /** PlaylistMetadataWithTargetClipStatusSchema */ PlaylistMetadataWithTargetClipStatusSchema: { /** Current Page */ current_page: number; /** Description */ description?: string | null; /** Dislike Count */ dislike_count?: number | null; /** * Entity Type * @default playlist_schema * @enum {string} */ entity_type?: "playlist_schema"; /** Flag Count */ flag_count?: number | null; /** Id */ id: string; /** Image Url */ image_url?: string | null; /** Is Clip Added */ is_clip_added: boolean; /** Is Discover Playlist */ is_discover_playlist?: boolean | null; /** * Is Owned * @default false */ is_owned?: boolean; /** Is Public */ is_public: boolean; /** Is Trashed */ is_trashed: boolean; /** Name */ name?: string | null; /** Num Total Results */ num_total_results: number; /** Play Count */ play_count?: number | null; /** Playlist Clips */ playlist_clips: components["schemas"]["PlaylistClipSchema"][]; /** Reaction */ reaction?: string | null; /** Skip Count */ skip_count?: number | null; /** Song Count */ song_count?: number | null; /** Upvote Count */ upvote_count?: number | null; /** User Avatar Image Url */ user_avatar_image_url: string | null; /** User Display Name */ user_display_name: string | null; /** User Handle */ user_handle: string | null; }; /** * PlaylistPlayCountSpec * @description Represent an increment of a playlist play count, with data need to pass in */ PlaylistPlayCountSpec: { /** * Clip Id * Format: uuid */ clip_id?: string | null; }; /** PlaylistSchema */ PlaylistSchema: { /** Current Page */ current_page: number; /** Description */ description?: string | null; /** Dislike Count */ dislike_count?: number | null; /** * Entity Type * @default playlist_schema * @enum {string} */ entity_type?: "playlist_schema"; /** Flag Count */ flag_count?: number | null; /** Id */ id: string; /** Image Url */ image_url?: string | null; /** Is Discover Playlist */ is_discover_playlist?: boolean | null; /** * Is Owned * @default false */ is_owned?: boolean; /** Is Public */ is_public: boolean; /** Is Trashed */ is_trashed: boolean; /** Name */ name?: string | null; /** Next Cursor */ next_cursor?: string | null; /** Num Total Results */ num_total_results: number; /** Play Count */ play_count?: number | null; /** Playlist Clips */ playlist_clips: components["schemas"]["PlaylistClipSchema"][]; /** Reaction */ reaction?: string | null; /** Skip Count */ skip_count?: number | null; /** Song Count */ song_count?: number | null; /** Upvote Count */ upvote_count?: number | null; /** User Avatar Image Url */ user_avatar_image_url: string | null; /** User Display Name */ user_display_name: string | null; /** User Handle */ user_handle: string | null; }; /** PlaylistSectionSchema */ PlaylistSectionSchema: { /** Description */ description?: string | null; /** Id */ id: string; /** Items */ items: components["schemas"]["GeneratedClipSchema"][]; /** Link */ link?: string | null; /** Mobile Link */ mobile_link?: string | null; /** Options */ options?: string[] | null; /** * Preview Items Count * @default 2 */ preview_items_count?: number; /** Secondary Options */ secondary_options?: string[] | null; /** Secondary Selected Option */ secondary_selected_option?: string | null; /** Section Name */ section_name?: string | null; /** * Section Type * @default playlist * @enum {string} */ section_type?: "playlist"; /** Selected Option */ selected_option?: string | null; /** * Style Type * @default normal * @enum {string} */ style_type?: "normal" | "contest" | "mini" | "featured"; /** Title */ title: string; }; /** PlaylistTrashSpec */ PlaylistTrashSpec: { /** Playlist Id */ playlist_id: string; /** Undo Trash */ undo_trash?: boolean | null; }; /** * PlaylistUpdateAction * @enum {string} */ PlaylistUpdateAction: "add" | "remove" | "remove_by_id" | "reorder"; /** PlaylistUpdateClipsSpec */ PlaylistUpdateClipsSpec: { /** Metadata */ metadata: { [key: string]: unknown; }; /** Playlist Id */ playlist_id: string; recommendation_metadata?: components["schemas"]["RecommendationMetadataSchema"]; update_type: components["schemas"]["PlaylistUpdateAction"]; }; /** PlaylistUpdateMetadataSpec */ PlaylistUpdateMetadataSpec: { /** Description */ description: string; /** Image Url */ image_url?: string | null; /** Name */ name: string; /** Playlist Id */ playlist_id: string; }; /** PlaylistVisibilitySpec */ PlaylistVisibilitySpec: { /** Is Public */ is_public: boolean; }; /** PlaylistsSchema */ PlaylistsSchema: { /** Current Page */ current_page: number; /** Num Total Results */ num_total_results: number; /** Playlists */ playlists: components["schemas"]["PlaylistMetadataSchema"][]; }; /** PlaylistsWithTargetClipStatusSchema */ PlaylistsWithTargetClipStatusSchema: { /** Current Page */ current_page: number; /** Num Total Results */ num_total_results: number; /** Playlists */ playlists: components["schemas"]["PlaylistMetadataWithTargetClipStatusSchema"][]; }; /** PortalRedirectSchemaResponse */ PortalRedirectSchemaResponse: { /** Url */ url: string; }; /** PostChatRequest */ PostChatRequest: { /** Channel Id */ channel_id?: string | null; /** Channel Type */ channel_type?: string | null; /** Chat Id */ chat_id?: string | null; /** Chat Text */ chat_text?: string | null; /** User Avatar Url */ user_avatar_url?: string | null; /** User Name */ user_name?: string | null; }; /** PostChatResponse */ PostChatResponse: Record; /** PostCommentRequest */ PostCommentRequest: { /** Content */ content: string; entity_type?: components["schemas"]["CommentEntityType"]; /** Parent Id */ parent_id?: string | null; recommendation_metadata?: components["schemas"]["RecommendationMetadataSchema"]; /** Track Timestamp */ track_timestamp?: number | null; /** User Mentions */ user_mentions?: components["schemas"]["Mention"][] | null; }; /** PreviewClipsSchema */ PreviewClipsSchema: { /** Preview Clips */ preview_clips: { [key: string]: components["schemas"]["GeneratedClipSchema"][]; }; }; /** PriceSchema */ PriceSchema: { /** Currency */ currency: string; /** Period Type */ period_type: string; /** Price */ price: number; }; /** ProfileFollowersSchema */ ProfileFollowersSchema: { /** Current Page */ current_page: number; /** Handle */ handle: string | null; /** Num Total Profiles */ num_total_profiles: number; /** Profiles */ profiles: components["schemas"]["SimpleProfileInfoSchema"][]; /** User Id */ user_id: string; }; /** ProfileFollowingSchema */ ProfileFollowingSchema: { /** Current Page */ current_page: number; /** Handle */ handle: string | null; /** Num Total Profiles */ num_total_profiles: number; /** Profiles */ profiles: components["schemas"]["SimpleProfileInfoSchema"][]; /** User Id */ user_id: string; }; /** ProfileInfoSchema */ ProfileInfoSchema: { artist_profile?: components["schemas"]["ArtistProfileInfoSchema"]; /** Artist Profiles Enabled */ artist_profiles_enabled?: boolean | null; /** Avatar Image Url */ avatar_image_url: string | null; /** Clips */ clips: components["schemas"]["GeneratedClipSchema"][]; contest_banner?: components["schemas"]["BannerSectionSchema"]; contest_submissions_playlist?: components["schemas"]["PlaylistMetadataSchema"]; /** Current Page */ current_page: number; /** Display Name */ display_name: string | null; /** * Favorite Songs * @default [] */ favorite_songs?: components["schemas"]["GeneratedClipSchema"][]; /** Handle */ handle: string | null; /** Hook Creator Label */ hook_creator_label?: string | null; /** Hooks */ hooks?: components["schemas"]["VideoHookSchema"][] | null; /** Is Flagged */ is_flagged: boolean; /** Is Following */ is_following: boolean; /** Num Total Clips */ num_total_clips: number; /** Personas */ personas: components["schemas"]["PersonaResponseSchema"][]; /** Playlists */ playlists: components["schemas"]["PlaylistMetadataSchema"][]; /** Profile Description */ profile_description: string | null; /** Stats */ stats: unknown; /** User Comments Blocked */ user_comments_blocked?: boolean | null; /** User Id */ user_id: string; /** Viewer Is Blocked By Profile */ viewer_is_blocked_by_profile: boolean; /** Viewer Is Blocking Profile */ viewer_is_blocking_profile: boolean; /** * Viewer Is Hiding Creator Clip * @default false */ viewer_is_hiding_creator_clip?: boolean; /** * Viewer Is Hiding Creator Hook * @default false */ viewer_is_hiding_creator_hook?: boolean; }; /** ProfileStatsSchema */ ProfileStatsSchema: { /** * Clips Count * @default 0 */ clips_count?: number; /** * Followers Count * @default 0 */ followers_count?: number; /** Last Login */ last_login?: string | null; /** * Likes Count * @default 0 */ likes_count?: number; }; /** ProjectAblyUpdateSpec */ ProjectAblyUpdateSpec: { /** * Update Type * @enum {string} */ update_type: "add_clips" | "remove_clips" | "move_clips" | "pin_clips" | "unpin_clips"; }; /** ProjectClipSchema */ ProjectClipSchema: { clip: components["schemas"]["GeneratedClipSchema"]; /** * Pinned * @default false */ pinned?: boolean; /** Relative Index */ relative_index: number; }; /** ProjectCreateSpec */ ProjectCreateSpec: { /** Description */ description: string; /** Image Url */ image_url?: string | null; /** Name */ name: string; }; /** ProjectInviteSchema */ ProjectInviteSchema: { /** * Created At * Format: date-time */ created_at: string; /** Id */ id: string; /** Invited By User Avatar Url */ invited_by_user_avatar_url?: string | null; /** Invited By User Display Name */ invited_by_user_display_name?: string | null; /** Invited By User Handle */ invited_by_user_handle?: string | null; /** * Invited By User Id * Format: uuid */ invited_by_user_id: string; /** Invited User Avatar Url */ invited_user_avatar_url?: string | null; /** Invited User Display Name */ invited_user_display_name?: string | null; /** Invited User Handle */ invited_user_handle?: string | null; /** * Invited User Id * Format: uuid */ invited_user_id: string; project: components["schemas"]["ProjectMetadataSchema"]; /** * Status * @enum {string} */ status: "accepted" | "pending" | "cancelled"; /** * Updated At * Format: date-time */ updated_at: string; }; /** ProjectInviteSpec */ ProjectInviteSpec: { /** * Invited User Id * Format: uuid */ invited_user_id: string; }; /** ProjectMetadataSchema */ ProjectMetadataSchema: { /** Clip Count */ clip_count: number; /** * Created At * Format: date-time */ created_at?: string | null; /** Description */ description: string; /** Id */ id: string; /** * Last Updated Clip * Format: date-time */ last_updated_clip: string | null; /** Name */ name: string; owner?: components["schemas"]["CollaboratorSchema"]; /** Shared */ shared: boolean; }; /** ProjectRemoveCollaboratorSpec */ ProjectRemoveCollaboratorSpec: { /** * Invited User Id * Format: uuid */ invited_user_id: string; }; /** ProjectSchema */ ProjectSchema: { /** Clip Count */ clip_count: number; /** Current Page */ current_page: number; /** Description */ description: string; /** Id */ id: string; /** Image Url */ image_url: string | null; /** Is Owned */ is_owned: boolean; /** Is Trashed */ is_trashed: boolean; /** Name */ name: string; owner?: components["schemas"]["CollaboratorSchema"]; /** Pinned Clips */ pinned_clips?: components["schemas"]["ProjectClipSchema"][] | null; /** Project Clips */ project_clips: components["schemas"]["ProjectClipSchema"][]; /** Shared */ shared: boolean; }; /** ProjectSpec */ ProjectSpec: { /** Credits Per Annotation */ credits_per_annotation?: number | null; /** Instructions */ instructions?: string | null; /** * Media Type * @enum {string} */ media_type: "audio" | "video"; /** Min Review Time Seconds */ min_review_time_seconds?: number | null; /** Preference Dimensions */ preference_dimensions: { [key: string]: string; }[]; /** Question */ question: string; }; /** ProjectTrashSpec */ ProjectTrashSpec: { /** Project Id */ project_id: string; /** Undo Trash */ undo_trash?: boolean | null; }; /** ProjectUpdateClipsSpec */ ProjectUpdateClipsSpec: { /** Metadata */ metadata: { [key: string]: unknown; }; /** * Update Type * @enum {string} */ update_type: "add" | "remove" | "move" | "pinned"; }; /** ProjectUpdateMetadataSpec */ ProjectUpdateMetadataSpec: { /** Description */ description: string; /** Image Url */ image_url?: string | null; /** Name */ name: string; }; /** ProjectVersionSchema */ ProjectVersionSchema: { /** Is Owner */ is_owner: boolean; /** Project Id */ project_id: string; /** Revision Id */ revision_id: number; /** Title */ title: string; }; /** ProjectsSchema */ ProjectsSchema: { /** Current Page */ current_page: number; /** Num Total Results */ num_total_results: number; /** Projects */ projects: components["schemas"]["ProjectMetadataSchema"][]; }; /** PromoBadgeSchema */ PromoBadgeSchema: { /** Background Color */ background_color?: string | null; /** Label */ label?: string | null; /** Text Color */ text_color?: string | null; }; /** PromoCodeStatusResponse */ PromoCodeStatusResponse: { /** Error Msg */ error_msg?: string | null; /** Inviter Handle */ inviter_handle?: string | null; /** Promo Code Url */ promo_code_url?: string | null; /** Redemptions Left */ redemptions_left?: number | null; }; /** PromoCtaSchema */ PromoCtaSchema: { /** * Action * @enum {string|null} */ action?: "play" | "remix" | "cover" | "extend" | "external_link" | null; /** Background Color */ background_color?: string | null; /** Label */ label?: string | null; /** Text Color */ text_color?: string | null; /** Url */ url?: string | null; }; /** PromoHeadlineSchema */ PromoHeadlineSchema: { /** Color */ color?: string | null; /** Text */ text?: string | null; }; /** PromoItemSchema */ PromoItemSchema: { /** Background Image Url */ background_image_url?: string | null; badge?: components["schemas"]["PromoBadgeSchema"]; /** Card Height */ card_height?: number | null; /** * Entity Type * @default promo_schema * @enum {string} */ entity_type?: "promo_schema"; /** Id */ id: string; primary_cta?: components["schemas"]["PromoCtaSchema"]; primary_headline?: components["schemas"]["PromoHeadlineSchema"]; secondary_cta?: components["schemas"]["PromoCtaSchema"]; secondary_headline?: components["schemas"]["PromoHeadlineSchema"]; }; /** PromoSectionSchema */ PromoSectionSchema: { /** Description */ description?: string | null; /** Id */ id: string; /** Items */ items: components["schemas"]["PromoItemSchema"][]; /** Link */ link?: string | null; /** Mobile Link */ mobile_link?: string | null; /** Options */ options?: string[] | null; /** Secondary Options */ secondary_options?: string[] | null; /** Secondary Selected Option */ secondary_selected_option?: string | null; /** Section Name */ section_name?: string | null; /** * Section Type * @default promo * @enum {string} */ section_type?: "promo"; /** Selected Option */ selected_option?: string | null; /** Style Type */ style_type?: string | null; /** Title */ title: string; }; /** * PromotionType * @enum {string} */ PromotionType: "500_credits"; /** * ProrationSchema * @description Schema representing the proration details for plan changes. */ ProrationSchema: { /** Currency */ currency: string; /** Discount */ discount: number; /** Price */ price: number; /** Subtotal */ subtotal: number; }; /** PublicSurveyQuestionListSchema */ PublicSurveyQuestionListSchema: { /** Questions */ questions: components["schemas"]["PublicSurveyQuestionSchema"][]; }; /** PublicSurveyQuestionSchema */ PublicSurveyQuestionSchema: { /** * Id * Format: uuid */ id: string; /** Is Required */ is_required: boolean; /** Options */ options?: string[] | null; /** Order */ order: number; /** Prompt */ prompt: string; type: components["schemas"]["QuestionType"]; }; /** PurchaseSpec */ PurchaseSpec: { /** Amount */ amount: number; /** Id */ id: string | null; }; /** * PurchaseStatusSchemaResponse * @description Schema for purchase status response when checking purchase status (credits, upgrades, etc.). */ PurchaseStatusSchemaResponse: { /** Client Secret */ client_secret?: string | null; /** Id */ id: string; /** Processing */ processing: boolean; /** Status */ status: string; }; /** * QuestionType * @enum {string} */ QuestionType: "input" | "textarea" | "radio" | "multi"; /** QueueClip */ QueueClip: { /** Clip Id */ clip_id: string; }; /** RadioFilters */ RadioFilters: { /** * Exclude Clip Ids * @default [] */ exclude_clip_ids?: string[]; }; /** RadioSchema */ RadioSchema: { /** Clips */ clips: components["schemas"]["GeneratedClipSchema"][]; /** Tag */ tag: string; }; /** RadioTagsSchema */ RadioTagsSchema: { /** Tags */ tags: string[]; }; /** RandomContestClipsResponse */ RandomContestClipsResponse: { /** Clips */ clips: components["schemas"]["ContestClipResponse"][]; /** Vote Id */ vote_id: string; }; /** * ReactionAction * @enum {string} */ ReactionAction: "like" | "unlike" | "dislike" | "undislike"; /** * ReactionSpec * @description Represent an update to a UserReaction.reaction_type, adding or removing a like / dislike. */ ReactionSpec: { /** * Captcha Token * @default */ captcha_token?: string; /** * Reaction * @enum {string|null} */ reaction?: "LIKE" | "DISLIKE" | null; recommendation_metadata?: components["schemas"]["RecommendationMetadataSchema"]; }; /** ReadNotificationsSpec */ ReadNotificationsSpec: { /** * After Datetime Utc * Format: date-time */ after_datetime_utc?: string | null; /** * All * @default false */ all?: boolean; /** * Before Datetime Utc * Format: date-time */ before_datetime_utc?: string | null; /** * Ids * @default [] */ ids?: string[]; }; /** RecommendStylesSchema */ RecommendStylesSchema: { /** Co Existing Styles Dict */ co_existing_styles_dict?: { [key: string]: { [key: string]: number; }; } | null; /** Default Styles */ default_styles?: string[] | null; /** Random Styles */ random_styles?: string[] | null; /** Recommend Styles */ recommend_styles?: string[] | null; }; /** RecommendStylesSpec */ RecommendStylesSpec: { /** Excluded Styles */ excluded_styles?: string[]; /** * Is Random * @default false */ is_random?: boolean; /** * Random Styles Counts * @default 0 */ random_styles_counts?: number; }; /** RecommendTagsRequest */ RecommendTagsRequest: { /** Tags */ tags: string[]; }; /** RecommendTagsResponse */ RecommendTagsResponse: { /** Recommended Tags */ recommended_tags: string[]; /** Tags */ tags: string[]; }; /** RecommendUser */ RecommendUser: { /** * Reason * @enum {string} */ reason: "popular" | "following_you" | "you_might_know" | "from_your_contacts"; user: components["schemas"]["SimpleProfileInfoSchema"]; }; /** RecommendUserReq */ RecommendUserReq: { /** * Phones * @default [] */ phones?: string[]; }; /** RecommendUserResp */ RecommendUserResp: { /** Result */ result: components["schemas"]["RecommendUser"][]; }; /** RecommendationMetadata */ RecommendationMetadata: { hook_interaction_type?: components["schemas"]["HookInteractionType"]; /** Recommendation Item Id */ recommendation_item_id?: string | null; }; /** RecommendationMetadataSchema */ RecommendationMetadataSchema: { /** Context Type */ context_type?: string | null; /** Hook Id */ hook_id?: string | null; /** Recommendation Item Id */ recommendation_item_id?: string | null; }; /** RecordSessionIdSchema */ RecordSessionIdSchema: { /** Is Success */ is_success: boolean; }; /** RecordSessionIdSpec */ RecordSessionIdSpec: { /** * Client Creation Time * Format: date-time */ client_creation_time?: string | null; /** * Client Expire Time * Format: date-time */ client_expire_time?: string | null; /** * Session Id * Format: uuid */ session_id: string; /** Session Length */ session_length: number; }; /** RegeneratePlaylistSpec */ RegeneratePlaylistSpec: { /** Configuration */ configuration?: ({ [key: string]: number | string | boolean; }) | null; /** Model Name */ model_name: string; }; /** * RemixAction * @enum {string} */ RemixAction: "extend" | "cover" | "use_styles_lyrics" | "speed"; /** RemixPermissionsUpdateSchema */ RemixPermissionsUpdateSchema: { /** Status */ status: string; /** Updated Count */ updated_count: number; }; /** * RemixesInspiredCountResponse * @description Response schema for the count of remixes inspired by a user's public clips. */ RemixesInspiredCountResponse: { /** Count */ count: number; }; /** RemixesInspiredParams */ RemixesInspiredParams: { /** * Page * @default 1 */ page?: number; /** * Page Size * @default 20 */ page_size?: number; }; /** RemoveGroupMembersRequest */ RemoveGroupMembersRequest: { /** Member Handles */ member_handles: string[]; }; /** RemoveGroupMembersResponse */ RemoveGroupMembersResponse: { /** New Participant Count */ new_participant_count: number; /** Removed Count */ removed_count: number; /** Success */ success: boolean; }; /** RemoveHookCreatorLabelResponse */ RemoveHookCreatorLabelResponse: { /** Success */ success: boolean; }; /** RemoveHookCreatorLabelSpec */ RemoveHookCreatorLabelSpec: { /** * Creator User Id * @default 0 */ creator_user_id?: number; /** * Creator User Uuid * @default */ creator_user_uuid?: string; }; /** RemoveHookQualityLabelRequest */ RemoveHookQualityLabelRequest: { /** * Label * @default */ label?: string; }; /** RemoveHookQualityLabelResponse */ RemoveHookQualityLabelResponse: { /** Success */ success: boolean; }; /** * RenderStateSchema * @description Schema for rendering a project state. */ RenderStateSchema: { /** Caption */ caption?: string | null; /** Downbeats */ downbeats?: number[][] | null; /** End Beats */ end_beats: number; /** From Studio Project Id */ from_studio_project_id?: string | null; /** Lyrics */ lyrics?: string | null; /** Negative Tags */ negative_tags?: string | null; /** Project Id */ project_id?: string | null; /** Start Beats */ start_beats: number; /** State */ state: unknown; /** Style Summary */ style_summary?: string | null; /** Tags */ tags?: string | null; /** Title */ title: string; /** Web Client Pathname */ web_client_pathname?: string | null; }; /** * RepeatState * @enum {string} */ RepeatState: "repeat" | "no-repeat"; /** ReplySchema */ ReplySchema: { /** Content */ content: string; /** * Created At * Format: date-time */ created_at: string; entity_type?: components["schemas"]["CommentEntityType"]; /** Id */ id: string; /** Num Likes */ num_likes: number; /** Parent Id */ parent_id?: string | null; /** Reaction Type */ reaction_type?: string | null; /** User Avatar Url */ user_avatar_url: string; /** User Comments Blocked */ user_comments_blocked?: boolean | null; /** User Display Name */ user_display_name: string; /** User Handle */ user_handle: string; /** User Id */ user_id: string; /** User Mentions */ user_mentions?: components["schemas"]["Mention"][] | null; }; /** ReportCommentRequest */ ReportCommentRequest: { entity_type?: components["schemas"]["CommentEntityType"]; /** Reason */ reason?: string | null; report_type?: components["schemas"]["HookReportType"]; }; /** ReportCommentResponse */ ReportCommentResponse: { /** Comment Id */ comment_id: string; /** Id */ id: string; /** Reason */ reason?: string | null; /** * Reported At * Format: date-time */ reported_at: string; /** User Id */ user_id: string; }; /** ReprocessHookRequest */ ReprocessHookRequest: { /** Hook Id */ hook_id: string; }; /** ReprocessHookResponse */ ReprocessHookResponse: { /** Modal Response */ modal_response?: { [key: string]: unknown; } | null; /** Success */ success: boolean; }; /** ResetModerationModeRequest */ ResetModerationModeRequest: { /** Hook Id */ hook_id: string; }; /** ResetModerationModeResponse */ ResetModerationModeResponse: { /** Success */ success: boolean; }; /** ResetWatchHistoryRequest */ ResetWatchHistoryRequest: { /** * Confirm * @default false */ confirm?: boolean; }; /** ResetWatchHistoryResponse */ ResetWatchHistoryResponse: { /** Message */ message: string; /** Success */ success: boolean; }; /** RespondToInviteSpec */ RespondToInviteSpec: { /** * Status * @enum {string} */ status: "accept" | "reject"; }; /** ReviewItemMetadataDict */ ReviewItemMetadataDict: { /** Genre */ genre?: string | null; /** Lyrics */ lyrics?: string | null; /** Tags */ tags?: string | null; }; /** ReviewItemSpec */ ReviewItemSpec: { /** Key */ key: string; metadata?: components["schemas"]["ReviewItemMetadataDict"]; /** Name */ name: string; /** Url */ url: string; }; /** SamplePackFileSchema */ SamplePackFileSchema: { /** Filename */ filename: string; /** Url */ url: string; }; /** SaveProjectSchema */ SaveProjectSchema: { /** Project Id */ project_id: string; /** State */ state: unknown; /** Title */ title?: string | null; }; /** SealedPayloadSpec */ SealedPayloadSpec: { /** Sealed */ sealed: string; }; /** * SearchOrderEnum * @enum {string} */ SearchOrderEnum: "asc" | "desc"; /** SearchQuerySchema */ SearchQuerySchema: { /** * Boosted User Handles * @default [] */ boosted_user_handles?: string[]; /** * Exclude Song Ids * @default [] */ exclude_song_ids?: string[]; filters?: components["schemas"]["Filters"]; /** * From Index * @default 0 */ from_index?: number; /** Genre */ genre?: string | null; /** Is Instrumental */ is_instrumental?: boolean | null; /** Is Liked */ is_liked?: boolean | null; /** Is Public */ is_public?: boolean | null; /** Is Suno Short */ is_suno_short?: boolean | null; /** @default clip */ item_type?: components["schemas"]["ItemTypeEnum"]; /** Languages */ languages?: string[] | null; /** Maximum Create Time */ maximum_create_time?: string | null; /** Model Version */ model_version?: string | null; /** * Name * @default */ name?: string; order?: components["schemas"]["SearchOrderEnum"]; /** Project Id */ project_id?: string | null; rank_by?: components["schemas"]["SearchRankingEnum"]; search_type: components["schemas"]["SearchTypeEnum"]; /** * Size * @default 20 */ size?: number; /** Song Id */ song_id?: string | null; /** * Term * @default */ term?: string; /** User Id */ user_id?: number | null; /** * User Ids * @default [] */ user_ids?: number[]; /** Vector */ vector?: number[] | null; }; /** * SearchRankingEnum * @enum {string} */ SearchRankingEnum: "upvote_count" | "play_count" | "dislike_count" | "trending" | "most_recent" | "most_relevant" | "by_hour" | "by_day" | "by_week" | "by_month" | "all_time" | "default"; /** SearchRequest */ SearchRequest: { /** Search Queries */ search_queries?: components["schemas"]["SearchQuerySchema"][] | null; }; /** * SearchResult * @description The Search result class returns the search result, which is a key val * pair that key is the plan name and the search result is the value */ SearchResult: { /** Result */ result: { [key: string]: components["schemas"]["BaseSearchResult"]; }; }; /** * SearchTypeEnum * @enum {string} */ SearchTypeEnum: "public_song" | "similar_song" | "library_song" | "test_library_song_db_query" | "library_playlist" | "tag_song" | "genre_preview_song" | "playlist" | "following_clip_feed" | "user" | "user_create_tags" | "suno_shorts" | "project" | "library_persona" | "public_persona" | "new_song_for_you" | "genre_embedding" | "genre_term" | "lyrics" | "hashtag_song" | "genre_for_you" | "playlist_for_you" | "user_to_follow" | "top_user_songs" | "similar_popular_songs" | "popular_song_tag" | "popular_song_genre_knn" | "platform_genre" | "user_genre_song_search" | "hooks_from_clips_similar_to_listening_history"; /** SendMessageRequest */ SendMessageRequest: { /** Content */ content: string; /** * Message Type * @default text */ message_type?: string; /** Thread Id */ thread_id: string; }; /** SendMessageResponse */ SendMessageResponse: { /** * Created At * Format: date-time */ created_at: string; /** Message Id */ message_id: string; /** Thread Id */ thread_id: string; }; /** * SessionSchema * @description Schema for Orpheus chat sessions */ SessionSchema: { /** * Created At * Format: date-time */ created_at: string; /** Name */ name: string; /** Session Id */ session_id: string; /** * Updated At * Format: date-time */ updated_at: string; /** User Id */ user_id: string; /** Visibility */ visibility: string; /** Workspace Id */ workspace_id: string; }; /** * SessionType * @enum {integer} */ SessionType: 1 | 2; /** SetVideoCoverHookPermRequest */ SetVideoCoverHookPermRequest: { /** Opt In */ opt_in: boolean; }; /** SetVideoCoverHookPermResponse */ SetVideoCoverHookPermResponse: { /** Success */ success: boolean; }; /** ShareAssetSchema */ ShareAssetSchema: { /** * Asset Id * Format: uuid */ asset_id: string; }; /** ShareAssetSpec */ ShareAssetSpec: { /** Asset Config */ asset_config: { [key: string]: number | string | boolean; }; /** Clip End Time */ clip_end_time: number; /** Clip Start Time */ clip_start_time: number; }; /** ShareAssetStatusSchema */ ShareAssetStatusSchema: { /** Asset Url */ asset_url?: string | null; /** Render Status */ render_status: string; }; /** ShareAttributionRequest */ ShareAttributionRequest: { /** Content Id */ content_id?: string | null; /** Content Type */ content_type?: string | null; /** Share Id */ share_id?: string | null; /** Source */ source?: string | null; }; /** ShareAttributionResponse */ ShareAttributionResponse: { /** Message */ message?: string | null; /** Success */ success: boolean; }; /** * ShareCodeResponse * @description Schema for share details response */ ShareCodeResponse: { /** Content Id */ content_id: string; /** * Content Type * @enum {string} */ content_type: "song" | "playlist" | "profile" | "hook"; /** Message */ message?: string | null; /** Sharer Avatar Url */ sharer_avatar_url?: string | null; /** Sharer Display Name */ sharer_display_name?: string | null; /** Sharer Handle */ sharer_handle?: string | null; /** Success */ success: boolean; }; /** ShareHookRequest */ ShareHookRequest: { recommendation_metadata?: components["schemas"]["RecommendationMetadata"]; }; /** ShareHookResponse */ ShareHookResponse: { /** Hook Id */ hook_id: string; /** Success */ success: boolean; }; /** ShareLinkRequest */ ShareLinkRequest: { /** Content Id */ content_id: string; /** Content Type */ content_type: string; /** Platform */ platform?: string | null; recommendation_metadata?: components["schemas"]["RecommendationMetadataSchema"]; /** Source */ source?: string | null; }; /** ShareLinkResponse */ ShareLinkResponse: { /** Link */ link?: string | null; /** Message */ message?: string | null; /** Share Id */ share_id?: string | null; /** Success */ success: boolean; }; /** ShortcutContext */ ShortcutContext: { /** Song Id */ song_id?: string | null; }; /** ShortcutItemSchema */ ShortcutItemSchema: { /** Description */ description?: string | null; /** * Entity Type * @default shortcut_schema * @enum {string} */ entity_type?: "shortcut_schema"; /** Id */ id: string; /** Image Url */ image_url: string; /** Name */ name: string; /** Redirect Url */ redirect_url?: string | null; shortcut_context?: components["schemas"]["ShortcutContext"]; shortcut_type?: components["schemas"]["ShortcutType"]; }; /** ShortcutResponse */ ShortcutResponse: { /** Page */ page?: number | null; /** Page Size */ page_size?: number | null; playlist?: components["schemas"]["PlaylistSchema"]; shortcut_type?: components["schemas"]["ShortcutType"]; /** Total Sections */ total_sections?: number | null; }; /** ShortcutSectionSchema */ ShortcutSectionSchema: { /** Description */ description?: string | null; /** Id */ id: string; /** Items */ items: components["schemas"]["ShortcutItemSchema"][]; /** Link */ link?: string | null; /** Mobile Link */ mobile_link?: string | null; /** Options */ options?: string[] | null; /** Secondary Options */ secondary_options?: string[] | null; /** Secondary Selected Option */ secondary_selected_option?: string | null; /** Section Name */ section_name?: string | null; /** * Section Type * @default shortcut * @enum {string} */ section_type?: "shortcut"; /** Selected Option */ selected_option?: string | null; /** Style Type */ style_type?: string | null; /** Title */ title: string; }; /** * ShortcutType * @enum {string} */ ShortcutType: "liked_songs" | "liked_playlists" | "on_repeat" | "my_songs" | "recently_played" | "song_radios" | "played_playlists"; /** ShouldShowVideoCoverHookNotificationResponse */ ShouldShowVideoCoverHookNotificationResponse: { /** Should Show */ should_show: boolean; }; /** SimilarClipsSchema */ SimilarClipsSchema: { /** Similar Clips */ similar_clips: components["schemas"]["GeneratedClipSchema"][]; }; /** SimilarClipsSpec */ SimilarClipsSpec: { /** * Count * @default -1 */ count?: number; /** * Exact Match * @default false */ exact_match?: boolean; /** Id */ id: string; }; /** SimilarCreatorsRequestV2 */ SimilarCreatorsRequestV2: { /** Handle */ handle: string; }; /** SimilarCreatorsResponse */ SimilarCreatorsResponse: { /** Creators */ creators: components["schemas"]["SimpleProfileInfoSchema"][]; /** * Fallback To Popular * @default false */ fallback_to_popular?: boolean; }; /** SimilarityCheckResponse */ SimilarityCheckResponse: { /** * Metadata * @default {} */ metadata?: unknown; /** Model Name */ model_name: string; /** Similarities */ similarities: components["schemas"]["LyricsSimilaritySpec"][]; }; /** SimplePersonaSchema */ SimplePersonaSchema: { /** * Id * Format: uuid */ id?: string | null; /** Image S3 Id */ image_s3_id?: string | null; /** * Is Owned * @default false */ is_owned?: boolean; /** * Is Public * @default false */ is_public?: boolean; /** * Is Trashed * @default false */ is_trashed?: boolean; /** Name */ name?: string | null; /** * Root Clip Id * Format: uuid */ root_clip_id?: string | null; /** User Display Name */ user_display_name?: string | null; /** User Handle */ user_handle?: string | null; /** User Image Url */ user_image_url?: string | null; }; /** SimpleProfileInfoSchema */ SimpleProfileInfoSchema: { /** Avatar Image Url */ avatar_image_url?: string | null; /** Display Name */ display_name?: string | null; /** * Entity Type * @default simple_profile_schema * @enum {string} */ entity_type?: "simple_profile_schema"; /** External User Id */ external_user_id: string; /** Handle */ handle?: string | null; /** * Is Following * @default false */ is_following?: boolean; stats: components["schemas"]["ProfileStatsSchema"]; /** * User Id * @default -1 */ user_id?: number; }; /** SimpleProjectSchema */ SimpleProjectSchema: { /** Description */ description: string; /** Id */ id: string; /** Is Public */ is_public: boolean; /** Is Trashed */ is_trashed: boolean; /** Name */ name: string; }; /** SongState */ SongState: { /** Description */ description: string; /** Duration */ duration: number; /** Image Url */ image_url: string; /** Song Id */ song_id: string; /** Song Url */ song_url: string; /** * Start Time * Format: date-time */ start_time: string; /** Styles */ styles: string[]; /** Title */ title: string; /** Winning Style */ winning_style: string; }; /** * SongifyCancelReasons * @enum {string} */ SongifyCancelReasons: "user_request" | "shutdown"; /** SongifyCreateGenerationRequest */ SongifyCreateGenerationRequest: { /** * Enablelyricoverlay * @default false */ enableLyricOverlay?: boolean; /** Genres */ genres: string[]; /** Uri */ uri: string; /** Uri Type */ uri_type: string; /** Uuids */ uuids: string[]; }; /** SongifyCreateVideoRequest */ SongifyCreateVideoRequest: { /** Enable Lyric Overlay */ enable_lyric_overlay: boolean; /** Genre */ genre: string; /** Is Public */ is_public: boolean; /** Original Video S3 Id */ original_video_s3_id: string; /** Request Id */ request_id: string; /** Title */ title: string; }; /** SongifyDeleteVideoRequest */ SongifyDeleteVideoRequest: { /** Video Id */ video_id: string; }; /** SongifyError */ SongifyError: { code: components["schemas"]["SongifyErrorCode"]; /** Message */ message: string; /** Origin */ origin: string; /** Retryable */ retryable: boolean; }; /** * SongifyErrorCode * @enum {string} */ SongifyErrorCode: "timeout" | "input_invalid" | "resource_exhausted" | "rate_limited" | "worker_crash" | "upstream_error" | "ffmpeg_error" | "storage_error" | "network_error" | "internal_error"; /** SongifySetStatusRequest */ SongifySetStatusRequest: { cancel_reason?: components["schemas"]["SongifyCancelReasons"]; error?: components["schemas"]["SongifyError"]; /** Message */ message?: string | null; /** Metadata */ metadata?: { [key: string]: unknown; } | null; /** Occurred At */ occurred_at: string; status: components["schemas"]["SongifyStatus"]; /** Video Progress Pct */ video_progress_pct?: { [key: string]: unknown; } | null; }; /** * SongifyStatus * @enum {string} */ SongifyStatus: "processing_upload" | "generating_remixes" | "generating_videos" | "completed" | "failed_expected" | "failed_system" | "cancelled"; /** SongifyUpdateVideoRequest */ SongifyUpdateVideoRequest: { error_details?: components["schemas"]["SongifyError"]; final_status: components["schemas"]["SongifyStatus"]; /** Final Video S3 Id */ final_video_s3_id?: string | null; /** Video Id */ video_id: string; }; /** StatsigAutocompleteRequest */ StatsigAutocompleteRequest: { /** Name */ name: string; /** Unit Type */ unit_type: string; }; /** StatsigAutocompleteResponse */ StatsigAutocompleteResponse: { data: components["schemas"]["AutoCompleteResults"]; /** Success */ success: boolean; }; /** StatsigCustomProperties */ StatsigCustomProperties: { /** * Custom * @default {} */ custom?: { [key: string]: string; }; /** * Custom Ids * @default {} */ custom_ids?: { [key: string]: string; }; }; /** StatsigExperimentRequest */ StatsigExperimentRequest: { /** Layer Name */ layer_name: string; /** Parameter Default */ parameter_default?: (string | null) | (boolean | null) | (number | null) | (unknown[] | null) | ({ [key: string]: unknown; } | null); /** Parameter Name */ parameter_name: string; /** * Parameter Type * @default boolean * @enum {string} */ parameter_type?: "string" | "boolean" | "integer" | "float" | "array" | "object"; }; /** StatsigExperimentResponse */ StatsigExperimentResponse: { /** Data */ data: { [key: string]: string | boolean | number; }; /** Success */ success: boolean; }; /** StatsigIdRequest */ StatsigIdRequest: { /** Id */ id: string; /** Unit Type */ unit_type: string; }; /** StatsigIdResponse */ StatsigIdResponse: { /** Data */ data: { [key: string]: unknown; }; /** Success */ success: boolean; }; /** StemActionRequestSchema */ StemActionRequestSchema: { /** Clips */ clips: components["schemas"]["GeneratedClipSchema"][]; }; /** * StemListRequestSpec * @description Request schema for listing stems */ StemListRequestSpec: { /** * Page * @default 0 */ page?: number; }; /** * StemListResponse * @description Response schema for listing stems */ StemListResponse: { /** Current Page */ current_page: number; /** Stems */ stems: components["schemas"]["GeneratedClipSchema"][]; }; /** StemMixInitializeSpec */ StemMixInitializeSpec: { /** Combined From Clip Ids */ combined_from_clip_ids?: string[] | null; /** Stem Remix Of Clip Id */ stem_remix_of_clip_id: string; }; /** * StemPagesResponse * @description Response schema for stem pages endpoint */ StemPagesResponse: { /** Pages */ pages: number; }; /** StreamingResponse */ StreamingResponse: { /** Message */ message: string; }; /** StudioAccessInviteSchema */ StudioAccessInviteSchema: { /** Invitations */ invitations: string[][]; /** * Updated At * Format: date-time */ updated_at: string; }; /** StudioAccessStatusSchema */ StudioAccessStatusSchema: { /** Can Use Studio */ can_use_studio: boolean; /** Invited By */ invited_by: string | null; /** Is On Waitlist */ is_on_waitlist: boolean; /** Owned Invite Code */ owned_invite_code: string | null; /** Owned Invite Code Count */ owned_invite_code_count: number | null; /** Owned Invite Code Redeemed Count */ owned_invite_code_redeemed_count: number | null; /** User Handle */ user_handle: string; /** User Id */ user_id: string; /** Waitlist Rank */ waitlist_rank: number | null; }; /** StudioAccessSummarySchema */ StudioAccessSummarySchema: { /** Num Unique Invite Codes */ num_unique_invite_codes: number; /** Num Users On Waitlist */ num_users_on_waitlist: number; /** Num Users Redeemed Code */ num_users_redeemed_code: number; }; /** StudioInvitationCodeBatchOperationSchema */ StudioInvitationCodeBatchOperationSchema: { /** Failed Users */ failed_users: string[]; /** Success Users */ success_users: string[]; }; /** StudioInvitationCodeBatchOperationSpec */ StudioInvitationCodeBatchOperationSpec: { /** Count */ count: number; /** Emails */ emails?: string[] | null; /** Handles */ handles?: string[] | null; /** Phone Numbers */ phone_numbers?: string[] | null; }; /** StudioInvitationCodeRedeemSchema */ StudioInvitationCodeRedeemSchema: { /** Code Owner Display Name */ code_owner_display_name: string | null; /** Success */ success: boolean; }; /** StudioInvitationCodeRedeemSpec */ StudioInvitationCodeRedeemSpec: { /** Code */ code: string; }; /** StudioInvitationCodeSchema */ StudioInvitationCodeSchema: { /** Code */ code: string; /** Count */ count: number; /** Redeemed Count */ redeemed_count: number; }; /** StudioProjectMetaSchema */ StudioProjectMetaSchema: { /** * Archived * @default false */ archived?: boolean; /** * Created At * Format: date-time */ created_at: string; /** * Id * Format: uuid */ id?: string | null; /** * Title * @default */ title?: string; /** * Updated At * Format: date-time */ updated_at: string; /** Version Id */ version_id?: string | null; }; /** StudioProjectSchema */ StudioProjectSchema: { /** * Archived * @default false */ archived?: boolean; /** * Created At * Format: date-time */ created_at: string; /** * Id * Format: uuid */ id?: string | null; /** State */ state: unknown; /** * Title * @default */ title?: string; /** * Updated At * Format: date-time */ updated_at: string; }; /** StudioProjectVersion */ StudioProjectVersion: { /** * Created At * Format: date-time */ created_at: string; /** Version */ version: number; /** Version Id */ version_id: string; }; /** StudioProjectVersionDay */ StudioProjectVersionDay: { /** * Date * Format: date-time */ date: string; /** Total Versions */ total_versions: number; }; /** StudioProjectVersionListSchema */ StudioProjectVersionListSchema: { /** Aggregated Versions */ aggregated_versions?: components["schemas"]["AggregatedStudioProjectVersion"][] | null; /** Days */ days?: components["schemas"]["StudioProjectVersionDay"][] | null; /** Id */ id: string; }; /** StudioVersionStateSchema */ StudioVersionStateSchema: { /** * Created At * Format: date-time */ created_at: string; /** Id */ id: string; /** Project Id */ project_id: string; /** State */ state: unknown; }; /** StudioWaitlistSchema */ StudioWaitlistSchema: { /** Has Studio Access */ has_studio_access: boolean; /** Rank */ rank: number | null; /** Success */ success: boolean; /** Waitlist Size */ waitlist_size: number | null; }; /** StyleItemSchema */ StyleItemSchema: { aura_settings?: components["schemas"]["AuraSettings"]; /** * Entity Type * @default style_schema * @enum {string} */ entity_type?: "style_schema"; /** Id */ id: string; /** Image Url */ image_url: string; /** Name */ name: string; /** Redirect Url */ redirect_url?: string | null; }; /** StyleListSectionSchema */ StyleListSectionSchema: { /** Description */ description?: string | null; /** Id */ id: string; /** Items */ items: components["schemas"]["StyleItemSchema"][]; /** Link */ link?: string | null; /** Mobile Link */ mobile_link?: string | null; /** Options */ options?: string[] | null; /** Secondary Options */ secondary_options?: string[] | null; /** Secondary Selected Option */ secondary_selected_option?: string | null; /** Section Name */ section_name?: string | null; /** * Section Type * @default style_list * @enum {string} */ section_type?: "style_list"; /** Selected Option */ selected_option?: string | null; /** Style Type */ style_type?: string | null; /** Title */ title: string; }; /** SubmitSurveyResponse */ SubmitSurveyResponse: { /** Success */ success: boolean; }; /** SubmitSurveySpec */ SubmitSurveySpec: { /** Custom Reason */ custom_reason?: string | null; reason: components["schemas"]["ChurnReason"]; }; /** SubscriptionCancelSchemaResponse */ SubscriptionCancelSchemaResponse: { /** Ok */ ok: boolean; }; /** SubscriptionInfoResponse */ SubscriptionInfoResponse: { /** Accessible Features */ accessible_features: components["schemas"]["FeatureSchema"][]; audio_upload_limits: components["schemas"]["IntRangeSchema"]; /** Can Upgrade Immediately */ can_upgrade_immediately: boolean | null; /** * Cancel On * Format: date-time */ cancel_on: string | null; /** Changing To */ changing_to: string | null; /** Credit Packs */ credit_packs: components["schemas"]["CreditPackSchema"][]; /** Credits */ credits: number; /** * Day0 Boost * @default -1 */ day0_boost?: number; /** Free Cover Clips Remaining */ free_cover_clips_remaining: number | null; /** Free Mobile Remasters Remaining */ free_mobile_remasters_remaining: number | null; /** Free Mobile V4 Gens Remaining */ free_mobile_v4_gens_remaining: number | null; /** Free Persona Clips Remaining */ free_persona_clips_remaining: number | null; /** Free Remasters Remaining */ free_remasters_remaining: number | null; /** Free Web V4 Gens Remaining */ free_web_v4_gens_remaining: number | null; /** Has Been Student Subscriber Before */ has_been_student_subscriber_before: boolean; /** Has Been Subscriber Before */ has_been_subscriber_before: boolean; /** Has Valid School Email */ has_valid_school_email: boolean; /** Is Active */ is_active: boolean; /** Is Past Due */ is_past_due: boolean; /** Models */ models: components["schemas"]["ExternalModelTypeSchema"][]; /** Monthly Limit */ monthly_limit: number; /** Monthly Usage */ monthly_usage: number; /** Payment Method Type */ payment_method_type: string | null; /** Period */ period: string | null; /** * Period End * Format: date-time */ period_end: string | null; plan?: components["schemas"]["UsagePlanSchema"]; /** Plan Currency */ plan_currency: string | null; /** Plan Currency Price */ plan_currency_price: number | null; /** Plan Price */ plan_price: number | null; /** Plans */ plans: components["schemas"]["UsagePlanSchema"][]; /** Promotions */ promotions?: components["schemas"]["PromotionType"][] | null; /** Remaster Model Types */ remaster_model_types?: components["schemas"]["ExternalRemasterModelTypeSchema"][] | null; /** * Renews On * Format: date-time */ renews_on: string | null; /** Revcat Subscriptions Offering Id */ revcat_subscriptions_offering_id?: string | null; /** * Subscription Anchor * Format: date-time */ subscription_anchor: string | null; /** Subscription Id */ subscription_id: string | null; /** Subscription Platform */ subscription_platform: string | null; /** Subscription Type */ subscription_type: boolean; /** Total Credits Left */ total_credits_left: number; }; /** * SubscriptionPeriodType * @enum {string} */ SubscriptionPeriodType: "month" | "year"; /** SubscriptionSyncSchemaResponse */ SubscriptionSyncSchemaResponse: { /** Ok */ ok: boolean; }; /** SuggestedClipsSchema */ SuggestedClipsSchema: { /** Clips */ clips: components["schemas"]["GeneratedClipSchema"][]; }; /** SuppressNotificationsSpec */ SuppressNotificationsSpec: { /** * Ids * @default [] */ ids?: string[]; }; /** TabCarouselRequest */ TabCarouselRequest: Record; /** TabCarouselResponse */ TabCarouselResponse: { /** Tabs */ tabs: components["schemas"]["TabItemSchema"][]; }; /** TabItemSchema */ TabItemSchema: { /** Description */ description?: string | null; /** Id */ id: string; /** Image Url */ image_url: string; /** Name */ name: string; /** Redirect Url */ redirect_url?: string | null; shortcut_type?: components["schemas"]["TabItemType"]; }; /** * TabItemType * @enum {string} */ TabItemType: "following" | "playlist" | "my_songs" | "continue_listening" | "liked_songs"; /** TableFeature */ TableFeature: { /** Name */ name: string; /** Tooltip */ tooltip?: string | null; [key: string]: unknown; }; /** TableSection */ TableSection: { /** Features */ features: components["schemas"]["TableFeature"][]; /** Icon */ icon?: string | null; /** Name */ name: string; }; /** * TaxInfoSchemaResponse * @description Schema for tax information response. */ TaxInfoSchemaResponse: { /** Error */ error?: string | null; /** Tax Rate */ tax_rate: number; }; /** * TextPlacement * @enum {integer} */ TextPlacement: 1 | 2 | 3; /** ThreadDetailSchema */ ThreadDetailSchema: { /** * All Users * @default [] */ all_users?: components["schemas"]["UserBasicInfo"][]; /** * Created At * Format: date-time */ created_at: string; /** Id */ id: string; /** Is Active */ is_active: boolean; /** Name */ name: string; /** * Thread Type * @default direct */ thread_type?: string; }; /** ThreadSummarySchema */ ThreadSummarySchema: { /** * Created At * Format: date-time */ created_at: string; /** Id */ id: string; /** Is Active */ is_active: boolean; /** * Last Message At * Format: date-time */ last_message_at?: string | null; /** Last Message Content */ last_message_content?: string | null; /** Name */ name: string; /** * Partial Users * @default [] */ partial_users?: components["schemas"]["UserBasicInfo"][]; /** * Thread Type * @default direct */ thread_type?: string; /** * Unread Count * @default 0 */ unread_count?: number; }; /** * TimeOfSkipSpec * @description Represent the event of a user skipping a clip at a given time. */ TimeOfSkipSpec: { /** * Clip Id * Format: uuid */ clip_id: string; /** Time Of Skip S */ time_of_skip_s: number; }; /** ToggleCommentsRequest */ ToggleCommentsRequest: { /** Can Comment */ can_comment: boolean; }; /** ToggleRemixesSpec */ ToggleRemixesSpec: { /** Can Remix */ can_remix: boolean; }; /** ToggleShowRemixesSpec */ ToggleShowRemixesSpec: { /** Show Remix */ show_remix: boolean; }; /** ToggleTestHookRequest */ ToggleTestHookRequest: { /** Is Test */ is_test: boolean; }; /** ToggleTestHookResponse */ ToggleTestHookResponse: { /** Id */ id: string; /** Success */ success: boolean; }; /** TopUserClipsResponse */ TopUserClipsResponse: { /** Clips */ clips: components["schemas"]["GeneratedClipSchema"][]; }; /** TrashSpec */ TrashSpec: { /** Clip Ids */ clip_ids: string[]; /** Trash */ trash: boolean; }; /** TrashedClipIdsSchema */ TrashedClipIdsSchema: { /** Clips */ clips: components["schemas"]["GeneratedClipSchema"][]; /** Num Total Results */ num_total_results: number; }; /** TrendingMetadataSchema */ TrendingMetadataSchema: { /** * Feed Metadata Type * @default trending_metadata * @enum {string} */ feed_metadata_type?: "trending_metadata"; /** Lang Map Keys */ lang_map_keys: string[]; /** Language */ language: string; /** Language Text */ language_text: string; /** Rank Text */ rank_text: string; /** Ranking Map Keys */ ranking_map_keys: string[]; }; /** UnauthenticatedSessionResponse */ UnauthenticatedSessionResponse: { /** Flags */ flags: { [key: string]: unknown; }; /** Models */ models: components["schemas"]["ExternalModelTypeSchema"][]; /** Roles */ roles: { [key: string]: unknown; }; statsig_custom_properties?: components["schemas"]["StatsigCustomProperties"]; }; /** * UpdateArtistProfileInfoSpec * @description Schema for updating artist profile information stored in DynamoDB. */ UpdateArtistProfileInfoSpec: { /** Cover Photo Position */ cover_photo_position?: string | null; /** Cover Photo Url */ cover_photo_url?: string | null; /** Instagram Link */ instagram_link?: string | null; /** Location */ location?: string | null; /** Section Order */ section_order?: string[] | null; /** Soundcloud Link */ soundcloud_link?: string | null; /** Spotify Link */ spotify_link?: string | null; /** User Inputted Genres */ user_inputted_genres?: string[] | null; /** X Link */ x_link?: string | null; /** Youtube Link */ youtube_link?: string | null; }; /** UpdateArtistProfileResponse */ UpdateArtistProfileResponse: { /** Avatar Image Url */ avatar_image_url?: string | null; /** Birth Date */ birth_date?: string | null; /** Display Name */ display_name?: string | null; /** Handle */ handle?: string | null; /** Profile Description */ profile_description?: string | null; /** Secondary Email */ secondary_email?: string | null; }; /** UpdateArtistProfileSpec */ UpdateArtistProfileSpec: { /** Avatar Image S3 Id */ avatar_image_s3_id?: string | null; /** Avatar Image Url */ avatar_image_url?: string | null; /** Birth Date */ birth_date?: string | null; /** Display Name */ display_name: string; /** Handle */ handle: string; /** Profile Description */ profile_description: string; /** Secondary Email */ secondary_email?: string | null; /** User Id */ user_id?: string | null; }; /** UpdateHookMetadataRequest */ UpdateHookMetadataRequest: { /** Allow Comments */ allow_comments?: boolean | null; /** Caption */ caption?: string | null; /** Show Lyrics */ show_lyrics?: boolean | null; }; /** UpdateHookMetadataResponse */ UpdateHookMetadataResponse: { /** Hook Id */ hook_id: string; /** Success */ success: boolean; }; /** UpdateHookWatchHistoryRequest */ UpdateHookWatchHistoryRequest: { /** Hook Ids To Times Listened */ hook_ids_to_times_listened: { [key: string]: number; }; }; /** UpdateHookWatchHistoryResponse */ UpdateHookWatchHistoryResponse: { /** Success */ success: boolean; }; /** UpdateSavedPromptSpec */ UpdateSavedPromptSpec: { /** Gpt Description Prompt */ gpt_description_prompt?: string | null; /** Id */ id?: string | null; /** Is Pinned */ is_pinned?: boolean | null; /** Lyrics */ lyrics?: string | null; /** Negative Tags */ negative_tags?: string | null; sliders?: components["schemas"]["ControlSlidersSchema"]; /** Tags */ tags?: string | null; /** Title */ title?: string | null; }; /** UpdateShareLinkRequest */ UpdateShareLinkRequest: { /** Platform */ platform?: string | null; /** Share Id */ share_id: string; }; /** UpdateShareLinkResponse */ UpdateShareLinkResponse: { /** Message */ message?: string | null; /** Success */ success: boolean; }; /** UpdateSongFeedbackRequest */ UpdateSongFeedbackRequest: { /** Custom Reason */ custom_reason?: string | null; /** Feedback Reasons */ feedback_reasons?: components["schemas"]["FeedbackReason"][] | null; feedback_type: components["schemas"]["FeedbackType"]; }; /** UpdateSurveyQuestionSpec */ UpdateSurveyQuestionSpec: { /** Group Id */ group_id?: string | null; /** Is Active */ is_active?: boolean | null; /** Is Required */ is_required?: boolean | null; /** Options */ options?: string[] | null; /** Order */ order?: number | null; /** Prompt */ prompt?: string | null; type?: components["schemas"]["QuestionType"]; }; /** UpdateSurveyResponseSpec */ UpdateSurveyResponseSpec: { /** Response */ response: string[]; }; /** UpdateUserConfigRequestSpec */ UpdateUserConfigRequestSpec: { /** Creation Song Language */ creation_song_language?: string | null; }; /** UpdateUserPhoneReq */ UpdateUserPhoneReq: { /** Phone */ phone: string; }; /** UpdatedClipPromptSpec */ UpdatedClipPromptSpec: { /** Model Name */ model_name?: string | null; /** Prompt */ prompt?: string | null; }; /** UploadClipSchema */ UploadClipSchema: { /** Clip Id */ clip_id?: string | null; }; /** UploadRequestSchema */ UploadRequestSchema: { /** Fields */ fields: { [key: string]: unknown; }; /** Id */ id: string; /** * Is File Uploaded * @default false */ is_file_uploaded?: boolean; /** Url */ url: string; }; /** UploadRequestSpec */ UploadRequestSpec: { /** Extension */ extension?: string | null; /** File Sha256 */ file_sha256?: string | null; /** * Is Stem Mix * @default false */ is_stem_mix?: boolean; }; /** UploadRequestStatusSchema */ UploadRequestStatusSchema: { /** Error Message */ error_message?: string | null; /** Has Vocal */ has_vocal?: boolean | null; /** Id */ id: string; /** Image Url */ image_url?: string | null; /** S3 Id */ s3_id?: string | null; /** Status */ status: string; /** Title */ title?: string | null; /** Video Url */ video_url?: string | null; }; /** UpsampleParamsSpec */ UpsampleParamsSpec: { /** * Batch Size * @default 2 */ batch_size?: number; /** Clarity */ clarity?: number | null; /** Clip Id */ clip_id?: string | null; /** Cover Image S3 Id */ cover_image_s3_id?: string | null; /** * Creation Source * @enum {string|null} */ creation_source?: "studio" | "radio" | null; /** Diffusion Context Cfg */ diffusion_context_cfg?: number | null; /** Diffusion Steps */ diffusion_steps?: number | null; /** Diffusion Text Cfg */ diffusion_text_cfg?: number | null; /** Freedom */ freedom?: number | null; /** Gpt Description Prompt */ gpt_description_prompt?: string | null; /** Gpt Lang */ gpt_lang?: string | null; /** Gpt Prompt */ gpt_prompt?: string | null; /** Make Instrumental */ make_instrumental?: boolean | null; /** * Metadata * @default {} */ metadata?: unknown; /** * Model Name * @default chirp-up */ model_name?: string; /** Prompt */ prompt?: string | null; /** Stereo Width */ stereo_width?: number | null; /** * Stream * @default false */ stream?: boolean; /** Strength */ strength?: number | null; /** Tags */ tags?: string | null; /** * Task * @enum {string|null} */ task?: "extend" | "upload_extend" | "infill" | "fixed_infill" | "infill_intro" | "infill_outro" | "cover_infill" | "cover_extend" | "artist_infill" | "artist_consistency" | "cover" | "image_to_song" | "video_to_song" | "concat" | "concat_infilling" | "upsample" | "twitter_to_song" | "artist_cover" | "vox_cover" | "artist_extend" | "artist_cover_extend" | "vox" | "stem" | "gen_stem" | "generate" | "multi_artist_consistency" | "playlist_condition" | "underpainting" | "overpainting" | "stem_condition" | "cover_stem_condition" | "artist_stem_condition" | "stem_infill" | "stem_condition_infill" | "vox_playlist_condition" | "" | null; /** * Title * @default */ title?: string; /** Tone */ tone?: number | null; /** * Variation Category * @enum {string|null} */ variation_category?: "subtle" | "normal" | "high" | null; /** Voice */ voice?: string | null; /** Voice Id */ voice_id?: string | null; }; /** UpsampleTagsRequest */ UpsampleTagsRequest: { /** Original Tags */ original_tags: string; }; /** UpsampleTagsResponse */ UpsampleTagsResponse: { /** * Request Id * Format: uuid */ request_id: string; /** Upsampled Tags */ upsampled_tags: string; }; /** UpsertLabelMakerProjectSpec */ UpsertLabelMakerProjectSpec: { /** Credits Per Annotation */ credits_per_annotation?: number | null; /** Enabled */ enabled?: boolean | null; /** Instructions */ instructions?: string | null; /** Max Annotations Per Task */ max_annotations_per_task?: number | null; /** Max Annotations Per User */ max_annotations_per_user?: number | null; /** * Media Type * @default audio * @enum {string} */ media_type?: "audio" | "video"; /** Min Review Time Seconds */ min_review_time_seconds?: number | null; /** Preference Dimensions */ preference_dimensions: { [key: string]: string; }[]; /** Priority */ priority?: number | null; /** * Project Id * Format: uuid */ project_id?: string | null; /** Project Name */ project_name: string; /** Question */ question: string; /** Statsig Gate */ statsig_gate?: string | null; /** Target Review Count */ target_review_count: number; }; /** UpsertPlaybarStateRequest */ UpsertPlaybarStateRequest: { /** Action Time */ action_time: string | null; /** Context Id */ context_id: string | null; /** Context Type */ context_type: string | null; /** Device Context */ device_context: string | null; /** Device Id */ device_id: string | null; /** Device Type */ device_type: string | null; /** Playbar State */ playbar_state: string | null; /** Playlist Context */ playlist_context: string | null; repeat_state: components["schemas"]["RepeatState"]; /** Song Ids In Queue */ song_ids_in_queue: string[] | null; /** Song Index */ song_index: number | null; /** Song Play Time */ song_play_time: number | null; /** Volume */ volume: number | null; }; /** UsagePlanDescription */ UsagePlanDescription: { /** Badge */ badge: { [key: string]: string; }; /** Feature Descriptions */ feature_descriptions: components["schemas"]["FeatureDescription"][]; /** Plan Description */ plan_description?: string | null; }; /** UsagePlanDescriptionsResponse */ UsagePlanDescriptionsResponse: { /** Usage Plan Descriptions */ usage_plan_descriptions: { [key: string]: components["schemas"]["UsagePlanDescription"]; }; }; /** UsagePlanFaqResponse */ UsagePlanFaqResponse: { /** Faq */ faq: components["schemas"]["FaqItem"][]; }; /** * UsagePlanKey * @enum {string} */ UsagePlanKey: "free" | "student" | "pro" | "premier" | "basic" | "pro_20250501"; /** UsagePlanSchema */ UsagePlanSchema: { /** Annual Price Usd */ annual_price_usd: number; /** Features */ features: string; /** * Id * Format: uuid */ id: string; /** Level */ level: number; /** Monthly Price Usd */ monthly_price_usd: number; /** Name */ name: string; /** Plan Key */ plan_key: string; /** Prices */ prices: components["schemas"]["PriceSchema"][]; /** Usage Plan Features */ usage_plan_features: components["schemas"]["FeatureSchema"][]; }; /** UsagePlanWebTableComparison */ UsagePlanWebTableComparison: { /** Table Sections */ table_sections: components["schemas"]["TableSection"][]; }; /** UsagePlanWebTableComparisonResponse */ UsagePlanWebTableComparisonResponse: { usage_plan_web_table_comparison: components["schemas"]["UsagePlanWebTableComparison"]; }; /** UsagePlansSchemaReponse */ UsagePlansSchemaReponse: { /** Plans */ plans: components["schemas"]["UsagePlanSchema"][]; }; /** UsePromoCodeRequest */ UsePromoCodeRequest: { /** Promo Code */ promo_code: string; }; /** UsePromoCodeResponse */ UsePromoCodeResponse: { /** Error Msg */ error_msg?: string | null; /** Promo Code */ promo_code?: string | null; /** Promo Code Url */ promo_code_url?: string | null; }; /** UserAnalyticsResponse */ UserAnalyticsResponse: { /** Has Created Song */ has_created_song: boolean; }; /** UserBasicInfo */ UserBasicInfo: { /** Avatar Url */ avatar_url?: string | null; /** Display Name */ display_name?: string | null; /** Handle */ handle?: string | null; /** Uid */ uid: string; }; /** UserChallenge */ UserChallenge: { /** Category */ category: string; /** Description */ description: string; /** Goal */ goal: number; /** Is Completed */ is_completed: boolean; /** Level */ level: number; /** Name */ name: string; /** Progress */ progress: number; /** Reward Credits */ reward_credits: number; }; /** UserChallengesSchema */ UserChallengesSchema: { /** Challenges */ challenges: components["schemas"]["UserChallenge"][]; current_level: components["schemas"]["UserJourneyLevel"]; /** Earned Credits */ earned_credits: number; /** Total Credits */ total_credits: number; }; /** * UserCheckSpec * @description Represent an User check with token */ UserCheckSpec: { /** * Captcha Token * @default */ captcha_token?: string; }; /** UserConfigSchema */ UserConfigSchema: { /** Creation Song Language */ creation_song_language?: string | null; /** Dismissed Banners Web */ dismissed_banners_web?: string[] | null; /** Has Accepted Timbaland Terms */ has_accepted_timbaland_terms?: boolean | null; /** Has Set Remix Perm */ has_set_remix_perm?: boolean | null; /** Has Set Video Cover Hook Perm */ has_set_video_cover_hook_perm?: boolean | null; /** Preferred Tags */ preferred_tags?: string[] | null; /** Shown Claim Username */ shown_claim_username?: boolean | null; /** Shown Creation Tour */ shown_creation_tour?: boolean | null; }; /** UserGroupSchema */ UserGroupSchema: { first_remix: components["schemas"]["GeneratedClipSchema"]; /** Remix Count */ remix_count: number; /** User Avatar Image Url */ user_avatar_image_url?: string | null; /** User Display Name */ user_display_name?: string | null; /** User Handle */ user_handle?: string | null; /** User Id */ user_id: string; }; /** UserJourneyLevel */ UserJourneyLevel: { /** Description */ description: string; /** Level */ level: number; /** Name */ name: string; }; /** UserListSectionSchema */ UserListSectionSchema: { /** Description */ description?: string | null; /** Id */ id: string; /** Items */ items: components["schemas"]["SimpleProfileInfoSchema"][]; /** Link */ link?: string | null; /** Mobile Link */ mobile_link?: string | null; /** Options */ options?: string[] | null; /** Secondary Options */ secondary_options?: string[] | null; /** Secondary Selected Option */ secondary_selected_option?: string | null; /** Section Name */ section_name?: string | null; /** * Section Type * @default user_list * @enum {string} */ section_type?: "user_list"; /** Selected Option */ selected_option?: string | null; /** Style Type */ style_type?: string | null; /** Title */ title: string; }; /** UserMobileProfileSchema */ UserMobileProfileSchema: { /** Phone */ phone: string; profile: components["schemas"]["SimpleProfileInfoSchema"]; }; /** UserNotificationSchema */ UserNotificationSchema: { /** * Notifications * @default [] */ notifications?: (components["schemas"]["NotificationReactSchema"] | components["schemas"]["NotificationFollowSchema"] | components["schemas"]["NotificationAnnouncementSchema"] | components["schemas"]["NotificationPersonaSchema"])[]; /** * Notified At * Format: date-time */ notified_at: string; }; /** UserNotificationV2Schema */ UserNotificationV2Schema: { /** * Notifications * @default [] */ notifications?: components["schemas"]["NotificationV2Schema"][]; /** * Notified At * Format: date-time */ notified_at: string; }; /** UserReactionSchema */ UserReactionSchema: { /** * Clip * Format: uuid */ clip?: string | null; /** Feedback Reason */ feedback_reason?: string | null; /** * Flagged * @default false */ flagged?: boolean; /** Flagged Reason */ flagged_reason?: string | null; /** * Play Count * @default 0 */ play_count?: number; /** Reaction Type */ reaction_type?: string | null; /** * Skip Count * @default 0 */ skip_count?: number; /** * Updated At * Format: date-time */ updated_at: string; }; /** UserSearchRequest */ UserSearchRequest: { /** Boosted User Handles */ boosted_user_handles?: string[] | null; /** Excluded User Handles */ excluded_user_handles?: string[] | null; /** Term */ term: string; }; /** VerifyExternalTokenResponse */ VerifyExternalTokenResponse: { /** Is Valid */ is_valid: boolean; /** User Email */ user_email: string; }; /** VideoCoverSchema */ VideoCoverSchema: { clip: components["schemas"]["GeneratedClipSchema"]; /** * Video Cover Status * @enum {string} */ video_cover_status: "uploading" | "processing" | "error" | "saved" | "removed"; }; /** VideoCoverSpec */ VideoCoverSpec: { /** Create Video Hook */ create_video_hook?: boolean | null; /** Video Cover Upload Id */ video_cover_upload_id?: string | null; }; /** VideoGenerationParams */ VideoGenerationParams: { /** Clip Id */ clip_id?: string | null; /** * Type * @enum {string|null} */ type?: "rainbow-text" | "instagram-comment" | "polaroid" | null; }; /** VideoHookCreationRequest */ VideoHookCreationRequest: { /** Clip Id */ clip_id: string; hook_publish: components["schemas"]["HookPublishSchema"]; video_render: components["schemas"]["VideoRenderSchema"]; }; /** VideoHookCreationResponse */ VideoHookCreationResponse: { /** Id */ id?: string | null; /** Original Clip Id */ original_clip_id?: string | null; /** Title */ title?: string | null; }; /** * VideoHookCreationSource * @enum {string} */ VideoHookCreationSource: "user_upload" | "backfill_video_cover" | "video_cover"; /** VideoHookFeedDiagnosticRequest */ VideoHookFeedDiagnosticRequest: { /** * Page Size * @default 25 */ page_size?: number; /** * Start Index * @default 0 */ start_index?: number; /** User Id */ user_id: number; }; /** VideoHookFeedDiagnosticResponse */ VideoHookFeedDiagnosticResponse: { /** Latency Ms */ latency_ms: number; /** Recommendation Run Id */ recommendation_run_id: string; }; /** VideoHookFeedRequest */ VideoHookFeedRequest: { /** * Page Size * @default 100 */ page_size?: number; /** * Start Index * @default 0 */ start_index?: number; }; /** VideoHookFeedResponse */ VideoHookFeedResponse: { /** Items */ items: components["schemas"]["VideoHookSchema"][]; }; /** VideoHookSchema */ VideoHookSchema: { /** * Allow Comments * @default true */ allow_comments?: boolean; /** * Caption * @default */ caption?: string; clip?: components["schemas"]["GeneratedClipSchema"]; /** * Comment Count * @default 0 */ comment_count?: number; /** Content Rating Tags */ content_rating_tags?: string[] | null; /** Created At */ created_at: string; creation_source?: components["schemas"]["VideoHookCreationSource"]; /** Current User Disliked */ current_user_disliked: boolean; /** Current User Follows Creator */ current_user_follows_creator: boolean; /** Current User Liked */ current_user_liked: boolean; /** End Clip Timestamp */ end_clip_timestamp: number; /** Human Rating */ human_rating?: string | null; /** Id */ id: string; /** Is Test */ is_test: boolean; /** Like Count */ like_count: number; lyric_display?: components["schemas"]["LyricDisplay"]; /** Original Clip Id */ original_clip_id: string; /** Recommendation Item Id */ recommendation_item_id?: string | null; /** Recommendation Run Id */ recommendation_run_id?: string | null; /** Rendered Video Preview S3 Id */ rendered_video_preview_s3_id: string | null; /** Rendered Video Preview Url */ rendered_video_preview_url: string | null; /** Rendered Video S3 Id */ rendered_video_s3_id: string | null; /** Rendered Video Url */ rendered_video_url: string | null; /** Report Count */ report_count?: number | null; /** * Show Lyrics * @default true */ show_lyrics?: boolean; /** Song Volume */ song_volume?: number | null; /** @default 0 */ staff_review_status?: components["schemas"]["HookStaffReviewStatus"]; /** Start Clip Timestamp */ start_clip_timestamp: number; status: components["schemas"]["VideoHookStatus"]; /** Thumbnail Image S3 Id */ thumbnail_image_s3_id: string | null; /** Thumbnail Image Url */ thumbnail_image_url: string | null; /** Title */ title: string; /** Updated At */ updated_at: string; user?: components["schemas"]["SimpleProfileInfoSchema"]; /** User Id */ user_id: number; /** Video Duration */ video_duration: number; /** Video Streaming Resolutions */ video_streaming_resolutions?: components["schemas"]["VideoStreamingResolutionSchema"][] | null; /** Video Upload Ids */ video_upload_ids?: string[] | null; /** Video Volume */ video_volume?: number | null; /** View Count */ view_count: number; }; /** * VideoHookStatus * @enum {string} */ VideoHookStatus: "video_processing" | "submitted" | "rendering" | "rendered_in_moderation" | "rendered_failed_moderation" | "rendered_passed_moderation" | "error"; /** VideoOutputSpec */ VideoOutputSpec: { /** Audio Id */ audio_id: string; /** Description */ description?: string | null; /** * Duration * @default 30 */ duration?: number; /** Image S3 Id */ image_s3_id?: string | null; /** Title */ title?: string | null; /** @default private */ visibility?: components["schemas"]["Visibility"]; }; /** VideoRenderImageSchema */ VideoRenderImageSchema: { /** * End Time * @default 0 */ end_time?: number; /** S3 Id */ s3_id: string; /** * Start Time * @default 0 */ start_time?: number; /** Upload Id */ upload_id?: string | null; }; /** VideoRenderLyricSchema */ VideoRenderLyricSchema: { /** End Time */ end_time: number; /** Height */ height: number; /** Lyric Font */ lyric_font: string; /** Lyric Style */ lyric_style: string; /** Start Time */ start_time: number; /** Text */ text: string; /** Width */ width: number; }; /** VideoRenderSchema */ VideoRenderSchema: { /** Images */ images?: components["schemas"]["VideoRenderImageSchema"][] | null; shader?: components["schemas"]["VideoRenderShaderSchema"]; song: components["schemas"]["VideoRenderSongSchema"]; text_sticker?: components["schemas"]["VideoRenderStickerSchema"]; /** Videos */ videos?: components["schemas"]["VideoRenderVideoSchema"][] | null; }; /** VideoRenderShaderSchema */ VideoRenderShaderSchema: { /** Shader Type */ shader_type: string; }; /** VideoRenderSongSchema */ VideoRenderSongSchema: { /** * Clip End Time * @default 30 */ clip_end_time?: number; /** * Clip Start Time * @default 0 */ clip_start_time?: number; lyric?: components["schemas"]["VideoRenderLyricSchema"]; /** Song Id */ song_id: string; /** * Volume * @default 100 */ volume?: number; }; /** VideoRenderStickerSchema */ VideoRenderStickerSchema: { /** Sticker Id */ sticker_id: string; /** Text */ text: string; }; /** VideoRenderVideoSchema */ VideoRenderVideoSchema: { /** * End Time * @default 0 */ end_time?: number; /** S3 Id */ s3_id?: string | null; /** * Source End Time * @default 0 */ source_end_time?: number; /** * Source Start Time * @default 0 */ source_start_time?: number; /** * Start Time * @default 0 */ start_time?: number; /** Upload Id */ upload_id?: string | null; /** * Volume * @default 0 */ volume?: number; }; /** VideoSpriteSchema */ VideoSpriteSchema: { /** Image Height */ image_height: number; /** Image Width */ image_width: number; /** Interval */ interval?: number | null; /** S3 Id */ s3_id: string; /** Thumbnail Height */ thumbnail_height: number; /** Thumbnail Width */ thumbnail_width: number; /** Total Frames */ total_frames?: number | null; }; /** VideoStreamingResolutionSchema */ VideoStreamingResolutionSchema: { /** Resolution */ resolution: number; /** Url */ url: string; }; /** * VideoUploadType * @enum {string} */ VideoUploadType: "video_cover" | "video_hook" | "video_scenes"; /** VideoWorkspaceResponse */ VideoWorkspaceResponse: { /** Clip Id */ clip_id?: string | null; /** Custom Reference Id */ custom_reference_id?: string | null; /** Id */ id: string; /** Image Url */ image_url?: string | null; /** Lyrics */ lyrics?: { [key: string]: unknown; }[] | null; /** Prompt */ prompt?: string | null; /** Scene Count */ scene_count: number; /** Scene Script */ scene_script?: { [key: string]: unknown; }[] | null; /** * Status * @enum {string} */ status: "workspace_created" | "script_generated" | "soul_images_generated" | "video_generated" | "scene_completed" | "completed" | "failed"; /** Video Url */ video_url?: string | null; }; /** * Visibility * @enum {string} */ Visibility: "private" | "link-only" | "public"; /** VisibilitySpec */ VisibilitySpec: { /** * Visibility * @enum {string} */ visibility: "private" | "public" | "link-only"; }; /** VoteRequest */ VoteRequest: { /** Style Index */ style_index: number; }; /** VoteResponse */ VoteResponse: Record; /** VoteSchema */ VoteSchema: { /** Contest */ contest: string; /** Contest Id */ contest_id: string; /** Id */ id: string; /** Loser */ loser: string; /** Loser Clip Id */ loser_clip_id: string; /** Processed */ processed: boolean; /** Swap Vote */ swap_vote: boolean | null; /** Winner */ winner: string; /** Winner Clip Id */ winner_clip_id: string; }; /** VoteStatusResponse */ VoteStatusResponse: { /** Styles */ styles: string[]; /** Vote Closed */ vote_closed: boolean; /** Vote Session Uuid */ vote_session_uuid: string; /** Votes */ votes: number[]; /** Winning Style */ winning_style: string | null; }; /** WavFileSchema */ WavFileSchema: { /** Wav File Url */ wav_file_url?: string | null; }; /** WaveformAggregateResponse */ WaveformAggregateResponse: { /** Waveform Aggregates */ waveform_aggregates: components["schemas"]["WaveformAggregateSchema"][]; }; /** WaveformAggregateSchema */ WaveformAggregateSchema: { /** Data */ data: number[][]; /** Mip Map Level */ mip_map_level: number; }; /** WebSubscriptionFeatureFlagResponse */ WebSubscriptionFeatureFlagResponse: { /** Use Aura Subscriptions */ use_aura_subscriptions: boolean; }; /** WordOutputSchema */ WordOutputSchema: { /** End S */ end_s: number; /** Start S */ start_s: number; /** Text */ text: string; }; }; responses: never; parameters: never; requestBodies: never; headers: never; pathItems: never; } export type $defs = Record; export type external = Record; export interface operations { /** Get Token */ studio_api_ably_api_get_token: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["AblyTokenResponse"]; }; }; }; }; /** * Get Clip Active Listeners * @description Get count of users currently listening to a specific song */ studio_api_bots_api_get_clip_active_listeners: { parameters: { path: { clip_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ActiveListenersResponse"]; }; }; }; }; /** * Create Or Update Ads User * @description Create or update an AdsUser record for the authenticated user */ studio_api_growth_ads_api_create_or_update_ads_user: { requestBody: { content: { "application/json": components["schemas"]["AdsUserRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["AdsUserResponse"]; }; }; }; }; /** * Get User Analytics Data * @description Get user tracking event data to determine whether to publish GA4 / Branch event */ studio_api_analytics_api_get_user_analytics_data: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["UserAnalyticsResponse"]; }; }; }; }; /** Get Version Updates */ studio_api_app_version_update_api_get_version_updates: { requestBody: { content: { "application/json": components["schemas"]["AppVersionUpdateRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["AppVersionUpdateResponse"]; }; }; }; }; /** Update Status */ studio_api_banner_api_update_status: { requestBody: { content: { "application/json": components["schemas"]["BannerUpdateRequest"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Accept Sub Coupon * @description Accept a discount coupon for the user's subscription. * * Note: This endpoint applies the coupon to the user's Stripe subscription, * but the discount is only actually redeemed/applied when the subscription * renews on its next billing cycle. */ studio_api_bots_billing_api_accept_sub_coupon: { requestBody: { content: { "application/json": components["schemas"]["AcceptSubCouponSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["AcceptSubCouponResponse"]; }; }; }; }; /** * Add Credits * @description Add credits to a user account. Staff only. */ studio_api_bots_billing_api_add_credits: { requestBody: { content: { "application/json": components["schemas"]["AddCreditsSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["AddCreditsResponse"]; }; }; }; }; /** Cancel Subscription */ studio_api_bots_billing_api_cancel_subscription: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["SubscriptionCancelSchemaResponse"]; }; }; }; }; /** Cancel Subscription Undo */ studio_api_bots_billing_api_cancel_subscription_undo: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["SubscriptionCancelSchemaResponse"]; }; }; }; }; /** Change Plan */ studio_api_bots_billing_api_change_plan: { requestBody: { content: { "application/json": components["schemas"]["PlanChangeSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PlanChangeSchemaResponse"]; }; }; }; }; /** Change Plan Preview */ studio_api_bots_billing_api_change_plan_preview: { requestBody: { content: { "application/json": components["schemas"]["PlanChangeSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PlanChangePreviewSchemaResponse"]; }; }; }; }; /** * Log Clip Download * @description Log a clip download to the ClipDownloadHistory table */ studio_api_bots_billing_api_log_clip_download: { parameters: { path: { clip_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ClipDownloadResponse"]; }; }; }; }; /** Create Portal Session */ studio_api_bots_billing_api_create_portal_session: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PortalRedirectSchemaResponse"]; }; }; }; }; /** Create Checkout Session */ studio_api_bots_billing_api_create_checkout_session: { requestBody: { content: { "application/json": components["schemas"]["PlanCreateSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["CheckoutSessionSchemaResponse"]; }; }; }; }; /** Get Credits Remaining */ studio_api_bots_billing_api_get_credits_remaining: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["CreditsRemainingResponse"]; }; }; }; }; /** * Get Default Currency * @description Return the default currency for the user based on their location. */ studio_api_bots_billing_api_get_default_currency: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["DefaultCurrencySchemaResponse"]; }; }; }; }; /** * Get Download Usage * @description Get the user's current month download usage and limits, optionally check specific clip ownership */ studio_api_bots_billing_api_get_download_usage: { parameters: { query?: { clip_id?: string | null; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["DownloadUsageResponse"]; }; }; }; }; /** Get Edu Info */ studio_api_bots_billing_edu_api_get_edu_info: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["EduInfoResponse"]; }; }; }; }; /** * Get Eligible Discounts Endpoint * @description Get eligible discount coupons by plan and subscription period. */ studio_api_bots_billing_api_get_eligible_discounts_endpoint: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["EligibleDiscountsResponse"]; }; }; }; }; /** Get Churn Survey Options */ studio_api_bots_billing_api_get_churn_survey_options: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ChurnSurveyOptionsResponse"]; }; }; }; }; /** * Get Discount Offer * @description Get the subscription retention offer (panic offer) for when a user tries to unsubscribe. * * This endpoint returns a discount offer that can be presented to users when they attempt * to cancel their subscription, in an effort to retain them as paying customers. */ studio_api_bots_billing_api_get_discount_offer: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["GetDiscountOfferResponse"]; }; }; }; }; /** Get Subscription Info */ studio_api_bots_billing_api_get_subscription_info: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["SubscriptionInfoResponse"]; }; }; }; }; /** Purchase Commercial Rights Api */ studio_api_bots_billing_api_purchase_commercial_rights_api: { requestBody: { content: { "application/json": components["schemas"]["CommercialRightsPurchaseSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["CommercialRightsPurchaseSchemaResponse"]; }; }; }; }; /** Purchase Credits */ studio_api_bots_billing_api_purchase_credits: { requestBody: { content: { "application/json": components["schemas"]["PurchaseSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["CreditPurchaseSchemaResponse"]; }; }; }; }; /** Purchase Credits Status */ studio_api_bots_billing_api_purchase_credits_status: { parameters: { path: { item_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PurchaseStatusSchemaResponse"]; }; }; }; }; /** Get Purchase Info Status */ studio_api_bots_billing_api_get_purchase_info_status: { parameters: { path: { purchase_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PurchaseStatusSchemaResponse"]; }; }; }; }; /** Submit Survey */ studio_api_bots_billing_api_submit_survey: { requestBody: { content: { "application/json": components["schemas"]["SubmitSurveySpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["SubmitSurveyResponse"]; }; }; }; }; /** Sync Subscription Info */ studio_api_bots_billing_api_sync_subscription_info: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["SubscriptionSyncSchemaResponse"]; }; }; }; }; /** * Get Tax Info * @description Returns the tax rate that the user is subject to for Stripe subscriptions. * Only works for users with active_subscription_platform = 'stripe' and active subscriptions. */ studio_api_bots_billing_api_get_tax_info: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["TaxInfoSchemaResponse"]; }; }; }; }; /** * Get Usage Plan Config * @description Returns the usage plan configuration which only includes the plans that the user is eligible for. */ studio_api_bots_billing_api_get_usage_plan_config: { responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Get Usage Plan Descriptions * @description Return the web usage plan descriptions for the current user. */ studio_api_bots_billing_api_get_usage_plan_descriptions: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["UsagePlanDescriptionsResponse"]; }; }; }; }; /** * Get Usage Plan Faq * @description Return the web usage plan FAQ for the current user. */ studio_api_bots_billing_api_get_usage_plan_faq: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["UsagePlanFaqResponse"]; }; }; }; }; /** Get Usage Plan Table Comparison */ studio_api_bots_billing_api_get_usage_plan_table_comparison: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["UsagePlanWebTableComparisonResponse"]; }; }; }; }; /** Get Usage Plans */ studio_api_bots_billing_api_get_usage_plans: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["UsagePlansSchemaReponse"]; }; }; }; }; /** Get Web Subscription Feature Flag */ studio_api_bots_billing_api_get_web_subscription_feature_flag: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["WebSubscriptionFeatureFlagResponse"]; }; }; }; }; /** Check Captcha */ studio_api_captcha_api_check_captcha: { requestBody: { content: { "application/json": components["schemas"]["CheckCaptchaRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["CheckCaptchaResponse"]; }; }; }; }; /** Get User Challenges Progress */ studio_api_challenge_api_get_user_challenges_progress: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["UserChallengesSchema"]; }; }; }; }; /** Flag Chat */ studio_api_chat_api_flag_chat: { requestBody: { content: { "application/json": components["schemas"]["FlagChatRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["FlagChatResponse"]; }; }; }; }; /** Get Chats */ studio_api_chat_api_get_chats: { parameters: { query: { channel_type: string; channel_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ChatRoomResponse"]; }; }; }; }; /** Post Chat */ studio_api_chat_api_post_chat: { requestBody: { content: { "application/json": components["schemas"]["PostChatRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PostChatResponse"]; }; }; }; }; /** Get Clip 2 */ studio_api_bots_api_get_clip_2: { parameters: { path: { clip_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["GeneratedClipSchema"]; }; }; }; }; /** Get Stems */ studio_api_bots_api_get_stems: { parameters: { query?: { page?: number; }; path: { clip_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["StemListResponse"]; }; }; }; }; /** Get Stem Pages */ studio_api_bots_api_get_stem_pages: { parameters: { path: { clip_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["StemPagesResponse"]; }; }; }; }; /** * Adjust Speed * @description Adjust the speed of a clip. * * Args: * data: Contains clip_id, speed_multiplier, and keep_pitch */ studio_api_clips_api_adjust_speed: { requestBody: { content: { "application/json": components["schemas"]["AdjustSpeedRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["GeneratedClipSchema"]; }; }; }; }; /** * Get Aligned Clip Siblings * @description Find all clips owned by the current user that have matching ClipAlignment data to the given clip. * Returns an empty list if no ClipAlignment exists for the given clip. */ studio_api_clips_api_get_aligned_clip_siblings: { parameters: { query: { clip_id: string; exclude_self?: boolean; window_seconds?: number; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["AlignedClipsResponseSchema"]; }; }; }; }; /** Get Aligned Clips */ studio_api_clips_api_get_aligned_clips: { parameters: { query?: { history_clip_id?: string | null; history_end_seconds?: number | null; history_end_seconds_gte?: number | null; history_end_seconds_lte?: number | null; future_clip_id?: string | null; future_start_seconds?: number | null; future_start_seconds_gte?: number | null; future_start_seconds_lte?: number | null; window_seconds?: number; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["AlignedClipsResponseSchema"]; }; }; }; }; /** Autoplay */ studio_api_clips_api_autoplay: { requestBody: { content: { "application/json": components["schemas"]["AutoplayRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["AutoplayResponse"]; }; }; }; }; /** * Get Children * @description find child clips for the given clip ID */ studio_api_clips_api_get_children: { parameters: { query: { clip_id: string; follow_concat_paths?: boolean; descend_from_roots?: boolean; exclude_non_owned_clips?: boolean; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ChildClipsSchema"]; }; }; }; }; /** Get Clip Prompts */ studio_api_clips_api_get_clip_prompts: { parameters: { query?: { page?: number; per_page?: number; filter_prompt_type?: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ClipPromptsSchema"]; }; }; }; }; /** * Delete Clips * @description Handle the deletion of clips specified by their IDs. * * This endpoint accepts a POST request with a JSON body containing a list * of clip IDs. It will then move these clips to a designated 'deleted' folder * on S3, effectively marking them as deleted in the system. * * Args: * request (HttpRequest): The HTTP request object containing the JSON payload * with a list of clip IDs under the key 'clip_ids'. * * Returns: * HttpResponse: An HTTP response with status 204 (No Content) if the clips * are successfully marked as deleted. This status indicates that the action * was successful, but there is no content to return in the response body. */ studio_api_clips_api_delete_clips: { requestBody: { content: { "application/json": components["schemas"]["DeletedClipsSchema"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Get Direct Children * @description Get immediate children of the given clip ID with pagination. */ studio_api_clips_api_get_direct_children: { parameters: { query: { clip_id: string; page?: number; page_size?: number; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["DirectChildrenSchema"]; }; }; }; }; /** * Get Direct Children By User * @description Get immediate children of the given clip ID grouped by user with pagination. */ studio_api_clips_api_get_direct_children_by_user: { parameters: { query: { clip_id: string; page?: number; page_size?: number; continuation_token?: string | null; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["DirectChildrenByUserSchema"]; }; }; }; }; /** * Get Direct Children Count * @description Get count of immediate children for the given clip ID. */ studio_api_clips_api_get_direct_children_count: { parameters: { query: { clip_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["DirectChildrenCountSchema"]; }; }; }; }; /** * Get Similar Endpoint * @description find similar public songs to the given clip ids. */ studio_api_clips_api_get_similar_endpoint: { parameters: { query: { id: string; count?: number; exact_match?: boolean; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["SimilarClipsSchema"]; }; }; }; }; /** Retrieve Songs By Ids */ studio_api_clips_api_retrieve_songs_by_ids: { parameters: { query: { ids: string[]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["GetSongsByIdsSchema"]; }; }; }; }; /** * Get Parent Clip * @description Get the parent clip for a given clip ID using the ClipParent table. */ studio_api_clips_api_get_parent_clip: { parameters: { query: { clip_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ParentClipSchema"]; }; }; }; }; /** Get Preview Clips For Styles */ studio_api_clips_api_get_preview_clips_for_styles: { parameters: { path: { styles: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PreviewClipsSchema"]; }; }; }; }; /** * Set All Remix Permissions * @description Set remix permissions for all public clips owned by the requesting user. * * This endpoint efficiently updates the remix permission setting for all of a user's public clips. * It will add or update the can_remix field for all clips regardless of the value being set. * * Args: * request: The HTTP request. * can_remix: Boolean indicating whether to allow remixes. * batch_size: Number of clips to process in each batch (default: 100). * * Returns: * Dict with count of updated clips and status. */ studio_api_clips_api_set_all_remix_permissions: { parameters: { query: { can_remix: boolean; batch_size?: number; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["RemixPermissionsUpdateSchema"]; }; }; }; }; /** Get Trashed Clips V2 */ studio_api_clips_api_get_trashed_clips_v2: { parameters: { query?: { is_liked?: boolean | null; is_public?: boolean | null; page?: number; page_size?: number; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["TrashedClipIdsSchema"]; }; }; }; }; /** Update Similar */ studio_api_clips_api_update_similar: { responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Get User Remixes For Clip * @description Get all remixes by a specific user for a given clip. */ studio_api_clips_api_get_user_remixes_for_clip: { parameters: { query: { clip_id: string; user_id: string; page?: number; page_size?: number; }; }; responses: { /** @description OK */ 200: { content: { "application/json": { [key: string]: unknown; }; }; }; }; }; /** * Check Commercial Rights Eligibility * @description Check if a clip is eligible for commercial rights purchase. * * Returns whether the clip can have commercial rights purchased for it. * Commercial rights are only available for clips that are not remixes * of someone else's work. * * Args: * request: The HTTP request. * clip_id: The ID of the clip to check. * * Returns: * dict: {"eligible": bool} indicating if commercial rights can be purchased */ studio_api_clips_api_check_commercial_rights_eligibility: { parameters: { path: { clip_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["CommercialRightsEligibilityResponse"]; }; }; }; }; /** * Mux Clip Video Audio * @description Download and mux video and audio for a clip, returning the muxed file. * * This endpoint downloads the video and audio files for a clip, muxes them together * using ffmpeg, and returns the muxed file for download. * * Args: * request: The HTTP request. * clip_id: The ID of the clip to mux. * * Returns: * HttpResponse: The muxed video file as a downloadable response. */ studio_api_clips_api_mux_clip_video_audio: { parameters: { path: { clip_id: string; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Get Clip Project */ studio_api_clips_api_get_clip_project: { parameters: { path: { clip_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ProjectMetadataSchema"]; }; }; }; }; /** * Set Remix Type * @description Set the remix type for a clip. * * Args: * request: The HTTP request. * clip_id: The ID of the clip to update. * data: A dictionary containing 'remix' string field. * * Returns: * HttpResponse: 204 No Content on success. */ studio_api_clips_api_set_remix_type: { parameters: { query: { data: { [key: string]: unknown; }; }; path: { clip_id: string; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Toggle Remixes * @description Toggle whether remixes are allowed for a clip. */ studio_api_clips_api_toggle_remixes: { parameters: { path: { clip_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["ToggleRemixesSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Toggle Show Remixes * @description Toggle whether remixes are shown for a user's own clip. */ studio_api_clips_api_toggle_show_remixes: { parameters: { path: { clip_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["ToggleShowRemixesSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Post Block User * @description Block a user from commenting on requesting user's songs */ studio_api_bots_comment_api_post_block_user: { requestBody: { content: { "application/json": components["schemas"]["CommentBlockRequest"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Post Unblock User * @description Unblock a user from commenting on requesting user's songs */ studio_api_bots_comment_api_post_unblock_user: { requestBody: { content: { "application/json": components["schemas"]["CommentBlockRequest"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Get Clip Comments By User * @description Get paginated clip comments by user with cursor-based pagination. */ studio_api_bots_comment_api_get_clip_comments_by_user: { parameters: { query?: { id_type?: "handle" | "email" | "phone_number"; cursor?: string | null; page_size?: number | null; }; path: { identifier: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["GetCommentsResponse"]; }; }; }; }; /** * Delete Clip Comments By User * @description Delete all clip comments for a user. */ studio_api_bots_comment_api_delete_clip_comments_by_user: { parameters: { query?: { id_type?: "handle" | "email" | "phone_number"; }; path: { identifier: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["DeleteCommentResponse"]; }; }; }; }; /** * Delete Comment * @description Delete a comment. Users can only delete their own comments. */ studio_api_bots_comment_api_delete_comment: { parameters: { path: { comment_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["DeleteCommentResponse"]; }; }; }; }; /** * Post Comment Reaction * @description Post a reaction to a comment. */ studio_api_bots_comment_api_post_comment_reaction: { parameters: { path: { comment_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["CommentReactionRequest"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Get Comment Replies * @description Get the replies to a comment. */ studio_api_bots_comment_api_get_comment_replies: { parameters: { query?: { cursor?: string | null; page_size?: number | null; deeplinked_comment_id?: string | null; }; path: { comment_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["GetCommentRepliesResponse"]; }; }; }; }; /** * Post Comment Report * @description Report a comment. */ studio_api_bots_comment_api_post_comment_report: { parameters: { path: { comment_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["ReportCommentRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ReportCommentResponse"]; }; }; }; }; /** Get All Contests */ studio_api_contests_api_get_all_contests: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["AllContestsResponse"]; }; }; }; }; /** Get Contest Info Endpoint */ studio_api_contests_api_get_contest_info_endpoint: { parameters: { path: { contest_identifier: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ContestInfoSchema"]; }; }; }; }; /** Set Contest Info */ studio_api_contests_api_set_contest_info: { parameters: { path: { contest_identifier: string; }; }; requestBody: { content: { "application/json": components["schemas"]["ContestInfoSchema"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ContestInfoSchema"]; }; }; }; }; /** Get Contest */ studio_api_contests_api_get_contest: { parameters: { path: { contest_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ContestSchema"]; }; }; }; }; /** Remove Contest */ studio_api_contests_api_remove_contest: { parameters: { path: { contest_id: string; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Get Contest Clips */ studio_api_contests_api_get_contest_clips: { parameters: { query?: { contest_id?: string | null; page?: number; page_size?: number; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PaginatedContestClipResponse"]; }; }; }; }; /** Create Contest */ studio_api_contests_api_create_contest: { requestBody: { content: { "application/json": components["schemas"]["CreateContestSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ContestSchema"]; }; }; }; }; /** Is Contest Clip */ studio_api_contests_api_is_contest_clip: { parameters: { path: { clip_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": boolean; }; }; }; }; /** Get Contest Landing Page */ studio_api_contests_api_get_contest_landing_page: { parameters: { path: { contest_identifier: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ContestLandingPageResponse"]; }; }; }; }; /** Get Random Contest Clips */ studio_api_contests_api_get_random_contest_clips: { parameters: { path: { contest_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["RandomContestClipsResponse"]; }; }; }; }; /** Submit Contest Clip */ studio_api_contests_api_submit_contest_clip: { parameters: { path: { clip_id: string; contest_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ContestClipResponse"]; }; }; }; }; /** Get Top K Contest Clips */ studio_api_contests_api_get_top_k_contest_clips: { parameters: { query?: { sort_by?: string; need_hydration?: boolean; }; path: { contest_id: string; k: number; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ContestClipResponse"][]; }; }; }; }; /** Get All Votes */ studio_api_contests_api_get_all_votes: { parameters: { query?: { page?: number; page_size?: number; contest_id?: string | null; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PaginatedVotesResponse"]; }; }; }; }; /** Place Vote */ studio_api_contests_api_place_vote: { requestBody: { content: { "application/json": components["schemas"]["PlaceVoteSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Count Reacted Beta Gens * @description Count the number of completed clips created by the current user that are marked as beta * and how many of those have user reactions */ studio_api_bots_api_count_reacted_beta_gens: { responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Discover Feed * @description Get homepage sections with timeout */ studio_api_discover_api_discover_feed: { requestBody: { content: { "application/json": components["schemas"]["DiscoverReq"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["DiscoverResp"]; }; }; }; }; /** * Get Discover Sections * @description api get request for 'Discover' section of Homepage */ studio_api_discover_api_get_discover_sections: { parameters: { path: { section_name: string; }; }; requestBody?: { content: { "application/json": components["schemas"]["DiscoverReq"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["BannerSectionSchema"] | components["schemas"]["PlaylistSectionSchema"] | components["schemas"]["PlaylistListSectionSchema"] | components["schemas"]["StyleListSectionSchema"] | components["schemas"]["UserListSectionSchema"] | components["schemas"]["CommunityPersonasSectionSchema"] | components["schemas"]["FeaturedFeedSectionSchema"] | components["schemas"]["ShortcutSectionSchema"] | components["schemas"]["PromoSectionSchema"] | components["schemas"]["HooksSectionSchema"] | components["schemas"]["ContestListSectionSchema"]; }; }; }; }; /** * Get Shortcuts * @description api get request for 'Discover' section of shortcuts * based on the shortcut_type and shortcut_context, we will return the appropriate playlist to play music on platform */ studio_api_discover_api_get_shortcuts: { parameters: { query: { shortcut_type: "liked_songs" | "liked_playlists" | "on_repeat" | "my_songs" | "recently_played" | "song_radios" | "played_playlists"; context_song_id?: string | null; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ShortcutResponse"]; }; }; }; }; /** * Create Direct Thread * @description Create a DM thread by providing a recipient handle. */ studio_api_dm_api_create_direct_thread: { requestBody: { content: { "application/json": components["schemas"]["CreateDMRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["CreateDMResponse"]; }; }; }; }; /** * Create Group * @description Create a group by providing a list of user ids. */ studio_api_dm_api_create_group: { requestBody: { content: { "application/json": components["schemas"]["CreateGroupRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["CreateGroupResponse"]; }; }; }; }; /** * Add Group Members * @description Add members to a group. */ studio_api_dm_api_add_group_members: { parameters: { path: { group_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["AddGroupMembersRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["AddGroupMembersResponse"]; }; }; }; }; /** * Remove Group Members * @description Remove members from a group. */ studio_api_dm_api_remove_group_members: { parameters: { path: { group_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["RemoveGroupMembersRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["RemoveGroupMembersResponse"]; }; }; }; }; /** * Send Message * @description Send a message to another user or a group. */ studio_api_dm_api_send_message: { requestBody: { content: { "application/json": components["schemas"]["SendMessageRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["SendMessageResponse"]; }; }; }; }; /** * Get Thread * @description Get a thread information such as users, group notes, etc. */ studio_api_dm_api_get_thread: { parameters: { path: { thread_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["GetThreadResponse"]; }; }; }; }; /** * Get Thread Messages * @description Get messages in a thread from the last 3 days. */ studio_api_dm_api_get_thread_messages: { parameters: { query?: { before?: string | null; }; path: { thread_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["GetThreadMessagesResponse"]; }; }; }; }; /** * Mark Thread Read * @description Mark all messages in a thread as read. */ studio_api_dm_api_mark_thread_read: { parameters: { path: { thread_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["MarkThreadReadResponse"]; }; }; }; }; /** * Get Paginated Threads * @description Get list of threads with thread name (user name or group name) and number of unread messages. */ studio_api_dm_api_get_paginated_threads: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PaginatedThreadsResponse"]; }; }; }; }; /** Get Action Status */ studio_api_bots_editing_api_get_action_status: { parameters: { path: { action_clip_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["EditActionStatusSchema"]; }; }; }; }; /** Crop Clip */ studio_api_bots_editing_api_crop_clip: { parameters: { path: { clip_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["CropClipSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["EditActionRequestSchema"]; }; }; }; }; /** Fade Clip */ studio_api_bots_editing_api_fade_clip: { parameters: { path: { clip_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["FadeClipSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["EditActionRequestSchema"]; }; }; }; }; /** Change Clip Speed */ studio_api_bots_editing_api_change_clip_speed: { parameters: { path: { clip_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["ChangeClipSpeedSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["EditActionRequestSchema"]; }; }; }; }; /** Stem Clip */ studio_api_bots_editing_api_stem_clip: { parameters: { path: { clip_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["StemActionRequestSchema"]; }; }; }; }; /** Get Feed */ studio_api_bots_api_get_feed: { parameters: { query?: { page?: number; query?: string | null; categories?: string[] | null; ids?: string | null; status?: string | null; is_liked?: boolean | null; hide_disliked?: boolean | null; is_public?: boolean | null; is_not_disliked?: boolean | null; is_full_song?: boolean | null; is_video_to_song?: boolean | null; is_suno_short?: boolean | null; add_preset_clips?: boolean | null; hide_gen_stems?: boolean | null; is_gen_stem?: boolean | null; hide_studio_clips?: boolean | null; is_trashed?: boolean | null; from_index?: number; page_size?: number; continuation_token?: string | null; is_cover?: boolean | null; is_extend?: boolean | null; is_infill?: boolean | null; is_persona?: boolean | null; is_scene?: boolean | null; is_upsample?: boolean | null; is_uploaded_audio?: boolean; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["GeneratedClipSchema"][]; }; }; }; }; /** Get Feed V2 */ studio_api_bots_api_get_feed_v2: { parameters: { query?: { page?: number; query?: string | null; categories?: string[] | null; ids?: string | null; status?: string | null; is_liked?: boolean | null; hide_disliked?: boolean | null; is_public?: boolean | null; is_not_disliked?: boolean | null; is_full_song?: boolean | null; is_video_to_song?: boolean | null; is_suno_short?: boolean | null; add_preset_clips?: boolean | null; hide_gen_stems?: boolean | null; is_gen_stem?: boolean | null; hide_studio_clips?: boolean | null; is_trashed?: boolean | null; from_index?: number; page_size?: number; continuation_token?: string | null; is_cover?: boolean | null; is_extend?: boolean | null; is_infill?: boolean | null; is_persona?: boolean | null; is_scene?: boolean | null; is_upsample?: boolean | null; is_uploaded_audio?: boolean; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["FeedSchema"]; }; }; }; }; /** Get Feed V3 */ studio_api_bots_api_get_feed_v3: { requestBody: { content: { "application/json": components["schemas"]["FeedV3RequestSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["FeedV3ResponseSchema"]; }; }; }; }; /** * Get Feed V3 Offset * @description Get clip ID at a specific offset for a given set of filters. * Returns the clip_id at the lesser of the given offset and the total number of results. * Uses database-level OFFSET/LIMIT for optimal performance. */ studio_api_bots_api_get_feed_v3_offset: { requestBody: { content: { "application/json": components["schemas"]["FeedOffsetRequestSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ClipOffsetResponse"]; }; }; }; }; /** Write */ studio_api_feedback_api_write: { requestBody: { content: { "application/json": components["schemas"]["FeedbackRequestSchema"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["FeedbackResponseSchema"]; }; }; }; }; /** Bulk Increment Play Counts With Spec */ studio_api_bots_gen_api_bulk_increment_play_counts_with_spec: { requestBody: { content: { "application/json": components["schemas"]["BulkPlayCountSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Increment Action Counts * @description Increment action count for multiple clips */ studio_api_bots_gen_api_increment_action_counts: { requestBody: { content: { "application/json": components["schemas"]["MultiGenActionSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Prompt Image */ studio_api_bots_gen_api_prompt_image: { requestBody: { content: { "application/json": components["schemas"]["ImagePromptSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Trash Gen * @description Move or remove a generated clip from trash. * * Args: * request (HttpRequest): The HTTP request object. * spec (TrashSpec): An object containing trash specifications. * * Returns: * TrashSchema: An object indicating the trash (deleted) status of the clip. */ studio_api_bots_gen_api_trash_gen: { requestBody: { content: { "application/json": components["schemas"]["TrashSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Get Aligned Lyrics */ studio_api_bots_gen_api_get_aligned_lyrics: { parameters: { path: { clip_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["AlignedLyricsSchema"]; }; }; }; }; /** Get Aligned Lyrics V2 */ studio_api_bots_gen_api_get_aligned_lyrics_v2: { parameters: { path: { clip_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["AlignedLyricsV2Schema"]; }; }; }; }; /** Regenerate Aligned Lyrics */ studio_api_bots_gen_api_regenerate_aligned_lyrics: { parameters: { path: { clip_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["AlignedLyricsV2Schema"]; }; }; }; }; /** Get Lyrics Alignment V3 */ studio_api_bots_gen_api_get_lyrics_alignment_v3: { parameters: { path: { clip_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["AlignedLyricsV3Schema"]; }; }; }; }; /** Do Aligned Lyrics V3 */ studio_api_bots_gen_api_do_aligned_lyrics_v3: { parameters: { path: { clip_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["AlignedLyricsV3Spec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["AlignedLyricsV3Schema"]; }; }; }; }; /** * Post Comment * @description Add a comment to a clip. */ studio_api_bots_gen_api_post_comment: { parameters: { path: { clip_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["PostCommentRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["CommentSchema"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["APIErrorSchema"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["APIErrorSchema"]; }; }; /** @description Unprocessable Content */ 422: { content: { "application/json": components["schemas"]["APIErrorSchema"]; }; }; /** @description Too Many Requests */ 429: { content: { "application/json": components["schemas"]["APIErrorSchema"]; }; }; }; }; /** * Get Comments * @description Get comments for a clip. */ studio_api_bots_gen_api_get_comments: { parameters: { query?: { cursor?: string | null; page_size?: number | null; order?: "newest" | "oldest" | "most_liked" | null; id?: string | null; deeplink?: boolean | null; }; path: { clip_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["GetCommentsResponse"]; }; }; }; }; /** * Get Comment Count * @description Get the count of comments for a clip. */ studio_api_bots_gen_api_get_comment_count: { parameters: { path: { clip_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["GetCommentCountResponse"]; }; }; }; }; /** Generate Opus File */ studio_api_bots_gen_api_generate_opus_file: { parameters: { path: { clip_id: string; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Generate Wav File */ studio_api_bots_gen_api_generate_wav_file: { parameters: { path: { clip_id: string; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Get Cached Value */ studio_api_bots_gen_api_get_audio_feature_downbeats_v1: { parameters: { path: { clip_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["DownbeatsSchema"]; }; }; }; }; /** Downbeats Streaming V2 */ studio_api_bots_gen_api_downbeats_streaming_v2: { parameters: { path: { clip_id: string; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Get Cached Value */ studio_api_bots_gen_api_get_audio_feature_instruments_v1: { parameters: { path: { clip_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["InstrumentsSchema"]; }; }; }; }; /** Get Cached Value */ studio_api_bots_gen_api_get_audio_feature_key_v1: { parameters: { path: { clip_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["KeySchema"]; }; }; }; }; /** Get Cached Value */ studio_api_bots_gen_api_get_midi_transcription_v1: { parameters: { path: { clip_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["MidiSchema"]; }; }; }; }; /** Get Clip Opus File */ studio_api_bots_gen_api_get_clip_opus_file: { parameters: { path: { clip_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["OpusFileSchema"]; }; }; }; }; /** * Get Time Sync Comments * @description Get time-synchronized comments for a clip. */ studio_api_bots_gen_api_get_time_sync_comments: { parameters: { query: { search_time: number; search_range?: number; margin?: number; num_requested?: number | null; end_time?: number | null; }; path: { clip_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["CommentSchema"][]; }; }; }; }; /** * Toggle Comments * @description Set allow_comments on a GeneratedClip. User must own clip. */ studio_api_bots_gen_api_toggle_comments: { parameters: { path: { clip_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["ToggleCommentsRequest"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Precalculate Audio Features * @description Pre-calculate audio features (keys, downbeats, waveform aggregates) for a clip to reduce latency. * This endpoint is idempotent and will not trigger extra calculations if data already exists. */ studio_api_bots_gen_api_precalculate_audio_features: { parameters: { path: { clip_id: string; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Get Clip Wav File */ studio_api_bots_gen_api_get_clip_wav_file: { parameters: { path: { clip_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["WavFileSchema"]; }; }; }; }; /** * Get Waveform Aggregates * @description Get the waveform aggregates for a clip. */ studio_api_bots_gen_api_get_waveform_aggregates: { parameters: { path: { clip_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["WaveformAggregateResponse"]; }; }; }; }; /** * Increment Action Count * @description Increment action count */ studio_api_bots_gen_api_increment_action_count: { parameters: { path: { gen_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["ActionSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Increment Play Count * @description Increment play count on UserReaction (and associated Generatedclip). */ studio_api_bots_gen_api_increment_play_count: { parameters: { path: { gen_id: string; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Increment Play Count With Spec */ studio_api_bots_gen_api_increment_play_count_with_spec: { parameters: { path: { gen_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["PlayCountSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Increment Skip Count * @description Increment skip count on UserReaction (and associated Generatedclip). */ studio_api_bots_gen_api_increment_skip_count: { parameters: { path: { gen_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["TimeOfSkipSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Like Gen */ studio_api_bots_gen_api_like_gen: { parameters: { path: { gen_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["LikeSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Set Artist Clip Id * @description Set artist_clip_id in the metadata of a GeneratedClip. User must own clip. */ studio_api_bots_gen_api_set_artist_clip_id: { parameters: { path: { gen_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["ArtistClipIdSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Set Clip Prompt * @description Set the metadata of a GeneratedClip. User must own clip. */ studio_api_bots_gen_api_set_clip_prompt: { parameters: { path: { gen_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["UpdatedClipPromptSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Set Configurations * @description Set configurations in the metadata of a GeneratedClip. User must own clip. */ studio_api_bots_gen_api_set_configurations: { parameters: { path: { gen_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["ClipConfigurationsSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Set Cover Clip Id * @description Set cover_clip_id in the metadata of a GeneratedClip. User must own clip. */ studio_api_bots_gen_api_set_cover_clip_id: { parameters: { path: { gen_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["CoverClipIdSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Set Display Tags * @description Set the displayed tags of a GeneratedClip. User must own clip. */ studio_api_bots_gen_api_set_display_tags: { parameters: { path: { gen_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["DisplayTagsSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["GeneratedClipSchema"] | components["schemas"]["MetadataEditErrorSchema"]; }; }; }; }; /** * Set Metadata * @description Set the metadata of a GeneratedClip. User must own clip. */ studio_api_bots_gen_api_set_metadata: { parameters: { path: { gen_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["ClipMetadataSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ClipMetadataSchema"] | components["schemas"]["MetadataEditErrorSchema"]; }; }; }; }; /** * Set Video Cover * @description Set video cover in the metadata of a GeneratedClip. User must own clip. */ studio_api_bots_gen_api_set_video_cover: { parameters: { path: { gen_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["VideoCoverSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["VideoCoverSchema"]; }; }; }; }; /** * Set Visibility * @description Set is_public visibility on a GeneratedClip. User must own clip. */ studio_api_bots_gen_api_set_visibility: { parameters: { path: { gen_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["ClipVisibilitySpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Share Asset * @description Generate a sharable asset for a song. */ studio_api_bots_gen_api_share_asset: { parameters: { path: { gen_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["ShareAssetSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ShareAssetSchema"]; }; }; }; }; /** * Get Share Asset * @description Get the status of a share asset. */ studio_api_bots_gen_api_get_share_asset: { parameters: { path: { gen_id: string; asset_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ShareAssetStatusSchema"]; }; }; }; }; /** Unlock Preview */ studio_api_bots_gen_api_unlock_preview: { parameters: { path: { gen_id: string; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Update Feedback State * @description Update feedback state on UserReaction. */ studio_api_bots_gen_api_update_feedback_state: { parameters: { path: { gen_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["FeedbackSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Update Flag State * @description Update flag state on UserReaction (and associated Generatedclip). */ studio_api_bots_gen_api_update_flag_state: { parameters: { path: { gen_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["FlagSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Update Reaction Type * @description Update reaction type on UserReaction (and associated GeneratedClip). */ studio_api_bots_gen_api_update_reaction_type: { parameters: { path: { gen_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["ReactionSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Check Lyrics Copyright Infringement */ studio_api_bots_generate_api_check_lyrics_copyright_infringement: { requestBody: { content: { "application/json": components["schemas"]["CheckLyricsCopyrightInfringementRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["CheckLyricsCopyrightInfringementResponse"]; }; }; }; }; /** Get Clip */ studio_api_bots_generate_api_get_clip: { parameters: { path: { clip_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["GeneratedClipSchema"]; }; }; }; }; /** Concat Generations */ studio_api_bots_generate_api_concat_generations: { requestBody: { content: { "application/json": components["schemas"]["GenConcatSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["GenerationRequestSimpleSchema"]; }; }; }; }; /** Concat Generations V2 */ studio_api_bots_generate_api_concat_generations_v2: { requestBody: { content: { "application/json": components["schemas"]["GenConcatSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["GeneratedClipSchema"]; }; }; }; }; /** Downsample Prompt */ studio_api_bots_generate_api_downsample_prompt: { requestBody: { content: { "application/json": components["schemas"]["DownsampleTagsRequest"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Get Existing Lyrics By Id */ studio_api_bots_generate_api_get_existing_lyrics_by_id: { parameters: { query?: { version?: string; }; path: { lyrics_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ExistingLyricsByIDResponse"]; }; }; }; }; /** Get Recommend Styles */ studio_api_bots_generate_api_get_recommend_styles: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["RecommendStylesSchema"]; }; }; }; }; /** Run Lyrics Generation */ studio_api_bots_generate_api_run_lyrics_generation: { requestBody: { content: { "application/json": components["schemas"]["GenLyricsSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["GenLyricsRequestId"]; }; }; }; }; /** Run Lyrics Infill */ studio_api_bots_generate_api_run_lyrics_infill: { requestBody: { content: { "application/json": components["schemas"]["InfillLyricsSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["InfillLyricsResult"]; }; }; }; }; /** Run Lyrics Infill Redo */ studio_api_bots_generate_api_run_lyrics_infill_redo: { requestBody: { content: { "application/json": components["schemas"]["InfillLyricsUndoRedoSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Run Lyrics Infill Undo */ studio_api_bots_generate_api_run_lyrics_infill_undo: { requestBody: { content: { "application/json": components["schemas"]["InfillLyricsUndoRedoSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Run Lyrics Pair Generation */ studio_api_bots_generate_api_run_lyrics_pair_generation: { requestBody: { content: { "application/json": components["schemas"]["GenLyricsSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["GenLyricsRequestIds"]; }; }; }; }; /** Rate Lyrics Pair */ studio_api_bots_generate_api_rate_lyrics_pair: { requestBody: { content: { "application/json": components["schemas"]["LyricsPairRatingSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Get Lyrics Generation */ studio_api_bots_generate_api_get_lyrics_generation: { parameters: { path: { lyrics_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["GenLyricsSchema"]; }; }; }; }; /** Get Advanced Gen Params */ studio_api_bots_generate_api_get_advanced_gen_params: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["MatrixResponse"]; }; }; }; }; /** Merge Generations */ studio_api_bots_generate_api_merge_generations: { requestBody: { content: { "application/json": components["schemas"]["MergeSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["GeneratedClipSchema"]; }; }; }; }; /** Get Gen Requests */ studio_api_bots_generate_api_get_gen_requests: { parameters: { query?: { page?: number; query?: string | null; categories?: string[] | null; ids?: string | null; status?: string | null; is_liked?: boolean | null; hide_disliked?: boolean | null; is_public?: boolean | null; is_not_disliked?: boolean | null; is_full_song?: boolean | null; is_video_to_song?: boolean | null; is_suno_short?: boolean | null; add_preset_clips?: boolean | null; hide_gen_stems?: boolean | null; is_gen_stem?: boolean | null; hide_studio_clips?: boolean | null; is_trashed?: boolean | null; from_index?: number; page_size?: number; continuation_token?: string | null; is_cover?: boolean | null; is_extend?: boolean | null; is_infill?: boolean | null; is_persona?: boolean | null; is_scene?: boolean | null; is_upsample?: boolean | null; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["GenerationRequestSchema"][]; }; }; }; }; /** Run Upsample */ studio_api_bots_generate_api_run_upsample: { requestBody: { content: { "application/json": components["schemas"]["UpsampleParamsSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["GenerationRequestSchema"]; }; }; }; }; /** Upsample Tags */ studio_api_bots_generate_api_upsample_tags: { requestBody: { content: { "application/json": components["schemas"]["UpsampleTagsRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["UpsampleTagsResponse"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["APIErrorSchema"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["APIErrorSchema"]; }; }; /** @description Unprocessable Content */ 422: { content: { "application/json": components["schemas"]["APIErrorSchema"]; }; }; /** @description Too Many Requests */ 429: { content: { "application/json": components["schemas"]["APIErrorSchema"]; }; }; }; }; /** * Run Generation V2 * @description The entrypoint for older web clients and also mobile */ studio_api_bots_generate_api_run_generation_v2: { requestBody: { content: { "application/json": components["schemas"]["GenParamsSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["GenerationRequestSchema"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["APIErrorSchema"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["APIErrorSchema"]; }; }; /** @description Unprocessable Content */ 422: { content: { "application/json": components["schemas"]["APIErrorSchema"]; }; }; /** @description Too Many Requests */ 429: { content: { "application/json": components["schemas"]["APIErrorSchema"]; }; }; }; }; /** * Run Generation V2 Web * @description The entrypoint for newer web clients */ studio_api_bots_generate_api_run_generation_v2_web: { requestBody: { content: { "application/json": components["schemas"]["GenParamsSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["GenerationRequestSchema"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["APIErrorSchema"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["APIErrorSchema"]; }; }; /** @description Unprocessable Content */ 422: { content: { "application/json": components["schemas"]["APIErrorSchema"]; }; }; /** @description Too Many Requests */ 429: { content: { "application/json": components["schemas"]["APIErrorSchema"]; }; }; }; }; /** Describe Upload */ studio_api_bots_generate_api_describe_upload: { parameters: { path: { clip_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["AudioDescriptionResponse"]; }; }; }; }; /** Generate Sample Pack */ studio_api_bots_generate_api_generate_sample_pack: { parameters: { path: { clip_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["SamplePackFileSchema"][]; }; }; }; }; /** * Create Invite Session * @description Create an InviteHistory record for an invited user and their inviter. */ studio_api_bots_invite_api_create_invite_session: { requestBody: { content: { "application/json": components["schemas"]["InviteSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["InviteSchema"]; }; }; }; }; /** * Redeem Promo Code * @description Redeem the promo code for the request user. * We use lower case promo codes in the db. * If successful, the user can log in, whether or not the promo code was used. */ studio_api_bots_invite_ios_api_redeem_promo_code: { requestBody: { content: { "application/json": components["schemas"]["UsePromoCodeRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["UsePromoCodeResponse"]; }; }; }; }; /** * Get Inviter Data From Promo Code * @description Get the inviter handle and avatar image URL from the promo code * We use lower case promo codes in the db. */ studio_api_bots_invite_ios_api_get_inviter_data_from_promo_code: { parameters: { path: { promo_code: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["IosInviterDataResponse"]; }; }; }; }; /** * Get Promo Code Status * @description Get the number of redemptions left of the user's promo code. * We use lower case promo codes in the db. */ studio_api_bots_invite_ios_api_get_promo_code_status: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PromoCodeStatusResponse"]; }; }; }; }; /** * Waitlist * @description Return True if the user is already on the waitlist or has just been added to the waitlist * as a result of this call (ie. no promo code exists for them yet). * Return False otherwise. */ studio_api_bots_invite_ios_api_waitlist: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["IosWaitlistResponse"]; }; }; }; }; /** Get Summary */ studio_api_bots_invite_api_get_summary: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["InviteHistorySchema"]; }; }; }; }; /** Get Ip Address */ studio_api_bots_api_get_ip_address: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["IpAddressResponse"]; }; }; }; }; /** * List Beta Gens * @description Fetch and return a list of clips created by the current user that are marked as beta */ studio_api_bots_api_list_beta_gens: { requestBody: { content: { "application/json": components["schemas"]["ListBetaGensSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Get Authed Ably Client Id */ studio_api_living_radio_api_get_authed_ably_client_id: { parameters: { path: { station_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["AblyClientIdResponse"]; }; }; }; }; /** Get Authed Ably Token */ studio_api_living_radio_api_get_authed_ably_token: { parameters: { path: { station_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["AblyTokenResponse"]; }; }; }; }; /** Get Anonymous Ably Token */ studio_api_living_radio_api_get_anonymous_ably_token: { parameters: { path: { station_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["AblyTokenResponse"]; }; }; }; }; /** Send Chat Message */ studio_api_living_radio_api_send_chat_message: { parameters: { path: { station_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["ChatMessageRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ChatMessageResponse"]; }; }; }; }; /** * Get Listener Count * @description Get the current listener count for a station using Ably's occupancy API. * This returns the actual number of connections to the chat channel. */ studio_api_living_radio_api_get_listener_count: { parameters: { path: { station_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ListenerCountResponse"]; }; }; }; }; /** Get Station Id Song List */ studio_api_living_radio_api_get_station_id_song_list: { parameters: { path: { station_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["SongState"][]; }; }; }; }; /** Vote For Style */ studio_api_living_radio_api_vote_for_style: { parameters: { path: { station_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["VoteRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["VoteResponse"]; }; }; }; }; /** Get Station Id Vote Status */ studio_api_living_radio_api_get_station_id_vote_status: { parameters: { path: { station_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["VoteStatusResponse"]; }; }; }; }; /** Acknowledge Warning */ studio_api_moderation_api_acknowledge_warning: { responses: { /** @description OK */ 200: { content: never; }; }; }; /** Add Copyright Lyrics */ studio_api_moderation_api_add_copyright_lyrics: { requestBody: { content: { "application/json": components["schemas"]["AddCopyrightLyricsSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Delete Copyright Lyrics */ studio_api_moderation_api_delete_copyright_lyrics: { parameters: { path: { doc_id: string; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Deprecated Hive Moderation * @deprecated * @description DEPRECATED: This endpoint has been moved to /moderation/hive/. * Please use the new endpoint instead. */ studio_api_moderation_api_deprecated_hive_moderation: { responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Deprecated Hive Moderation Hook * @deprecated * @description DEPRECATED: This endpoint has been moved to /moderation/hive/hook/{hook_id}. * Please use the new endpoint instead. */ studio_api_moderation_api_deprecated_hive_moderation_hook: { parameters: { path: { hook_id: string; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Hive Moderation */ studio_api_moderation_hive_moderation_api_hive_moderation: { parameters: { query: { bucket_name: string; upload_key: string; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Hive Moderation Hook */ studio_api_moderation_hive_moderation_api_hive_moderation_hook: { parameters: { path: { hook_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["HiveModerationResponseSchema"][]; }; }; }; }; /** * Get Video Upload Moderation Results * @description Get moderation results for a specific video upload ID */ studio_api_moderation_hive_moderation_api_get_video_upload_moderation_results: { parameters: { path: { video_upload_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["HiveModerationResponseSchema"]; }; }; }; }; /** Update Copyright Lyrics */ studio_api_moderation_api_update_copyright_lyrics: { parameters: { path: { doc_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["AddCopyrightLyricsSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Get Playbar State */ studio_api_music_player_api_get_playbar_state: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PlaybarStateResponse"]; }; }; }; }; /** Upsert Playbar State */ studio_api_music_player_api_upsert_playbar_state: { requestBody: { content: { "application/json": components["schemas"]["UpsertPlaybarStateRequest"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Get Notifications * @description fetch the notifications. */ studio_api_bots_notification_api_get_notifications: { parameters: { query?: { after_datetime_utc?: string | null; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["UserNotificationSchema"]; }; }; }; }; /** * Mark Notifications As Read * @description Mark notifications as read. */ studio_api_bots_notification_api_mark_notifications_as_read: { requestBody: { content: { "application/json": components["schemas"]["ReadNotificationsSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Mark Notifications As Not Interested * @description Mark notifications as not showing up any more. */ studio_api_bots_notification_api_mark_notifications_as_not_interested: { requestBody: { content: { "application/json": components["schemas"]["SuppressNotificationsSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Get Notifications V2 * @description fetch the notifications. */ studio_api_bots_notification_api_get_notifications_v2: { parameters: { query?: { after_datetime_utc?: string | null; before_datetime_utc?: string | null; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["UserNotificationV2Schema"]; }; }; }; }; /** * Mark Notifications As Read V2 * @description Mark notifications as read. */ studio_api_bots_notification_api_mark_notifications_as_read_v2: { requestBody: { content: { "application/json": components["schemas"]["ReadNotificationsSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Get Oembed */ studio_api_bots_oembed_api_get_oembed: { parameters: { query: { url: string; maxwidth?: number; maxheight?: number; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["OEmbedResponse"]; }; }; }; }; /** Enable Oembed For Clip */ studio_api_bots_oembed_api_enable_oembed_for_clip: { parameters: { query?: { clip_id?: string | null; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["OEmbedEnableResponse"]; }; }; }; }; /** * Get User Sessions * @description Get Orpheus chat sessions for a specific user (staff only). * * Returns the latest 200 sessions sorted by updated_at (newest first). * * Args: * uid: User ID to fetch sessions for * * Returns: * ListSessionResponse with up to 200 sessions */ studio_api_bots_orpheus_api_get_user_sessions: { parameters: { path: { uid: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ListSessionResponse"]; }; }; }; }; /** * Stream Orpheus Chat * @description Orpheus backend entrypoint */ studio_api_bots_orpheus_api_stream_orpheus_chat: { requestBody: { content: { "application/json": components["schemas"]["OrpheusChatSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["StreamingResponse"]; }; }; }; }; /** * Stream Lyrics * @description Orpheus backend entrypoint */ studio_api_bots_orpheus_api_stream_lyrics: { requestBody: { content: { "application/json": components["schemas"]["OrpheusLyricsSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["StreamingResponse"]; }; }; }; }; /** Create Persona */ studio_api_bots_persona_api_create_persona: { requestBody: { content: { "application/json": components["schemas"]["CreatePersonaSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PersonaResponseSchema"]; }; }; }; }; /** Edit Persona */ studio_api_bots_persona_api_edit_persona: { parameters: { path: { persona_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["EditPersonaSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PersonaResponseSchema"]; }; }; }; }; /** * Follow Persona * @description Follow/unfollow a persona. */ studio_api_bots_persona_api_follow_persona: { parameters: { query?: { follow?: boolean; }; path: { persona_id: string; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Get Followed Personas */ studio_api_bots_persona_api_get_followed_personas: { parameters: { query?: { page?: number; query?: string | null; categories?: string[] | null; ids?: string | null; status?: string | null; is_liked?: boolean | null; hide_disliked?: boolean | null; is_public?: boolean | null; is_not_disliked?: boolean | null; is_full_song?: boolean | null; is_video_to_song?: boolean | null; is_suno_short?: boolean | null; add_preset_clips?: boolean | null; hide_gen_stems?: boolean | null; is_gen_stem?: boolean | null; hide_studio_clips?: boolean | null; is_trashed?: boolean | null; from_index?: number; page_size?: number; continuation_token?: string | null; is_cover?: boolean | null; is_extend?: boolean | null; is_infill?: boolean | null; is_persona?: boolean | null; is_scene?: boolean | null; is_upsample?: boolean | null; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PersonasResponseSchema"]; }; }; }; }; /** Get Loved Personas */ studio_api_bots_persona_api_get_loved_personas: { parameters: { query?: { page?: number; query?: string | null; categories?: string[] | null; ids?: string | null; status?: string | null; is_liked?: boolean | null; hide_disliked?: boolean | null; is_public?: boolean | null; is_not_disliked?: boolean | null; is_full_song?: boolean | null; is_video_to_song?: boolean | null; is_suno_short?: boolean | null; add_preset_clips?: boolean | null; hide_gen_stems?: boolean | null; is_gen_stem?: boolean | null; hide_studio_clips?: boolean | null; is_trashed?: boolean | null; from_index?: number; page_size?: number; continuation_token?: string | null; is_cover?: boolean | null; is_extend?: boolean | null; is_infill?: boolean | null; is_persona?: boolean | null; is_scene?: boolean | null; is_upsample?: boolean | null; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PersonasResponseSchema"]; }; }; }; }; /** Get Persona Paginated */ studio_api_bots_persona_api_get_persona_paginated: { parameters: { query?: { page?: number; page_size?: number; }; path: { persona_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PaginatedPersonaResponseSchema"]; }; }; }; }; /** Get Persona */ studio_api_bots_persona_api_get_persona: { parameters: { path: { persona_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PersonaResponseSchema"]; }; }; }; }; /** Get Personas By User */ studio_api_bots_persona_api_get_personas_by_user: { parameters: { query?: { page?: number; query?: string | null; categories?: string[] | null; ids?: string | null; status?: string | null; is_liked?: boolean | null; hide_disliked?: boolean | null; is_public?: boolean | null; is_not_disliked?: boolean | null; is_full_song?: boolean | null; is_video_to_song?: boolean | null; is_suno_short?: boolean | null; add_preset_clips?: boolean | null; hide_gen_stems?: boolean | null; is_gen_stem?: boolean | null; hide_studio_clips?: boolean | null; is_trashed?: boolean | null; from_index?: number; page_size?: number; continuation_token?: string | null; is_cover?: boolean | null; is_extend?: boolean | null; is_infill?: boolean | null; is_persona?: boolean | null; is_scene?: boolean | null; is_upsample?: boolean | null; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PersonasResponseSchema"]; }; }; }; }; /** Get Suno Personas */ studio_api_bots_persona_api_get_suno_personas: { parameters: { query?: { page?: number; query?: string | null; categories?: string[] | null; ids?: string | null; status?: string | null; is_liked?: boolean | null; hide_disliked?: boolean | null; is_public?: boolean | null; is_not_disliked?: boolean | null; is_full_song?: boolean | null; is_video_to_song?: boolean | null; is_suno_short?: boolean | null; add_preset_clips?: boolean | null; hide_gen_stems?: boolean | null; is_gen_stem?: boolean | null; hide_studio_clips?: boolean | null; is_trashed?: boolean | null; from_index?: number; page_size?: number; continuation_token?: string | null; is_cover?: boolean | null; is_extend?: boolean | null; is_infill?: boolean | null; is_persona?: boolean | null; is_scene?: boolean | null; is_upsample?: boolean | null; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PersonasResponseSchema"]; }; }; }; }; /** Get Trashed Personas */ studio_api_bots_persona_api_get_trashed_personas: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PersonaResponseSchema"][]; }; }; }; }; /** Set Persona Visibility */ studio_api_bots_persona_api_set_persona_visibility: { parameters: { query: { is_public: boolean; }; path: { persona_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PersonaResponseSchema"]; }; }; }; }; /** Trash Persona */ studio_api_bots_persona_api_trash_persona: { parameters: { query?: { undo?: boolean; }; path: { persona_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PersonaResponseSchema"]; }; }; }; }; /** Get Persona Love Status */ studio_api_bots_persona_api_get_persona_love_status: { parameters: { path: { persona_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": { [key: string]: unknown; }; }; }; }; }; /** Get Persona Metadata */ studio_api_bots_persona_api_get_persona_metadata: { parameters: { path: { persona_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PersonaMetadataResponseSchema"]; }; }; }; }; /** * Toggle Persona Love * @description Toggle love status on UserPersonaReaction. */ studio_api_bots_persona_api_toggle_persona_love: { parameters: { path: { persona_id: string; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Create Playlist */ studio_api_bots_playlist_api_create_playlist: { requestBody: { content: { "application/json": components["schemas"]["PlaylistCreateSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PlaylistSchema"]; }; }; }; }; /** Get User Liked Playlists */ studio_api_bots_playlist_api_get_user_liked_playlists: { parameters: { query?: { page?: number; query?: string | null; categories?: string[] | null; ids?: string | null; status?: string | null; is_liked?: boolean | null; hide_disliked?: boolean | null; is_public?: boolean | null; is_not_disliked?: boolean | null; is_full_song?: boolean | null; is_video_to_song?: boolean | null; is_suno_short?: boolean | null; add_preset_clips?: boolean | null; hide_gen_stems?: boolean | null; is_gen_stem?: boolean | null; hide_studio_clips?: boolean | null; is_trashed?: boolean | null; from_index?: number; page_size?: number; continuation_token?: string | null; is_cover?: boolean | null; is_extend?: boolean | null; is_infill?: boolean | null; is_persona?: boolean | null; is_scene?: boolean | null; is_upsample?: boolean | null; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PlaylistsSchema"]; }; }; }; }; /** * Get User Playlists * @description Get user's library of owned playlists. */ studio_api_bots_playlist_api_get_user_playlists: { parameters: { query?: { page?: number; query?: string | null; categories?: string[] | null; ids?: string | null; status?: string | null; is_liked?: boolean | null; hide_disliked?: boolean | null; is_public?: boolean | null; is_not_disliked?: boolean | null; is_full_song?: boolean | null; is_video_to_song?: boolean | null; is_suno_short?: boolean | null; add_preset_clips?: boolean | null; hide_gen_stems?: boolean | null; is_gen_stem?: boolean | null; hide_studio_clips?: boolean | null; is_trashed?: boolean | null; from_index?: number; page_size?: number; continuation_token?: string | null; is_cover?: boolean | null; is_extend?: boolean | null; is_infill?: boolean | null; is_persona?: boolean | null; is_scene?: boolean | null; is_upsample?: boolean | null; show_trashed?: boolean | null; show_liked?: boolean | null; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PlaylistsSchema"]; }; }; }; }; /** Get User Playlists And Target Clip Status */ studio_api_bots_playlist_api_get_user_playlists_and_target_clip_status: { parameters: { query: { clip_id: string; page?: number; query?: string | null; categories?: string[] | null; ids?: string | null; status?: string | null; is_liked?: boolean | null; hide_disliked?: boolean | null; is_public?: boolean | null; is_not_disliked?: boolean | null; is_full_song?: boolean | null; is_video_to_song?: boolean | null; is_suno_short?: boolean | null; add_preset_clips?: boolean | null; hide_gen_stems?: boolean | null; is_gen_stem?: boolean | null; hide_studio_clips?: boolean | null; is_trashed?: boolean | null; from_index?: number; page_size?: number; continuation_token?: string | null; is_cover?: boolean | null; is_extend?: boolean | null; is_infill?: boolean | null; is_persona?: boolean | null; is_scene?: boolean | null; is_upsample?: boolean | null; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PlaylistsWithTargetClipStatusSchema"]; }; }; }; }; /** Set Playlist Metadata */ studio_api_bots_playlist_api_set_playlist_metadata: { requestBody: { content: { "application/json": components["schemas"]["PlaylistUpdateMetadataSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PlaylistSchema"] | components["schemas"]["GenericModerationErrorSchema"]; }; }; }; }; /** Trash Playlist */ studio_api_bots_playlist_api_trash_playlist: { requestBody: { content: { "application/json": components["schemas"]["PlaylistTrashSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PlaylistSchema"]; }; }; }; }; /** Update Playlist Clips */ studio_api_bots_playlist_api_update_playlist_clips: { requestBody: { content: { "application/json": components["schemas"]["PlaylistUpdateClipsSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PlaylistSchema"]; }; }; }; }; /** * Get Playlist * @description Get a playlist by ID. */ studio_api_bots_playlist_api_get_playlist: { parameters: { query?: { page?: number; query?: string | null; categories?: string[] | null; ids?: string | null; status?: string | null; is_liked?: boolean | null; hide_disliked?: boolean | null; is_public?: boolean | null; is_not_disliked?: boolean | null; is_full_song?: boolean | null; is_video_to_song?: boolean | null; is_suno_short?: boolean | null; add_preset_clips?: boolean | null; hide_gen_stems?: boolean | null; is_gen_stem?: boolean | null; hide_studio_clips?: boolean | null; is_trashed?: boolean | null; from_index?: number; page_size?: number; continuation_token?: string | null; is_cover?: boolean | null; is_extend?: boolean | null; is_infill?: boolean | null; is_persona?: boolean | null; is_scene?: boolean | null; is_upsample?: boolean | null; cursor?: string | null; }; path: { playlist_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PlaylistSchema"]; }; }; }; }; /** * Get Playlist Embedding * @description Calculate vector for a playlist based on top 3 clips and store it in PlaylistAnalytics table */ studio_api_bots_playlist_api_get_playlist_embedding: { parameters: { path: { playlist_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PlaylistEmbeddingSchema"]; }; }; }; }; /** * Regenerate Playlist * @description This api is very dangerous and should be used with caution. It will regenerate all the clips in the playlist. * Will limit the usage of api in staging only. If you want to promote this to production, please reach out to Jinhui. */ studio_api_bots_playlist_api_regenerate_playlist: { parameters: { path: { playlist_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["RegeneratePlaylistSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PlaylistSchema"]; }; }; }; }; /** * Increment Play Count * @description Increment play count on UserPlaylistReaction (and associated Playlist). */ studio_api_bots_playlist_reaction_api_increment_play_count: { parameters: { path: { playlist_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["PlaylistPlayCountSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Set Visibility * @description Set is_public visibility on a Playlist. User must own playlist. */ studio_api_bots_playlist_reaction_api_set_visibility: { parameters: { path: { playlist_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["PlaylistVisibilitySpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Update Flag State * @description Update flag state on UserReaction (and associated Playlisteratedplaylist). */ studio_api_bots_playlist_reaction_api_update_flag_state: { parameters: { path: { playlist_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["FlagSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Update Reaction Type * @description Update reaction type on UserPlaylistReaction (and associated Playlist). */ studio_api_bots_playlist_reaction_api_update_reaction_type: { parameters: { path: { playlist_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["ReactionSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Bulk Upsert Label Maker Tasks */ studio_api_preferences_api_bulk_upsert_label_maker_tasks: { requestBody: { content: { "application/json": components["schemas"]["BulkUpsertLabelMakerTasksSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Clear Label Maker Tasks */ studio_api_preferences_api_clear_label_maker_tasks: { parameters: { path: { project_id: number; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** List Label Maker Projects */ studio_api_preferences_api_list_label_maker_projects: { responses: { /** @description OK */ 200: { content: never; }; }; }; /** Skip Label Maker Task */ studio_api_preferences_api_skip_label_maker_task: { parameters: { path: { task_id: string; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Submit User Annotation */ studio_api_preferences_api_submit_user_annotation: { requestBody: { content: { "application/json": components["schemas"]["SealedPayloadSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Get User Preference Summary */ studio_api_preferences_api_get_user_preference_summary: { responses: { /** @description OK */ 200: { content: never; }; }; }; /** Get Next Label Maker Task */ studio_api_preferences_api_get_next_label_maker_task: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["NextLabelMakerTaskResponseSpec"]; }; }; }; }; /** Upsert Label Maker Project */ studio_api_preferences_api_upsert_label_maker_project: { requestBody: { content: { "application/json": components["schemas"]["UpsertLabelMakerProjectSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Cache Check */ studio_api_prober_api_cache_check: { responses: { /** @description OK */ 200: { content: never; }; }; }; /** Db Check */ studio_api_prober_api_db_check: { responses: { /** @description OK */ 200: { content: never; }; }; }; /** Migration Check */ studio_api_prober_api_migration_check: { responses: { /** @description OK */ 200: { content: never; }; }; }; /** Update Artist Profile */ studio_api_bots_profiles_api_update_artist_profile: { requestBody: { content: { "application/json": components["schemas"]["UpdateArtistProfileSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["UpdateArtistProfileResponse"]; }; }; }; }; /** Patch Artist Profile */ studio_api_bots_profiles_api_patch_artist_profile: { requestBody: { content: { "application/json": components["schemas"]["ModifyArtistProfileSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["GetUserMeResponse"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["APIErrorSchema"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["APIErrorSchema"]; }; }; /** @description Unprocessable Content */ 422: { content: { "application/json": components["schemas"]["APIErrorSchema"]; }; }; /** @description Too Many Requests */ 429: { content: { "application/json": components["schemas"]["APIErrorSchema"]; }; }; }; }; /** Block User */ studio_api_bots_profiles_api_block_user: { requestBody: { content: { "application/json": components["schemas"]["BlockUserSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** List Blocked Users */ studio_api_bots_profiles_api_list_blocked_users: { parameters: { query?: { page?: number; query?: string | null; categories?: string[] | null; ids?: string | null; status?: string | null; is_liked?: boolean | null; hide_disliked?: boolean | null; is_public?: boolean | null; is_not_disliked?: boolean | null; is_full_song?: boolean | null; is_video_to_song?: boolean | null; is_suno_short?: boolean | null; add_preset_clips?: boolean | null; hide_gen_stems?: boolean | null; is_gen_stem?: boolean | null; hide_studio_clips?: boolean | null; is_trashed?: boolean | null; from_index?: number; page_size?: number; continuation_token?: string | null; is_cover?: boolean | null; is_extend?: boolean | null; is_infill?: boolean | null; is_persona?: boolean | null; is_scene?: boolean | null; is_upsample?: boolean | null; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ProfileFollowersSchema"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["APIErrorSchema"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["APIErrorSchema"]; }; }; /** @description Unprocessable Content */ 422: { content: { "application/json": components["schemas"]["APIErrorSchema"]; }; }; /** @description Too Many Requests */ 429: { content: { "application/json": components["schemas"]["APIErrorSchema"]; }; }; }; }; /** Backfill Creator Common Tags */ studio_api_bots_profiles_api_backfill_creator_common_tags: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["GetCommonCreateTagsResponse"]; }; }; }; }; /** Check Display Name Availability */ studio_api_bots_profiles_api_check_display_name_availability: { parameters: { path: { handle: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["CheckHandleAvailabilityResponse"]; }; }; }; }; /** Flag Artist Profile */ studio_api_bots_profiles_api_flag_artist_profile: { requestBody: { content: { "application/json": components["schemas"]["FlagArtistProfileSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Follow Artist Profile */ studio_api_bots_profiles_api_follow_artist_profile: { requestBody: { content: { "application/json": components["schemas"]["FollowArtistProfileSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Get Profiles Followers */ studio_api_bots_profiles_api_get_profiles_followers: { parameters: { query?: { page?: number; query?: string | null; categories?: string[] | null; ids?: string | null; status?: string | null; is_liked?: boolean | null; hide_disliked?: boolean | null; is_public?: boolean | null; is_not_disliked?: boolean | null; is_full_song?: boolean | null; is_video_to_song?: boolean | null; is_suno_short?: boolean | null; add_preset_clips?: boolean | null; hide_gen_stems?: boolean | null; is_gen_stem?: boolean | null; hide_studio_clips?: boolean | null; is_trashed?: boolean | null; from_index?: number; page_size?: number; continuation_token?: string | null; is_cover?: boolean | null; is_extend?: boolean | null; is_infill?: boolean | null; is_persona?: boolean | null; is_scene?: boolean | null; is_upsample?: boolean | null; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ProfileFollowersSchema"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["APIErrorSchema"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["APIErrorSchema"]; }; }; /** @description Unprocessable Content */ 422: { content: { "application/json": components["schemas"]["APIErrorSchema"]; }; }; /** @description Too Many Requests */ 429: { content: { "application/json": components["schemas"]["APIErrorSchema"]; }; }; }; }; /** Get Profiles Following */ studio_api_bots_profiles_api_get_profiles_following: { parameters: { query?: { page?: number; query?: string | null; categories?: string[] | null; ids?: string | null; status?: string | null; is_liked?: boolean | null; hide_disliked?: boolean | null; is_public?: boolean | null; is_not_disliked?: boolean | null; is_full_song?: boolean | null; is_video_to_song?: boolean | null; is_suno_short?: boolean | null; add_preset_clips?: boolean | null; hide_gen_stems?: boolean | null; is_gen_stem?: boolean | null; hide_studio_clips?: boolean | null; is_trashed?: boolean | null; from_index?: number; page_size?: number; continuation_token?: string | null; is_cover?: boolean | null; is_extend?: boolean | null; is_infill?: boolean | null; is_persona?: boolean | null; is_scene?: boolean | null; is_upsample?: boolean | null; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ProfileFollowingSchema"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["APIErrorSchema"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["APIErrorSchema"]; }; }; /** @description Unprocessable Content */ 422: { content: { "application/json": components["schemas"]["APIErrorSchema"]; }; }; /** @description Too Many Requests */ 429: { content: { "application/json": components["schemas"]["APIErrorSchema"]; }; }; }; }; /** * Update Artist Profile Info * @description Update artist profile information in DynamoDB. * * Updates the artist profile fields stored in DynamoDB. */ studio_api_bots_profiles_api_update_artist_profile_info: { requestBody: { content: { "application/json": components["schemas"]["UpdateArtistProfileInfoSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Get Current User Listen History * @description Get the current authenticated user's listen history. * cursor: str | None - the cursor to paginate the listen history, defaults to None * limit: int - the number of clips to return */ studio_api_bots_profiles_api_get_current_user_listen_history: { parameters: { query?: { cursor?: string | null; limit?: number; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ListenHistoryResponse"]; }; }; }; }; /** Pin Clip */ studio_api_bots_profiles_api_pin_clip: { parameters: { path: { clip_id: string; }; }; requestBody?: { content: { "application/json": components["schemas"]["PinClipSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PinnedClipsSchema"]; }; }; }; }; /** * Get Pinned Clips * @description Get all clips pinned by the current user. */ studio_api_bots_profiles_api_get_pinned_clips: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PinnedClipsSchema"]; }; }; }; }; /** Get User Top Clips */ studio_api_bots_profiles_api_get_user_top_clips: { parameters: { query?: { size?: number; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["TopUserClipsResponse"]; }; }; }; }; /** Get Artist Profile */ studio_api_bots_profiles_api_get_artist_profile: { parameters: { query: { playlists_sort_by: string; clips_sort_by: string; page?: number; query?: string | null; categories?: string[] | null; ids?: string | null; status?: string | null; is_liked?: boolean | null; hide_disliked?: boolean | null; is_public?: boolean | null; is_not_disliked?: boolean | null; is_full_song?: boolean | null; is_video_to_song?: boolean | null; is_suno_short?: boolean | null; add_preset_clips?: boolean | null; hide_gen_stems?: boolean | null; is_gen_stem?: boolean | null; hide_studio_clips?: boolean | null; is_trashed?: boolean | null; from_index?: number; page_size?: number; continuation_token?: string | null; is_cover?: boolean | null; is_extend?: boolean | null; is_infill?: boolean | null; is_persona?: boolean | null; is_scene?: boolean | null; is_upsample?: boolean | null; include_artist_profile?: boolean; include_hooks?: boolean; clip_sort_by_override?: string | null; }; path: { handle: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ProfileInfoSchema"]; }; }; }; }; /** Get Profiles Followers By Handle */ studio_api_bots_profiles_api_get_profiles_followers_by_handle: { parameters: { query?: { page?: number; query?: string | null; categories?: string[] | null; ids?: string | null; status?: string | null; is_liked?: boolean | null; hide_disliked?: boolean | null; is_public?: boolean | null; is_not_disliked?: boolean | null; is_full_song?: boolean | null; is_video_to_song?: boolean | null; is_suno_short?: boolean | null; add_preset_clips?: boolean | null; hide_gen_stems?: boolean | null; is_gen_stem?: boolean | null; hide_studio_clips?: boolean | null; is_trashed?: boolean | null; from_index?: number; page_size?: number; continuation_token?: string | null; is_cover?: boolean | null; is_extend?: boolean | null; is_infill?: boolean | null; is_persona?: boolean | null; is_scene?: boolean | null; is_upsample?: boolean | null; }; path: { handle: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ProfileFollowersSchema"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["APIErrorSchema"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["APIErrorSchema"]; }; }; /** @description Unprocessable Content */ 422: { content: { "application/json": components["schemas"]["APIErrorSchema"]; }; }; /** @description Too Many Requests */ 429: { content: { "application/json": components["schemas"]["APIErrorSchema"]; }; }; }; }; /** Get Profiles Following By Handle */ studio_api_bots_profiles_api_get_profiles_following_by_handle: { parameters: { query?: { page?: number; query?: string | null; categories?: string[] | null; ids?: string | null; status?: string | null; is_liked?: boolean | null; hide_disliked?: boolean | null; is_public?: boolean | null; is_not_disliked?: boolean | null; is_full_song?: boolean | null; is_video_to_song?: boolean | null; is_suno_short?: boolean | null; add_preset_clips?: boolean | null; hide_gen_stems?: boolean | null; is_gen_stem?: boolean | null; hide_studio_clips?: boolean | null; is_trashed?: boolean | null; from_index?: number; page_size?: number; continuation_token?: string | null; is_cover?: boolean | null; is_extend?: boolean | null; is_infill?: boolean | null; is_persona?: boolean | null; is_scene?: boolean | null; is_upsample?: boolean | null; }; path: { handle: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ProfileFollowingSchema"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["APIErrorSchema"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["APIErrorSchema"]; }; }; /** @description Unprocessable Content */ 422: { content: { "application/json": components["schemas"]["APIErrorSchema"]; }; }; /** @description Too Many Requests */ 429: { content: { "application/json": components["schemas"]["APIErrorSchema"]; }; }; }; }; /** * Get Artist Profile Info * @description Get artist profile information from DynamoDB. * * Returns the additional profile fields stored in DynamoDB. */ studio_api_bots_profiles_api_get_artist_profile_info: { parameters: { path: { handle: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ArtistProfileInfoSchema"]; }; }; }; }; /** * Get Use Listen History * @description Get the user's listen history. * handle: str - the handle of the user * cursor: str | None - the cursor to paginate the listen history, defaults to None * limit: int - the number of clips to return */ studio_api_bots_profiles_api_get_use_listen_history: { parameters: { query?: { cursor?: string | null; limit?: number; }; path: { handle: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ListenHistoryResponse"]; }; }; }; }; /** Get Artist Recent Clips */ studio_api_bots_profiles_api_get_artist_recent_clips: { parameters: { path: { handle: string; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Get Remixes Inspired * @description Get remixes inspired by a user's public clips. * This returns public clips that have the user's public clips as non-owned parents. */ studio_api_bots_profiles_api_get_remixes_inspired: { parameters: { query?: { page?: number; page_size?: number; }; path: { handle: string; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Get Remixes Inspired Count * @description Get the count of remixes inspired by a user's public clips. */ studio_api_bots_profiles_api_get_remixes_inspired_count: { parameters: { path: { handle: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["RemixesInspiredCountResponse"]; }; }; }; }; /** Get Common Create Tags */ studio_api_bots_profiles_api_get_common_create_tags: { parameters: { path: { user_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["GetCommonCreateTagsResponse"]; }; }; }; }; /** Create Project */ studio_api_bots_project_api_create_project: { requestBody: { content: { "application/json": components["schemas"]["ProjectCreateSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ProjectSchema"]; }; }; }; }; /** Get Invites */ studio_api_bots_project_api_get_invites: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ProjectInviteSchema"][]; }; }; }; }; /** Respond To Invite */ studio_api_bots_project_api_respond_to_invite: { parameters: { path: { invite_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["RespondToInviteSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Get User Projects * @description Get user's library of owned projects. */ studio_api_bots_project_api_get_user_projects: { parameters: { query?: { page?: number; query?: string | null; categories?: string[] | null; ids?: string | null; status?: string | null; is_liked?: boolean | null; hide_disliked?: boolean | null; is_public?: boolean | null; is_not_disliked?: boolean | null; is_full_song?: boolean | null; is_video_to_song?: boolean | null; is_suno_short?: boolean | null; add_preset_clips?: boolean | null; hide_gen_stems?: boolean | null; is_gen_stem?: boolean | null; hide_studio_clips?: boolean | null; is_trashed?: boolean | null; from_index?: number; page_size?: number; continuation_token?: string | null; is_cover?: boolean | null; is_extend?: boolean | null; is_infill?: boolean | null; is_persona?: boolean | null; is_scene?: boolean | null; is_upsample?: boolean | null; show_trashed?: boolean | null; sort?: string | null; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ProjectsSchema"]; }; }; }; }; /** Trash Project */ studio_api_bots_project_api_trash_project: { requestBody: { content: { "application/json": components["schemas"]["ProjectTrashSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ProjectSchema"]; }; }; }; }; /** * Get Project * @description Get a project by ID. */ studio_api_bots_project_api_get_project: { parameters: { query?: { page?: number; query?: string | null; categories?: string[] | null; ids?: string | null; status?: string | null; is_liked?: boolean | null; hide_disliked?: boolean | null; is_public?: boolean | null; is_not_disliked?: boolean | null; is_full_song?: boolean | null; is_video_to_song?: boolean | null; is_suno_short?: boolean | null; add_preset_clips?: boolean | null; hide_gen_stems?: boolean | null; is_gen_stem?: boolean | null; hide_studio_clips?: boolean | null; is_trashed?: boolean | null; from_index?: number; page_size?: number; continuation_token?: string | null; is_cover?: boolean | null; is_extend?: boolean | null; is_infill?: boolean | null; is_persona?: boolean | null; is_scene?: boolean | null; is_upsample?: boolean | null; is_uploaded_audio?: boolean; }; path: { project_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ProjectSchema"]; }; }; }; }; /** Get Authed Ably Client Id */ studio_api_bots_project_api_get_authed_ably_client_id: { parameters: { path: { project_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["AblyClientIdResponse"]; }; }; }; }; /** Get Authed Ably Token */ studio_api_bots_project_api_get_authed_ably_token: { parameters: { path: { project_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["AblyTokenResponse"]; }; }; }; }; /** Send Ably Update Project */ studio_api_bots_project_api_send_ably_update_project: { parameters: { path: { project_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["ProjectAblyUpdateSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Update Project Clips */ studio_api_bots_project_api_update_project_clips: { parameters: { path: { project_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["ProjectUpdateClipsSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ProjectSchema"]; }; }; }; }; /** Get Project Collaborators */ studio_api_bots_project_api_get_project_collaborators: { parameters: { path: { project_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["CollaboratorSchema"][]; }; }; }; }; /** Remove Project Collaborator */ studio_api_bots_project_api_remove_project_collaborator: { parameters: { path: { project_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["ProjectRemoveCollaboratorSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Remove Self From Project */ studio_api_bots_project_api_remove_self_from_project: { parameters: { path: { project_id: string; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Send Invite To Project */ studio_api_bots_project_api_send_invite_to_project: { parameters: { path: { project_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["ProjectInviteSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Set Project Metadata */ studio_api_bots_project_api_set_project_metadata: { parameters: { path: { project_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["ProjectUpdateMetadataSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ProjectSchema"]; }; }; }; }; /** * Get Project Pinned Clips * @description Get a project by ID. */ studio_api_bots_project_api_get_project_pinned_clips: { parameters: { path: { project_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PinnedClipsSchema"]; }; }; }; }; /** * Search Project Clips * @description Search clips within a specific project using Elasticsearch */ studio_api_bots_project_api_search_project_clips: { parameters: { query?: { page?: number; query?: string | null; categories?: string[] | null; ids?: string | null; status?: string | null; is_liked?: boolean | null; hide_disliked?: boolean | null; is_public?: boolean | null; is_not_disliked?: boolean | null; is_full_song?: boolean | null; is_video_to_song?: boolean | null; is_suno_short?: boolean | null; add_preset_clips?: boolean | null; hide_gen_stems?: boolean | null; is_gen_stem?: boolean | null; hide_studio_clips?: boolean | null; is_trashed?: boolean | null; from_index?: number; page_size?: number; continuation_token?: string | null; is_cover?: boolean | null; is_extend?: boolean | null; is_infill?: boolean | null; is_persona?: boolean | null; is_scene?: boolean | null; is_upsample?: boolean | null; }; path: { project_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ProjectSchema"]; }; }; }; }; /** Create Or Update Saved Prompt */ studio_api_bots_prompts_api_create_or_update_saved_prompt: { requestBody: { content: { "application/json": components["schemas"]["UpdateSavedPromptSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Delete Saved Prompt */ studio_api_bots_prompts_api_delete_saved_prompt: { requestBody: { content: { "application/json": components["schemas"]["DeleteSavedPromptSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Get Radio Tags */ studio_api_bots_api_get_radio_tags: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["RadioTagsSchema"]; }; }; }; }; /** Get Radio */ studio_api_bots_api_get_radio: { parameters: { query?: { exclude_clip_ids?: string[]; }; path: { tag: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["RadioSchema"]; }; }; }; }; /** Update Song Feedback */ studio_api_recommendations_api_update_song_feedback: { parameters: { path: { clip_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["UpdateSongFeedbackRequest"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Remove Song Feedback */ studio_api_recommendations_api_remove_song_feedback: { parameters: { path: { clip_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["UpdateSongFeedbackRequest"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Hide Creator * @description Hide or unhide a creator from recommendations. */ studio_api_recommendations_api_hide_creator: { requestBody: { content: { "application/json": components["schemas"]["HideCreatorSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["HideCreatorResponse"]; }; }; }; }; /** * Similar Creators * @description Get similar creators for a given user */ studio_api_recommendations_api_similar_creators: { requestBody: { content: { "application/json": components["schemas"]["SimilarCreatorsRequestV2"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["SimilarCreatorsResponse"]; }; }; }; }; /** Get Recommendations Endpoint */ studio_api_bots_recommendation_api_get_recommendations_endpoint: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["GeneratedClipSchema"][]; }; }; }; }; /** Refresh Recommend Styles */ studio_api_bots_api_refresh_recommend_styles: { requestBody: { content: { "application/json": components["schemas"]["RecommendStylesSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["RecommendStylesSchema"]; }; }; }; }; /** Get Status */ studio_api_bots_api_get_status: { responses: { /** @description OK */ 200: { content: never; }; }; }; /** Search */ studio_api_search_api_search: { requestBody: { content: { "application/json": components["schemas"]["SearchRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["SearchResult"]; }; }; }; }; /** Search Hashtag Suggestions */ studio_api_search_api_search_hashtag_suggestions: { requestBody: { content: { "application/json": components["schemas"]["HashtagSearchRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["HashtagSearchResult"]; }; }; }; }; /** Search Trending Hashtags */ studio_api_search_api_search_trending_hashtags: { parameters: { query?: { days?: number; size?: number; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["HashtagSearchResult"]; }; }; }; }; /** Is This Us */ studio_api_search_api_is_this_us: { requestBody: { content: { "application/json": components["schemas"]["LyricsSearchRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["GeneratedClipSchema"][]; }; }; }; }; /** Update Clip Embedding V2 */ studio_api_search_api_update_clip_embedding_v2: { responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Update Lyrics Embedding * @description Callback for the lyrics embedding update. */ studio_api_search_api_update_lyrics_embedding: { responses: { /** @description OK */ 200: { content: never; }; }; }; /** Update Text Embedding */ studio_api_search_api_update_text_embedding: { responses: { /** @description OK */ 200: { content: never; }; }; }; /** Search Users */ studio_api_search_api_search_users: { requestBody: { content: { "application/json": components["schemas"]["UserSearchRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["SimpleProfileInfoSchema"][]; }; }; }; }; /** Get Me */ studio_api_bots_api_get_me: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["LoggedInSessionResponse"] | components["schemas"]["UnauthenticatedSessionResponse"]; }; }; }; }; /** * Attribute User To Share * @description Create share attribution record linking a user to the share that led to it */ studio_api_growth_share_api_attribute_user_to_share: { requestBody: { content: { "application/json": components["schemas"]["ShareAttributionRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ShareAttributionResponse"]; }; }; }; }; /** * Get Share Details * @description Get details about a share by its ID */ studio_api_growth_share_api_get_share_details: { parameters: { path: { share_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ShareCodeResponse"]; }; }; }; }; /** * Get Share Link * @description Create a share link record */ studio_api_growth_share_api_get_share_link: { requestBody: { content: { "application/json": components["schemas"]["ShareLinkRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ShareLinkResponse"]; }; }; }; }; /** * Update Share Link * @description Update a share link record */ studio_api_growth_share_api_update_share_link: { requestBody: { content: { "application/json": components["schemas"]["UpdateShareLinkRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["UpdateShareLinkResponse"]; }; }; }; }; /** Signout */ studio_api_bots_api_signout: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["LoggedOutResponse"]; }; }; }; }; /** Folllowing Feed */ studio_api_social_api_folllowing_feed: { requestBody: { content: { "application/json": components["schemas"]["FollowingFeedRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["FollowingFeedResponse"]; }; }; }; }; /** Get Following Feed Items */ studio_api_social_api_get_following_feed_items: { requestBody: { content: { "application/json": components["schemas"]["FollowingFeedRequestSchema"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["FollowingFeedResponseSchema"]; }; }; }; }; /** * Recommend Users * @description api post request for 'Recommend Users' section of Homepage * Post request have more controls on inputs with nested data structure. * returns: list of SimpleProfileInfoSchemas (can be empty) of each user to be displayed. * users must be initialized in User model to be pulled. */ studio_api_social_api_recommend_users: { requestBody: { content: { "application/json": components["schemas"]["RecommendUserReq"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["RecommendUserResp"]; }; }; }; }; /** Create Songify Video */ studio_api_songify_api_create_songify_video: { requestBody: { content: { "application/json": components["schemas"]["SongifyCreateVideoRequest"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Delete Songify Video */ studio_api_songify_api_delete_songify_video: { requestBody: { content: { "application/json": components["schemas"]["SongifyDeleteVideoRequest"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Update Songify Video */ studio_api_songify_api_update_songify_video: { requestBody: { content: { "application/json": components["schemas"]["SongifyUpdateVideoRequest"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Create Songify Generation * @description v2 endpoint for creating a songify generation (v1 endpoint is in the modal stub itself) */ studio_api_songify_api_create_songify_generation: { requestBody: { content: { "application/json": components["schemas"]["SongifyCreateGenerationRequest"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Get Songify Status */ studio_api_songify_api_get_songify_status: { parameters: { path: { songify_id: string; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Set Songify Status */ studio_api_songify_api_set_songify_status: { parameters: { path: { songify_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["SongifySetStatusRequest"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Resolve Autocomplete */ studio_api_bots_statsig_api_resolve_autocomplete: { requestBody: { content: { "application/json": components["schemas"]["StatsigAutocompleteRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["StatsigAutocompleteResponse"]; }; }; }; }; /** Resolve Experiment */ studio_api_bots_statsig_api_resolve_experiment: { requestBody: { content: { "application/json": components["schemas"]["StatsigExperimentRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["StatsigExperimentResponse"]; }; }; }; }; /** Resolve Id */ studio_api_bots_statsig_api_resolve_id: { requestBody: { content: { "application/json": components["schemas"]["StatsigIdRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["StatsigIdResponse"]; }; }; }; }; /** * Get Access Invitations * @description Get paginated list of studio invitation codes. * Staff users see all invitations, regular users see only their own. */ studio_api_bots_studio_api_get_access_invitations: { parameters: { query?: { cursor?: string | null; limit?: number; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["StudioAccessInviteSchema"]; }; }; }; }; /** Get Access Status */ studio_api_bots_studio_api_get_access_status: { parameters: { query?: { handle?: string | null; email?: string | null; phone_number?: string | null; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["StudioAccessStatusSchema"]; }; }; }; }; /** * Get Access Summary * @description Get summary statistics for studio access. Staff only. */ studio_api_bots_studio_api_get_access_summary: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["StudioAccessSummarySchema"]; }; }; }; }; /** * Bulk Admit Users * @description Bulk admit users to studio. */ studio_api_bots_studio_api_bulk_admit_users: { requestBody: { content: { "application/json": components["schemas"]["BulkAdmitUsersSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["BulkAdmitUsersSchema"]; }; }; }; }; /** * Get Code * @description Get a Studio invitation code. */ studio_api_bots_studio_api_get_code: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["StudioInvitationCodeSchema"]; }; }; }; }; /** * Create Or Load Studio Project For Clip * @description Create a new Studio project for the current user, with the given clip as the first clip in the project. * * Args: * clip_id: The ID of the clip to create the project for */ studio_api_bots_studio_api_create_or_load_studio_project_for_clip: { parameters: { path: { clip_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["StudioProjectMetaSchema"]; }; }; }; }; /** * Create Studio Project * @description Create a new Studio project for the current user. * * Args: * title: The title of the project */ studio_api_bots_studio_api_create_studio_project: { parameters: { query: { title: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["StudioProjectMetaSchema"]; }; }; }; }; /** * Join Waitlist * @description Join the Studio waitlist. */ studio_api_bots_studio_api_join_waitlist: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["StudioWaitlistSchema"]; }; }; }; }; /** * List Projects * @description Get a list of StudioProjects owned by the current user. * * Args: * cursor: Optional cursor for pagination * limit: Number of items to return per page (default: 20) * name: Optional filter by project name * archived: Optional filter by archived status (default: False) */ studio_api_bots_studio_api_list_projects: { parameters: { query?: { cursor?: string | null; limit?: number; name?: string | null; archived?: boolean | null; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["StudioProjectMetaSchema"][]; }; }; }; }; /** * Get Studio Project By Id * @description Get a single StudioProject by ID. * * Args: * project_id: The ID of the project to retrieve */ studio_api_bots_studio_api_get_studio_project_by_id: { parameters: { path: { project_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["StudioProjectSchema"]; }; }; }; }; /** * Archive Studio Project * @description Archive a Studio project. * * Args: * project_id: The ID of the project to archive */ studio_api_bots_studio_api_archive_studio_project: { parameters: { path: { project_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["StudioProjectMetaSchema"]; }; }; }; }; /** * Unarchive Studio Project * @description Unarchive a Studio project. * * Args: * project_id: The ID of the project to unarchive */ studio_api_bots_studio_api_unarchive_studio_project: { parameters: { path: { project_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["StudioProjectMetaSchema"]; }; }; }; }; /** * Get Studio Project Revision * @description Get a single StudioProjectVersion by ID with hybrid payload reading. */ studio_api_bots_studio_api_get_studio_project_revision: { parameters: { path: { revision_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ProjectVersionSchema"]; }; }; }; }; /** * Clone Studio Project * @description Clone another user's studio project. * * Args: * project_id: The ID of the project to clone * data: Contains optional title for the cloned project */ studio_api_bots_studio_api_clone_studio_project: { parameters: { path: { revision_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["CloneProjectSchema"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["StudioProjectMetaSchema"]; }; }; }; }; /** * Redeem Code * @description Redeem a Studio invitation code. */ studio_api_bots_studio_api_redeem_code: { requestBody: { content: { "application/json": components["schemas"]["StudioInvitationCodeRedeemSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["StudioInvitationCodeRedeemSchema"]; }; }; }; }; /** * Render State * @description Render a project state to generate a clip. * * Args: * data: Contains state, start_beats, and end_beats to render */ studio_api_bots_studio_api_render_state: { requestBody: { content: { "application/json": components["schemas"]["RenderStateSchema"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["GeneratedClipSchema"] | components["schemas"]["GenericModerationErrorSchema"]; }; }; }; }; /** * Save Studio Project * @description Save a new version of a Studio project with DynamoDB payload migration. * * Args: * data: Contains project_id and state to save */ studio_api_bots_studio_api_save_studio_project: { requestBody: { content: { "application/json": components["schemas"]["SaveProjectSchema"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["StudioProjectMetaSchema"]; }; }; }; }; /** * Delete Codes * @description Delete a Studio invitation code for a batch of users. */ studio_api_bots_studio_api_delete_codes: { requestBody: { content: { "application/json": components["schemas"]["StudioInvitationCodeBatchOperationSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["StudioInvitationCodeBatchOperationSchema"]; }; }; }; }; /** * Generate Codes * @description Generate a Studio invitation code for a batch of users. */ studio_api_bots_studio_api_generate_codes: { requestBody: { content: { "application/json": components["schemas"]["StudioInvitationCodeBatchOperationSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["StudioInvitationCodeBatchOperationSchema"]; }; }; }; }; /** * Verify Code * @description Verify a Studio invitation code. */ studio_api_bots_studio_api_verify_code: { parameters: { query: { code: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["StudioInvitationCodeRedeemSchema"]; }; }; }; }; /** * Get Waitlist Status * @description Check if the user is in the Studio waitlist and get waitlist information. */ studio_api_bots_studio_api_get_waitlist_status: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["StudioWaitlistSchema"]; }; }; }; }; /** Get Version State */ studio_api_bots_studio_api_get_version_state: { parameters: { path: { project_id: string; version_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["StudioVersionStateSchema"]; }; }; }; }; /** * Get Studio Project Versions * @description Get the versions for a Studio project. */ studio_api_bots_studio_api_get_studio_project_versions: { parameters: { query?: { from_timestamp?: string | null; to_timestamp?: string | null; return_days_only?: boolean; }; path: { project_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["StudioProjectVersionListSchema"]; }; }; }; }; /** Embed Genre */ studio_api_sunoverse_api_embed_genre: { parameters: { query: { genres: string[]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Embed My Songs */ studio_api_sunoverse_api_embed_my_songs: { responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Get Survey Questions * @description Get survey questions - all, by group, or by ID (Staff only) */ studio_api_survey_api_get_survey_questions: { parameters: { query?: { group_id?: string | null; question_id?: string | null; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Create Survey Question * @description Create a new survey question (Staff only) */ studio_api_survey_api_create_survey_question: { requestBody: { content: { "application/json": components["schemas"]["CreateSurveyQuestionSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Update Survey Question * @description Update question text, options, group, or type (Staff only) */ studio_api_survey_api_update_survey_question: { parameters: { query: { question_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["UpdateSurveyQuestionSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Get Public Survey Questions * @description Returns an array of active questions for this group */ studio_api_survey_api_get_public_survey_questions: { parameters: { path: { group_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PublicSurveyQuestionListSchema"]; }; }; }; }; /** * Create Survey Response * @description Submit a user's answer */ studio_api_survey_api_create_survey_response: { requestBody: { content: { "application/json": components["schemas"]["CreateSurveyResponseSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Create Bulk Survey Responses * @description Submit multiple survey responses at once */ studio_api_survey_api_create_bulk_survey_responses: { requestBody: { content: { "application/json": components["schemas"]["BulkCreateSurveyResponseSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Delete Survey Response * @description Allow users to revoke their answers (Only for their own user_id) */ studio_api_survey_api_delete_survey_response: { parameters: { path: { response_id: string; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Update Survey Response * @description Update an existing response */ studio_api_survey_api_update_survey_response: { parameters: { path: { response_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["UpdateSurveyResponseSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Recommend Tags */ studio_api_tag_recommendations_api_recommend_tags: { requestBody: { content: { "application/json": components["schemas"]["RecommendTagsRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["RecommendTagsResponse"]; }; }; }; }; /** * Get Trending Playlist Endpoint * @description api get request for Homepage * Returns: PlaylistSchema of global trending playlist (id hardcoded in constants.py) */ studio_api_bots_api_get_trending_playlist_endpoint: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PlaylistSchema"]; }; }; }; }; /** * Get Trending En Playlist Endpoint * @description api get request for English-language trending playlist * Returns: PlaylistSchema of global EN trending playlist (id hardcoded in constants.py) */ studio_api_bots_api_get_trending_en_playlist_endpoint: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PlaylistSchema"]; }; }; }; }; /** * Get Trending Playlist En V2 Endpoint * @description Returns: PlaylistSchema of trending v2 EN playlist */ studio_api_bots_api_get_trending_playlist_en_v2_endpoint: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PlaylistSchema"]; }; }; }; }; /** * Get Trending Metaplaylist Endpoint * @description api get request for trending metaplaylist * Returns: list of PlaylistSchemas of trending playlists */ studio_api_bots_api_get_trending_metaplaylist_endpoint: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PlaylistsSchema"]; }; }; }; }; /** * Get New Playlist Endpoint * @description api get request for New playlist * Returns: PlaylistSchema of global New playlist (id hardcoded in constants.py) */ studio_api_bots_api_get_new_playlist_endpoint: { parameters: { query?: { page?: number; query?: string | null; categories?: string[] | null; ids?: string | null; status?: string | null; is_liked?: boolean | null; hide_disliked?: boolean | null; is_public?: boolean | null; is_not_disliked?: boolean | null; is_full_song?: boolean | null; is_video_to_song?: boolean | null; is_suno_short?: boolean | null; add_preset_clips?: boolean | null; hide_gen_stems?: boolean | null; is_gen_stem?: boolean | null; hide_studio_clips?: boolean | null; is_trashed?: boolean | null; from_index?: number; page_size?: number; continuation_token?: string | null; is_cover?: boolean | null; is_extend?: boolean | null; is_infill?: boolean | null; is_persona?: boolean | null; is_scene?: boolean | null; is_upsample?: boolean | null; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PlaylistSchema"]; }; }; }; }; /** * Get Top Playlist Endpoint * @description api get request for Top playlist * Returns: PlaylistSchema of a global Top playlist (weekly, monthly, yearly or alltime). */ studio_api_bots_api_get_top_playlist_endpoint: { parameters: { query?: { page?: number; query?: string | null; categories?: string[] | null; ids?: string | null; status?: string | null; is_liked?: boolean | null; hide_disliked?: boolean | null; is_public?: boolean | null; is_not_disliked?: boolean | null; is_full_song?: boolean | null; is_video_to_song?: boolean | null; is_suno_short?: boolean | null; add_preset_clips?: boolean | null; hide_gen_stems?: boolean | null; is_gen_stem?: boolean | null; hide_studio_clips?: boolean | null; is_trashed?: boolean | null; from_index?: number; page_size?: number; continuation_token?: string | null; is_cover?: boolean | null; is_extend?: boolean | null; is_infill?: boolean | null; is_persona?: boolean | null; is_scene?: boolean | null; is_upsample?: boolean | null; }; path: { period: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PlaylistSchema"]; }; }; }; }; /** * Get Trending Playlist V2 Endpoint * @description Returns: PlaylistSchema of trending v2 ALL playlist */ studio_api_bots_api_get_trending_playlist_v2_endpoint: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["PlaylistSchema"]; }; }; }; }; /** Update User Config */ studio_api_bots_api_update_user_config: { requestBody: { content: { "application/json": components["schemas"]["UpdateUserConfigRequestSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["UserConfigSchema"]; }; }; }; }; /** Start Audio Upload */ studio_api_bots_uploads_api_start_audio_upload: { requestBody: { content: { "application/json": components["schemas"]["UploadRequestSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["UploadRequestSchema"]; }; }; }; }; /** Get Audio Upload Status */ studio_api_bots_uploads_api_get_audio_upload_status: { parameters: { path: { upload_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["UploadRequestStatusSchema"]; }; }; }; }; /** Initialize Upload Clip */ studio_api_bots_uploads_api_initialize_upload_clip: { parameters: { path: { upload_id: string; }; }; requestBody?: { content: { "application/json": components["schemas"]["InitializeClipSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["UploadClipSchema"]; }; }; }; }; /** Initialize Stem Mix Upload Clip */ studio_api_bots_uploads_api_initialize_stem_mix_upload_clip: { parameters: { path: { upload_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["StemMixInitializeSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["UploadClipSchema"]; }; }; }; }; /** Finish S3 Upload Audio */ studio_api_bots_uploads_api_finish_s3_upload_audio: { parameters: { path: { upload_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["FinishUploadSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Start Image Upload */ studio_api_bots_uploads_api_start_image_upload: { requestBody: { content: { "application/json": components["schemas"]["UploadRequestSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["UploadRequestSchema"]; }; }; }; }; /** Start Video Upload */ studio_api_bots_uploads_api_start_video_upload: { requestBody: { content: { "application/json": components["schemas"]["UploadRequestSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["UploadRequestSchema"]; }; }; }; }; /** Process Video Output */ studio_api_bots_uploads_api_process_video_output: { parameters: { path: { upload_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["VideoOutputSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["GeneratedClipSchema"]; }; }; }; }; /** Get Video Upload Status */ studio_api_bots_uploads_api_get_video_upload_status: { parameters: { path: { upload_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["UploadRequestStatusSchema"]; }; }; }; }; /** Finish S3 Upload Video */ studio_api_bots_uploads_api_finish_s3_upload_video: { parameters: { path: { upload_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["FinishUploadSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Accept Custom Mode Tos * @description Accept TOS for custom mode lyrics. */ studio_api_bots_user_api_accept_custom_mode_tos: { responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Accept Timbaland Terms * @description Accept Timbaland terms for the user. */ studio_api_bots_user_api_accept_timbaland_terms: { responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Create Session Id * @description Create a session id for the user. * * If a session id is already created, return the cached session id and extend the session length to 15 mins. */ studio_api_bots_user_api_create_session_id: { requestBody: { content: { "application/json": components["schemas"]["CreateSessionIdSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["CreateSessionIdSchema"]; }; }; }; }; /** * Delete User Account * @description Delete the logged-in user's account. */ studio_api_bots_user_api_delete_user_account: { requestBody: { content: { "application/json": components["schemas"]["DeleteAccountSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Delete Phone Number */ studio_api_bots_user_api_delete_phone_number: { requestBody: { content: { "application/json": components["schemas"]["UpdateUserPhoneReq"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Extend Session Id */ studio_api_bots_user_api_extend_session_id: { requestBody: { content: { "application/json": components["schemas"]["ExtendSessionIdSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ExtendSessionIdSchema"]; }; }; }; }; /** Find Existing User By Phone */ studio_api_bots_user_api_find_existing_user_by_phone: { requestBody: { content: { "application/json": components["schemas"]["FindExistingUserByPhoneReq"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["FindExistingUserByPhoneResp"]; }; }; }; }; /** * Get Creator Info * @description the logged-in user's account. */ studio_api_bots_user_api_get_creator_info: { parameters: { path: { creator_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["SimpleProfileInfoSchema"]; }; }; }; }; /** Get User Session Id */ studio_api_bots_user_api_get_user_session_id: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["GetUserSessionIdSchema"]; }; }; }; }; /** * Get User Profile * @description Get the current user's personal profile, including birthday, email, phone number, etc. * * This endpoint is only available for authenticated users. */ studio_api_bots_user_api_get_user_profile: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["GetUserMeResponse"]; }; }; }; }; /** Record Session Id */ studio_api_bots_user_api_record_session_id: { requestBody: { content: { "application/json": components["schemas"]["RecordSessionIdSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["RecordSessionIdSchema"]; }; }; }; }; /** Update Phone Number */ studio_api_bots_user_api_update_phone_number: { requestBody: { content: { "application/json": components["schemas"]["UpdateUserPhoneReq"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Update User Config */ studio_api_bots_user_api_update_user_config: { requestBody: { content: { "application/json": components["schemas"]["UserConfigSchema"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** User Config */ studio_api_bots_user_api_user_config: { requestBody: { content: { "application/json": components["schemas"]["GetUserConfigRequestSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["UserConfigSchema"]; }; }; }; }; /** * Action Check * @description Action check whether we need to add captcha check */ studio_api_user_actions_api_action_check: { responses: { /** @description OK */ 200: { content: never; }; }; }; /** Is Bot Check */ studio_api_user_actions_api_is_bot_check: { requestBody: { content: { "application/json": components["schemas"]["UserCheckSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Get User Config */ studio_api_bots_api_get_user_config: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["UserConfigSchema"]; }; }; }; }; /** Merge Accounts View */ studio_api_bots_api_merge_accounts_view: { requestBody: { content: { "application/json": components["schemas"]["MergeAccountsSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Get Clips External */ studio_api_bots_external_api_get_clips_external: { parameters: { query?: { page?: number; ids?: string | null; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ExternalClipSchema"][]; }; }; }; }; /** * Get Clips External Auth * @description Retrieve clips by IDs using external authentication. */ studio_api_bots_external_api_get_clips_external_auth: { parameters: { query?: { page?: number; ids?: string | null; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ExternalClipSchema"][]; }; }; }; }; /** * Get Aligned Lyrics External * @description Get aligned lyrics for a clip via external API. */ studio_api_bots_external_api_get_aligned_lyrics_external: { parameters: { path: { clip_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ExternalAlignedLyricsV2Schema"]; }; }; }; }; /** Run Generation Integration */ studio_api_bots_external_api_run_generation_integration: { requestBody: { content: { "application/json": components["schemas"]["ExternalGenerationSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ExternalClipSchema"]; }; }; }; }; /** Generate External */ studio_api_bots_external_api_generate_external: { requestBody: { content: { "application/json": components["schemas"]["ExternalGenerationSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ExternalClipSchema"]; }; }; }; }; /** * Generate Anonymous Lyrics * @description Generate lyrics from a prompt with Cloudflare Turnstile verification. */ studio_api_bots_external_api_generate_anonymous_lyrics: { requestBody: { content: { "application/json": components["schemas"]["AnonymousLyricsGenerationSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["AnonymousLyricsResponseSchema"]; }; }; }; }; /** * Get Clips Hackmit * @description Get clips for HackMIT participants. */ studio_api_bots_hackmit_api_get_clips_hackmit: { parameters: { query?: { page?: number; ids?: string | null; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ExternalClipSchema"][]; }; }; }; }; /** * Generate Hackmit * @description Generate music for HackMIT participants. * Automatically uses chirp-auk-turbo model and tracks usage. */ studio_api_bots_hackmit_api_generate_hackmit: { requestBody: { content: { "application/json": components["schemas"]["ExternalGenerationSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ExternalClipSchema"]; }; }; }; }; /** * Generate Stems Hackmit * @description Generate stems for HackMIT participants. * Uses chirp-stem model for stem generation. */ studio_api_bots_hackmit_api_generate_stems_hackmit: { requestBody: { content: { "application/json": components["schemas"]["HackMITStemsSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ExternalClipSchema"][]; }; }; }; }; /** * Get Lyrics External * @description Get lyrics for a clip in WebVTT format. */ studio_api_bots_external_api_get_lyrics_external: { parameters: { query: { clip_id: string; format?: string; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Get Alexa User Info Via Oauth * @description Get Alxa-specific user information through OAuth. */ studio_api_bots_external_api_get_alexa_user_info_via_oauth: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["AlexaUserInfoSchema"]; }; }; }; }; /** * Alexa Skill Account Linked * @description Handles the Alexa skill account linking event and self-healing requests. * * This endpoint is called by the Alexa skill Lambda function when: * 1. A user links their Suno account to their Alexa account * 2. Alexa performs self-healing to ensure catalogs are synchronized * * If previous_sync_token is provided, this is a self-healing request. */ studio_api_bots_external_api_alexa_skill_account_linked: { parameters: { query: { alexa_user_id: string; alexa_api_endpoint?: string | null; previous_sync_token?: string | null; }; }; responses: { /** @description OK */ 200: { content: { "application/json": { [key: string]: unknown; }; }; }; }; }; /** * Alexa Song Created * @description Handles notification of a newly created song that needs to be added to the Alexa catalog. * * This endpoint is called by the Lambda function after a song is successfully created * to update the user's Alexa music catalog with the new song. * * If no AlexaUserInfo record exists, it will create one if alexa_user_id is provided. */ studio_api_bots_external_api_alexa_song_created: { parameters: { query: { clip_id: string; title?: string | null; alexa_user_id?: string | null; alexa_api_endpoint?: string | null; }; }; responses: { /** @description OK */ 200: { content: { "application/json": { [key: string]: unknown; }; }; }; }; }; /** * Oauth Authorize * @description OAuth 2.0 authorization endpoint redirecting to frontend for authentication. */ studio_api_bots_external_api_oauth_authorize: { responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Oauth Authorize Confirm * @description Confirms OAuth authorization after user authentication. */ studio_api_bots_external_api_oauth_authorize_confirm: { responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Get Oauth Client Info * @description Get information about an OAuth client application by client_id. */ studio_api_bots_external_api_get_oauth_client_info: { parameters: { query: { client_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["OAuthClientInfoSchema"]; }; }; }; }; /** * Get Clips Via Oauth * @description Retrieve clips by IDs through OAuth with the 'read_music' scope. */ studio_api_bots_external_api_get_clips_via_oauth: { parameters: { query?: { page?: number; ids?: string | null; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ExternalClipSchema"][]; }; }; }; }; /** * Generate Via Oauth * @description Generate a song through OAuth with the 'generate_music' scope. */ studio_api_bots_external_api_generate_via_oauth: { requestBody: { content: { "application/json": components["schemas"]["ExternalGenerationSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ExternalClipSchema"][]; }; }; }; }; /** * Generate Authorization Code * @description Generate an authorization code after user authenticates with Clerk. */ studio_api_bots_external_api_generate_authorization_code: { requestBody: { content: { "application/json": components["schemas"]["OAuthCodeRequestSchema"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["OAuthRedirectResponseSchema"]; }; }; }; }; /** * Search User Library Via Oauth * @description Search the user's library via OAuth with the 'read_music' scope. */ studio_api_bots_external_api_search_user_library_via_oauth: { requestBody: { content: { "application/json": components["schemas"]["SearchRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["SearchResult"]; }; }; }; }; /** * Search User Clips Via Oauth * @description Retrieve clips by various criteria through OAuth with the 'read_music' scope. * * Supports three filter modes: * 1. N most recent songs (default) * 2. N songs newer than a specific song (after_id) * 3. N songs older than a specific song (before_id) */ studio_api_bots_external_api_search_user_clips_via_oauth: { parameters: { query?: { limit?: number; after_id?: string | null; before_id?: string | null; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ExternalClipSchema"][]; }; }; }; }; /** * Get User Info Via Oauth * @description Get user profile and subscription details through OAuth. */ studio_api_bots_external_api_get_user_info_via_oauth: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ExternalUserInfoSchema"]; }; }; }; }; /** Run Stem Integration */ studio_api_bots_external_api_run_stem_integration: { requestBody: { content: { "application/json": components["schemas"]["ExternalStemsSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ExternalClipSchema"][]; }; }; }; }; /** Start Audio Upload */ studio_api_bots_external_api_start_audio_upload: { requestBody: { content: { "application/json": components["schemas"]["UploadRequestSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["UploadRequestSchema"]; }; }; }; }; /** Get Audio Upload Status */ studio_api_bots_external_api_get_audio_upload_status: { parameters: { path: { upload_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["UploadRequestStatusSchema"]; }; }; }; }; /** Initialize Audio Upload Clip */ studio_api_bots_external_api_initialize_audio_upload_clip: { parameters: { path: { upload_id: string; }; }; requestBody?: { content: { "application/json": components["schemas"]["InitializeClipSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["UploadClipSchema"]; }; }; }; }; /** Finish Processing Audio Upload */ studio_api_bots_external_api_finish_processing_audio_upload: { parameters: { path: { upload_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["FinishUploadSpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Verify External Token */ studio_api_bots_external_api_verify_external_token: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["VerifyExternalTokenResponse"]; }; }; }; }; /** Generate Video */ studio_api_video_api_generate_video: { parameters: { path: { clip_id: string; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Get Video Status */ studio_api_video_api_get_video_status: { parameters: { path: { clip_id: string; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Batch Admin Hooks * @description Batch fetch hooks for admin visualization and ranking analysis. * Staff-only endpoint that returns fully hydrated hooks including test hooks and flagged content. */ studio_api_video_hooks_admin_api_batch_admin_hooks: { requestBody: { content: { "application/json": components["schemas"]["BatchAdminHooksRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["BatchAdminHooksResponse"]; }; }; }; }; /** * Reprocess Hook * @description Set the current user's video cover hook perm in Redis. * Staff-only endpoint that sets the video cover hook perm for the current user. */ studio_api_video_hooks_admin_api_reprocess_hook: { requestBody: { content: { "application/json": components["schemas"]["ReprocessHookRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ReprocessHookResponse"]; }; }; }; }; /** * Reset Moderation * @description Set the current user's video cover hook perm in Redis. * Staff-only endpoint that sets the video cover hook perm for the current user. */ studio_api_video_hooks_admin_api_reset_moderation: { requestBody: { content: { "application/json": components["schemas"]["ResetModerationModeRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ResetModerationModeResponse"]; }; }; }; }; /** * Inspect Watch History * @description Inspect the current user's Hooks watch history from Redis. * Staff-only endpoint that returns the list of watched hook IDs. */ studio_api_video_hooks_admin_api_inspect_watch_history: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["InspectWatchHistoryResponse"]; }; }; }; }; /** * Reset Watch History * @description Reset the current user's Hooks watch history in Redis. * Staff-only endpoint that clears all watched hook records. * Requires confirmation flag to prevent accidental resets. */ studio_api_video_hooks_admin_api_reset_watch_history: { requestBody: { content: { "application/json": components["schemas"]["ResetWatchHistoryRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ResetWatchHistoryResponse"]; }; }; }; }; /** Add Quality Label */ studio_api_video_hooks_admin_api_add_quality_label: { parameters: { path: { hook_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["AddHookQualityLabelRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["AddHookQualityLabelResponse"]; }; }; }; }; /** Remove Quality Label */ studio_api_video_hooks_admin_api_remove_quality_label: { parameters: { path: { hook_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["RemoveHookQualityLabelRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["RemoveHookQualityLabelResponse"]; }; }; }; }; /** * Delete Comment * @description Delete a comment. Users can only delete their own comments. */ studio_api_video_hooks_comments_api_delete_comment: { parameters: { path: { comment_id: string; }; }; requestBody?: { content: { "application/json": components["schemas"]["DeleteCommentRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["DeleteCommentResponse"]; }; }; }; }; /** * Post Comment Reaction * @description Post a reaction to a comment. */ studio_api_video_hooks_comments_api_post_comment_reaction: { parameters: { path: { comment_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["CommentReactionRequest"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Get Comment Replies * @description Get the replies to a comment. */ studio_api_video_hooks_comments_api_get_comment_replies: { parameters: { query?: { cursor?: string | null; page_size?: number | null; deeplinked_comment_id?: string | null; entity_type?: components["schemas"]["CommentEntityType"]; }; path: { comment_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["GetCommentRepliesResponse"]; }; }; }; }; /** * Post Comment Report * @description Report a comment. */ studio_api_video_hooks_comments_api_post_comment_report: { parameters: { path: { comment_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["ReportCommentRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ReportCommentResponse"]; }; }; }; }; /** Post Comment */ studio_api_video_hooks_comments_api_post_comment: { parameters: { path: { hook_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["PostCommentRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["CommentSchema"]; }; }; /** @description Forbidden */ 403: { content: { "application/json": components["schemas"]["APIErrorSchema"]; }; }; /** @description Not Found */ 404: { content: { "application/json": components["schemas"]["APIErrorSchema"]; }; }; /** @description Unprocessable Content */ 422: { content: { "application/json": components["schemas"]["APIErrorSchema"]; }; }; /** @description Too Many Requests */ 429: { content: { "application/json": components["schemas"]["APIErrorSchema"]; }; }; }; }; /** * Get Comments * @description Get comments for a clip. */ studio_api_video_hooks_comments_api_get_comments: { parameters: { query?: { cursor?: string | null; page_size?: number | null; order?: "newest" | "oldest" | "most_liked" | null; id?: string | null; deeplink?: boolean | null; }; path: { hook_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["GetCommentsResponse"]; }; }; }; }; /** * Get Comment Count * @description Get the count of comments for a clip. */ studio_api_video_hooks_comments_api_get_comment_count: { parameters: { path: { hook_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["GetCommentCountResponse"]; }; }; }; }; /** * Get Time Sync Comments * @description Get time-synchronized comments for a clip. */ studio_api_video_hooks_comments_api_get_time_sync_comments: { parameters: { query: { search_time: number; search_range?: number; margin?: number; num_requested?: number | null; end_time?: number | null; }; path: { hook_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["CommentSchema"][]; }; }; }; }; /** Toggle Comments */ studio_api_video_hooks_comments_api_toggle_comments: { parameters: { path: { hook_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["ToggleCommentsRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["GenericToggleCommentsResponse"]; }; }; }; }; /** Create Hook */ studio_api_video_hooks_api_create_hook: { requestBody: { content: { "application/json": components["schemas"]["VideoHookCreationRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["VideoHookCreationResponse"]; }; }; }; }; /** * Add Hook Creator Label * @description Add a label to a hook creator. */ studio_api_video_hooks_api_add_hook_creator_label: { requestBody: { content: { "application/json": components["schemas"]["AddHookCreatorLabelSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["AddHookCreatorLabelResponse"]; }; }; }; }; /** Delete Video Hook */ studio_api_video_hooks_api_delete_video_hook: { parameters: { path: { hook_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["DeleteHookResponse"]; }; }; }; }; /** Fetch Video Hook Feed */ studio_api_video_hooks_api_fetch_video_hook_feed: { requestBody: { content: { "application/json": components["schemas"]["VideoHookFeedRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["VideoHookFeedResponse"]; }; }; }; }; /** Fetch Video Hook Admin Feed */ studio_api_video_hooks_api_fetch_video_hook_admin_feed: { requestBody: { content: { "application/json": components["schemas"]["VideoHookFeedRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["VideoHookFeedResponse"]; }; }; }; }; /** Fetch Video Hook Feed Diagnostic */ studio_api_video_hooks_api_fetch_video_hook_feed_diagnostic: { requestBody: { content: { "application/json": components["schemas"]["VideoHookFeedDiagnosticRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["VideoHookFeedDiagnosticResponse"]; }; }; }; }; /** Fetch Hook Lyrics */ studio_api_video_hooks_api_fetch_hook_lyrics: { requestBody: { content: { "application/json": components["schemas"]["HookLyricsRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["HookLyricsResponse"]; }; }; }; }; /** Get Video Hooks From Clip */ studio_api_video_hooks_api_get_video_hooks_from_clip: { parameters: { query?: { start_index?: number; page_size?: number; user_handle?: string | null; }; path: { clip_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["GetVideoHooksFromClipResponse"]; }; }; }; }; /** Get User Video Hooks */ studio_api_video_hooks_api_get_user_video_hooks: { parameters: { query?: { start_index?: number; page_size?: number; user_handle?: string | null; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["VideoHookSchema"][]; }; }; }; }; /** * Get User Liked Hooks * @description Get hooks that the user has liked, sorted by most recently liked. */ studio_api_video_hooks_api_get_user_liked_hooks: { parameters: { query?: { start_index?: number; page_size?: number; user_handle?: string | null; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["VideoHookSchema"][]; }; }; }; }; /** * Get User Liked Hooks V2 * @description Get hooks that the user has liked, sorted by most recently liked. Returns wrapped response. */ studio_api_video_hooks_api_get_user_liked_hooks_v2: { parameters: { query?: { start_index?: number; page_size?: number; user_handle?: string | null; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["GetUserVideoHooksResponse"]; }; }; }; }; /** * Remove Hook Creator Label * @description Remove a label from a hook creator. */ studio_api_video_hooks_api_remove_hook_creator_label: { requestBody: { content: { "application/json": components["schemas"]["RemoveHookCreatorLabelSpec"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["RemoveHookCreatorLabelResponse"]; }; }; }; }; /** Set Video Cover Hook Perm */ studio_api_video_hooks_api_set_video_cover_hook_perm: { requestBody: { content: { "application/json": components["schemas"]["SetVideoCoverHookPermRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["SetVideoCoverHookPermResponse"]; }; }; }; }; /** Should Show Video Cover Hook Notification */ studio_api_video_hooks_api_should_show_video_cover_hook_notification: { responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ShouldShowVideoCoverHookNotificationResponse"]; }; }; }; }; /** Suggested Clips */ studio_api_video_hooks_api_suggested_clips: { parameters: { query?: { page_size?: number; start_index?: number; is_liked?: boolean; is_public_only?: boolean; search_term?: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["SuggestedClipsSchema"]; }; }; }; }; /** Tab Carousel */ studio_api_video_hooks_api_tab_carousel: { requestBody: { content: { "application/json": components["schemas"]["TabCarouselRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["TabCarouselResponse"]; }; }; }; }; /** Get User Video Hooks V2 */ studio_api_video_hooks_api_get_user_video_hooks_v2: { parameters: { query?: { start_index?: number; page_size?: number; user_handle?: string | null; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["GetUserVideoHooksResponse"]; }; }; }; }; /** Update Video Hook Watch History */ studio_api_video_hooks_api_update_video_hook_watch_history: { requestBody: { content: { "application/json": components["schemas"]["UpdateHookWatchHistoryRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["UpdateHookWatchHistoryResponse"]; }; }; }; }; /** Get Video Hook */ studio_api_video_hooks_api_get_video_hook: { parameters: { query?: { bust_cache?: boolean; }; path: { hook_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["VideoHookSchema"]; }; }; }; }; /** Get Hook Download Url */ studio_api_video_hooks_api_get_hook_download_url: { parameters: { query?: { force_update?: boolean; }; path: { hook_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["HookDownloadResponse"]; }; }; }; }; /** Flag Hook */ studio_api_video_hooks_api_flag_hook: { parameters: { path: { hook_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["FlagHookRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["FlagHookResponse"]; }; }; }; }; /** Set Hook Reaction */ studio_api_video_hooks_api_set_hook_reaction: { parameters: { path: { hook_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["HookReactionRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["HookReactionResponse"]; }; }; }; }; /** Report Hook */ studio_api_video_hooks_api_report_hook: { parameters: { path: { hook_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["HookReportRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["HookReportResponse"]; }; }; }; }; /** Share Hook */ studio_api_video_hooks_api_share_hook: { parameters: { path: { hook_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["ShareHookRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ShareHookResponse"]; }; }; }; }; /** Toggle Test */ studio_api_video_hooks_api_toggle_test: { parameters: { path: { hook_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["ToggleTestHookRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["ToggleTestHookResponse"]; }; }; }; }; /** Update Hook Metadata */ studio_api_video_hooks_api_update_hook_metadata: { parameters: { path: { hook_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["UpdateHookMetadataRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["UpdateHookMetadataResponse"]; }; }; }; }; /** Internal Generate Video */ studio_api_video_api_internal_generate_video: { requestBody: { content: { "application/json": components["schemas"]["VideoGenerationParams"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Get Internal Video Status */ studio_api_video_api_get_internal_video_status: { parameters: { path: { clip_id: string; video_type: string; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Get Video Short */ studio_api_video_api_get_video_short: { parameters: { path: { video_id: string; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Set Video Visibility */ studio_api_video_api_set_video_visibility: { parameters: { path: { video_id: string; }; }; requestBody: { content: { "application/json": components["schemas"]["VisibilitySpec"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Get Video Sprite */ studio_api_video_api_get_video_sprite: { parameters: { query?: { entity_id?: string | null; type?: "video_upload" | "sprite"; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["VideoSpriteSchema"]; }; }; }; }; /** Generate Scene Script */ studio_api_video_gen_api_generate_scene_script: { requestBody: { content: { "application/json": components["schemas"]["GenerateSceneScriptRequest"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Generate Video */ studio_api_video_gen_api_generate_video: { requestBody: { content: { "application/json": components["schemas"]["GenerateVideoRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["GenerateVideoResponse"]; }; }; }; }; /** Generate Video Cover */ studio_api_video_gen_api_generate_video_cover: { requestBody: { content: { "application/json": components["schemas"]["GenerateVideoCoverRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["GenerateVideoCoverResponse"]; }; }; }; }; /** Generate Video Cover Prompt */ studio_api_video_gen_api_generate_video_cover_prompt: { requestBody: { content: { "application/json": components["schemas"]["GenerateVideoCoverPromptRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["GenerateVideoCoverPromptResponse"]; }; }; }; }; /** Get Ai Video Cover */ studio_api_video_gen_api_get_ai_video_cover: { parameters: { query: { task_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["GetVideoCoverResponse"]; }; }; }; }; /** * Create Custom Reference * @description Create a custom reference for text2image generation */ studio_api_video_gen_higgsfield_api_create_custom_reference: { requestBody: { content: { "application/json": components["schemas"]["CreateCustomReferenceRequest"]; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["CreateCustomReferenceResponse"]; }; }; }; }; /** * Get Custom Reference * @description Get details of a custom reference */ studio_api_video_gen_higgsfield_api_get_custom_reference: { parameters: { path: { reference_id: string; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Finished Hf Gen * @description Finished higgsfield gen */ studio_api_video_gen_higgsfield_api_finished_hf_gen: { responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Generate Image * @description Start soul image generation for a video workspace */ studio_api_video_gen_higgsfield_api_generate_image: { parameters: { query: { video_workspace_id: string; custom_reference_id?: string | null; image_url?: string | null; scene_index?: number; prompt?: string | null; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Get Images * @description Get generated images for a video workspace */ studio_api_video_gen_higgsfield_api_get_images: { parameters: { query: { video_workspace_id: string; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Create Soul Image * @description Create a text-to-image soul job */ studio_api_video_gen_higgsfield_api_create_soul_image: { requestBody: { content: { "application/json": components["schemas"]["CreateSoulImageRequest"]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Get Soul Styles * @description Get available soul styles for text2image generation */ studio_api_video_gen_higgsfield_api_get_soul_styles: { responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Start Concatenation * @description Start video concatenation for a workspace */ studio_api_video_gen_higgsfield_api_start_concatenation: { parameters: { query: { video_workspace_id: string; }; }; requestBody: { content: { "application/json": string[]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Start Soul Images * @description Start soul image generation for a video workspace */ studio_api_video_gen_higgsfield_api_start_soul_images: { parameters: { query: { video_workspace_id: string; custom_reference_id?: string | null; image_url?: string | null; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Start Video Generation */ studio_api_video_gen_higgsfield_api_start_video_generation: { requestBody?: { content: { "application/json": string[]; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** * Get Videos * @description Get generated videos for a video workspace */ studio_api_video_gen_higgsfield_api_get_videos: { parameters: { query: { video_workspace_id: string; }; }; responses: { /** @description OK */ 200: { content: never; }; }; }; /** Track Task Status */ studio_api_video_gen_minimax_api_track_task_status: { responses: { /** @description OK */ 200: { content: never; }; }; }; /** Update Video Status */ studio_api_video_gen_api_update_video_status: { responses: { /** @description OK */ 200: { content: never; }; }; }; /** Get Video Workspace */ studio_api_video_gen_api_get_video_workspace: { parameters: { query: { video_workspace_id: string; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["VideoWorkspaceResponse"]; }; }; }; }; /** Get Video Status */ studio_api_video_gen_api_get_video_status: { parameters: { query: { clip_id: string; page_size?: number; }; }; responses: { /** @description OK */ 200: { content: { "application/json": components["schemas"]["GetVideosResponse"]; }; }; }; }; }