api.md

Tasks

Types:

• TaskRetrieveResponse

Methods:

• client.tasks.retrieve(id) -> TaskRetrieveResponse
• client.tasks.delete(id) -> void

ImageToVideo

Types:

• ImageToVideoCreateResponse

Methods:

• client.imageToVideo.create({ ...params }) -> ImageToVideoCreateResponse

VideoToVideo

Types:

• VideoToVideoCreateResponse

Methods:

• client.videoToVideo.create({ ...params }) -> VideoToVideoCreateResponse

TextToVideo

Types:

• TextToVideoCreateResponse

Methods:

• client.textToVideo.create({ ...params }) -> TextToVideoCreateResponse

TextToImage

Types:

• TextToImageCreateResponse

Methods:

• client.textToImage.create({ ...params }) -> TextToImageCreateResponse

CharacterPerformance

Types:

• CharacterPerformanceCreateResponse

Methods:

• client.characterPerformance.create({ ...params }) -> CharacterPerformanceCreateResponse

TextToSpeech

Types:

• TextToSpeechCreateResponse

Methods:

• client.textToSpeech.create({ ...params }) -> TextToSpeechCreateResponse

SoundEffect

Types:

• SoundEffectCreateResponse

Methods:

• client.soundEffect.create({ ...params }) -> SoundEffectCreateResponse

VoiceIsolation

Types:

• VoiceIsolationCreateResponse

Methods:

• client.voiceIsolation.create({ ...params }) -> VoiceIsolationCreateResponse

VoiceDubbing

Types:

• VoiceDubbingCreateResponse

Methods:

• client.voiceDubbing.create({ ...params }) -> VoiceDubbingCreateResponse

SpeechToSpeech

Types:

• SpeechToSpeechCreateResponse

Methods:

• client.speechToSpeech.create({ ...params }) -> SpeechToSpeechCreateResponse

ImageUpscale

Types:

• ImageUpscaleCreateResponse

Methods:

• client.imageUpscale.create({ ...params }) -> ImageUpscaleCreateResponse

Organization

Types:

• OrganizationRetrieveResponse
• OrganizationRetrieveUsageResponse

Methods:

• client.organization.retrieve() -> OrganizationRetrieveResponse
• client.organization.retrieveUsage({ ...params }) -> OrganizationRetrieveUsageResponse

Avatars

Types:

• AvatarCreateResponse
• AvatarRetrieveResponse
• AvatarUpdateResponse
• AvatarListResponse
• AvatarGetUsageResponse

Methods:

• client.avatars.create({ ...params }) -> AvatarCreateResponse
• client.avatars.retrieve(id) -> AvatarRetrieveResponse
• client.avatars.update(id, { ...params }) -> AvatarUpdateResponse
• client.avatars.list({ ...params }) -> AvatarListResponsesCursorPage
• client.avatars.delete(id) -> void
• client.avatars.getUsage({ ...params }) -> AvatarGetUsageResponse

AvatarConversations

Types:

• AvatarConversationRetrieveResponse
• AvatarConversationListResponse

Methods:

• client.avatarConversations.retrieve(id) -> AvatarConversationRetrieveResponse
• client.avatarConversations.list({ ...params }) -> AvatarConversationListResponsesCursorPage
• client.avatarConversations.delete(id) -> void

AvatarVideos

Types:

• AvatarVideoCreateResponse

Methods:

• client.avatarVideos.create({ ...params }) -> AvatarVideoCreateResponse

Documents

Types:

• DocumentCreateResponse
• DocumentRetrieveResponse
• DocumentListResponse

Methods:

• client.documents.create({ ...params }) -> DocumentCreateResponse
• client.documents.retrieve(id) -> DocumentRetrieveResponse
• client.documents.update(id, { ...params }) -> void
• client.documents.list({ ...params }) -> DocumentListResponsesCursorPage
• client.documents.delete(id) -> void

RealtimeSessions

Types:

• RealtimeSessionCreateResponse
• RealtimeSessionRetrieveResponse

Methods:

• client.realtimeSessions.create({ ...params }) -> RealtimeSessionCreateResponse
• client.realtimeSessions.retrieve(id) -> RealtimeSessionRetrieveResponse
• client.realtimeSessions.delete(id) -> void

Recipes

Types:

• RecipeMarketingStockImageResponse
• RecipeMultiShotVideoResponse
• RecipeProductAdResponse
• RecipeProductCampaignImageResponse
• RecipeProductSwapResponse
• RecipeProductUgcResponse

Methods:

• client.recipes.marketingStockImage({ ...params }) -> RecipeMarketingStockImageResponse
• client.recipes.multiShotVideo({ ...params }) -> RecipeMultiShotVideoResponse
• client.recipes.productAd({ ...params }) -> RecipeProductAdResponse
• client.recipes.productCampaignImage({ ...params }) -> RecipeProductCampaignImageResponse
• client.recipes.productSwap({ ...params }) -> RecipeProductSwapResponse
• client.recipes.productUgc({ ...params }) -> RecipeProductUgcResponse

Voices

Types:

• VoiceCreateResponse
• VoiceRetrieveResponse
• VoiceUpdateResponse
• VoiceListResponse
• VoicePreviewResponse

Methods:

• client.voices.create({ ...params }) -> VoiceCreateResponse
• client.voices.retrieve(id) -> VoiceRetrieveResponse
• client.voices.update(id, { ...params }) -> VoiceUpdateResponse
• client.voices.list({ ...params }) -> VoiceListResponsesCursorPage
• client.voices.delete(id) -> void
• client.voices.preview({ ...params }) -> VoicePreviewResponse

Workflows

Types:

• WorkflowRetrieveResponse
• WorkflowListResponse
• WorkflowRunResponse

Methods:

• client.workflows.retrieve(id) -> WorkflowRetrieveResponse
• client.workflows.list() -> WorkflowListResponse
• client.workflows.run(id, { ...params }) -> WorkflowRunResponse

WorkflowInvocations

Types:

• WorkflowInvocationRetrieveResponse

Methods:

• client.workflowInvocations.retrieve(id) -> WorkflowInvocationRetrieveResponse