yakyak-sdk 0.0.3

Open API

yakyak-sdk

The Yakyak API documentation

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.0
• Package version: 0.0.3
• Generator version: 7.22.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.10+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/yakyak-support/cookbook.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/yakyak-support/cookbook.git)

Then import the package:

import yakyak_sdk

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import yakyak_sdk

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import yakyak_sdk
from yakyak_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.yakyak.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = yakyak_sdk.Configuration(
    host = "https://api.yakyak.ai"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): access-token
configuration = yakyak_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with yakyak_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = yakyak_sdk.DataApi(api_client)

    try:
        # Get featured decorative fonts
        api_instance.data_controller_get_featured_fonts()
    except ApiException as e:
        print("Exception when calling DataApi->data_controller_get_featured_fonts: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.yakyak.ai

Class	Method	HTTP request	Description
DataApi	data_controller_get_featured_fonts	GET /data/font/featured	Get featured decorative fonts
DataApi	data_controller_get_fonts	GET /data/font	Get all active fonts from inventory_font
DataApi	data_controller_get_styles	GET /data/style	Get all active styles from inventory_style
DataApi	data_controller_get_voices	GET /data/voice	Get all active voices from inventory_voice
SchedulerApi	scheduler_controller_enable_trigger	POST /scheduler/enable-trigger
SchedulerApi	scheduler_controller_get_schedule	GET /scheduler/schedule/{campaignId}
SchedulerApi	scheduler_controller_set_frequency	POST /scheduler/set-frequency
SchedulerApi	scheduler_controller_set_next_trigger	POST /scheduler/set-next-trigger
SocialApi	social_controller_connect_network	POST /social/connect-network	Connect a social network to a user
SocialApi	social_controller_create_campaign_link	POST /social/campaign-link	Create a campaign link to a social network
SocialApi	social_controller_delete_campaign_link	DELETE /social/campaign-link/{campaignId}/{connectedNetworkId}	Delete a campaign link to a social network
SocialApi	social_controller_disconnect_network	DELETE /social/disconnect-network/{connectedNetworkId}	Disconnect a social network from a user
SocialApi	social_controller_get_bluesky_auth_url	POST /social/network-auth/bluesky	Get connect URL for BlueSky (handle + app password)
SocialApi	social_controller_get_campaign_links	GET /social/campaign-links/{campaignId}	Get all campaign links for a campaign
SocialApi	social_controller_get_connected_networks	GET /social/connected-networks/{userId}	Get user connected networks
SocialApi	social_controller_get_movie_post_status	GET /social/post-status/{movieId}	Get per-network post attempt status for a movie
SocialApi	social_controller_get_network_auth_url	GET /social/network-auth/{identifier}	Get OAuth auth URL for a social network
SocialApi	social_controller_get_networks	GET /social/network	Get all social networks
SocialApi	social_controller_post_movie_to_social	POST /social/post-movie/{movieId}/{connectedNetworkId}	Post a specific movie (by id) to one connected network
SocialApi	social_controller_post_movie_to_social_batch	POST /social/post-movie-batch/{movieId}	Post a specific movie to many connected networks in one PFM request
SocialApi	social_controller_post_to_social	POST /social/post/{campaignId}/{connectedNetworkId}	Post latest campaign episode to social network
SocialApi	social_controller_update_campaign_link_auto_post	PATCH /social/campaign-link/{campaignId}/{connectedNetworkId}/auto-post	Update autoPost setting for a campaign link
UsersApi	users_controller_become_insider	POST /users/become-insider	Set user as insider and optionally activate campaign
UsersApi	users_controller_confirm_email	POST /users/confirm-email	Confirm user email with verification code
UsersApi	users_controller_create_by_email	POST /users/create-by-email	Create user by email and password, returns verification code
UsersApi	users_controller_find_one	GET /users/{id}	Get user by ID (self or admin)
UsersApi	users_controller_get_insider_questions	GET /users/{id}/insider-questions	Get next insider survey questions for user (self or admin)
UsersApi	users_controller_get_insider_quota_status	GET /users/insider-quota-status	Check if today's insider signup quota is full
UsersApi	users_controller_get_token_transactions	GET /users/{id}/token-transactions	List token transactions for user, paginated, newest first (self or admin)
UsersApi	users_controller_leave_insider	POST /users/leave-insider	User leaves the insider program
UsersApi	users_controller_login_by_email	POST /users/login-by-email	Login user by email and password, returns JWT token
UsersApi	users_controller_social_login	POST /users/social-login	Login with Apple or Google
UsersApi	users_controller_submit_insider_answers	POST /users/submit-insider-answers	Submit answers to insider survey questions
UsersApi	users_controller_update_email	POST /users/update-email	Update user email address
UsersApi	users_controller_update_insider_profile	POST /users/update-insider-profile	Update insider profile description and social links
WorkflowApi	workflow_controller_copy_cast_to_episode	POST /workflow/copy-cast-to-episode	Copy cast from previous episode or template to an episode for editing
WorkflowApi	workflow_controller_create_campaign	POST /workflow/create-campaign	Create a new campaign with style
WorkflowApi	workflow_controller_create_new_season	POST /workflow/create-new-season	Create the next season placeholder episodes for a campaign (no rendering)
WorkflowApi	workflow_controller_create_scene	POST /workflow/create-scene	Create a new scene at a given position
WorkflowApi	workflow_controller_delete_campaign	POST /workflow/delete-campaign	Delete a campaign by setting status to deleted
WorkflowApi	workflow_controller_delete_scene	POST /workflow/delete-scene	Delete a scene and its related data
WorkflowApi	workflow_controller_delete_user_media	POST /workflow/delete-user-media	Delete a user media item
WorkflowApi	workflow_controller_export_campaign	GET /workflow/export-campaign/{campaignId}	Export full campaign data as JSON
WorkflowApi	workflow_controller_export_render	POST /workflow/export-render	Smart export render — detects changes and triggers only needed steps. Pass `force: true` to skip smart-detection and always redo concat + soundtrack.
WorkflowApi	workflow_controller_fork_campaign	POST /workflow/fork-campaign	Fork a campaign by deep-copying a movie (episode or trailer) as the new trailer
WorkflowApi	workflow_controller_gen_custom_cast_image	POST /workflow/gen-custom-cast-image	Generate an AI image for a custom cast character from their description
WorkflowApi	workflow_controller_gen_movie_cast	POST /workflow/gen-movie-cast	Generate movie cast (movie-level)
WorkflowApi	workflow_controller_gen_movie_cast_image	POST /workflow/gen-movie-cast-image	Generate images for each cast character (movie-level)
WorkflowApi	workflow_controller_gen_movie_cast_subtitle	POST /workflow/gen-movie-cast-subtitle	Generate subtitle style per cast character
WorkflowApi	workflow_controller_gen_movie_cast_voice	POST /workflow/gen-movie-cast-voice	Generate voice per cast character
WorkflowApi	workflow_controller_gen_movie_screenplay	POST /workflow/gen-movie-screenplay	Generate movie screenplay (movie-level)
WorkflowApi	workflow_controller_gen_movie_season	POST /workflow/gen-movie-season	Generate movie season
WorkflowApi	workflow_controller_gen_movie_soundtrack	POST /workflow/gen-movie-soundtrack	Add soundtrack to concatenated movie (movie-level)
WorkflowApi	workflow_controller_gen_movie_summary	POST /workflow/gen-movie-summary	Generate movie summary (movie-level)
WorkflowApi	workflow_controller_get_active_jobs	GET /workflow/active-jobs/{userId}	Get active and recently finished rendering jobs for a user
WorkflowApi	workflow_controller_get_audio_tracks	GET /workflow/audio-tracks/{movieId}	Get audio tracks for a movie
WorkflowApi	workflow_controller_get_available_soundtracks	GET /workflow/available-soundtracks/{movieId}	List available soundtracks from other movies
WorkflowApi	workflow_controller_get_campaign	GET /workflow/get-campaign/{campaignId}	Get campaign with movies ordered by season/episode
WorkflowApi	workflow_controller_get_cast	GET /workflow/get-cast/{movieId}	Get cast for a specific movie
WorkflowApi	workflow_controller_get_featured_campaigns	GET /workflow/featured-campaigns	Get featured completed campaigns for the gallery
WorkflowApi	workflow_controller_get_forked_sources	GET /workflow/forked-sources/{userId}	Map of source campaign id -> the user's existing fork (for homepage Edit/Fork buttons)
WorkflowApi	workflow_controller_get_ig_videos	GET /workflow/ig/{userId}	Get all completed movies for a user (public Instagram bio page)
WorkflowApi	workflow_controller_get_movie	GET /workflow/get-movie/{movieId}	Get a single movie by ID
WorkflowApi	workflow_controller_get_movie_custom_cast	GET /workflow/movie-custom-cast/{movieId}	Get custom cast characters for a specific movie
WorkflowApi	workflow_controller_get_movie_failures	GET /workflow/movie/{movieId}/failures	List external-API failures recorded for a movie, grouped by step
WorkflowApi	workflow_controller_get_movie_progress	GET /workflow/get-movie-progress/{movieId}	Get progress of a specific movie (summary/cast/screenplay)
WorkflowApi	workflow_controller_get_movie_scene_progress	GET /workflow/get-movie-scene-progress/{movieId}	Get aggregate scene pipeline progress for a movie
WorkflowApi	workflow_controller_get_render_diff	GET /workflow/render-diff/{movieId}	List edits made since the last completed render — what would change on the next re-render
WorkflowApi	workflow_controller_get_render_time_estimates	GET /workflow/render-time-estimates	Get average render time estimates per step type
WorkflowApi	workflow_controller_get_scene_asset_history	GET /workflow/scene-asset-history/{sceneId}/{asset}	List all previously generated versions of a scene asset (image/movie/subtitle/burn) from S3
WorkflowApi	workflow_controller_get_scene_progress	GET /workflow/get-scene-progress/{sceneId}	Get progress of a specific scene
WorkflowApi	workflow_controller_get_scenes	GET /workflow/get-scenes/{movieId}	Get scenes for a movie with images and dialogue
WorkflowApi	workflow_controller_get_suggested_music_prompt	GET /workflow/suggested-music-prompt/{movieId}	Get a suggested music prompt based on the movie summary
WorkflowApi	workflow_controller_get_template_movie	GET /workflow/get-template-movie/{campaignId}	Get template movie soundtrack URL for campaign
WorkflowApi	workflow_controller_import_campaign	POST /workflow/import-campaign	Import campaigns from exported JSON
WorkflowApi	workflow_controller_insert_media_scene	POST /workflow/insert-media-scene	Insert a prerendered media file as a scene in a movie
WorkflowApi	workflow_controller_list_campaigns	GET /workflow/list-campaign/{userId}	List campaigns for a specific user
WorkflowApi	workflow_controller_list_cast_image_history	GET /workflow/cast-image-history/{movieId}/{characterName}	List all historical CDN URLs for a cast character image
WorkflowApi	workflow_controller_list_render_history	GET /workflow/render-history/{movieId}	List historical full renders (concat+soundtrack) for a movie so the export page can cycle through them
WorkflowApi	workflow_controller_list_soundtrack_history	GET /workflow/soundtrack-history/{movieId}	List historical soundtracks (audio tracks) generated for a movie so the export page can cycle through them
WorkflowApi	workflow_controller_list_user_media	GET /workflow/user-media/{userId}	List user media library (paginated, 12/page)
WorkflowApi	workflow_controller_preview_movie	GET /workflow/preview-movie/{movieId}	Public read-only preview of a published movie (for fork landing)
WorkflowApi	workflow_controller_regen_scene_asset	POST /workflow/regen-scene-asset	Regenerate a single scene asset without triggering downstream pipeline
WorkflowApi	workflow_controller_regen_subtitle	POST /workflow/regen-subtitle	Regenerate subtitles for a movie
WorkflowApi	workflow_controller_render_movie	POST /workflow/render-movie	Render movie by finding previous movie or template and cloning cast data
WorkflowApi	workflow_controller_render_next_movie	POST /workflow/render-next-movie	Render next episode or generate next season based on campaign state
WorkflowApi	workflow_controller_reorder_scenes	POST /workflow/reorder-scenes	Reorder scenes within a movie
WorkflowApi	workflow_controller_rerun_and_continue	POST /workflow/rerun-and-continue	Restart from the first incomplete/failed step and continue all downstream steps
WorkflowApi	workflow_controller_rerun_scene	POST /workflow/rerun-scene	Rerun the processing pipeline for a single scene
WorkflowApi	workflow_controller_restore_campaign_by_movie	POST /workflow/restore-campaign-by-movie	Restore the campaign owning a movie (undelete-on-edit for forks)
WorkflowApi	workflow_controller_resume_movie	POST /workflow/resume	Resume movie workflow from where it was interrupted
WorkflowApi	workflow_controller_save_movie_custom_cast	POST /workflow/save-movie-custom-cast	Save custom cast characters to a specific movie
WorkflowApi	workflow_controller_select_cast_image	POST /workflow/select-cast-image	Set the active cast character image to a specific historical URL
WorkflowApi	workflow_controller_select_scene_asset	POST /workflow/select-scene-asset	Set a previously generated version of a scene asset as the current one
WorkflowApi	workflow_controller_select_soundtrack_history	POST /workflow/select-soundtrack-history	Set the active movie soundtrack to a historical audioPath (no re-render — applied on next Render)
WorkflowApi	workflow_controller_set_cast	POST /workflow/set-cast	Update cast voice assignments for a movie
WorkflowApi	workflow_controller_set_movie_ig_grid_visibility	POST /workflow/movie/{movieId}/ig-grid	Set whether a movie is shown on the IG grid view
WorkflowApi	workflow_controller_set_movie_metadata	POST /workflow/set-movie-metadata	Update episode title and description for a movie
WorkflowApi	workflow_controller_set_soundtrack_audio_path	POST /workflow/set-soundtrack-audio	Set the audio path for a movie soundtrack (reuse existing)
WorkflowApi	workflow_controller_start_campaign	POST /workflow/start-campaign	Start a campaign by creating a movie from existing campaign
WorkflowApi	workflow_controller_subscription_calculator	GET /workflow/subscription-calculator/{userId}	Per-campaign render costs + totals for the subscription calculator
WorkflowApi	workflow_controller_switch_campaign_mode	POST /workflow/switch-campaign-mode	Switch campaign mode between basic and pro
WorkflowApi	workflow_controller_update_campaign_settings	POST /workflow/update-campaign-settings	Update campaign settings (aspect ratio, animation type, image quality, additional description)
WorkflowApi	workflow_controller_update_movie_cast	POST /workflow/update-movie-cast	Update movie cast data (Pro mode editing)
WorkflowApi	workflow_controller_update_movie_social_description	POST /workflow/update-movie-social-description	Update per-movie social post overrides (title and/or description)
WorkflowApi	workflow_controller_update_movie_summary	POST /workflow/update-movie-summary	Update movie summary text (Pro mode editing)
WorkflowApi	workflow_controller_update_movie_title	POST /workflow/update-movie-title	Update movie title
WorkflowApi	workflow_controller_update_scene_animation_prompt	POST /workflow/update-scene-animation-prompt	Update scene Kling animation prompt
WorkflowApi	workflow_controller_update_scene_background_color	POST /workflow/update-scene-background-color	Update scene background color (for dialogue-only scenes)
WorkflowApi	workflow_controller_update_scene_dialogue	POST /workflow/update-scene-dialogue	Update dialogue for a scene
WorkflowApi	workflow_controller_update_scene_lead_cast	POST /workflow/update-scene-lead-cast	Update scene lead cast character
WorkflowApi	workflow_controller_update_scene_story	POST /workflow/update-scene-story	Update scene story/prompt text (Pro mode editing)
WorkflowApi	workflow_controller_update_scene_title	POST /workflow/update-scene-title	Update scene title (Pro mode editing)
WorkflowApi	workflow_controller_update_soundtrack_volume	POST /workflow/set-soundtrack	Update soundtrack volume percentage for a movie
WorkflowApi	workflow_controller_upload_cast_character_image	POST /workflow/upload-cast-character-image	Upload a custom cast character image
WorkflowApi	workflow_controller_upload_scene_image	POST /workflow/upload-scene-image	Upload a custom scene image
WorkflowApi	workflow_controller_upload_scene_movie	POST /workflow/upload-scene-movie	Upload a custom rendered scene movie
WorkflowApi	workflow_controller_upload_user_media	POST /workflow/upload-user-media	Upload a video to the user media library

Documentation For Models

• ActivateSubscriptionDto
• BlueskyAuthUrlDto
• CampaignResponseDto
• CampaignResponseDtoCampaign
• CastMemberDto
• ConfirmEmailDto
• ConnectNetworkDto
• CreateAccessTokenDto
• CreateByEmailDto
• CreateProductDto
• CreateSubscriptionDto
• CreateUserDto
• ExecutionLogEntryDto
• ExecutionLogResponseDto
• GenMovieCastVoiceRequestDto
• GenMovieSceneConcatHookDto
• GenMovieSceneConcatRequestDto
• GenMovieScreenplayHookDto
• GenMovieScreenplayRequestDto
• GenSceneImageDto
• GenSceneImageRequestDto
• GenSceneMovieDto
• GenSceneMovieRequestDto
• GenSceneSubtitlesMovieHookDto
• GenSceneSubtitlesMovieRequestDto
• LoginByEmailDto
• RegenSubtitleRequestDto
• RenderMovieRequestDto
• ResumeMovieDto
• SceneCharacterDto
• SchedulerControllerEnableTriggerRequest
• SchedulerControllerSetFrequencyRequest
• SchedulerControllerSetNextTriggerRequest
• SendFreeTrialDto
• SetCastDto
• SetMovieMetadataDto
• SocialControllerConnectNetwork201Response
• SocialControllerConnectNetwork201ResponseLinkedNetwork
• SocialControllerCreateCampaignLink201Response
• SocialControllerCreateCampaignLink201ResponseCampaignLink
• SocialControllerDeleteCampaignLink200Response
• SocialControllerDisconnectNetwork200Response
• SocialControllerGetBlueskyAuthUrl201Response
• SocialControllerGetCampaignLinks200Response
• SocialControllerGetCampaignLinks200ResponseCampaignLinksInner
• SocialControllerGetConnectedNetworks200Response
• SocialControllerGetConnectedNetworks200ResponseConnectedNetworksInner
• SocialControllerGetNetworkAuthUrl200Response
• SocialControllerGetNetworks200Response
• SocialControllerGetNetworks200ResponseNetworksInner
• SocialControllerPostToSocial200Response
• SocialControllerUpdateCampaignLinkAutoPost200Response
• SocialControllerUpdateCampaignLinkAutoPost200ResponseCampaignLink
• SoundtrackVolumeRequestDto
• TrackEventDto
• UpdateUserDto
• User
• UsersControllerConfirmEmail200Response
• UsersControllerCreateByEmail201Response
• UsersControllerLoginByEmail201Response
• WorkflowControllerResumeMovie200Response
• WorkflowControllerResumeMovie200ResponseDetails

Documentation For Authorization

Authentication schemes defined for the API:

access-token

• Type: Bearer authentication (JWT)

Author