@sync.so/sdk 0.3.0 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/Client.d.ts +28 -1
- package/Client.js +53 -8
- package/api/resources/account/client/Client.d.ts +45 -0
- package/api/resources/account/client/Client.js +130 -0
- package/api/resources/account/client/index.d.ts +1 -0
- package/api/resources/account/client/index.js +2 -0
- package/api/resources/account/index.d.ts +2 -0
- package/api/resources/account/index.js +18 -0
- package/api/resources/account/types/AccountActiveJobs.d.ts +9 -0
- package/api/resources/account/types/AccountActiveJobs.js +5 -0
- package/api/resources/account/types/AccountAllowanceUsage.d.ts +11 -0
- package/api/resources/account/types/AccountAllowanceUsage.js +5 -0
- package/api/resources/account/types/AccountBillingModel.d.ts +10 -0
- package/api/resources/account/types/AccountBillingModel.js +12 -0
- package/api/resources/account/types/AccountBillingPeriod.d.ts +7 -0
- package/api/resources/account/types/AccountBillingPeriod.js +5 -0
- package/api/resources/account/types/AccountCredentialType.d.ts +9 -0
- package/api/resources/account/types/AccountCredentialType.js +11 -0
- package/api/resources/account/types/AccountCredits.d.ts +11 -0
- package/api/resources/account/types/AccountCredits.js +5 -0
- package/api/resources/account/types/AccountFreeAllowance.d.ts +12 -0
- package/api/resources/account/types/AccountFreeAllowance.js +5 -0
- package/api/resources/account/types/AccountLimits.d.ts +13 -0
- package/api/resources/account/types/AccountLimits.js +5 -0
- package/api/resources/account/types/AccountOrganization.d.ts +9 -0
- package/api/resources/account/types/AccountOrganization.js +5 -0
- package/api/resources/account/types/AccountOverview.d.ts +31 -0
- package/api/resources/account/types/AccountOverview.js +5 -0
- package/api/resources/account/types/AccountPlan.d.ts +9 -0
- package/api/resources/account/types/AccountPlan.js +5 -0
- package/api/resources/account/types/AccountUser.d.ts +8 -0
- package/api/resources/account/types/AccountUser.js +5 -0
- package/api/resources/account/types/index.d.ts +12 -0
- package/api/resources/account/types/index.js +28 -0
- package/api/resources/assets/client/Client.d.ts +80 -1
- package/api/resources/assets/client/Client.js +296 -2
- package/api/resources/batch/client/Client.d.ts +283 -2
- package/api/resources/batch/client/Client.js +342 -4
- package/api/resources/batch/client/requests/CreateBatchFromRowsRequest.d.ts +279 -0
- package/api/resources/batch/client/requests/CreateBatchFromRowsRequest.js +5 -0
- package/api/resources/batch/client/requests/CreateBatchRequest.d.ts +2 -2
- package/api/resources/batch/client/requests/index.d.ts +1 -0
- package/api/resources/common/errors/ConflictError.d.ts +9 -0
- package/api/resources/common/errors/ConflictError.js +52 -0
- package/api/resources/common/errors/ForbiddenError.d.ts +9 -0
- package/api/resources/common/errors/ForbiddenError.js +52 -0
- package/api/resources/common/errors/GatewayTimeoutError.d.ts +9 -0
- package/api/resources/common/errors/GatewayTimeoutError.js +52 -0
- package/api/resources/common/errors/GenerationDeletedError.d.ts +9 -0
- package/api/resources/common/errors/GenerationDeletedError.js +52 -0
- package/api/resources/common/errors/GenerationTooManyRequestsError.d.ts +9 -0
- package/api/resources/common/errors/GenerationTooManyRequestsError.js +52 -0
- package/api/resources/common/errors/PayloadTooLargeError.d.ts +9 -0
- package/api/resources/common/errors/PayloadTooLargeError.js +52 -0
- package/api/resources/common/errors/ServiceUnavailableError.d.ts +9 -0
- package/api/resources/common/errors/ServiceUnavailableError.js +52 -0
- package/api/resources/common/errors/TooManyRequestsError.d.ts +1 -1
- package/api/resources/common/errors/UnprocessableEntityError.d.ts +9 -0
- package/api/resources/common/errors/UnprocessableEntityError.js +52 -0
- package/api/resources/common/errors/VoiceCloneTooManyRequestsError.d.ts +9 -0
- package/api/resources/common/errors/VoiceCloneTooManyRequestsError.js +52 -0
- package/api/resources/common/errors/index.d.ts +9 -0
- package/api/resources/common/errors/index.js +9 -0
- package/api/resources/common/types/ActiveSpeaker.d.ts +7 -1
- package/api/resources/common/types/Asset.d.ts +4 -0
- package/api/resources/common/types/AssetInputType.d.ts +8 -1
- package/api/resources/common/types/AssetInputType.js +7 -0
- package/api/resources/common/types/AssetUploadResponse.d.ts +14 -0
- package/api/resources/common/types/AssetUploadResponse.js +5 -0
- package/api/resources/common/types/AttachProjectAssetRequest.d.ts +11 -0
- package/api/resources/common/types/AttachProjectAssetRequest.js +5 -0
- package/api/resources/common/types/BatchConcurrencyError.d.ts +23 -0
- package/api/resources/common/types/BatchConcurrencyError.js +5 -0
- package/api/resources/common/types/BatchResponse.d.ts +2 -2
- package/api/resources/common/types/BatchRow.d.ts +15 -0
- package/api/resources/common/types/BatchRow.js +5 -0
- package/api/resources/common/types/BlendingMode.d.ts +9 -0
- package/api/resources/common/types/BlendingMode.js +11 -0
- package/api/resources/common/types/ClonedVoiceResponse.d.ts +14 -0
- package/api/resources/common/types/ClonedVoiceResponse.js +5 -0
- package/api/resources/common/types/CreateAssetRequest.d.ts +33 -0
- package/api/resources/common/types/CreateAssetRequest.js +5 -0
- package/api/resources/common/types/CreateAssetUploadRequest.d.ts +14 -0
- package/api/resources/common/types/CreateAssetUploadRequest.js +5 -0
- package/api/resources/common/types/CreateDialogueEditDto.d.ts +27 -0
- package/api/resources/common/types/CreateDialogueEditDto.js +5 -0
- package/api/resources/common/types/CreateGenerationDto.d.ts +11 -3
- package/api/resources/common/types/CreateProjectRequest.d.ts +21 -0
- package/api/resources/common/types/CreateProjectRequest.js +5 -0
- package/api/resources/common/types/CreateTranscriptionDto.d.ts +21 -0
- package/api/resources/common/types/CreateTranscriptionDto.js +5 -0
- package/api/resources/common/types/CreateTtsRequest.d.ts +19 -0
- package/api/resources/common/types/CreateTtsRequest.js +5 -0
- package/api/resources/common/types/CreateVoiceRequest.d.ts +19 -0
- package/api/resources/common/types/CreateVoiceRequest.js +5 -0
- package/api/resources/common/types/CreatorWorkflow.d.ts +37 -0
- package/api/resources/common/types/CreatorWorkflow.js +15 -0
- package/api/resources/common/types/DeleteAssetResponse.d.ts +11 -0
- package/api/resources/common/types/DeleteAssetResponse.js +5 -0
- package/api/resources/common/types/DeleteProjectResponse.d.ts +11 -0
- package/api/resources/common/types/DeleteProjectResponse.js +5 -0
- package/api/resources/common/types/DialogueEditChange.d.ts +14 -0
- package/api/resources/common/types/DialogueEditChange.js +5 -0
- package/api/resources/common/types/DialogueEditError.d.ts +15 -0
- package/api/resources/common/types/DialogueEditError.js +5 -0
- package/api/resources/common/types/DialogueEditErrorCode.d.ts +18 -0
- package/api/resources/common/types/DialogueEditErrorCode.js +17 -0
- package/api/resources/common/types/DialogueEditFailedSlot.d.ts +9 -0
- package/api/resources/common/types/DialogueEditFailedSlot.js +5 -0
- package/api/resources/common/types/DialogueEditJob.d.ts +49 -0
- package/api/resources/common/types/DialogueEditJob.js +5 -0
- package/api/resources/common/types/DialogueEditJobId.d.ts +7 -0
- package/api/resources/common/types/DialogueEditJobId.js +5 -0
- package/api/resources/common/types/DialogueEditJobStatus.d.ts +14 -0
- package/api/resources/common/types/DialogueEditJobStatus.js +13 -0
- package/api/resources/common/types/DialogueEditOperation.d.ts +16 -0
- package/api/resources/common/types/DialogueEditOperation.js +5 -0
- package/api/resources/common/types/DialogueEditPartialDetail.d.ts +17 -0
- package/api/resources/common/types/DialogueEditPartialDetail.js +5 -0
- package/api/resources/common/types/DialogueEditReference.d.ts +11 -0
- package/api/resources/common/types/DialogueEditReference.js +5 -0
- package/api/resources/common/types/DialogueEditRemoval.d.ts +10 -0
- package/api/resources/common/types/DialogueEditRemoval.js +5 -0
- package/api/resources/common/types/DialogueEditResultSlot.d.ts +19 -0
- package/api/resources/common/types/DialogueEditResultSlot.js +5 -0
- package/api/resources/common/types/DialogueEditResultSlotKind.d.ts +12 -0
- package/api/resources/common/types/DialogueEditResultSlotKind.js +11 -0
- package/api/resources/common/types/DialogueEditRetimeFailureSection.d.ts +14 -0
- package/api/resources/common/types/DialogueEditRetimeFailureSection.js +5 -0
- package/api/resources/common/types/DubDto.d.ts +17 -0
- package/api/resources/common/types/DubDto.js +5 -0
- package/api/resources/common/types/DubLanguage.d.ts +105 -0
- package/api/resources/common/types/DubLanguage.js +101 -0
- package/api/resources/common/types/DubProviderName.d.ts +10 -0
- package/api/resources/common/types/DubProviderName.js +9 -0
- package/api/resources/common/types/DubSourceLanguage.d.ts +106 -0
- package/api/resources/common/types/DubSourceLanguage.js +102 -0
- package/api/resources/common/types/ErrorCatalogEntry.d.ts +14 -0
- package/api/resources/common/types/ErrorCatalogEntry.js +5 -0
- package/api/resources/common/types/EstimateBreakdown.d.ts +13 -0
- package/api/resources/common/types/EstimateBreakdown.js +5 -0
- package/api/resources/common/types/EstimateCostRequest.d.ts +16 -0
- package/api/resources/common/types/EstimateCostRequest.js +5 -0
- package/api/resources/common/types/EstimateDubbingBilling.d.ts +10 -0
- package/api/resources/common/types/EstimateDubbingBilling.js +12 -0
- package/api/resources/common/types/EstimateDubbingPart.d.ts +12 -0
- package/api/resources/common/types/EstimateDubbingPart.js +5 -0
- package/api/resources/common/types/EstimateDurationCheck.d.ts +22 -0
- package/api/resources/common/types/EstimateDurationCheck.js +5 -0
- package/api/resources/common/types/EstimateLipsyncPart.d.ts +9 -0
- package/api/resources/common/types/EstimateLipsyncPart.js +5 -0
- package/api/resources/common/types/EstimateWorkflow.d.ts +11 -0
- package/api/resources/common/types/{ModelType.js → EstimateWorkflow.js} +3 -3
- package/api/resources/common/types/EstimatedGenerationCost.d.ts +7 -0
- package/api/resources/common/types/Generation.d.ts +12 -2
- package/api/resources/common/types/GenerationConcurrencyError.d.ts +21 -0
- package/api/resources/common/types/GenerationConcurrencyError.js +5 -0
- package/api/resources/common/types/GenerationError.d.ts +16 -0
- package/api/resources/common/types/GenerationEstimate.d.ts +39 -0
- package/api/resources/common/types/GenerationEstimate.js +5 -0
- package/api/resources/common/types/GenerationEstimateConfidence.d.ts +12 -0
- package/api/resources/common/types/GenerationEstimateConfidence.js +11 -0
- package/api/resources/common/types/GenerationEstimateResolutionSource.d.ts +12 -0
- package/api/resources/common/types/GenerationEstimateResolutionSource.js +11 -0
- package/api/resources/common/types/GenerationEstimateScope.d.ts +11 -0
- package/api/resources/common/types/GenerationEstimateScope.js +10 -0
- package/api/resources/common/types/GenerationEstimateSource.d.ts +15 -0
- package/api/resources/common/types/GenerationEstimateSource.js +14 -0
- package/api/resources/common/types/GenerationOptions.d.ts +22 -4
- package/api/resources/common/types/GenerationSegment.d.ts +14 -6
- package/api/resources/common/types/Image.d.ts +16 -0
- package/api/resources/common/types/Image.js +5 -0
- package/api/resources/common/types/Input.d.ts +1 -1
- package/api/resources/common/types/Model.d.ts +2 -2
- package/api/resources/common/types/Model.js +1 -1
- package/api/resources/common/types/ModelInfo.d.ts +3 -2
- package/api/resources/common/types/OutputAudio.d.ts +10 -0
- package/api/resources/common/types/OutputAudio.js +5 -0
- package/api/resources/common/types/OutputFormat.d.ts +8 -0
- package/api/resources/common/types/OutputFormat.js +10 -0
- package/api/resources/common/types/PaginatedProjectsResponse.d.ts +13 -0
- package/api/resources/common/types/PaginatedProjectsResponse.js +5 -0
- package/api/resources/common/types/Project.d.ts +24 -0
- package/api/resources/common/types/Project.js +5 -0
- package/api/resources/common/types/ProjectGeneration.d.ts +41 -0
- package/api/resources/common/types/ProjectGeneration.js +5 -0
- package/api/resources/common/types/ProjectGenerationError.d.ts +9 -0
- package/api/resources/common/types/ProjectGenerationError.js +5 -0
- package/api/resources/common/types/ProjectGenerationInput.d.ts +18 -0
- package/api/resources/common/types/ProjectGenerationInput.js +5 -0
- package/api/resources/common/types/ProjectGenerationModel.d.ts +12 -0
- package/api/resources/common/types/ProjectGenerationModel.js +5 -0
- package/api/resources/common/types/ProjectGenerationProvider.d.ts +10 -0
- package/api/resources/common/types/ProjectGenerationProvider.js +5 -0
- package/api/resources/common/types/ProjectGenerationSegment.d.ts +14 -0
- package/api/resources/common/types/ProjectGenerationSegment.js +5 -0
- package/api/resources/common/types/ProjectId.d.ts +7 -0
- package/api/resources/common/types/ProjectId.js +5 -0
- package/api/resources/common/types/ProjectListItem.d.ts +28 -0
- package/api/resources/common/types/ProjectListItem.js +5 -0
- package/api/resources/common/types/ProjectMode.d.ts +11 -0
- package/api/resources/common/types/ProjectMode.js +10 -0
- package/api/resources/common/types/ProjectSort.d.ts +11 -0
- package/api/resources/common/types/ProjectSort.js +10 -0
- package/api/resources/common/types/ProjectVisibility.d.ts +17 -0
- package/api/resources/common/types/ProjectVisibility.js +10 -0
- package/api/resources/common/types/SegmentAudioInput.d.ts +2 -2
- package/api/resources/common/types/SegmentOptionsOverride.d.ts +17 -0
- package/api/resources/common/types/SegmentOptionsOverride.js +5 -0
- package/api/resources/common/types/SyncMode.d.ts +1 -1
- package/api/resources/common/types/Transcript.d.ts +13 -0
- package/api/resources/common/types/Transcript.js +5 -0
- package/api/resources/common/types/TranscriptSegment.d.ts +13 -0
- package/api/resources/common/types/TranscriptSegment.js +5 -0
- package/api/resources/common/types/TranscriptWord.d.ts +16 -0
- package/api/resources/common/types/TranscriptWord.js +5 -0
- package/api/resources/common/types/TranscriptionDifficulty.d.ts +13 -0
- package/api/resources/common/types/TranscriptionDifficulty.js +5 -0
- package/api/resources/common/types/TranscriptionDifficultyReason.d.ts +17 -0
- package/api/resources/common/types/TranscriptionDifficultyReason.js +16 -0
- package/api/resources/common/types/TranscriptionDifficultyTier.d.ts +12 -0
- package/api/resources/common/types/TranscriptionDifficultyTier.js +11 -0
- package/api/resources/common/types/TranscriptionError.d.ts +13 -0
- package/api/resources/common/types/TranscriptionError.js +5 -0
- package/api/resources/common/types/TranscriptionErrorCode.d.ts +16 -0
- package/api/resources/common/types/TranscriptionErrorCode.js +15 -0
- package/api/resources/common/types/TranscriptionJob.d.ts +35 -0
- package/api/resources/common/types/TranscriptionJob.js +5 -0
- package/api/resources/common/types/TranscriptionJobId.d.ts +7 -0
- package/api/resources/common/types/TranscriptionJobId.js +5 -0
- package/api/resources/common/types/TranscriptionJobStatus.d.ts +13 -0
- package/api/resources/common/types/TranscriptionJobStatus.js +12 -0
- package/api/resources/common/types/TtsGenerationResponse.d.ts +14 -0
- package/api/resources/common/types/TtsGenerationResponse.js +5 -0
- package/api/resources/common/types/TtsJob.d.ts +25 -0
- package/api/resources/common/types/TtsJob.js +5 -0
- package/api/resources/common/types/TtsJobError.d.ts +13 -0
- package/api/resources/common/types/TtsJobError.js +5 -0
- package/api/resources/common/types/TtsJobErrorCode.d.ts +16 -0
- package/api/resources/common/types/TtsJobErrorCode.js +15 -0
- package/api/resources/common/types/TtsJobStatus.d.ts +13 -0
- package/api/resources/common/types/TtsJobStatus.js +12 -0
- package/api/resources/common/types/UpdateAssetRequest.d.ts +23 -0
- package/api/resources/common/types/UpdateAssetRequest.js +5 -0
- package/api/resources/common/types/UpdateProjectRequest.d.ts +17 -0
- package/api/resources/common/types/UpdateProjectRequest.js +5 -0
- package/api/resources/common/types/Video.d.ts +2 -0
- package/api/resources/common/types/Voice.d.ts +23 -0
- package/api/resources/common/types/Voice.js +5 -0
- package/api/resources/common/types/VoiceCloneRateLimitError.d.ts +16 -0
- package/api/resources/common/types/VoiceCloneRateLimitError.js +5 -0
- package/api/resources/common/types/VoiceProvider.d.ts +10 -0
- package/api/resources/common/types/VoiceProvider.js +9 -0
- package/api/resources/common/types/VoiceRestriction.d.ts +11 -0
- package/api/resources/common/types/VoiceRestriction.js +10 -0
- package/api/resources/common/types/index.d.ts +87 -1
- package/api/resources/common/types/index.js +87 -1
- package/api/resources/dialogueEdits/client/Client.d.ts +95 -0
- package/api/resources/dialogueEdits/client/Client.js +241 -0
- package/api/resources/dialogueEdits/client/index.d.ts +1 -0
- package/api/resources/dialogueEdits/client/index.js +2 -0
- package/api/resources/dialogueEdits/index.d.ts +1 -0
- package/api/resources/dialogueEdits/index.js +17 -0
- package/api/resources/errors/client/Client.d.ts +44 -0
- package/api/resources/errors/client/Client.js +127 -0
- package/api/resources/errors/client/index.d.ts +1 -0
- package/api/resources/errors/client/index.js +2 -0
- package/api/resources/errors/index.d.ts +1 -0
- package/api/resources/errors/index.js +17 -0
- package/api/resources/feedback/client/Client.d.ts +55 -0
- package/api/resources/feedback/client/Client.js +145 -0
- package/api/resources/feedback/client/index.d.ts +1 -0
- package/api/resources/feedback/client/index.js +17 -0
- package/api/resources/feedback/client/requests/SubmitFeedbackRequest.d.ts +37 -0
- package/api/resources/feedback/client/requests/SubmitFeedbackRequest.js +5 -0
- package/api/resources/feedback/client/requests/index.d.ts +1 -0
- package/api/resources/feedback/client/requests/index.js +2 -0
- package/api/resources/feedback/errors/FeedbackTooManyRequestsError.d.ts +9 -0
- package/api/resources/feedback/errors/FeedbackTooManyRequestsError.js +52 -0
- package/api/resources/feedback/errors/index.d.ts +1 -0
- package/api/resources/feedback/errors/index.js +17 -0
- package/api/resources/feedback/index.d.ts +3 -0
- package/api/resources/feedback/index.js +19 -0
- package/api/resources/feedback/types/FeedbackClient.d.ts +9 -0
- package/api/resources/feedback/types/FeedbackClient.js +5 -0
- package/api/resources/feedback/types/FeedbackKind.d.ts +12 -0
- package/api/resources/feedback/types/FeedbackKind.js +14 -0
- package/api/resources/feedback/types/FeedbackRateLimitError.d.ts +16 -0
- package/api/resources/feedback/types/FeedbackRateLimitError.js +5 -0
- package/api/resources/feedback/types/FeedbackReceipt.d.ts +9 -0
- package/api/resources/feedback/types/FeedbackReceipt.js +5 -0
- package/api/resources/feedback/types/FeedbackSeverity.d.ts +9 -0
- package/api/resources/feedback/types/FeedbackSeverity.js +11 -0
- package/api/resources/feedback/types/FeedbackSource.d.ts +8 -0
- package/api/resources/feedback/types/FeedbackSource.js +10 -0
- package/api/resources/feedback/types/index.d.ts +6 -0
- package/api/resources/feedback/types/index.js +22 -0
- package/api/resources/generations/client/Client.d.ts +149 -19
- package/api/resources/generations/client/Client.js +366 -30
- package/api/resources/generations/client/requests/CreateGenerationJsonRequest.d.ts +51 -0
- package/api/resources/generations/client/requests/CreateGenerationJsonRequest.js +5 -0
- package/api/resources/generations/client/requests/CreateGenerationRequest.d.ts +13 -1
- package/api/resources/generations/client/requests/GetGenerationDownloadRequest.d.ts +17 -0
- package/api/resources/generations/client/requests/GetGenerationDownloadRequest.js +5 -0
- package/api/resources/generations/client/requests/GetGenerationRequest.d.ts +21 -0
- package/api/resources/generations/client/requests/GetGenerationRequest.js +5 -0
- package/api/resources/generations/client/requests/ListGenerationsRequest.d.ts +16 -0
- package/api/resources/generations/client/requests/index.d.ts +3 -0
- package/api/resources/index.d.ts +18 -0
- package/api/resources/index.js +19 -1
- package/api/resources/models/client/Client.d.ts +1 -1
- package/api/resources/models/client/Client.js +1 -1
- package/api/resources/organizations/client/Client.d.ts +46 -0
- package/api/resources/organizations/client/Client.js +137 -0
- package/api/resources/organizations/client/index.d.ts +1 -0
- package/api/resources/organizations/client/index.js +17 -0
- package/api/resources/organizations/client/requests/GetWebhookSecretRequest.d.ts +13 -0
- package/api/resources/organizations/client/requests/GetWebhookSecretRequest.js +5 -0
- package/api/resources/organizations/client/requests/index.d.ts +1 -0
- package/api/resources/organizations/client/requests/index.js +2 -0
- package/api/resources/organizations/index.d.ts +2 -0
- package/api/resources/organizations/index.js +18 -0
- package/api/resources/organizations/types/WebhookSecretResponse.d.ts +10 -0
- package/api/resources/organizations/types/WebhookSecretResponse.js +5 -0
- package/api/resources/organizations/types/index.d.ts +1 -0
- package/api/resources/organizations/types/index.js +17 -0
- package/api/resources/projects/client/Client.d.ts +159 -0
- package/api/resources/projects/client/Client.js +582 -0
- package/api/resources/projects/client/index.d.ts +1 -0
- package/api/resources/projects/client/index.js +17 -0
- package/api/resources/projects/client/requests/ListProjectsRequest.d.ts +29 -0
- package/api/resources/projects/client/requests/ListProjectsRequest.js +5 -0
- package/api/resources/projects/client/requests/index.d.ts +1 -0
- package/api/resources/projects/client/requests/index.js +2 -0
- package/api/resources/projects/index.d.ts +1 -0
- package/api/resources/projects/index.js +17 -0
- package/api/resources/transcriptions/client/Client.d.ts +67 -0
- package/api/resources/transcriptions/client/Client.js +209 -0
- package/api/resources/transcriptions/client/index.d.ts +1 -0
- package/api/resources/transcriptions/client/index.js +2 -0
- package/api/resources/transcriptions/index.d.ts +1 -0
- package/api/resources/transcriptions/index.js +17 -0
- package/api/resources/tts/client/Client.d.ts +93 -0
- package/api/resources/tts/client/Client.js +306 -0
- package/api/resources/tts/client/index.d.ts +1 -0
- package/api/resources/tts/client/index.js +17 -0
- package/api/resources/tts/client/requests/SubmitTtsJobRequest.d.ts +18 -0
- package/api/resources/tts/client/requests/SubmitTtsJobRequest.js +5 -0
- package/api/resources/tts/client/requests/index.d.ts +1 -0
- package/api/resources/tts/client/requests/index.js +2 -0
- package/api/resources/tts/index.d.ts +1 -0
- package/api/resources/tts/index.js +17 -0
- package/api/resources/voices/client/Client.d.ts +107 -0
- package/api/resources/voices/client/Client.js +369 -0
- package/api/resources/voices/client/index.d.ts +1 -0
- package/api/resources/voices/client/index.js +17 -0
- package/api/resources/voices/client/requests/GetVoiceRequest.d.ts +14 -0
- package/api/resources/voices/client/requests/GetVoiceRequest.js +5 -0
- package/api/resources/voices/client/requests/ListVoicesRequest.d.ts +14 -0
- package/api/resources/voices/client/requests/ListVoicesRequest.js +5 -0
- package/api/resources/voices/client/requests/index.d.ts +2 -0
- package/api/resources/voices/client/requests/index.js +2 -0
- package/api/resources/voices/index.d.ts +1 -0
- package/api/resources/voices/index.js +17 -0
- package/api/resources/webhooks/types/BatchNotification.d.ts +21 -0
- package/api/resources/webhooks/types/BatchNotification.js +5 -0
- package/api/resources/webhooks/types/BatchNotificationMetrics.d.ts +13 -0
- package/api/resources/webhooks/types/BatchNotificationMetrics.js +5 -0
- package/api/resources/webhooks/types/GenerationNotification.d.ts +14 -16
- package/api/resources/webhooks/types/WebhookStatus.d.ts +3 -2
- package/api/resources/webhooks/types/WebhookStatus.js +1 -0
- package/api/resources/webhooks/types/index.d.ts +2 -0
- package/api/resources/webhooks/types/index.js +2 -0
- package/dist/Client.d.ts +28 -1
- package/dist/Client.js +53 -8
- package/dist/api/resources/account/client/Client.d.ts +45 -0
- package/dist/api/resources/account/client/Client.js +130 -0
- package/dist/api/resources/account/client/index.d.ts +1 -0
- package/dist/api/resources/account/client/index.js +2 -0
- package/dist/api/resources/account/index.d.ts +2 -0
- package/dist/api/resources/account/index.js +18 -0
- package/dist/api/resources/account/types/AccountActiveJobs.d.ts +9 -0
- package/dist/api/resources/account/types/AccountActiveJobs.js +5 -0
- package/dist/api/resources/account/types/AccountAllowanceUsage.d.ts +11 -0
- package/dist/api/resources/account/types/AccountAllowanceUsage.js +5 -0
- package/dist/api/resources/account/types/AccountBillingModel.d.ts +10 -0
- package/dist/api/resources/account/types/AccountBillingModel.js +12 -0
- package/dist/api/resources/account/types/AccountBillingPeriod.d.ts +7 -0
- package/dist/api/resources/account/types/AccountBillingPeriod.js +5 -0
- package/dist/api/resources/account/types/AccountCredentialType.d.ts +9 -0
- package/dist/api/resources/account/types/AccountCredentialType.js +11 -0
- package/dist/api/resources/account/types/AccountCredits.d.ts +11 -0
- package/dist/api/resources/account/types/AccountCredits.js +5 -0
- package/dist/api/resources/account/types/AccountFreeAllowance.d.ts +12 -0
- package/dist/api/resources/account/types/AccountFreeAllowance.js +5 -0
- package/dist/api/resources/account/types/AccountLimits.d.ts +13 -0
- package/dist/api/resources/account/types/AccountLimits.js +5 -0
- package/dist/api/resources/account/types/AccountOrganization.d.ts +9 -0
- package/dist/api/resources/account/types/AccountOrganization.js +5 -0
- package/dist/api/resources/account/types/AccountOverview.d.ts +31 -0
- package/dist/api/resources/account/types/AccountOverview.js +5 -0
- package/dist/api/resources/account/types/AccountPlan.d.ts +9 -0
- package/dist/api/resources/account/types/AccountPlan.js +5 -0
- package/dist/api/resources/account/types/AccountUser.d.ts +8 -0
- package/dist/api/resources/account/types/AccountUser.js +5 -0
- package/dist/api/resources/account/types/index.d.ts +12 -0
- package/dist/api/resources/account/types/index.js +28 -0
- package/dist/api/resources/assets/client/Client.d.ts +80 -1
- package/dist/api/resources/assets/client/Client.js +296 -2
- package/dist/api/resources/batch/client/Client.d.ts +283 -2
- package/dist/api/resources/batch/client/Client.js +342 -4
- package/dist/api/resources/batch/client/requests/CreateBatchFromRowsRequest.d.ts +279 -0
- package/dist/api/resources/batch/client/requests/CreateBatchFromRowsRequest.js +5 -0
- package/dist/api/resources/batch/client/requests/CreateBatchRequest.d.ts +2 -2
- package/dist/api/resources/batch/client/requests/index.d.ts +1 -0
- package/dist/api/resources/common/errors/ConflictError.d.ts +9 -0
- package/dist/api/resources/common/errors/ConflictError.js +52 -0
- package/dist/api/resources/common/errors/ForbiddenError.d.ts +9 -0
- package/dist/api/resources/common/errors/ForbiddenError.js +52 -0
- package/dist/api/resources/common/errors/GatewayTimeoutError.d.ts +9 -0
- package/dist/api/resources/common/errors/GatewayTimeoutError.js +52 -0
- package/dist/api/resources/common/errors/GenerationDeletedError.d.ts +9 -0
- package/dist/api/resources/common/errors/GenerationDeletedError.js +52 -0
- package/dist/api/resources/common/errors/GenerationTooManyRequestsError.d.ts +9 -0
- package/dist/api/resources/common/errors/GenerationTooManyRequestsError.js +52 -0
- package/dist/api/resources/common/errors/PayloadTooLargeError.d.ts +9 -0
- package/dist/api/resources/common/errors/PayloadTooLargeError.js +52 -0
- package/dist/api/resources/common/errors/ServiceUnavailableError.d.ts +9 -0
- package/dist/api/resources/common/errors/ServiceUnavailableError.js +52 -0
- package/dist/api/resources/common/errors/TooManyRequestsError.d.ts +1 -1
- package/dist/api/resources/common/errors/UnprocessableEntityError.d.ts +9 -0
- package/dist/api/resources/common/errors/UnprocessableEntityError.js +52 -0
- package/dist/api/resources/common/errors/VoiceCloneTooManyRequestsError.d.ts +9 -0
- package/dist/api/resources/common/errors/VoiceCloneTooManyRequestsError.js +52 -0
- package/dist/api/resources/common/errors/index.d.ts +9 -0
- package/dist/api/resources/common/errors/index.js +9 -0
- package/dist/api/resources/common/types/ActiveSpeaker.d.ts +7 -1
- package/dist/api/resources/common/types/Asset.d.ts +4 -0
- package/dist/api/resources/common/types/AssetInputType.d.ts +8 -1
- package/dist/api/resources/common/types/AssetInputType.js +7 -0
- package/dist/api/resources/common/types/AssetUploadResponse.d.ts +14 -0
- package/dist/api/resources/common/types/AssetUploadResponse.js +5 -0
- package/dist/api/resources/common/types/AttachProjectAssetRequest.d.ts +11 -0
- package/dist/api/resources/common/types/AttachProjectAssetRequest.js +5 -0
- package/dist/api/resources/common/types/BatchConcurrencyError.d.ts +23 -0
- package/dist/api/resources/common/types/BatchConcurrencyError.js +5 -0
- package/dist/api/resources/common/types/BatchResponse.d.ts +2 -2
- package/dist/api/resources/common/types/BatchRow.d.ts +15 -0
- package/dist/api/resources/common/types/BatchRow.js +5 -0
- package/dist/api/resources/common/types/BlendingMode.d.ts +9 -0
- package/dist/api/resources/common/types/BlendingMode.js +11 -0
- package/dist/api/resources/common/types/ClonedVoiceResponse.d.ts +14 -0
- package/dist/api/resources/common/types/ClonedVoiceResponse.js +5 -0
- package/dist/api/resources/common/types/CreateAssetRequest.d.ts +33 -0
- package/dist/api/resources/common/types/CreateAssetRequest.js +5 -0
- package/dist/api/resources/common/types/CreateAssetUploadRequest.d.ts +14 -0
- package/dist/api/resources/common/types/CreateAssetUploadRequest.js +5 -0
- package/dist/api/resources/common/types/CreateDialogueEditDto.d.ts +27 -0
- package/dist/api/resources/common/types/CreateDialogueEditDto.js +5 -0
- package/dist/api/resources/common/types/CreateGenerationDto.d.ts +11 -3
- package/dist/api/resources/common/types/CreateProjectRequest.d.ts +21 -0
- package/dist/api/resources/common/types/CreateProjectRequest.js +5 -0
- package/dist/api/resources/common/types/CreateTranscriptionDto.d.ts +21 -0
- package/dist/api/resources/common/types/CreateTranscriptionDto.js +5 -0
- package/dist/api/resources/common/types/CreateTtsRequest.d.ts +19 -0
- package/dist/api/resources/common/types/CreateTtsRequest.js +5 -0
- package/dist/api/resources/common/types/CreateVoiceRequest.d.ts +19 -0
- package/dist/api/resources/common/types/CreateVoiceRequest.js +5 -0
- package/dist/api/resources/common/types/CreatorWorkflow.d.ts +37 -0
- package/dist/api/resources/common/types/CreatorWorkflow.js +15 -0
- package/dist/api/resources/common/types/DeleteAssetResponse.d.ts +11 -0
- package/dist/api/resources/common/types/DeleteAssetResponse.js +5 -0
- package/dist/api/resources/common/types/DeleteProjectResponse.d.ts +11 -0
- package/dist/api/resources/common/types/DeleteProjectResponse.js +5 -0
- package/dist/api/resources/common/types/DialogueEditChange.d.ts +14 -0
- package/dist/api/resources/common/types/DialogueEditChange.js +5 -0
- package/dist/api/resources/common/types/DialogueEditError.d.ts +15 -0
- package/dist/api/resources/common/types/DialogueEditError.js +5 -0
- package/dist/api/resources/common/types/DialogueEditErrorCode.d.ts +18 -0
- package/dist/api/resources/common/types/DialogueEditErrorCode.js +17 -0
- package/dist/api/resources/common/types/DialogueEditFailedSlot.d.ts +9 -0
- package/dist/api/resources/common/types/DialogueEditFailedSlot.js +5 -0
- package/dist/api/resources/common/types/DialogueEditJob.d.ts +49 -0
- package/dist/api/resources/common/types/DialogueEditJob.js +5 -0
- package/dist/api/resources/common/types/DialogueEditJobId.d.ts +7 -0
- package/dist/api/resources/common/types/DialogueEditJobId.js +5 -0
- package/dist/api/resources/common/types/DialogueEditJobStatus.d.ts +14 -0
- package/dist/api/resources/common/types/DialogueEditJobStatus.js +13 -0
- package/dist/api/resources/common/types/DialogueEditOperation.d.ts +16 -0
- package/dist/api/resources/common/types/DialogueEditOperation.js +5 -0
- package/dist/api/resources/common/types/DialogueEditPartialDetail.d.ts +17 -0
- package/dist/api/resources/common/types/DialogueEditPartialDetail.js +5 -0
- package/dist/api/resources/common/types/DialogueEditReference.d.ts +11 -0
- package/dist/api/resources/common/types/DialogueEditReference.js +5 -0
- package/dist/api/resources/common/types/DialogueEditRemoval.d.ts +10 -0
- package/dist/api/resources/common/types/DialogueEditRemoval.js +5 -0
- package/dist/api/resources/common/types/DialogueEditResultSlot.d.ts +19 -0
- package/dist/api/resources/common/types/DialogueEditResultSlot.js +5 -0
- package/dist/api/resources/common/types/DialogueEditResultSlotKind.d.ts +12 -0
- package/dist/api/resources/common/types/DialogueEditResultSlotKind.js +11 -0
- package/dist/api/resources/common/types/DialogueEditRetimeFailureSection.d.ts +14 -0
- package/dist/api/resources/common/types/DialogueEditRetimeFailureSection.js +5 -0
- package/dist/api/resources/common/types/DubDto.d.ts +17 -0
- package/dist/api/resources/common/types/DubDto.js +5 -0
- package/dist/api/resources/common/types/DubLanguage.d.ts +105 -0
- package/dist/api/resources/common/types/DubLanguage.js +101 -0
- package/dist/api/resources/common/types/DubProviderName.d.ts +10 -0
- package/dist/api/resources/common/types/DubProviderName.js +9 -0
- package/dist/api/resources/common/types/DubSourceLanguage.d.ts +106 -0
- package/dist/api/resources/common/types/DubSourceLanguage.js +102 -0
- package/dist/api/resources/common/types/ErrorCatalogEntry.d.ts +14 -0
- package/dist/api/resources/common/types/ErrorCatalogEntry.js +5 -0
- package/dist/api/resources/common/types/EstimateBreakdown.d.ts +13 -0
- package/dist/api/resources/common/types/EstimateBreakdown.js +5 -0
- package/dist/api/resources/common/types/EstimateCostRequest.d.ts +16 -0
- package/dist/api/resources/common/types/EstimateCostRequest.js +5 -0
- package/dist/api/resources/common/types/EstimateDubbingBilling.d.ts +10 -0
- package/dist/api/resources/common/types/EstimateDubbingBilling.js +12 -0
- package/dist/api/resources/common/types/EstimateDubbingPart.d.ts +12 -0
- package/dist/api/resources/common/types/EstimateDubbingPart.js +5 -0
- package/dist/api/resources/common/types/EstimateDurationCheck.d.ts +22 -0
- package/dist/api/resources/common/types/EstimateDurationCheck.js +5 -0
- package/dist/api/resources/common/types/EstimateLipsyncPart.d.ts +9 -0
- package/dist/api/resources/common/types/EstimateLipsyncPart.js +5 -0
- package/dist/api/resources/common/types/EstimateWorkflow.d.ts +11 -0
- package/dist/api/resources/common/types/{ModelType.js → EstimateWorkflow.js} +3 -3
- package/dist/api/resources/common/types/EstimatedGenerationCost.d.ts +7 -0
- package/dist/api/resources/common/types/Generation.d.ts +12 -2
- package/dist/api/resources/common/types/GenerationConcurrencyError.d.ts +21 -0
- package/dist/api/resources/common/types/GenerationConcurrencyError.js +5 -0
- package/dist/api/resources/common/types/GenerationError.d.ts +16 -0
- package/dist/api/resources/common/types/GenerationEstimate.d.ts +39 -0
- package/dist/api/resources/common/types/GenerationEstimate.js +5 -0
- package/dist/api/resources/common/types/GenerationEstimateConfidence.d.ts +12 -0
- package/dist/api/resources/common/types/GenerationEstimateConfidence.js +11 -0
- package/dist/api/resources/common/types/GenerationEstimateResolutionSource.d.ts +12 -0
- package/dist/api/resources/common/types/GenerationEstimateResolutionSource.js +11 -0
- package/dist/api/resources/common/types/GenerationEstimateScope.d.ts +11 -0
- package/dist/api/resources/common/types/GenerationEstimateScope.js +10 -0
- package/dist/api/resources/common/types/GenerationEstimateSource.d.ts +15 -0
- package/dist/api/resources/common/types/GenerationEstimateSource.js +14 -0
- package/dist/api/resources/common/types/GenerationOptions.d.ts +22 -4
- package/dist/api/resources/common/types/GenerationSegment.d.ts +14 -6
- package/dist/api/resources/common/types/Image.d.ts +16 -0
- package/dist/api/resources/common/types/Image.js +5 -0
- package/dist/api/resources/common/types/Input.d.ts +1 -1
- package/dist/api/resources/common/types/Model.d.ts +2 -2
- package/dist/api/resources/common/types/Model.js +1 -1
- package/dist/api/resources/common/types/ModelInfo.d.ts +3 -2
- package/dist/api/resources/common/types/OutputAudio.d.ts +10 -0
- package/dist/api/resources/common/types/OutputAudio.js +5 -0
- package/dist/api/resources/common/types/OutputFormat.d.ts +8 -0
- package/dist/api/resources/common/types/OutputFormat.js +10 -0
- package/dist/api/resources/common/types/PaginatedProjectsResponse.d.ts +13 -0
- package/dist/api/resources/common/types/PaginatedProjectsResponse.js +5 -0
- package/dist/api/resources/common/types/Project.d.ts +24 -0
- package/dist/api/resources/common/types/Project.js +5 -0
- package/dist/api/resources/common/types/ProjectGeneration.d.ts +41 -0
- package/dist/api/resources/common/types/ProjectGeneration.js +5 -0
- package/dist/api/resources/common/types/ProjectGenerationError.d.ts +9 -0
- package/dist/api/resources/common/types/ProjectGenerationError.js +5 -0
- package/dist/api/resources/common/types/ProjectGenerationInput.d.ts +18 -0
- package/dist/api/resources/common/types/ProjectGenerationInput.js +5 -0
- package/dist/api/resources/common/types/ProjectGenerationModel.d.ts +12 -0
- package/dist/api/resources/common/types/ProjectGenerationModel.js +5 -0
- package/dist/api/resources/common/types/ProjectGenerationProvider.d.ts +10 -0
- package/dist/api/resources/common/types/ProjectGenerationProvider.js +5 -0
- package/dist/api/resources/common/types/ProjectGenerationSegment.d.ts +14 -0
- package/dist/api/resources/common/types/ProjectGenerationSegment.js +5 -0
- package/dist/api/resources/common/types/ProjectId.d.ts +7 -0
- package/dist/api/resources/common/types/ProjectId.js +5 -0
- package/dist/api/resources/common/types/ProjectListItem.d.ts +28 -0
- package/dist/api/resources/common/types/ProjectListItem.js +5 -0
- package/dist/api/resources/common/types/ProjectMode.d.ts +11 -0
- package/dist/api/resources/common/types/ProjectMode.js +10 -0
- package/dist/api/resources/common/types/ProjectSort.d.ts +11 -0
- package/dist/api/resources/common/types/ProjectSort.js +10 -0
- package/dist/api/resources/common/types/ProjectVisibility.d.ts +17 -0
- package/dist/api/resources/common/types/ProjectVisibility.js +10 -0
- package/dist/api/resources/common/types/SegmentAudioInput.d.ts +2 -2
- package/dist/api/resources/common/types/SegmentOptionsOverride.d.ts +17 -0
- package/dist/api/resources/common/types/SegmentOptionsOverride.js +5 -0
- package/dist/api/resources/common/types/SyncMode.d.ts +1 -1
- package/dist/api/resources/common/types/Transcript.d.ts +13 -0
- package/dist/api/resources/common/types/Transcript.js +5 -0
- package/dist/api/resources/common/types/TranscriptSegment.d.ts +13 -0
- package/dist/api/resources/common/types/TranscriptSegment.js +5 -0
- package/dist/api/resources/common/types/TranscriptWord.d.ts +16 -0
- package/dist/api/resources/common/types/TranscriptWord.js +5 -0
- package/dist/api/resources/common/types/TranscriptionDifficulty.d.ts +13 -0
- package/dist/api/resources/common/types/TranscriptionDifficulty.js +5 -0
- package/dist/api/resources/common/types/TranscriptionDifficultyReason.d.ts +17 -0
- package/dist/api/resources/common/types/TranscriptionDifficultyReason.js +16 -0
- package/dist/api/resources/common/types/TranscriptionDifficultyTier.d.ts +12 -0
- package/dist/api/resources/common/types/TranscriptionDifficultyTier.js +11 -0
- package/dist/api/resources/common/types/TranscriptionError.d.ts +13 -0
- package/dist/api/resources/common/types/TranscriptionError.js +5 -0
- package/dist/api/resources/common/types/TranscriptionErrorCode.d.ts +16 -0
- package/dist/api/resources/common/types/TranscriptionErrorCode.js +15 -0
- package/dist/api/resources/common/types/TranscriptionJob.d.ts +35 -0
- package/dist/api/resources/common/types/TranscriptionJob.js +5 -0
- package/dist/api/resources/common/types/TranscriptionJobId.d.ts +7 -0
- package/dist/api/resources/common/types/TranscriptionJobId.js +5 -0
- package/dist/api/resources/common/types/TranscriptionJobStatus.d.ts +13 -0
- package/dist/api/resources/common/types/TranscriptionJobStatus.js +12 -0
- package/dist/api/resources/common/types/TtsGenerationResponse.d.ts +14 -0
- package/dist/api/resources/common/types/TtsGenerationResponse.js +5 -0
- package/dist/api/resources/common/types/TtsJob.d.ts +25 -0
- package/dist/api/resources/common/types/TtsJob.js +5 -0
- package/dist/api/resources/common/types/TtsJobError.d.ts +13 -0
- package/dist/api/resources/common/types/TtsJobError.js +5 -0
- package/dist/api/resources/common/types/TtsJobErrorCode.d.ts +16 -0
- package/dist/api/resources/common/types/TtsJobErrorCode.js +15 -0
- package/dist/api/resources/common/types/TtsJobStatus.d.ts +13 -0
- package/dist/api/resources/common/types/TtsJobStatus.js +12 -0
- package/dist/api/resources/common/types/UpdateAssetRequest.d.ts +23 -0
- package/dist/api/resources/common/types/UpdateAssetRequest.js +5 -0
- package/dist/api/resources/common/types/UpdateProjectRequest.d.ts +17 -0
- package/dist/api/resources/common/types/UpdateProjectRequest.js +5 -0
- package/dist/api/resources/common/types/Video.d.ts +2 -0
- package/dist/api/resources/common/types/Voice.d.ts +23 -0
- package/dist/api/resources/common/types/Voice.js +5 -0
- package/dist/api/resources/common/types/VoiceCloneRateLimitError.d.ts +16 -0
- package/dist/api/resources/common/types/VoiceCloneRateLimitError.js +5 -0
- package/dist/api/resources/common/types/VoiceProvider.d.ts +10 -0
- package/dist/api/resources/common/types/VoiceProvider.js +9 -0
- package/dist/api/resources/common/types/VoiceRestriction.d.ts +11 -0
- package/dist/api/resources/common/types/VoiceRestriction.js +10 -0
- package/dist/api/resources/common/types/index.d.ts +87 -1
- package/dist/api/resources/common/types/index.js +87 -1
- package/dist/api/resources/dialogueEdits/client/Client.d.ts +95 -0
- package/dist/api/resources/dialogueEdits/client/Client.js +241 -0
- package/dist/api/resources/dialogueEdits/client/index.d.ts +1 -0
- package/dist/api/resources/dialogueEdits/client/index.js +2 -0
- package/dist/api/resources/dialogueEdits/index.d.ts +1 -0
- package/dist/api/resources/dialogueEdits/index.js +17 -0
- package/dist/api/resources/errors/client/Client.d.ts +44 -0
- package/dist/api/resources/errors/client/Client.js +127 -0
- package/dist/api/resources/errors/client/index.d.ts +1 -0
- package/dist/api/resources/errors/client/index.js +2 -0
- package/dist/api/resources/errors/index.d.ts +1 -0
- package/dist/api/resources/errors/index.js +17 -0
- package/dist/api/resources/feedback/client/Client.d.ts +55 -0
- package/dist/api/resources/feedback/client/Client.js +145 -0
- package/dist/api/resources/feedback/client/index.d.ts +1 -0
- package/dist/api/resources/feedback/client/index.js +17 -0
- package/dist/api/resources/feedback/client/requests/SubmitFeedbackRequest.d.ts +37 -0
- package/dist/api/resources/feedback/client/requests/SubmitFeedbackRequest.js +5 -0
- package/dist/api/resources/feedback/client/requests/index.d.ts +1 -0
- package/dist/api/resources/feedback/client/requests/index.js +2 -0
- package/dist/api/resources/feedback/errors/FeedbackTooManyRequestsError.d.ts +9 -0
- package/dist/api/resources/feedback/errors/FeedbackTooManyRequestsError.js +52 -0
- package/dist/api/resources/feedback/errors/index.d.ts +1 -0
- package/dist/api/resources/feedback/errors/index.js +17 -0
- package/dist/api/resources/feedback/index.d.ts +3 -0
- package/dist/api/resources/feedback/index.js +19 -0
- package/dist/api/resources/feedback/types/FeedbackClient.d.ts +9 -0
- package/dist/api/resources/feedback/types/FeedbackClient.js +5 -0
- package/dist/api/resources/feedback/types/FeedbackKind.d.ts +12 -0
- package/dist/api/resources/feedback/types/FeedbackKind.js +14 -0
- package/dist/api/resources/feedback/types/FeedbackRateLimitError.d.ts +16 -0
- package/dist/api/resources/feedback/types/FeedbackRateLimitError.js +5 -0
- package/dist/api/resources/feedback/types/FeedbackReceipt.d.ts +9 -0
- package/dist/api/resources/feedback/types/FeedbackReceipt.js +5 -0
- package/dist/api/resources/feedback/types/FeedbackSeverity.d.ts +9 -0
- package/dist/api/resources/feedback/types/FeedbackSeverity.js +11 -0
- package/dist/api/resources/feedback/types/FeedbackSource.d.ts +8 -0
- package/dist/api/resources/feedback/types/FeedbackSource.js +10 -0
- package/dist/api/resources/feedback/types/index.d.ts +6 -0
- package/dist/api/resources/feedback/types/index.js +22 -0
- package/dist/api/resources/generations/client/Client.d.ts +149 -19
- package/dist/api/resources/generations/client/Client.js +366 -30
- package/dist/api/resources/generations/client/requests/CreateGenerationJsonRequest.d.ts +51 -0
- package/dist/api/resources/generations/client/requests/CreateGenerationJsonRequest.js +5 -0
- package/dist/api/resources/generations/client/requests/CreateGenerationRequest.d.ts +13 -1
- package/dist/api/resources/generations/client/requests/GetGenerationDownloadRequest.d.ts +17 -0
- package/dist/api/resources/generations/client/requests/GetGenerationDownloadRequest.js +5 -0
- package/dist/api/resources/generations/client/requests/GetGenerationRequest.d.ts +21 -0
- package/dist/api/resources/generations/client/requests/GetGenerationRequest.js +5 -0
- package/dist/api/resources/generations/client/requests/ListGenerationsRequest.d.ts +16 -0
- package/dist/api/resources/generations/client/requests/index.d.ts +3 -0
- package/dist/api/resources/index.d.ts +18 -0
- package/dist/api/resources/index.js +19 -1
- package/dist/api/resources/models/client/Client.d.ts +1 -1
- package/dist/api/resources/models/client/Client.js +1 -1
- package/dist/api/resources/organizations/client/Client.d.ts +46 -0
- package/dist/api/resources/organizations/client/Client.js +137 -0
- package/dist/api/resources/organizations/client/index.d.ts +1 -0
- package/dist/api/resources/organizations/client/index.js +17 -0
- package/dist/api/resources/organizations/client/requests/GetWebhookSecretRequest.d.ts +13 -0
- package/dist/api/resources/organizations/client/requests/GetWebhookSecretRequest.js +5 -0
- package/dist/api/resources/organizations/client/requests/index.d.ts +1 -0
- package/dist/api/resources/organizations/client/requests/index.js +2 -0
- package/dist/api/resources/organizations/index.d.ts +2 -0
- package/dist/api/resources/organizations/index.js +18 -0
- package/dist/api/resources/organizations/types/WebhookSecretResponse.d.ts +10 -0
- package/dist/api/resources/organizations/types/WebhookSecretResponse.js +5 -0
- package/dist/api/resources/organizations/types/index.d.ts +1 -0
- package/dist/api/resources/organizations/types/index.js +17 -0
- package/dist/api/resources/projects/client/Client.d.ts +159 -0
- package/dist/api/resources/projects/client/Client.js +582 -0
- package/dist/api/resources/projects/client/index.d.ts +1 -0
- package/dist/api/resources/projects/client/index.js +17 -0
- package/dist/api/resources/projects/client/requests/ListProjectsRequest.d.ts +29 -0
- package/dist/api/resources/projects/client/requests/ListProjectsRequest.js +5 -0
- package/dist/api/resources/projects/client/requests/index.d.ts +1 -0
- package/dist/api/resources/projects/client/requests/index.js +2 -0
- package/dist/api/resources/projects/index.d.ts +1 -0
- package/dist/api/resources/projects/index.js +17 -0
- package/dist/api/resources/transcriptions/client/Client.d.ts +67 -0
- package/dist/api/resources/transcriptions/client/Client.js +209 -0
- package/dist/api/resources/transcriptions/client/index.d.ts +1 -0
- package/dist/api/resources/transcriptions/client/index.js +2 -0
- package/dist/api/resources/transcriptions/index.d.ts +1 -0
- package/dist/api/resources/transcriptions/index.js +17 -0
- package/dist/api/resources/tts/client/Client.d.ts +93 -0
- package/dist/api/resources/tts/client/Client.js +306 -0
- package/dist/api/resources/tts/client/index.d.ts +1 -0
- package/dist/api/resources/tts/client/index.js +17 -0
- package/dist/api/resources/tts/client/requests/SubmitTtsJobRequest.d.ts +18 -0
- package/dist/api/resources/tts/client/requests/SubmitTtsJobRequest.js +5 -0
- package/dist/api/resources/tts/client/requests/index.d.ts +1 -0
- package/dist/api/resources/tts/client/requests/index.js +2 -0
- package/dist/api/resources/tts/index.d.ts +1 -0
- package/dist/api/resources/tts/index.js +17 -0
- package/dist/api/resources/voices/client/Client.d.ts +107 -0
- package/dist/api/resources/voices/client/Client.js +369 -0
- package/dist/api/resources/voices/client/index.d.ts +1 -0
- package/dist/api/resources/voices/client/index.js +17 -0
- package/dist/api/resources/voices/client/requests/GetVoiceRequest.d.ts +14 -0
- package/dist/api/resources/voices/client/requests/GetVoiceRequest.js +5 -0
- package/dist/api/resources/voices/client/requests/ListVoicesRequest.d.ts +14 -0
- package/dist/api/resources/voices/client/requests/ListVoicesRequest.js +5 -0
- package/dist/api/resources/voices/client/requests/index.d.ts +2 -0
- package/dist/api/resources/voices/client/requests/index.js +2 -0
- package/dist/api/resources/voices/index.d.ts +1 -0
- package/dist/api/resources/voices/index.js +17 -0
- package/dist/api/resources/webhooks/types/BatchNotification.d.ts +21 -0
- package/dist/api/resources/webhooks/types/BatchNotification.js +5 -0
- package/dist/api/resources/webhooks/types/BatchNotificationMetrics.d.ts +13 -0
- package/dist/api/resources/webhooks/types/BatchNotificationMetrics.js +5 -0
- package/dist/api/resources/webhooks/types/GenerationNotification.d.ts +14 -16
- package/dist/api/resources/webhooks/types/WebhookStatus.d.ts +3 -2
- package/dist/api/resources/webhooks/types/WebhookStatus.js +1 -0
- package/dist/api/resources/webhooks/types/index.d.ts +2 -0
- package/dist/api/resources/webhooks/types/index.js +2 -0
- package/dist/environments.d.ts +2 -1
- package/dist/environments.js +1 -0
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/environments.d.ts +2 -1
- package/environments.js +1 -0
- package/package.json +1 -1
- package/reference.md +2475 -110
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/api/resources/common/types/ModelType.d.ts +0 -11
- package/dist/api/resources/common/types/ModelType.d.ts +0 -11
package/reference.md
CHANGED
|
@@ -1,21 +1,2270 @@
|
|
|
1
1
|
# Reference
|
|
2
2
|
|
|
3
|
+
## Account
|
|
4
|
+
|
|
5
|
+
<details><summary><code>client.account.<a href="/src/api/resources/account/client/Client.ts">get</a>() -> Sync.AccountOverview</code></summary>
|
|
6
|
+
<dl>
|
|
7
|
+
<dd>
|
|
8
|
+
|
|
9
|
+
#### 📝 Description
|
|
10
|
+
|
|
11
|
+
<dl>
|
|
12
|
+
<dd>
|
|
13
|
+
|
|
14
|
+
<dl>
|
|
15
|
+
<dd>
|
|
16
|
+
|
|
17
|
+
Get the account, plan, limits and balance behind these credentials. Call it before submitting work to check plan limits and remaining credits or free allowance, and after a 402, 403 or 429 to decide how to recover: `billingModel` says whether to top up credits (`credits`), pay or update the payment method (`usage`), upgrade (`free`) or contact sync. (`enterprise`). Send people to `billingUrl` for anything that needs a payment.
|
|
18
|
+
</dd>
|
|
19
|
+
</dl>
|
|
20
|
+
</dd>
|
|
21
|
+
</dl>
|
|
22
|
+
|
|
23
|
+
#### 🔌 Usage
|
|
24
|
+
|
|
25
|
+
<dl>
|
|
26
|
+
<dd>
|
|
27
|
+
|
|
28
|
+
<dl>
|
|
29
|
+
<dd>
|
|
30
|
+
|
|
31
|
+
```typescript
|
|
32
|
+
await client.account.get();
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
</dd>
|
|
36
|
+
</dl>
|
|
37
|
+
</dd>
|
|
38
|
+
</dl>
|
|
39
|
+
|
|
40
|
+
#### ⚙️ Parameters
|
|
41
|
+
|
|
42
|
+
<dl>
|
|
43
|
+
<dd>
|
|
44
|
+
|
|
45
|
+
<dl>
|
|
46
|
+
<dd>
|
|
47
|
+
|
|
48
|
+
**requestOptions:** `Account.RequestOptions`
|
|
49
|
+
|
|
50
|
+
</dd>
|
|
51
|
+
</dl>
|
|
52
|
+
</dd>
|
|
53
|
+
</dl>
|
|
54
|
+
|
|
55
|
+
</dd>
|
|
56
|
+
</dl>
|
|
57
|
+
</details>
|
|
58
|
+
|
|
3
59
|
## Assets
|
|
4
60
|
|
|
5
|
-
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">list</a>({ ...params }) -> Sync.PaginatedAssetsResponse</code></summary>
|
|
61
|
+
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">list</a>({ ...params }) -> Sync.PaginatedAssetsResponse</code></summary>
|
|
62
|
+
<dl>
|
|
63
|
+
<dd>
|
|
64
|
+
|
|
65
|
+
#### 📝 Description
|
|
66
|
+
|
|
67
|
+
<dl>
|
|
68
|
+
<dd>
|
|
69
|
+
|
|
70
|
+
<dl>
|
|
71
|
+
<dd>
|
|
72
|
+
|
|
73
|
+
List all assets in your organization's media library.
|
|
74
|
+
</dd>
|
|
75
|
+
</dl>
|
|
76
|
+
</dd>
|
|
77
|
+
</dl>
|
|
78
|
+
|
|
79
|
+
#### 🔌 Usage
|
|
80
|
+
|
|
81
|
+
<dl>
|
|
82
|
+
<dd>
|
|
83
|
+
|
|
84
|
+
<dl>
|
|
85
|
+
<dd>
|
|
86
|
+
|
|
87
|
+
```typescript
|
|
88
|
+
await client.assets.list({
|
|
89
|
+
limit: 10,
|
|
90
|
+
sortBy: "dateDesc",
|
|
91
|
+
});
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
</dd>
|
|
95
|
+
</dl>
|
|
96
|
+
</dd>
|
|
97
|
+
</dl>
|
|
98
|
+
|
|
99
|
+
#### ⚙️ Parameters
|
|
100
|
+
|
|
101
|
+
<dl>
|
|
102
|
+
<dd>
|
|
103
|
+
|
|
104
|
+
<dl>
|
|
105
|
+
<dd>
|
|
106
|
+
|
|
107
|
+
**request:** `Sync.ListAssetsRequest`
|
|
108
|
+
|
|
109
|
+
</dd>
|
|
110
|
+
</dl>
|
|
111
|
+
|
|
112
|
+
<dl>
|
|
113
|
+
<dd>
|
|
114
|
+
|
|
115
|
+
**requestOptions:** `Assets.RequestOptions`
|
|
116
|
+
|
|
117
|
+
</dd>
|
|
118
|
+
</dl>
|
|
119
|
+
</dd>
|
|
120
|
+
</dl>
|
|
121
|
+
|
|
122
|
+
</dd>
|
|
123
|
+
</dl>
|
|
124
|
+
</details>
|
|
125
|
+
|
|
126
|
+
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">get</a>(id) -> Sync.Asset</code></summary>
|
|
127
|
+
<dl>
|
|
128
|
+
<dd>
|
|
129
|
+
|
|
130
|
+
#### 📝 Description
|
|
131
|
+
|
|
132
|
+
<dl>
|
|
133
|
+
<dd>
|
|
134
|
+
|
|
135
|
+
<dl>
|
|
136
|
+
<dd>
|
|
137
|
+
|
|
138
|
+
Retrieve a specific asset by ID.
|
|
139
|
+
</dd>
|
|
140
|
+
</dl>
|
|
141
|
+
</dd>
|
|
142
|
+
</dl>
|
|
143
|
+
|
|
144
|
+
#### 🔌 Usage
|
|
145
|
+
|
|
146
|
+
<dl>
|
|
147
|
+
<dd>
|
|
148
|
+
|
|
149
|
+
<dl>
|
|
150
|
+
<dd>
|
|
151
|
+
|
|
152
|
+
```typescript
|
|
153
|
+
await client.assets.get("550e8400-e29b-41d4-a716-446655440000");
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
</dd>
|
|
157
|
+
</dl>
|
|
158
|
+
</dd>
|
|
159
|
+
</dl>
|
|
160
|
+
|
|
161
|
+
#### ⚙️ Parameters
|
|
162
|
+
|
|
163
|
+
<dl>
|
|
164
|
+
<dd>
|
|
165
|
+
|
|
166
|
+
<dl>
|
|
167
|
+
<dd>
|
|
168
|
+
|
|
169
|
+
**id:** `Sync.AssetId`
|
|
170
|
+
|
|
171
|
+
</dd>
|
|
172
|
+
</dl>
|
|
173
|
+
|
|
174
|
+
<dl>
|
|
175
|
+
<dd>
|
|
176
|
+
|
|
177
|
+
**requestOptions:** `Assets.RequestOptions`
|
|
178
|
+
|
|
179
|
+
</dd>
|
|
180
|
+
</dl>
|
|
181
|
+
</dd>
|
|
182
|
+
</dl>
|
|
183
|
+
|
|
184
|
+
</dd>
|
|
185
|
+
</dl>
|
|
186
|
+
</details>
|
|
187
|
+
|
|
188
|
+
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">createUpload</a>({ ...params }) -> Sync.AssetUploadResponse</code></summary>
|
|
189
|
+
<dl>
|
|
190
|
+
<dd>
|
|
191
|
+
|
|
192
|
+
#### 📝 Description
|
|
193
|
+
|
|
194
|
+
<dl>
|
|
195
|
+
<dd>
|
|
196
|
+
|
|
197
|
+
<dl>
|
|
198
|
+
<dd>
|
|
199
|
+
|
|
200
|
+
Request a presigned URL to upload a local file. PUT the file bytes to the returned uploadUrl with the same Content-Type, then register the file as an asset via POST /v2/assets using the returned url. Single uploads are capped at 5GB.
|
|
201
|
+
</dd>
|
|
202
|
+
</dl>
|
|
203
|
+
</dd>
|
|
204
|
+
</dl>
|
|
205
|
+
|
|
206
|
+
#### 🔌 Usage
|
|
207
|
+
|
|
208
|
+
<dl>
|
|
209
|
+
<dd>
|
|
210
|
+
|
|
211
|
+
<dl>
|
|
212
|
+
<dd>
|
|
213
|
+
|
|
214
|
+
```typescript
|
|
215
|
+
await client.assets.createUpload({
|
|
216
|
+
fileName: "my-video.mp4",
|
|
217
|
+
contentType: "video/mp4",
|
|
218
|
+
size: 10485760,
|
|
219
|
+
});
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
</dd>
|
|
223
|
+
</dl>
|
|
224
|
+
</dd>
|
|
225
|
+
</dl>
|
|
226
|
+
|
|
227
|
+
#### ⚙️ Parameters
|
|
228
|
+
|
|
229
|
+
<dl>
|
|
230
|
+
<dd>
|
|
231
|
+
|
|
232
|
+
<dl>
|
|
233
|
+
<dd>
|
|
234
|
+
|
|
235
|
+
**request:** `Sync.CreateAssetUploadRequest`
|
|
236
|
+
|
|
237
|
+
</dd>
|
|
238
|
+
</dl>
|
|
239
|
+
|
|
240
|
+
<dl>
|
|
241
|
+
<dd>
|
|
242
|
+
|
|
243
|
+
**requestOptions:** `Assets.RequestOptions`
|
|
244
|
+
|
|
245
|
+
</dd>
|
|
246
|
+
</dl>
|
|
247
|
+
</dd>
|
|
248
|
+
</dl>
|
|
249
|
+
|
|
250
|
+
</dd>
|
|
251
|
+
</dl>
|
|
252
|
+
</details>
|
|
253
|
+
|
|
254
|
+
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">create</a>({ ...params }) -> Sync.Asset</code></summary>
|
|
255
|
+
<dl>
|
|
256
|
+
<dd>
|
|
257
|
+
|
|
258
|
+
#### 📝 Description
|
|
259
|
+
|
|
260
|
+
<dl>
|
|
261
|
+
<dd>
|
|
262
|
+
|
|
263
|
+
<dl>
|
|
264
|
+
<dd>
|
|
265
|
+
|
|
266
|
+
Register a media URL as a reusable asset and get back its id. Use the id in generation inputs (input[].assetId) or as a voice clone sample. To upload a local file, first request a presigned URL via POST /v2/assets/upload, PUT the file there, then register the returned url here. Registration verifies the upload happened and enforces plan limits on the actual file size.
|
|
267
|
+
|
|
268
|
+
projectId is optional. When provided it must reference a project in your organization — a stale or foreign id is rejected with a 422 and errorCode project_not_found; omit the field if you don't need the asset attached to a project.
|
|
269
|
+
</dd>
|
|
270
|
+
</dl>
|
|
271
|
+
</dd>
|
|
272
|
+
</dl>
|
|
273
|
+
|
|
274
|
+
#### 🔌 Usage
|
|
275
|
+
|
|
276
|
+
<dl>
|
|
277
|
+
<dd>
|
|
278
|
+
|
|
279
|
+
<dl>
|
|
280
|
+
<dd>
|
|
281
|
+
|
|
282
|
+
```typescript
|
|
283
|
+
await client.assets.create({
|
|
284
|
+
url: "https://assets.sync.so/org-123/my-video.mp4",
|
|
285
|
+
type: "VIDEO",
|
|
286
|
+
name: "my-video.mp4",
|
|
287
|
+
});
|
|
288
|
+
```
|
|
289
|
+
|
|
290
|
+
</dd>
|
|
291
|
+
</dl>
|
|
292
|
+
</dd>
|
|
293
|
+
</dl>
|
|
294
|
+
|
|
295
|
+
#### ⚙️ Parameters
|
|
296
|
+
|
|
297
|
+
<dl>
|
|
298
|
+
<dd>
|
|
299
|
+
|
|
300
|
+
<dl>
|
|
301
|
+
<dd>
|
|
302
|
+
|
|
303
|
+
**request:** `Sync.CreateAssetRequest`
|
|
304
|
+
|
|
305
|
+
</dd>
|
|
306
|
+
</dl>
|
|
307
|
+
|
|
308
|
+
<dl>
|
|
309
|
+
<dd>
|
|
310
|
+
|
|
311
|
+
**requestOptions:** `Assets.RequestOptions`
|
|
312
|
+
|
|
313
|
+
</dd>
|
|
314
|
+
</dl>
|
|
315
|
+
</dd>
|
|
316
|
+
</dl>
|
|
317
|
+
|
|
318
|
+
</dd>
|
|
319
|
+
</dl>
|
|
320
|
+
</details>
|
|
321
|
+
|
|
322
|
+
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">update</a>(id, { ...params }) -> Sync.Asset</code></summary>
|
|
323
|
+
<dl>
|
|
324
|
+
<dd>
|
|
325
|
+
|
|
326
|
+
#### 📝 Description
|
|
327
|
+
|
|
328
|
+
<dl>
|
|
329
|
+
<dd>
|
|
330
|
+
|
|
331
|
+
<dl>
|
|
332
|
+
<dd>
|
|
333
|
+
|
|
334
|
+
Update an asset's name or visibility. With API-key auth the asset must be owned by the key owner; organization-shared assets can only be updated from an admin/owner session. An asset you can view but not edit returns a 403 with errorCode asset_forbidden; an unknown id returns a 404 with errorCode asset_not_found.
|
|
335
|
+
</dd>
|
|
336
|
+
</dl>
|
|
337
|
+
</dd>
|
|
338
|
+
</dl>
|
|
339
|
+
|
|
340
|
+
#### 🔌 Usage
|
|
341
|
+
|
|
342
|
+
<dl>
|
|
343
|
+
<dd>
|
|
344
|
+
|
|
345
|
+
<dl>
|
|
346
|
+
<dd>
|
|
347
|
+
|
|
348
|
+
```typescript
|
|
349
|
+
await client.assets.update("550e8400-e29b-41d4-a716-446655440000", {
|
|
350
|
+
name: "Renamed asset",
|
|
351
|
+
});
|
|
352
|
+
```
|
|
353
|
+
|
|
354
|
+
</dd>
|
|
355
|
+
</dl>
|
|
356
|
+
</dd>
|
|
357
|
+
</dl>
|
|
358
|
+
|
|
359
|
+
#### ⚙️ Parameters
|
|
360
|
+
|
|
361
|
+
<dl>
|
|
362
|
+
<dd>
|
|
363
|
+
|
|
364
|
+
<dl>
|
|
365
|
+
<dd>
|
|
366
|
+
|
|
367
|
+
**id:** `Sync.AssetId`
|
|
368
|
+
|
|
369
|
+
</dd>
|
|
370
|
+
</dl>
|
|
371
|
+
|
|
372
|
+
<dl>
|
|
373
|
+
<dd>
|
|
374
|
+
|
|
375
|
+
**request:** `Sync.UpdateAssetRequest`
|
|
376
|
+
|
|
377
|
+
</dd>
|
|
378
|
+
</dl>
|
|
379
|
+
|
|
380
|
+
<dl>
|
|
381
|
+
<dd>
|
|
382
|
+
|
|
383
|
+
**requestOptions:** `Assets.RequestOptions`
|
|
384
|
+
|
|
385
|
+
</dd>
|
|
386
|
+
</dl>
|
|
387
|
+
</dd>
|
|
388
|
+
</dl>
|
|
389
|
+
|
|
390
|
+
</dd>
|
|
391
|
+
</dl>
|
|
392
|
+
</details>
|
|
393
|
+
|
|
394
|
+
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">delete</a>(id) -> Sync.DeleteAssetResponse</code></summary>
|
|
395
|
+
<dl>
|
|
396
|
+
<dd>
|
|
397
|
+
|
|
398
|
+
#### 📝 Description
|
|
399
|
+
|
|
400
|
+
<dl>
|
|
401
|
+
<dd>
|
|
402
|
+
|
|
403
|
+
<dl>
|
|
404
|
+
<dd>
|
|
405
|
+
|
|
406
|
+
Delete an asset. With API-key auth the asset must be owned by the key owner; organization-shared assets can only be deleted from an admin/owner session. An asset you can view but not delete returns a 403 with errorCode asset_forbidden; an unknown id returns a 404 with errorCode asset_not_found.
|
|
407
|
+
</dd>
|
|
408
|
+
</dl>
|
|
409
|
+
</dd>
|
|
410
|
+
</dl>
|
|
411
|
+
|
|
412
|
+
#### 🔌 Usage
|
|
413
|
+
|
|
414
|
+
<dl>
|
|
415
|
+
<dd>
|
|
416
|
+
|
|
417
|
+
<dl>
|
|
418
|
+
<dd>
|
|
419
|
+
|
|
420
|
+
```typescript
|
|
421
|
+
await client.assets.delete("550e8400-e29b-41d4-a716-446655440000");
|
|
422
|
+
```
|
|
423
|
+
|
|
424
|
+
</dd>
|
|
425
|
+
</dl>
|
|
426
|
+
</dd>
|
|
427
|
+
</dl>
|
|
428
|
+
|
|
429
|
+
#### ⚙️ Parameters
|
|
430
|
+
|
|
431
|
+
<dl>
|
|
432
|
+
<dd>
|
|
433
|
+
|
|
434
|
+
<dl>
|
|
435
|
+
<dd>
|
|
436
|
+
|
|
437
|
+
**id:** `Sync.AssetId`
|
|
438
|
+
|
|
439
|
+
</dd>
|
|
440
|
+
</dl>
|
|
441
|
+
|
|
442
|
+
<dl>
|
|
443
|
+
<dd>
|
|
444
|
+
|
|
445
|
+
**requestOptions:** `Assets.RequestOptions`
|
|
446
|
+
|
|
447
|
+
</dd>
|
|
448
|
+
</dl>
|
|
449
|
+
</dd>
|
|
450
|
+
</dl>
|
|
451
|
+
|
|
452
|
+
</dd>
|
|
453
|
+
</dl>
|
|
454
|
+
</details>
|
|
455
|
+
|
|
456
|
+
## Batch
|
|
457
|
+
|
|
458
|
+
<details><summary><code>client.batch.<a href="/src/api/resources/batch/client/Client.ts">create</a>(input, { ...params }) -> Sync.CreateBatchResponse</code></summary>
|
|
459
|
+
<dl>
|
|
460
|
+
<dd>
|
|
461
|
+
|
|
462
|
+
#### 📝 Description
|
|
463
|
+
|
|
464
|
+
<dl>
|
|
465
|
+
<dd>
|
|
466
|
+
|
|
467
|
+
<dl>
|
|
468
|
+
<dd>
|
|
469
|
+
|
|
470
|
+
Create a batch processing job from a JSONL file. Requires a paid plan; free accounts get 402 `plan_feature_unavailable`. Send the file in multipart field `input` (or the accepted `file` alias); it must be 5 MB or smaller. On Scale and above a batch holds 20-500 records by default and is queued, holding one concurrency slot. Below Scale every record runs as a generation right away, so a batch holds 1 record up to your plan's concurrency limit: more records than that returns 400, and more records than your currently free generation slots returns 429 `concurrency_limit_reached`. Credit-billed plans reserve credits for the whole batch at submit and get 402 `insufficient_credits` when the balance is short. Each line must contain `request_id`, endpoint exactly `/v2/generate`, and a generation `payload`. To send the records as a JSON array instead of a file, use "Create Batch from Rows", the `application/json` form of the same endpoint. Errors name a refused record by its 1-based line, counting non-empty lines: dialogue edit refusals return it as `lineNumber`, other record errors only in `message`.
|
|
471
|
+
</dd>
|
|
472
|
+
</dl>
|
|
473
|
+
</dd>
|
|
474
|
+
</dl>
|
|
475
|
+
|
|
476
|
+
#### 🔌 Usage
|
|
477
|
+
|
|
478
|
+
<dl>
|
|
479
|
+
<dd>
|
|
480
|
+
|
|
481
|
+
<dl>
|
|
482
|
+
<dd>
|
|
483
|
+
|
|
484
|
+
```typescript
|
|
485
|
+
await client.batch.create(fs.createReadStream("/path/to/your/file"), {
|
|
486
|
+
webhook_url: "https://your-webhook-url.com/batch-webhook",
|
|
487
|
+
dry_run: false,
|
|
488
|
+
});
|
|
489
|
+
```
|
|
490
|
+
|
|
491
|
+
</dd>
|
|
492
|
+
</dl>
|
|
493
|
+
</dd>
|
|
494
|
+
</dl>
|
|
495
|
+
|
|
496
|
+
#### ⚙️ Parameters
|
|
497
|
+
|
|
498
|
+
<dl>
|
|
499
|
+
<dd>
|
|
500
|
+
|
|
501
|
+
<dl>
|
|
502
|
+
<dd>
|
|
503
|
+
|
|
504
|
+
**input:** `File | fs.ReadStream | Blob`
|
|
505
|
+
|
|
506
|
+
</dd>
|
|
507
|
+
</dl>
|
|
508
|
+
|
|
509
|
+
<dl>
|
|
510
|
+
<dd>
|
|
511
|
+
|
|
512
|
+
**request:** `Sync.CreateBatchRequest`
|
|
513
|
+
|
|
514
|
+
</dd>
|
|
515
|
+
</dl>
|
|
516
|
+
|
|
517
|
+
<dl>
|
|
518
|
+
<dd>
|
|
519
|
+
|
|
520
|
+
**requestOptions:** `Batch.RequestOptions`
|
|
521
|
+
|
|
522
|
+
</dd>
|
|
523
|
+
</dl>
|
|
524
|
+
</dd>
|
|
525
|
+
</dl>
|
|
526
|
+
|
|
527
|
+
</dd>
|
|
528
|
+
</dl>
|
|
529
|
+
</details>
|
|
530
|
+
|
|
531
|
+
<details><summary><code>client.batch.<a href="/src/api/resources/batch/client/Client.ts">createFromRows</a>({ ...params }) -> Sync.CreateBatchResponse</code></summary>
|
|
532
|
+
<dl>
|
|
533
|
+
<dd>
|
|
534
|
+
|
|
535
|
+
#### 📝 Description
|
|
536
|
+
|
|
537
|
+
<dl>
|
|
538
|
+
<dd>
|
|
539
|
+
|
|
540
|
+
<dl>
|
|
541
|
+
<dd>
|
|
542
|
+
|
|
543
|
+
The `application/json` form of `POST /v2/batch`, the same endpoint as "Create Batch": send the records in a `rows` array instead of a JSONL file. Each row is the same object as one JSONL line and is validated the same way: 20-500 rows by default on Scale and above, 1 row up to your free generation slots below Scale, 5 MB or smaller when serialized as JSONL, unique `request_id` values, and endpoint exactly `/v2/generate`. Errors name a refused row by its line, where line N is `rows[N-1]`: dialogue edit refusals return it as `lineNumber`, other record errors only in `message`. Requires a paid plan. In early access, enabled per organization, a row's payload can carry `dialogueEdit` to render a completed preview from POST /v2/dialogue-edits: send one video input, the video the preview was made from, and no audio input. All dialogue edit rows in a batch must come from the same source video. Each row is expanded at submit into the request POST /v2/generate builds for that preview and is charged the same. A dialogue edit row that cannot be rendered refuses the whole batch with the `/v2/generate` errorCode (for example dialogue_edit_not_found, 422) and `lineNumber`. See [Batch Processing](/api-reference/guides/batch-processing).
|
|
544
|
+
</dd>
|
|
545
|
+
</dl>
|
|
546
|
+
</dd>
|
|
547
|
+
</dl>
|
|
548
|
+
|
|
549
|
+
#### 🔌 Usage
|
|
550
|
+
|
|
551
|
+
<dl>
|
|
552
|
+
<dd>
|
|
553
|
+
|
|
554
|
+
<dl>
|
|
555
|
+
<dd>
|
|
556
|
+
|
|
557
|
+
```typescript
|
|
558
|
+
await client.batch.createFromRows({
|
|
559
|
+
rows: [
|
|
560
|
+
{
|
|
561
|
+
request_id: "line-2",
|
|
562
|
+
endpoint: "/v2/generate",
|
|
563
|
+
payload: {
|
|
564
|
+
model: "sync-3",
|
|
565
|
+
input: [
|
|
566
|
+
{
|
|
567
|
+
type: "video",
|
|
568
|
+
url: "https://assets.sync.so/docs/example-video.mp4",
|
|
569
|
+
},
|
|
570
|
+
],
|
|
571
|
+
dialogueEdit: {
|
|
572
|
+
id: "fa350e8a-0c6b-50c3-96de-7e4ce81ed0ce",
|
|
573
|
+
},
|
|
574
|
+
},
|
|
575
|
+
},
|
|
576
|
+
{
|
|
577
|
+
request_id: "line-3",
|
|
578
|
+
endpoint: "/v2/generate",
|
|
579
|
+
payload: {
|
|
580
|
+
model: "sync-3",
|
|
581
|
+
input: [
|
|
582
|
+
{
|
|
583
|
+
type: "video",
|
|
584
|
+
url: "https://assets.sync.so/docs/example-video.mp4",
|
|
585
|
+
},
|
|
586
|
+
],
|
|
587
|
+
dialogueEdit: {
|
|
588
|
+
id: "ddaea593-cf1f-5916-aaef-c60ab5f63090",
|
|
589
|
+
},
|
|
590
|
+
},
|
|
591
|
+
},
|
|
592
|
+
{
|
|
593
|
+
request_id: "line-4",
|
|
594
|
+
endpoint: "/v2/generate",
|
|
595
|
+
payload: {
|
|
596
|
+
model: "sync-3",
|
|
597
|
+
input: [
|
|
598
|
+
{
|
|
599
|
+
type: "video",
|
|
600
|
+
url: "https://assets.sync.so/docs/example-video.mp4",
|
|
601
|
+
},
|
|
602
|
+
],
|
|
603
|
+
dialogueEdit: {
|
|
604
|
+
id: "532a08cd-becc-5630-8109-58d22206db7e",
|
|
605
|
+
},
|
|
606
|
+
},
|
|
607
|
+
},
|
|
608
|
+
{
|
|
609
|
+
request_id: "line-5",
|
|
610
|
+
endpoint: "/v2/generate",
|
|
611
|
+
payload: {
|
|
612
|
+
model: "sync-3",
|
|
613
|
+
input: [
|
|
614
|
+
{
|
|
615
|
+
type: "video",
|
|
616
|
+
url: "https://assets.sync.so/docs/example-video.mp4",
|
|
617
|
+
},
|
|
618
|
+
],
|
|
619
|
+
dialogueEdit: {
|
|
620
|
+
id: "68f897e5-78e3-55d3-9ca3-d8ba0d16c5c4",
|
|
621
|
+
},
|
|
622
|
+
},
|
|
623
|
+
},
|
|
624
|
+
{
|
|
625
|
+
request_id: "line-6",
|
|
626
|
+
endpoint: "/v2/generate",
|
|
627
|
+
payload: {
|
|
628
|
+
model: "sync-3",
|
|
629
|
+
input: [
|
|
630
|
+
{
|
|
631
|
+
type: "video",
|
|
632
|
+
url: "https://assets.sync.so/docs/example-video.mp4",
|
|
633
|
+
},
|
|
634
|
+
],
|
|
635
|
+
dialogueEdit: {
|
|
636
|
+
id: "f4aa2ca8-006d-5301-baf7-4ce543188328",
|
|
637
|
+
},
|
|
638
|
+
},
|
|
639
|
+
},
|
|
640
|
+
{
|
|
641
|
+
request_id: "line-7",
|
|
642
|
+
endpoint: "/v2/generate",
|
|
643
|
+
payload: {
|
|
644
|
+
model: "sync-3",
|
|
645
|
+
input: [
|
|
646
|
+
{
|
|
647
|
+
type: "video",
|
|
648
|
+
url: "https://assets.sync.so/docs/example-video.mp4",
|
|
649
|
+
},
|
|
650
|
+
],
|
|
651
|
+
dialogueEdit: {
|
|
652
|
+
id: "636f1dd4-f4e1-508d-8cdd-6dac1dd002a3",
|
|
653
|
+
},
|
|
654
|
+
},
|
|
655
|
+
},
|
|
656
|
+
{
|
|
657
|
+
request_id: "line-8",
|
|
658
|
+
endpoint: "/v2/generate",
|
|
659
|
+
payload: {
|
|
660
|
+
model: "sync-3",
|
|
661
|
+
input: [
|
|
662
|
+
{
|
|
663
|
+
type: "video",
|
|
664
|
+
url: "https://assets.sync.so/docs/example-video.mp4",
|
|
665
|
+
},
|
|
666
|
+
],
|
|
667
|
+
dialogueEdit: {
|
|
668
|
+
id: "8f6640f5-6139-5271-ab33-f43fc91fc1ad",
|
|
669
|
+
},
|
|
670
|
+
},
|
|
671
|
+
},
|
|
672
|
+
{
|
|
673
|
+
request_id: "line-9",
|
|
674
|
+
endpoint: "/v2/generate",
|
|
675
|
+
payload: {
|
|
676
|
+
model: "sync-3",
|
|
677
|
+
input: [
|
|
678
|
+
{
|
|
679
|
+
type: "video",
|
|
680
|
+
url: "https://assets.sync.so/docs/example-video.mp4",
|
|
681
|
+
},
|
|
682
|
+
],
|
|
683
|
+
dialogueEdit: {
|
|
684
|
+
id: "6c101a02-cdd8-5ec0-9df9-1ffea33a11bd",
|
|
685
|
+
},
|
|
686
|
+
},
|
|
687
|
+
},
|
|
688
|
+
{
|
|
689
|
+
request_id: "line-10",
|
|
690
|
+
endpoint: "/v2/generate",
|
|
691
|
+
payload: {
|
|
692
|
+
model: "sync-3",
|
|
693
|
+
input: [
|
|
694
|
+
{
|
|
695
|
+
type: "video",
|
|
696
|
+
url: "https://assets.sync.so/docs/example-video.mp4",
|
|
697
|
+
},
|
|
698
|
+
],
|
|
699
|
+
dialogueEdit: {
|
|
700
|
+
id: "258f60c2-b635-5ab6-a565-ae81a709e221",
|
|
701
|
+
},
|
|
702
|
+
},
|
|
703
|
+
},
|
|
704
|
+
{
|
|
705
|
+
request_id: "line-11",
|
|
706
|
+
endpoint: "/v2/generate",
|
|
707
|
+
payload: {
|
|
708
|
+
model: "sync-3",
|
|
709
|
+
input: [
|
|
710
|
+
{
|
|
711
|
+
type: "video",
|
|
712
|
+
url: "https://assets.sync.so/docs/example-video.mp4",
|
|
713
|
+
},
|
|
714
|
+
],
|
|
715
|
+
dialogueEdit: {
|
|
716
|
+
id: "09dc425b-4d7e-5813-8c6c-81bd38993a7b",
|
|
717
|
+
},
|
|
718
|
+
},
|
|
719
|
+
},
|
|
720
|
+
{
|
|
721
|
+
request_id: "line-12",
|
|
722
|
+
endpoint: "/v2/generate",
|
|
723
|
+
payload: {
|
|
724
|
+
model: "sync-3",
|
|
725
|
+
input: [
|
|
726
|
+
{
|
|
727
|
+
type: "video",
|
|
728
|
+
url: "https://assets.sync.so/docs/example-video.mp4",
|
|
729
|
+
},
|
|
730
|
+
],
|
|
731
|
+
dialogueEdit: {
|
|
732
|
+
id: "b93c54d3-28d6-5fa3-abaf-5220c38e31a1",
|
|
733
|
+
},
|
|
734
|
+
},
|
|
735
|
+
},
|
|
736
|
+
{
|
|
737
|
+
request_id: "line-13",
|
|
738
|
+
endpoint: "/v2/generate",
|
|
739
|
+
payload: {
|
|
740
|
+
model: "sync-3",
|
|
741
|
+
input: [
|
|
742
|
+
{
|
|
743
|
+
type: "video",
|
|
744
|
+
url: "https://assets.sync.so/docs/example-video.mp4",
|
|
745
|
+
},
|
|
746
|
+
],
|
|
747
|
+
dialogueEdit: {
|
|
748
|
+
id: "e8a1dea0-b3f9-5266-badd-f8a2aae77ea3",
|
|
749
|
+
},
|
|
750
|
+
},
|
|
751
|
+
},
|
|
752
|
+
{
|
|
753
|
+
request_id: "line-14",
|
|
754
|
+
endpoint: "/v2/generate",
|
|
755
|
+
payload: {
|
|
756
|
+
model: "sync-3",
|
|
757
|
+
input: [
|
|
758
|
+
{
|
|
759
|
+
type: "video",
|
|
760
|
+
url: "https://assets.sync.so/docs/example-video.mp4",
|
|
761
|
+
},
|
|
762
|
+
],
|
|
763
|
+
dialogueEdit: {
|
|
764
|
+
id: "a09967c4-8171-582f-8dba-1ba07d55f918",
|
|
765
|
+
},
|
|
766
|
+
},
|
|
767
|
+
},
|
|
768
|
+
{
|
|
769
|
+
request_id: "line-15",
|
|
770
|
+
endpoint: "/v2/generate",
|
|
771
|
+
payload: {
|
|
772
|
+
model: "sync-3",
|
|
773
|
+
input: [
|
|
774
|
+
{
|
|
775
|
+
type: "video",
|
|
776
|
+
url: "https://assets.sync.so/docs/example-video.mp4",
|
|
777
|
+
},
|
|
778
|
+
],
|
|
779
|
+
dialogueEdit: {
|
|
780
|
+
id: "39df4e4f-b23d-54ca-99a8-f29ec567790b",
|
|
781
|
+
},
|
|
782
|
+
},
|
|
783
|
+
},
|
|
784
|
+
{
|
|
785
|
+
request_id: "line-16",
|
|
786
|
+
endpoint: "/v2/generate",
|
|
787
|
+
payload: {
|
|
788
|
+
model: "sync-3",
|
|
789
|
+
input: [
|
|
790
|
+
{
|
|
791
|
+
type: "video",
|
|
792
|
+
url: "https://assets.sync.so/docs/example-video.mp4",
|
|
793
|
+
},
|
|
794
|
+
],
|
|
795
|
+
dialogueEdit: {
|
|
796
|
+
id: "0370783a-12d5-5dfb-8736-49118428df47",
|
|
797
|
+
},
|
|
798
|
+
},
|
|
799
|
+
},
|
|
800
|
+
{
|
|
801
|
+
request_id: "line-17",
|
|
802
|
+
endpoint: "/v2/generate",
|
|
803
|
+
payload: {
|
|
804
|
+
model: "sync-3",
|
|
805
|
+
input: [
|
|
806
|
+
{
|
|
807
|
+
type: "video",
|
|
808
|
+
url: "https://assets.sync.so/docs/example-video.mp4",
|
|
809
|
+
},
|
|
810
|
+
],
|
|
811
|
+
dialogueEdit: {
|
|
812
|
+
id: "a65eecc2-ad79-5123-acf7-e81a57b2422f",
|
|
813
|
+
},
|
|
814
|
+
},
|
|
815
|
+
},
|
|
816
|
+
{
|
|
817
|
+
request_id: "line-18",
|
|
818
|
+
endpoint: "/v2/generate",
|
|
819
|
+
payload: {
|
|
820
|
+
model: "sync-3",
|
|
821
|
+
input: [
|
|
822
|
+
{
|
|
823
|
+
type: "video",
|
|
824
|
+
url: "https://assets.sync.so/docs/example-video.mp4",
|
|
825
|
+
},
|
|
826
|
+
],
|
|
827
|
+
dialogueEdit: {
|
|
828
|
+
id: "a0200ef6-d140-50bb-9784-3b9e265be374",
|
|
829
|
+
},
|
|
830
|
+
},
|
|
831
|
+
},
|
|
832
|
+
{
|
|
833
|
+
request_id: "line-19",
|
|
834
|
+
endpoint: "/v2/generate",
|
|
835
|
+
payload: {
|
|
836
|
+
model: "sync-3",
|
|
837
|
+
input: [
|
|
838
|
+
{
|
|
839
|
+
type: "video",
|
|
840
|
+
url: "https://assets.sync.so/docs/example-video.mp4",
|
|
841
|
+
},
|
|
842
|
+
],
|
|
843
|
+
dialogueEdit: {
|
|
844
|
+
id: "06cc754a-b625-58c2-ad2d-74ec08fb517a",
|
|
845
|
+
},
|
|
846
|
+
},
|
|
847
|
+
},
|
|
848
|
+
{
|
|
849
|
+
request_id: "line-20",
|
|
850
|
+
endpoint: "/v2/generate",
|
|
851
|
+
payload: {
|
|
852
|
+
model: "sync-3",
|
|
853
|
+
input: [
|
|
854
|
+
{
|
|
855
|
+
type: "video",
|
|
856
|
+
url: "https://assets.sync.so/docs/example-video.mp4",
|
|
857
|
+
},
|
|
858
|
+
],
|
|
859
|
+
dialogueEdit: {
|
|
860
|
+
id: "32889341-cc9e-59c6-b18a-32bbb525c26e",
|
|
861
|
+
},
|
|
862
|
+
},
|
|
863
|
+
},
|
|
864
|
+
{
|
|
865
|
+
request_id: "line-21",
|
|
866
|
+
endpoint: "/v2/generate",
|
|
867
|
+
payload: {
|
|
868
|
+
model: "sync-3",
|
|
869
|
+
input: [
|
|
870
|
+
{
|
|
871
|
+
type: "video",
|
|
872
|
+
url: "https://assets.sync.so/docs/example-video.mp4",
|
|
873
|
+
},
|
|
874
|
+
],
|
|
875
|
+
dialogueEdit: {
|
|
876
|
+
id: "f6568dbc-0390-5227-b107-64c3842adb3b",
|
|
877
|
+
},
|
|
878
|
+
},
|
|
879
|
+
},
|
|
880
|
+
],
|
|
881
|
+
dry_run: true,
|
|
882
|
+
});
|
|
883
|
+
```
|
|
884
|
+
|
|
885
|
+
</dd>
|
|
886
|
+
</dl>
|
|
887
|
+
</dd>
|
|
888
|
+
</dl>
|
|
889
|
+
|
|
890
|
+
#### ⚙️ Parameters
|
|
891
|
+
|
|
892
|
+
<dl>
|
|
893
|
+
<dd>
|
|
894
|
+
|
|
895
|
+
<dl>
|
|
896
|
+
<dd>
|
|
897
|
+
|
|
898
|
+
**request:** `Sync.CreateBatchFromRowsRequest`
|
|
899
|
+
|
|
900
|
+
</dd>
|
|
901
|
+
</dl>
|
|
902
|
+
|
|
903
|
+
<dl>
|
|
904
|
+
<dd>
|
|
905
|
+
|
|
906
|
+
**requestOptions:** `Batch.RequestOptions`
|
|
907
|
+
|
|
908
|
+
</dd>
|
|
909
|
+
</dl>
|
|
910
|
+
</dd>
|
|
911
|
+
</dl>
|
|
912
|
+
|
|
913
|
+
</dd>
|
|
914
|
+
</dl>
|
|
915
|
+
</details>
|
|
916
|
+
|
|
917
|
+
<details><summary><code>client.batch.<a href="/src/api/resources/batch/client/Client.ts">get</a>(id) -> Sync.BatchResponse</code></summary>
|
|
918
|
+
<dl>
|
|
919
|
+
<dd>
|
|
920
|
+
|
|
921
|
+
#### 📝 Description
|
|
922
|
+
|
|
923
|
+
<dl>
|
|
924
|
+
<dd>
|
|
925
|
+
|
|
926
|
+
<dl>
|
|
927
|
+
<dd>
|
|
928
|
+
|
|
929
|
+
Retrieve details about a specific batch, including its current status, processing metrics, and output file URL when available.
|
|
930
|
+
</dd>
|
|
931
|
+
</dl>
|
|
932
|
+
</dd>
|
|
933
|
+
</dl>
|
|
934
|
+
|
|
935
|
+
#### 🔌 Usage
|
|
936
|
+
|
|
937
|
+
<dl>
|
|
938
|
+
<dd>
|
|
939
|
+
|
|
940
|
+
<dl>
|
|
941
|
+
<dd>
|
|
942
|
+
|
|
943
|
+
```typescript
|
|
944
|
+
await client.batch.get("batch_abc123");
|
|
945
|
+
```
|
|
946
|
+
|
|
947
|
+
</dd>
|
|
948
|
+
</dl>
|
|
949
|
+
</dd>
|
|
950
|
+
</dl>
|
|
951
|
+
|
|
952
|
+
#### ⚙️ Parameters
|
|
953
|
+
|
|
954
|
+
<dl>
|
|
955
|
+
<dd>
|
|
956
|
+
|
|
957
|
+
<dl>
|
|
958
|
+
<dd>
|
|
959
|
+
|
|
960
|
+
**id:** `Sync.BatchId` — The unique identifier of the batch
|
|
961
|
+
|
|
962
|
+
</dd>
|
|
963
|
+
</dl>
|
|
964
|
+
|
|
965
|
+
<dl>
|
|
966
|
+
<dd>
|
|
967
|
+
|
|
968
|
+
**requestOptions:** `Batch.RequestOptions`
|
|
969
|
+
|
|
970
|
+
</dd>
|
|
971
|
+
</dl>
|
|
972
|
+
</dd>
|
|
973
|
+
</dl>
|
|
974
|
+
|
|
975
|
+
</dd>
|
|
976
|
+
</dl>
|
|
977
|
+
</details>
|
|
978
|
+
|
|
979
|
+
<details><summary><code>client.batch.<a href="/src/api/resources/batch/client/Client.ts">list</a>({ ...params }) -> Sync.BatchResponse[]</code></summary>
|
|
980
|
+
<dl>
|
|
981
|
+
<dd>
|
|
982
|
+
|
|
983
|
+
#### 📝 Description
|
|
984
|
+
|
|
985
|
+
<dl>
|
|
986
|
+
<dd>
|
|
987
|
+
|
|
988
|
+
<dl>
|
|
989
|
+
<dd>
|
|
990
|
+
|
|
991
|
+
List all batches for your organization with optional filtering by status and creation date. Results are ordered by creation date (newest first).
|
|
992
|
+
</dd>
|
|
993
|
+
</dl>
|
|
994
|
+
</dd>
|
|
995
|
+
</dl>
|
|
996
|
+
|
|
997
|
+
#### 🔌 Usage
|
|
998
|
+
|
|
999
|
+
<dl>
|
|
1000
|
+
<dd>
|
|
1001
|
+
|
|
1002
|
+
<dl>
|
|
1003
|
+
<dd>
|
|
1004
|
+
|
|
1005
|
+
```typescript
|
|
1006
|
+
await client.batch.list();
|
|
1007
|
+
```
|
|
1008
|
+
|
|
1009
|
+
</dd>
|
|
1010
|
+
</dl>
|
|
1011
|
+
</dd>
|
|
1012
|
+
</dl>
|
|
1013
|
+
|
|
1014
|
+
#### ⚙️ Parameters
|
|
1015
|
+
|
|
1016
|
+
<dl>
|
|
1017
|
+
<dd>
|
|
1018
|
+
|
|
1019
|
+
<dl>
|
|
1020
|
+
<dd>
|
|
1021
|
+
|
|
1022
|
+
**request:** `Sync.ListBatchesRequest`
|
|
1023
|
+
|
|
1024
|
+
</dd>
|
|
1025
|
+
</dl>
|
|
1026
|
+
|
|
1027
|
+
<dl>
|
|
1028
|
+
<dd>
|
|
1029
|
+
|
|
1030
|
+
**requestOptions:** `Batch.RequestOptions`
|
|
1031
|
+
|
|
1032
|
+
</dd>
|
|
1033
|
+
</dl>
|
|
1034
|
+
</dd>
|
|
1035
|
+
</dl>
|
|
1036
|
+
|
|
1037
|
+
</dd>
|
|
1038
|
+
</dl>
|
|
1039
|
+
</details>
|
|
1040
|
+
|
|
1041
|
+
## DialogueEdits
|
|
1042
|
+
|
|
1043
|
+
<details><summary><code>client.dialogueEdits.<a href="/src/api/resources/dialogueEdits/client/Client.ts">create</a>({ ...params }) -> Sync.DialogueEditJob</code></summary>
|
|
1044
|
+
<dl>
|
|
1045
|
+
<dd>
|
|
1046
|
+
|
|
1047
|
+
#### 📝 Description
|
|
1048
|
+
|
|
1049
|
+
<dl>
|
|
1050
|
+
<dd>
|
|
1051
|
+
|
|
1052
|
+
<dl>
|
|
1053
|
+
<dd>
|
|
1054
|
+
|
|
1055
|
+
Applies word-level edits to a transcript from `POST /v2/transcriptions` and synthesizes preview audio for the same window: only the edited spans are re-spoken in a voice cloned from the source, everything else stays the original recording. Poll `GET /v2/dialogue-edits/{id}` until `status` is `COMPLETED`, `COMPLETED_PARTIAL` or `FAILED`; a completed or partially completed job carries `previewAudioUrl`, the retimed `resultTranscript` and the edited regions as `resultSlots`. Edits that cannot be applied to the transcript are refused with a 400 before a job exists. An API-key request is admitted only for the whole video (leave startMs and endMs unset) and only when the organization's rollout enables segment lipsync and section expansion: a partial window is refused with errorCode `dialogue_edit_unsupported` (422), a rollout without both flags with `dialogue_edit_retime_required` (422), and a rollout that cannot be evaluated with `generation_infra_service_unavailable` (503; retry with backoff). Studio sessions may select a window. Normal billing, planning, duration and rate limits still apply.
|
|
1056
|
+
</dd>
|
|
1057
|
+
</dl>
|
|
1058
|
+
</dd>
|
|
1059
|
+
</dl>
|
|
1060
|
+
|
|
1061
|
+
#### 🔌 Usage
|
|
1062
|
+
|
|
1063
|
+
<dl>
|
|
1064
|
+
<dd>
|
|
1065
|
+
|
|
1066
|
+
<dl>
|
|
1067
|
+
<dd>
|
|
1068
|
+
|
|
1069
|
+
```typescript
|
|
1070
|
+
await client.dialogueEdits.create({
|
|
1071
|
+
sourceVideoUrl: "https://assets.sync.so/docs/example-video.mp4",
|
|
1072
|
+
transcript: {
|
|
1073
|
+
segments: [
|
|
1074
|
+
{
|
|
1075
|
+
id: "seg_1",
|
|
1076
|
+
words: [
|
|
1077
|
+
{
|
|
1078
|
+
id: "w_1",
|
|
1079
|
+
text: "The",
|
|
1080
|
+
startMs: 120,
|
|
1081
|
+
endMs: 260,
|
|
1082
|
+
},
|
|
1083
|
+
{
|
|
1084
|
+
id: "w_2",
|
|
1085
|
+
text: "quarterly",
|
|
1086
|
+
startMs: 260,
|
|
1087
|
+
endMs: 820,
|
|
1088
|
+
},
|
|
1089
|
+
{
|
|
1090
|
+
id: "w_3",
|
|
1091
|
+
text: "results",
|
|
1092
|
+
startMs: 820,
|
|
1093
|
+
endMs: 1240,
|
|
1094
|
+
},
|
|
1095
|
+
],
|
|
1096
|
+
},
|
|
1097
|
+
],
|
|
1098
|
+
speakerCount: 1,
|
|
1099
|
+
},
|
|
1100
|
+
edits: [
|
|
1101
|
+
{
|
|
1102
|
+
kind: "change",
|
|
1103
|
+
wordId: "w_2",
|
|
1104
|
+
replacement: "annual",
|
|
1105
|
+
},
|
|
1106
|
+
],
|
|
1107
|
+
});
|
|
1108
|
+
```
|
|
1109
|
+
|
|
1110
|
+
</dd>
|
|
1111
|
+
</dl>
|
|
1112
|
+
</dd>
|
|
1113
|
+
</dl>
|
|
1114
|
+
|
|
1115
|
+
#### ⚙️ Parameters
|
|
1116
|
+
|
|
1117
|
+
<dl>
|
|
1118
|
+
<dd>
|
|
1119
|
+
|
|
1120
|
+
<dl>
|
|
1121
|
+
<dd>
|
|
1122
|
+
|
|
1123
|
+
**request:** `Sync.CreateDialogueEditDto`
|
|
1124
|
+
|
|
1125
|
+
</dd>
|
|
1126
|
+
</dl>
|
|
1127
|
+
|
|
1128
|
+
<dl>
|
|
1129
|
+
<dd>
|
|
1130
|
+
|
|
1131
|
+
**requestOptions:** `DialogueEdits.RequestOptions`
|
|
1132
|
+
|
|
1133
|
+
</dd>
|
|
1134
|
+
</dl>
|
|
1135
|
+
</dd>
|
|
1136
|
+
</dl>
|
|
1137
|
+
|
|
1138
|
+
</dd>
|
|
1139
|
+
</dl>
|
|
1140
|
+
</details>
|
|
1141
|
+
|
|
1142
|
+
<details><summary><code>client.dialogueEdits.<a href="/src/api/resources/dialogueEdits/client/Client.ts">get</a>(id) -> Sync.DialogueEditJob</code></summary>
|
|
1143
|
+
<dl>
|
|
1144
|
+
<dd>
|
|
1145
|
+
|
|
1146
|
+
#### 📝 Description
|
|
1147
|
+
|
|
1148
|
+
<dl>
|
|
1149
|
+
<dd>
|
|
1150
|
+
|
|
1151
|
+
<dl>
|
|
1152
|
+
<dd>
|
|
1153
|
+
|
|
1154
|
+
Returns the job status and, once it completed, the preview audio url, the retimed transcript and the edited regions. `COMPLETED`, `COMPLETED_PARTIAL` and `FAILED` are terminal; `error.code` says why a job failed.
|
|
1155
|
+
</dd>
|
|
1156
|
+
</dl>
|
|
1157
|
+
</dd>
|
|
1158
|
+
</dl>
|
|
1159
|
+
|
|
1160
|
+
#### 🔌 Usage
|
|
1161
|
+
|
|
1162
|
+
<dl>
|
|
1163
|
+
<dd>
|
|
1164
|
+
|
|
1165
|
+
<dl>
|
|
1166
|
+
<dd>
|
|
1167
|
+
|
|
1168
|
+
```typescript
|
|
1169
|
+
await client.dialogueEdits.get("7644754c-bdfc-4d51-a78f-e0cb0cbbd40f");
|
|
1170
|
+
```
|
|
1171
|
+
|
|
1172
|
+
</dd>
|
|
1173
|
+
</dl>
|
|
1174
|
+
</dd>
|
|
1175
|
+
</dl>
|
|
1176
|
+
|
|
1177
|
+
#### ⚙️ Parameters
|
|
1178
|
+
|
|
1179
|
+
<dl>
|
|
1180
|
+
<dd>
|
|
1181
|
+
|
|
1182
|
+
<dl>
|
|
1183
|
+
<dd>
|
|
1184
|
+
|
|
1185
|
+
**id:** `Sync.DialogueEditJobId` — Dialogue edit job id.
|
|
1186
|
+
|
|
1187
|
+
</dd>
|
|
1188
|
+
</dl>
|
|
1189
|
+
|
|
1190
|
+
<dl>
|
|
1191
|
+
<dd>
|
|
1192
|
+
|
|
1193
|
+
**requestOptions:** `DialogueEdits.RequestOptions`
|
|
1194
|
+
|
|
1195
|
+
</dd>
|
|
1196
|
+
</dl>
|
|
1197
|
+
</dd>
|
|
1198
|
+
</dl>
|
|
1199
|
+
|
|
1200
|
+
</dd>
|
|
1201
|
+
</dl>
|
|
1202
|
+
</details>
|
|
1203
|
+
|
|
1204
|
+
## Errors
|
|
1205
|
+
|
|
1206
|
+
<details><summary><code>client.errors.<a href="/src/api/resources/errors/client/Client.ts">list</a>() -> Sync.ErrorCatalogEntry[]</code></summary>
|
|
1207
|
+
<dl>
|
|
1208
|
+
<dd>
|
|
1209
|
+
|
|
1210
|
+
#### 📝 Description
|
|
1211
|
+
|
|
1212
|
+
<dl>
|
|
1213
|
+
<dd>
|
|
1214
|
+
|
|
1215
|
+
<dl>
|
|
1216
|
+
<dd>
|
|
1217
|
+
|
|
1218
|
+
Returns the full catalog of machine-readable error codes — each with a human-readable message and a suggested fix. It covers generation failures plus the coded errors returned by the assets, voices, and TTS endpoints (e.g. project_not_found, voice_not_found, asset_forbidden). This endpoint is unauthenticated. Pair it with the errorCode field returned on a failed generation or on a coded 4xx/5xx response so an agent can look up what went wrong and how to correct it without hard-coding error strings.
|
|
1219
|
+
</dd>
|
|
1220
|
+
</dl>
|
|
1221
|
+
</dd>
|
|
1222
|
+
</dl>
|
|
1223
|
+
|
|
1224
|
+
#### 🔌 Usage
|
|
1225
|
+
|
|
1226
|
+
<dl>
|
|
1227
|
+
<dd>
|
|
1228
|
+
|
|
1229
|
+
<dl>
|
|
1230
|
+
<dd>
|
|
1231
|
+
|
|
1232
|
+
```typescript
|
|
1233
|
+
await client.errors.list();
|
|
1234
|
+
```
|
|
1235
|
+
|
|
1236
|
+
</dd>
|
|
1237
|
+
</dl>
|
|
1238
|
+
</dd>
|
|
1239
|
+
</dl>
|
|
1240
|
+
|
|
1241
|
+
#### ⚙️ Parameters
|
|
1242
|
+
|
|
1243
|
+
<dl>
|
|
1244
|
+
<dd>
|
|
1245
|
+
|
|
1246
|
+
<dl>
|
|
1247
|
+
<dd>
|
|
1248
|
+
|
|
1249
|
+
**requestOptions:** `Errors.RequestOptions`
|
|
1250
|
+
|
|
1251
|
+
</dd>
|
|
1252
|
+
</dl>
|
|
1253
|
+
</dd>
|
|
1254
|
+
</dl>
|
|
1255
|
+
|
|
1256
|
+
</dd>
|
|
1257
|
+
</dl>
|
|
1258
|
+
</details>
|
|
1259
|
+
|
|
1260
|
+
## Feedback
|
|
1261
|
+
|
|
1262
|
+
<details><summary><code>client.feedback.<a href="/src/api/resources/feedback/client/Client.ts">submit</a>({ ...params }) -> Sync.FeedbackReceipt</code></summary>
|
|
1263
|
+
<dl>
|
|
1264
|
+
<dd>
|
|
1265
|
+
|
|
1266
|
+
#### 📝 Description
|
|
1267
|
+
|
|
1268
|
+
<dl>
|
|
1269
|
+
<dd>
|
|
1270
|
+
|
|
1271
|
+
<dl>
|
|
1272
|
+
<dd>
|
|
1273
|
+
|
|
1274
|
+
Report a problem you hit with the API or the sync. MCP server, such as an error that didn't say what to fix, a wrong result, a missing capability, or a workaround you needed. Send one report per problem. The sync. team reviews reports daily. Works with an API key, an OAuth access token, or a Studio session. Submitting feedback doesn't change, retry, or cancel any job. Limited to 30 reports per minute per caller. Unknown body fields return 400.
|
|
1275
|
+
</dd>
|
|
1276
|
+
</dl>
|
|
1277
|
+
</dd>
|
|
1278
|
+
</dl>
|
|
1279
|
+
|
|
1280
|
+
#### 🔌 Usage
|
|
1281
|
+
|
|
1282
|
+
<dl>
|
|
1283
|
+
<dd>
|
|
1284
|
+
|
|
1285
|
+
<dl>
|
|
1286
|
+
<dd>
|
|
1287
|
+
|
|
1288
|
+
```typescript
|
|
1289
|
+
await client.feedback.submit({
|
|
1290
|
+
kind: "confusing_error",
|
|
1291
|
+
severity: "major",
|
|
1292
|
+
message:
|
|
1293
|
+
"POST /v2/generate returned generation_input_video_inaccessible for a presigned URL that plays in a browser. Saying whether the URL had expired or was blocked would have helped.",
|
|
1294
|
+
tool: "generations.create",
|
|
1295
|
+
errorCode: "generation_input_video_inaccessible",
|
|
1296
|
+
generationId: "6533643b-acbb-4c4f-a5b3-5ba2e5ab6b5f",
|
|
1297
|
+
});
|
|
1298
|
+
```
|
|
1299
|
+
|
|
1300
|
+
</dd>
|
|
1301
|
+
</dl>
|
|
1302
|
+
</dd>
|
|
1303
|
+
</dl>
|
|
1304
|
+
|
|
1305
|
+
#### ⚙️ Parameters
|
|
1306
|
+
|
|
1307
|
+
<dl>
|
|
1308
|
+
<dd>
|
|
1309
|
+
|
|
1310
|
+
<dl>
|
|
1311
|
+
<dd>
|
|
1312
|
+
|
|
1313
|
+
**request:** `Sync.SubmitFeedbackRequest`
|
|
1314
|
+
|
|
1315
|
+
</dd>
|
|
1316
|
+
</dl>
|
|
1317
|
+
|
|
1318
|
+
<dl>
|
|
1319
|
+
<dd>
|
|
1320
|
+
|
|
1321
|
+
**requestOptions:** `Feedback.RequestOptions`
|
|
1322
|
+
|
|
1323
|
+
</dd>
|
|
1324
|
+
</dl>
|
|
1325
|
+
</dd>
|
|
1326
|
+
</dl>
|
|
1327
|
+
|
|
1328
|
+
</dd>
|
|
1329
|
+
</dl>
|
|
1330
|
+
</details>
|
|
1331
|
+
|
|
1332
|
+
## Generations
|
|
1333
|
+
|
|
1334
|
+
<details><summary><code>client.generations.<a href="/src/api/resources/generations/client/Client.ts">create</a>({ ...params }) -> Sync.Generation</code></summary>
|
|
1335
|
+
<dl>
|
|
1336
|
+
<dd>
|
|
1337
|
+
|
|
1338
|
+
#### 📝 Description
|
|
1339
|
+
|
|
1340
|
+
<dl>
|
|
1341
|
+
<dd>
|
|
1342
|
+
|
|
1343
|
+
<dl>
|
|
1344
|
+
<dd>
|
|
1345
|
+
|
|
1346
|
+
Create a lip sync generation with `application/json` — provide each input by `url` or by `assetId` from an uploaded asset. For reusable or large local files, upload them first with POST /v2/assets/upload and pass the returned `assetId`; see [Asset Uploads](/developer-guides/asset-uploads). Use the multipart "Create Generation with Files" form only when uploading direct audio, video, or image file fields; it has a 5 GiB per-file application parser limit, subject to your plan and any lower proxy limits. Nested fields such as input, options, segments, outputAudio, dubParams, and dialogueEdit must be JSON strings in multipart requests. If a `text` input requires speech synthesis and the ElevenLabs provider is temporarily unavailable, the request returns errorCode elevenlabs_service_unavailable: 504 for provider timeouts and 503 for other provider outages for unkeyed requests. Keyed uncertain outcomes return 503 IDEMPOTENCY_OUTCOME_UNKNOWN instead. An API-key request that passes dialogueEdit is refused with errorCode dialogue_edit_retime_required (422) when the organization's rollout lacks segment lipsync and section expansion. A dialogueEdit that removes more speech than the surrounding footage can absorb returns errorCode dialogue_edit_removal_too_large (422). When the failing section can be identified, `dialogueEditSection` on the error names it; change it and create a new preview before submitting again. Retrying the same preview fails again. Send the optional Idempotency-Key header on the first request and reuse it with the same payload on retries. An accepted replay returns 200 with the original generation's current state and Idempotency-Replayed: true. A retry after that generation ended FAILED or REJECTED starts a new generation instead (201). An API-key request without the header that is identical to one your organization sent in the last 60 seconds returns 409 DUPLICATE_SUBMISSION with the original generationId; send a unique Idempotency-Key with each generation you intend. See [Idempotent Requests](/api-reference/guides/idempotency) for key validation, conflicts, retention, duplicates, and uncertain-outcome recovery.
|
|
1347
|
+
</dd>
|
|
1348
|
+
</dl>
|
|
1349
|
+
</dd>
|
|
1350
|
+
</dl>
|
|
1351
|
+
|
|
1352
|
+
#### 🔌 Usage
|
|
1353
|
+
|
|
1354
|
+
<dl>
|
|
1355
|
+
<dd>
|
|
1356
|
+
|
|
1357
|
+
<dl>
|
|
1358
|
+
<dd>
|
|
1359
|
+
|
|
1360
|
+
```typescript
|
|
1361
|
+
await client.generations.create({
|
|
1362
|
+
input: [
|
|
1363
|
+
{
|
|
1364
|
+
type: "video",
|
|
1365
|
+
url: "https://assets.sync.so/docs/example-video.mp4",
|
|
1366
|
+
},
|
|
1367
|
+
{
|
|
1368
|
+
type: "audio",
|
|
1369
|
+
url: "https://assets.sync.so/docs/example-audio.wav",
|
|
1370
|
+
},
|
|
1371
|
+
],
|
|
1372
|
+
model: "sync-3",
|
|
1373
|
+
});
|
|
1374
|
+
```
|
|
1375
|
+
|
|
1376
|
+
</dd>
|
|
1377
|
+
</dl>
|
|
1378
|
+
</dd>
|
|
1379
|
+
</dl>
|
|
1380
|
+
|
|
1381
|
+
#### ⚙️ Parameters
|
|
1382
|
+
|
|
1383
|
+
<dl>
|
|
1384
|
+
<dd>
|
|
1385
|
+
|
|
1386
|
+
<dl>
|
|
1387
|
+
<dd>
|
|
1388
|
+
|
|
1389
|
+
**request:** `Sync.CreateGenerationJsonRequest`
|
|
1390
|
+
|
|
1391
|
+
</dd>
|
|
1392
|
+
</dl>
|
|
1393
|
+
|
|
1394
|
+
<dl>
|
|
1395
|
+
<dd>
|
|
1396
|
+
|
|
1397
|
+
**requestOptions:** `Generations.RequestOptions`
|
|
1398
|
+
|
|
1399
|
+
</dd>
|
|
1400
|
+
</dl>
|
|
1401
|
+
</dd>
|
|
1402
|
+
</dl>
|
|
1403
|
+
|
|
1404
|
+
</dd>
|
|
1405
|
+
</dl>
|
|
1406
|
+
</details>
|
|
1407
|
+
|
|
1408
|
+
<details><summary><code>client.generations.<a href="/src/api/resources/generations/client/Client.ts">createWithFiles</a>(video, image, audio, { ...params }) -> Sync.Generation</code></summary>
|
|
1409
|
+
<dl>
|
|
1410
|
+
<dd>
|
|
1411
|
+
|
|
1412
|
+
#### 📝 Description
|
|
1413
|
+
|
|
1414
|
+
<dl>
|
|
1415
|
+
<dd>
|
|
1416
|
+
|
|
1417
|
+
<dl>
|
|
1418
|
+
<dd>
|
|
1419
|
+
|
|
1420
|
+
The multipart/form-data form of `POST /v2/generate` — the same endpoint as "Create Generation", for uploading local files directly instead of passing URLs. Send each file under a field named for its type (`video`, `image`, `audio`), at most one of each. The application parser allows up to 5 GiB (5 × 1024³ bytes) per file, 3 files, 32 fields, 35 total parts, and 1 MiB per field. A file over the parser limit returns 413 generation_input_validation_failed, and a file over your plan limit returns 422 file_size_exceeds_plan_limit. Proxy limits may be lower; this ceiling does not guarantee a 5 GiB direct transfer. Each file is saved as an asset in your organization and passed to the generation by `assetId`. For large files, upload via POST /v2/assets/upload first and pass the `assetId`, so retries don't resend the file. Nested fields such as `input`, `options`, `segments`, `outputAudio`, `dubParams`, and `dialogueEdit` must be sent as JSON strings in multipart requests. Image inputs are sync-3 only. If a `text` input requires speech synthesis and the ElevenLabs provider is temporarily unavailable, the request returns errorCode elevenlabs_service_unavailable: 504 for provider timeouts and 503 for other provider outages for unkeyed requests. Keyed uncertain outcomes return 503 IDEMPOTENCY_OUTCOME_UNKNOWN instead. An API-key request that passes dialogueEdit is refused with errorCode dialogue_edit_retime_required (422) when the organization's rollout lacks segment lipsync and section expansion. A dialogueEdit that removes more speech than the surrounding footage can absorb returns errorCode dialogue_edit_removal_too_large (422). When the failing section can be identified, `dialogueEditSection` on the error names it; change it and create a new preview before submitting again. Retrying the same preview fails again. Send the optional Idempotency-Key header on the first request and reuse it with the same payload on retries. An accepted replay returns 200 with the original generation's current state and Idempotency-Replayed: true. A retry after that generation ended FAILED or REJECTED starts a new generation instead (201). An API-key request without the header that is identical to one your organization sent in the last 60 seconds returns 409 DUPLICATE_SUBMISSION with the original generationId; send a unique Idempotency-Key with each generation you intend. See [Idempotent Requests](/api-reference/guides/idempotency) for key validation, conflicts, retention, duplicates, and uncertain-outcome recovery.
|
|
1421
|
+
</dd>
|
|
1422
|
+
</dl>
|
|
1423
|
+
</dd>
|
|
1424
|
+
</dl>
|
|
1425
|
+
|
|
1426
|
+
#### 🔌 Usage
|
|
1427
|
+
|
|
1428
|
+
<dl>
|
|
1429
|
+
<dd>
|
|
1430
|
+
|
|
1431
|
+
<dl>
|
|
1432
|
+
<dd>
|
|
1433
|
+
|
|
1434
|
+
```typescript
|
|
1435
|
+
await client.generations.createWithFiles(
|
|
1436
|
+
fs.createReadStream("/path/to/your/file"),
|
|
1437
|
+
fs.createReadStream("/path/to/your/file"),
|
|
1438
|
+
fs.createReadStream("/path/to/your/file"),
|
|
1439
|
+
{
|
|
1440
|
+
model: "lipsync-2",
|
|
1441
|
+
},
|
|
1442
|
+
);
|
|
1443
|
+
```
|
|
1444
|
+
|
|
1445
|
+
</dd>
|
|
1446
|
+
</dl>
|
|
1447
|
+
</dd>
|
|
1448
|
+
</dl>
|
|
1449
|
+
|
|
1450
|
+
#### ⚙️ Parameters
|
|
1451
|
+
|
|
1452
|
+
<dl>
|
|
1453
|
+
<dd>
|
|
1454
|
+
|
|
1455
|
+
<dl>
|
|
1456
|
+
<dd>
|
|
1457
|
+
|
|
1458
|
+
**video:** `File | fs.ReadStream | Blob | undefined`
|
|
1459
|
+
|
|
1460
|
+
</dd>
|
|
1461
|
+
</dl>
|
|
1462
|
+
|
|
1463
|
+
<dl>
|
|
1464
|
+
<dd>
|
|
1465
|
+
|
|
1466
|
+
**image:** `File | fs.ReadStream | Blob | undefined`
|
|
1467
|
+
|
|
1468
|
+
</dd>
|
|
1469
|
+
</dl>
|
|
1470
|
+
|
|
1471
|
+
<dl>
|
|
1472
|
+
<dd>
|
|
1473
|
+
|
|
1474
|
+
**audio:** `File | fs.ReadStream | Blob | undefined`
|
|
1475
|
+
|
|
1476
|
+
</dd>
|
|
1477
|
+
</dl>
|
|
1478
|
+
|
|
1479
|
+
<dl>
|
|
1480
|
+
<dd>
|
|
1481
|
+
|
|
1482
|
+
**request:** `Sync.CreateGenerationRequest`
|
|
1483
|
+
|
|
1484
|
+
</dd>
|
|
1485
|
+
</dl>
|
|
1486
|
+
|
|
1487
|
+
<dl>
|
|
1488
|
+
<dd>
|
|
1489
|
+
|
|
1490
|
+
**requestOptions:** `Generations.RequestOptions`
|
|
1491
|
+
|
|
1492
|
+
</dd>
|
|
1493
|
+
</dl>
|
|
1494
|
+
</dd>
|
|
1495
|
+
</dl>
|
|
1496
|
+
|
|
1497
|
+
</dd>
|
|
1498
|
+
</dl>
|
|
1499
|
+
</details>
|
|
1500
|
+
|
|
1501
|
+
<details><summary><code>client.generations.<a href="/src/api/resources/generations/client/Client.ts">get</a>(id, { ...params }) -> Sync.Generation</code></summary>
|
|
1502
|
+
<dl>
|
|
1503
|
+
<dd>
|
|
1504
|
+
|
|
1505
|
+
#### 📝 Description
|
|
1506
|
+
|
|
1507
|
+
<dl>
|
|
1508
|
+
<dd>
|
|
1509
|
+
|
|
1510
|
+
<dl>
|
|
1511
|
+
<dd>
|
|
1512
|
+
|
|
1513
|
+
Retrieve the current generation state. This /v2/generate/{id} route supports the wait, timeout and include options below.
|
|
1514
|
+
</dd>
|
|
1515
|
+
</dl>
|
|
1516
|
+
</dd>
|
|
1517
|
+
</dl>
|
|
1518
|
+
|
|
1519
|
+
#### 🔌 Usage
|
|
1520
|
+
|
|
1521
|
+
<dl>
|
|
1522
|
+
<dd>
|
|
1523
|
+
|
|
1524
|
+
<dl>
|
|
1525
|
+
<dd>
|
|
1526
|
+
|
|
1527
|
+
```typescript
|
|
1528
|
+
await client.generations.get("6533643b-aceb-4c40-967e-d9ba9baac39e");
|
|
1529
|
+
```
|
|
1530
|
+
|
|
1531
|
+
</dd>
|
|
1532
|
+
</dl>
|
|
1533
|
+
</dd>
|
|
1534
|
+
</dl>
|
|
1535
|
+
|
|
1536
|
+
#### ⚙️ Parameters
|
|
1537
|
+
|
|
1538
|
+
<dl>
|
|
1539
|
+
<dd>
|
|
1540
|
+
|
|
1541
|
+
<dl>
|
|
1542
|
+
<dd>
|
|
1543
|
+
|
|
1544
|
+
**id:** `Sync.GenerationId`
|
|
1545
|
+
|
|
1546
|
+
</dd>
|
|
1547
|
+
</dl>
|
|
1548
|
+
|
|
1549
|
+
<dl>
|
|
1550
|
+
<dd>
|
|
1551
|
+
|
|
1552
|
+
**request:** `Sync.GetGenerationRequest`
|
|
1553
|
+
|
|
1554
|
+
</dd>
|
|
1555
|
+
</dl>
|
|
1556
|
+
|
|
1557
|
+
<dl>
|
|
1558
|
+
<dd>
|
|
1559
|
+
|
|
1560
|
+
**requestOptions:** `Generations.RequestOptions`
|
|
1561
|
+
|
|
1562
|
+
</dd>
|
|
1563
|
+
</dl>
|
|
1564
|
+
</dd>
|
|
1565
|
+
</dl>
|
|
1566
|
+
|
|
1567
|
+
</dd>
|
|
1568
|
+
</dl>
|
|
1569
|
+
</details>
|
|
1570
|
+
|
|
1571
|
+
<details><summary><code>client.generations.<a href="/src/api/resources/generations/client/Client.ts">download</a>(id, { ...params }) -> string</code></summary>
|
|
1572
|
+
<dl>
|
|
1573
|
+
<dd>
|
|
1574
|
+
|
|
1575
|
+
#### 📝 Description
|
|
1576
|
+
|
|
1577
|
+
<dl>
|
|
1578
|
+
<dd>
|
|
1579
|
+
|
|
1580
|
+
<dl>
|
|
1581
|
+
<dd>
|
|
1582
|
+
|
|
1583
|
+
Obtain the available full output of a completed generation in your
|
|
1584
|
+
organization. Authenticate with `x-api-key`; no Studio project or user
|
|
1585
|
+
session is required. Any valid API key belonging to the generation's
|
|
1586
|
+
organization can request the URL.
|
|
1587
|
+
|
|
1588
|
+
The successful response is an **unquoted URL in a text/plain body**,
|
|
1589
|
+
not JSON, a redirect, or the video itself. Fetch that URL separately
|
|
1590
|
+
without forwarding your API key.
|
|
1591
|
+
|
|
1592
|
+
```bash
|
|
1593
|
+
download_url=$(curl --fail-with-body --silent --show-error \
|
|
1594
|
+
-H "x-api-key: $SYNC_API_KEY" \
|
|
1595
|
+
"https://api.sync.so/v2/generations/$GENERATION_ID/download") &&
|
|
1596
|
+
curl --fail --location "$download_url" --output output.mov
|
|
1597
|
+
```
|
|
1598
|
+
|
|
1599
|
+
The URL resolves an existing output using your organization's current
|
|
1600
|
+
plan and billing-version eligibility. Free and watermark-required plans
|
|
1601
|
+
receive the watermarked derivative when present. Entitled plans (such
|
|
1602
|
+
as v2 Creator and v3 Starter or higher) receive the clean output when
|
|
1603
|
+
available. Historical outputs can have the watermark burned in, so an
|
|
1604
|
+
upgrade does not guarantee every old output becomes watermark-free.
|
|
1605
|
+
Outputs created without a watermark can remain clean after a downgrade.
|
|
1606
|
+
If no watermarked derivative exists, the resolver retains its existing
|
|
1607
|
+
fallback to the original output; changing plans does not rewrite files.
|
|
1608
|
+
This endpoint does not generate a new render or remove burned-in watermarks.
|
|
1609
|
+
|
|
1610
|
+
Signed S3 URLs request seven-day validity, but credential expiry,
|
|
1611
|
+
revocation, access changes, or file deletion can make them unusable
|
|
1612
|
+
sooner. Request this endpoint again for a fresh signed URL while the
|
|
1613
|
+
output is still available. The selected S3 file is checked before
|
|
1614
|
+
signing; a successful response does not guarantee future availability.
|
|
1615
|
+
Older URL-only records return their stored URL unchanged, without
|
|
1616
|
+
checking its availability or extending its original expiration.
|
|
1617
|
+
These URLs are download credentials: keep them private.
|
|
1618
|
+
|
|
1619
|
+
Errors use the standard JSON error body and stable `errorCode`:
|
|
1620
|
+
|
|
1621
|
+
| Status | Code | Meaning / next step |
|
|
1622
|
+
| ------ | --------------------------------- | ------------------------------------------------------------------------------ |
|
|
1623
|
+
| 400 | — | Invalid generation UUID. |
|
|
1624
|
+
| 401 | — | API key missing, invalid, or revoked. |
|
|
1625
|
+
| 404 | `generation_not_found` | Missing, deleted, or outside your organization. |
|
|
1626
|
+
| 404 | `generation_output_unavailable` | No eligible output reference or the selected file is missing; contact support. |
|
|
1627
|
+
| 409 | `generation_not_ready` | Pending or processing; poll Get Generation until COMPLETED. |
|
|
1628
|
+
| 422 | `generation_not_downloadable` | Failed or rejected; inspect the generation error. |
|
|
1629
|
+
| 503 | `generation_download_unavailable` | Storage lookup or signing failed; retry with backoff. |
|
|
1630
|
+
|
|
1631
|
+
Authentication also returns 422 for draft organizations. Requesting a
|
|
1632
|
+
download URL does not create a project, incur a generation charge, or
|
|
1633
|
+
restore deleted files.
|
|
1634
|
+
</dd>
|
|
1635
|
+
</dl>
|
|
1636
|
+
</dd>
|
|
1637
|
+
</dl>
|
|
1638
|
+
|
|
1639
|
+
#### 🔌 Usage
|
|
1640
|
+
|
|
1641
|
+
<dl>
|
|
1642
|
+
<dd>
|
|
1643
|
+
|
|
1644
|
+
<dl>
|
|
1645
|
+
<dd>
|
|
1646
|
+
|
|
1647
|
+
```typescript
|
|
1648
|
+
await client.generations.download("id");
|
|
1649
|
+
```
|
|
1650
|
+
|
|
1651
|
+
</dd>
|
|
1652
|
+
</dl>
|
|
1653
|
+
</dd>
|
|
1654
|
+
</dl>
|
|
1655
|
+
|
|
1656
|
+
#### ⚙️ Parameters
|
|
1657
|
+
|
|
1658
|
+
<dl>
|
|
1659
|
+
<dd>
|
|
1660
|
+
|
|
1661
|
+
<dl>
|
|
1662
|
+
<dd>
|
|
1663
|
+
|
|
1664
|
+
**id:** `Sync.GenerationId`
|
|
1665
|
+
|
|
1666
|
+
</dd>
|
|
1667
|
+
</dl>
|
|
1668
|
+
|
|
1669
|
+
<dl>
|
|
1670
|
+
<dd>
|
|
1671
|
+
|
|
1672
|
+
**request:** `Sync.GetGenerationDownloadRequest`
|
|
1673
|
+
|
|
1674
|
+
</dd>
|
|
1675
|
+
</dl>
|
|
1676
|
+
|
|
1677
|
+
<dl>
|
|
1678
|
+
<dd>
|
|
1679
|
+
|
|
1680
|
+
**requestOptions:** `Generations.RequestOptions`
|
|
1681
|
+
|
|
1682
|
+
</dd>
|
|
1683
|
+
</dl>
|
|
1684
|
+
</dd>
|
|
1685
|
+
</dl>
|
|
1686
|
+
|
|
1687
|
+
</dd>
|
|
1688
|
+
</dl>
|
|
1689
|
+
</details>
|
|
1690
|
+
|
|
1691
|
+
<details><summary><code>client.generations.<a href="/src/api/resources/generations/client/Client.ts">list</a>({ ...params }) -> Sync.Generation[]</code></summary>
|
|
1692
|
+
<dl>
|
|
1693
|
+
<dd>
|
|
1694
|
+
|
|
1695
|
+
#### 🔌 Usage
|
|
1696
|
+
|
|
1697
|
+
<dl>
|
|
1698
|
+
<dd>
|
|
1699
|
+
|
|
1700
|
+
<dl>
|
|
1701
|
+
<dd>
|
|
1702
|
+
|
|
1703
|
+
```typescript
|
|
1704
|
+
await client.generations.list();
|
|
1705
|
+
```
|
|
1706
|
+
|
|
1707
|
+
</dd>
|
|
1708
|
+
</dl>
|
|
1709
|
+
</dd>
|
|
1710
|
+
</dl>
|
|
1711
|
+
|
|
1712
|
+
#### ⚙️ Parameters
|
|
1713
|
+
|
|
1714
|
+
<dl>
|
|
1715
|
+
<dd>
|
|
1716
|
+
|
|
1717
|
+
<dl>
|
|
1718
|
+
<dd>
|
|
1719
|
+
|
|
1720
|
+
**request:** `Sync.ListGenerationsRequest`
|
|
1721
|
+
|
|
1722
|
+
</dd>
|
|
1723
|
+
</dl>
|
|
1724
|
+
|
|
1725
|
+
<dl>
|
|
1726
|
+
<dd>
|
|
1727
|
+
|
|
1728
|
+
**requestOptions:** `Generations.RequestOptions`
|
|
1729
|
+
|
|
1730
|
+
</dd>
|
|
1731
|
+
</dl>
|
|
1732
|
+
</dd>
|
|
1733
|
+
</dl>
|
|
1734
|
+
|
|
1735
|
+
</dd>
|
|
1736
|
+
</dl>
|
|
1737
|
+
</details>
|
|
1738
|
+
|
|
1739
|
+
<details><summary><code>client.generations.<a href="/src/api/resources/generations/client/Client.ts">estimateCost</a>({ ...params }) -> Sync.EstimatedGenerationCost</code></summary>
|
|
1740
|
+
<dl>
|
|
1741
|
+
<dd>
|
|
1742
|
+
|
|
1743
|
+
#### 📝 Description
|
|
1744
|
+
|
|
1745
|
+
<dl>
|
|
1746
|
+
<dd>
|
|
1747
|
+
|
|
1748
|
+
<dl>
|
|
1749
|
+
<dd>
|
|
1750
|
+
|
|
1751
|
+
Estimate a generation from its model and billable duration in seconds. Supply a finite positive duration and, optionally, a finite positive fps (defaults to 25 for credit-billed organizations and 30 otherwise). Set `workflow` to `translate-and-dub` to include dubbing; the response then carries a `breakdown`. `durationCheck` says whether your account and the model allow the quoted duration. No media is fetched and no generation is created. POST /v2/generate/estimate-cost is an alias of this endpoint. Invalid request fields return 400. If the billing calculation rejects the duration or frame rate, it returns 422 cost_estimate_unavailable without price fields.
|
|
1752
|
+
</dd>
|
|
1753
|
+
</dl>
|
|
1754
|
+
</dd>
|
|
1755
|
+
</dl>
|
|
1756
|
+
|
|
1757
|
+
#### 🔌 Usage
|
|
1758
|
+
|
|
1759
|
+
<dl>
|
|
1760
|
+
<dd>
|
|
1761
|
+
|
|
1762
|
+
<dl>
|
|
1763
|
+
<dd>
|
|
1764
|
+
|
|
1765
|
+
```typescript
|
|
1766
|
+
await client.generations.estimateCost({
|
|
1767
|
+
model: "model",
|
|
1768
|
+
duration: 1.1,
|
|
1769
|
+
fps: undefined,
|
|
1770
|
+
workflow: undefined,
|
|
1771
|
+
reasoningEnabled: undefined,
|
|
1772
|
+
});
|
|
1773
|
+
```
|
|
1774
|
+
|
|
1775
|
+
</dd>
|
|
1776
|
+
</dl>
|
|
1777
|
+
</dd>
|
|
1778
|
+
</dl>
|
|
1779
|
+
|
|
1780
|
+
#### ⚙️ Parameters
|
|
1781
|
+
|
|
1782
|
+
<dl>
|
|
1783
|
+
<dd>
|
|
1784
|
+
|
|
1785
|
+
<dl>
|
|
1786
|
+
<dd>
|
|
1787
|
+
|
|
1788
|
+
**request:** `Sync.EstimateCostRequest`
|
|
1789
|
+
|
|
1790
|
+
</dd>
|
|
1791
|
+
</dl>
|
|
1792
|
+
|
|
1793
|
+
<dl>
|
|
1794
|
+
<dd>
|
|
1795
|
+
|
|
1796
|
+
**requestOptions:** `Generations.RequestOptions`
|
|
1797
|
+
|
|
1798
|
+
</dd>
|
|
1799
|
+
</dl>
|
|
1800
|
+
</dd>
|
|
1801
|
+
</dl>
|
|
1802
|
+
|
|
1803
|
+
</dd>
|
|
1804
|
+
</dl>
|
|
1805
|
+
</details>
|
|
1806
|
+
|
|
1807
|
+
<details><summary><code>client.generations.<a href="/src/api/resources/generations/client/Client.ts">delete</a>(id) -> Sync.ProjectGeneration</code></summary>
|
|
1808
|
+
<dl>
|
|
1809
|
+
<dd>
|
|
1810
|
+
|
|
1811
|
+
#### 📝 Description
|
|
1812
|
+
|
|
1813
|
+
<dl>
|
|
1814
|
+
<dd>
|
|
1815
|
+
|
|
1816
|
+
<dl>
|
|
1817
|
+
<dd>
|
|
1818
|
+
|
|
1819
|
+
Delete a generation. Generations are organization-scoped, so any member — or an API key for the organization — can delete one. Only generations in a terminal state can be deleted; deleting one that is still processing returns 409 (errorCode `generation_not_deletable_while_processing`). Returns the deleted generation in its stored shape (`modelName`, `inputs`, `outputMediaUrl`, `deletedAt`), not the Get Generation shape.
|
|
1820
|
+
</dd>
|
|
1821
|
+
</dl>
|
|
1822
|
+
</dd>
|
|
1823
|
+
</dl>
|
|
1824
|
+
|
|
1825
|
+
#### 🔌 Usage
|
|
1826
|
+
|
|
1827
|
+
<dl>
|
|
1828
|
+
<dd>
|
|
1829
|
+
|
|
1830
|
+
<dl>
|
|
1831
|
+
<dd>
|
|
1832
|
+
|
|
1833
|
+
```typescript
|
|
1834
|
+
await client.generations.delete("6533643b-aceb-4c40-967e-d9ba9baac39e");
|
|
1835
|
+
```
|
|
1836
|
+
|
|
1837
|
+
</dd>
|
|
1838
|
+
</dl>
|
|
1839
|
+
</dd>
|
|
1840
|
+
</dl>
|
|
1841
|
+
|
|
1842
|
+
#### ⚙️ Parameters
|
|
1843
|
+
|
|
1844
|
+
<dl>
|
|
1845
|
+
<dd>
|
|
1846
|
+
|
|
1847
|
+
<dl>
|
|
1848
|
+
<dd>
|
|
1849
|
+
|
|
1850
|
+
**id:** `Sync.GenerationId`
|
|
1851
|
+
|
|
1852
|
+
</dd>
|
|
1853
|
+
</dl>
|
|
1854
|
+
|
|
1855
|
+
<dl>
|
|
1856
|
+
<dd>
|
|
1857
|
+
|
|
1858
|
+
**requestOptions:** `Generations.RequestOptions`
|
|
1859
|
+
|
|
1860
|
+
</dd>
|
|
1861
|
+
</dl>
|
|
1862
|
+
</dd>
|
|
1863
|
+
</dl>
|
|
1864
|
+
|
|
1865
|
+
</dd>
|
|
1866
|
+
</dl>
|
|
1867
|
+
</details>
|
|
1868
|
+
|
|
1869
|
+
## Models
|
|
1870
|
+
|
|
1871
|
+
<details><summary><code>client.models.<a href="/src/api/resources/models/client/Client.ts">list</a>() -> Sync.ModelInfo[]</code></summary>
|
|
1872
|
+
<dl>
|
|
1873
|
+
<dd>
|
|
1874
|
+
|
|
1875
|
+
#### 📝 Description
|
|
1876
|
+
|
|
1877
|
+
<dl>
|
|
1878
|
+
<dd>
|
|
1879
|
+
|
|
1880
|
+
<dl>
|
|
1881
|
+
<dd>
|
|
1882
|
+
|
|
1883
|
+
List all available models for the authenticated user. Returns active (non-deprecated) models the user has access to, including any feature-flagged models enabled for their account.
|
|
1884
|
+
</dd>
|
|
1885
|
+
</dl>
|
|
1886
|
+
</dd>
|
|
1887
|
+
</dl>
|
|
1888
|
+
|
|
1889
|
+
#### 🔌 Usage
|
|
1890
|
+
|
|
1891
|
+
<dl>
|
|
1892
|
+
<dd>
|
|
1893
|
+
|
|
1894
|
+
<dl>
|
|
1895
|
+
<dd>
|
|
1896
|
+
|
|
1897
|
+
```typescript
|
|
1898
|
+
await client.models.list();
|
|
1899
|
+
```
|
|
1900
|
+
|
|
1901
|
+
</dd>
|
|
1902
|
+
</dl>
|
|
1903
|
+
</dd>
|
|
1904
|
+
</dl>
|
|
1905
|
+
|
|
1906
|
+
#### ⚙️ Parameters
|
|
1907
|
+
|
|
1908
|
+
<dl>
|
|
1909
|
+
<dd>
|
|
1910
|
+
|
|
1911
|
+
<dl>
|
|
1912
|
+
<dd>
|
|
1913
|
+
|
|
1914
|
+
**requestOptions:** `Models.RequestOptions`
|
|
1915
|
+
|
|
1916
|
+
</dd>
|
|
1917
|
+
</dl>
|
|
1918
|
+
</dd>
|
|
1919
|
+
</dl>
|
|
1920
|
+
|
|
1921
|
+
</dd>
|
|
1922
|
+
</dl>
|
|
1923
|
+
</details>
|
|
1924
|
+
|
|
1925
|
+
## Organizations
|
|
1926
|
+
|
|
1927
|
+
<details><summary><code>client.organizations.<a href="/src/api/resources/organizations/client/Client.ts">getWebhookSecret</a>({ ...params }) -> Sync.WebhookSecretResponse</code></summary>
|
|
1928
|
+
<dl>
|
|
1929
|
+
<dd>
|
|
1930
|
+
|
|
1931
|
+
#### 📝 Description
|
|
1932
|
+
|
|
1933
|
+
<dl>
|
|
1934
|
+
<dd>
|
|
1935
|
+
|
|
1936
|
+
<dl>
|
|
1937
|
+
<dd>
|
|
1938
|
+
|
|
1939
|
+
Retrieve your organization's webhook signing secret. This is a public, authenticated endpoint you can use to verify the `Sync-Signature` header on generation and batch webhook deliveries: Sync signs the raw JSON request body as HMAC-SHA256 over `${timestamp}.${rawBody}` and sends it as `Sync-Signature: t=<unix>,v1=<hmac_sha256>`. Store the full `whsec_...` value securely. `masked=true` returns a display-only value; do not use it as a verification secret. The same secret is available on the [webhooks settings page](https://sync.so/settings/webhooks).
|
|
1940
|
+
</dd>
|
|
1941
|
+
</dl>
|
|
1942
|
+
</dd>
|
|
1943
|
+
</dl>
|
|
1944
|
+
|
|
1945
|
+
#### 🔌 Usage
|
|
1946
|
+
|
|
1947
|
+
<dl>
|
|
1948
|
+
<dd>
|
|
1949
|
+
|
|
1950
|
+
<dl>
|
|
1951
|
+
<dd>
|
|
1952
|
+
|
|
1953
|
+
```typescript
|
|
1954
|
+
await client.organizations.getWebhookSecret();
|
|
1955
|
+
```
|
|
1956
|
+
|
|
1957
|
+
</dd>
|
|
1958
|
+
</dl>
|
|
1959
|
+
</dd>
|
|
1960
|
+
</dl>
|
|
1961
|
+
|
|
1962
|
+
#### ⚙️ Parameters
|
|
1963
|
+
|
|
1964
|
+
<dl>
|
|
1965
|
+
<dd>
|
|
1966
|
+
|
|
1967
|
+
<dl>
|
|
1968
|
+
<dd>
|
|
1969
|
+
|
|
1970
|
+
**request:** `Sync.GetWebhookSecretRequest`
|
|
1971
|
+
|
|
1972
|
+
</dd>
|
|
1973
|
+
</dl>
|
|
1974
|
+
|
|
1975
|
+
<dl>
|
|
1976
|
+
<dd>
|
|
1977
|
+
|
|
1978
|
+
**requestOptions:** `Organizations.RequestOptions`
|
|
1979
|
+
|
|
1980
|
+
</dd>
|
|
1981
|
+
</dl>
|
|
1982
|
+
</dd>
|
|
1983
|
+
</dl>
|
|
1984
|
+
|
|
1985
|
+
</dd>
|
|
1986
|
+
</dl>
|
|
1987
|
+
</details>
|
|
1988
|
+
|
|
1989
|
+
## Projects
|
|
1990
|
+
|
|
1991
|
+
<details><summary><code>client.projects.<a href="/src/api/resources/projects/client/Client.ts">create</a>({ ...params }) -> Sync.Project</code></summary>
|
|
1992
|
+
<dl>
|
|
1993
|
+
<dd>
|
|
1994
|
+
|
|
1995
|
+
#### 📝 Description
|
|
1996
|
+
|
|
1997
|
+
<dl>
|
|
1998
|
+
<dd>
|
|
1999
|
+
|
|
2000
|
+
<dl>
|
|
2001
|
+
<dd>
|
|
2002
|
+
|
|
2003
|
+
Create a project to group related generations and assets. Pass the returned id as projectId on POST /v2/generate or POST /v2/assets to file them under this project so they show up together in Studio. Only name is required — visibility defaults to USER and mode to CREATOR. Supply a client-generated UUID as id for idempotent creation. A retry with the same id returns the existing project and ignores other request fields; an id owned by another user/organization or a deleted project returns 409.
|
|
2004
|
+
</dd>
|
|
2005
|
+
</dl>
|
|
2006
|
+
</dd>
|
|
2007
|
+
</dl>
|
|
2008
|
+
|
|
2009
|
+
#### 🔌 Usage
|
|
2010
|
+
|
|
2011
|
+
<dl>
|
|
2012
|
+
<dd>
|
|
2013
|
+
|
|
2014
|
+
<dl>
|
|
2015
|
+
<dd>
|
|
2016
|
+
|
|
2017
|
+
```typescript
|
|
2018
|
+
await client.projects.create({
|
|
2019
|
+
id: "612bb64a-e7f4-40c1-977b-3e9797845637",
|
|
2020
|
+
name: "My API Project",
|
|
2021
|
+
});
|
|
2022
|
+
```
|
|
2023
|
+
|
|
2024
|
+
</dd>
|
|
2025
|
+
</dl>
|
|
2026
|
+
</dd>
|
|
2027
|
+
</dl>
|
|
2028
|
+
|
|
2029
|
+
#### ⚙️ Parameters
|
|
2030
|
+
|
|
2031
|
+
<dl>
|
|
2032
|
+
<dd>
|
|
2033
|
+
|
|
2034
|
+
<dl>
|
|
2035
|
+
<dd>
|
|
2036
|
+
|
|
2037
|
+
**request:** `Sync.CreateProjectRequest`
|
|
2038
|
+
|
|
2039
|
+
</dd>
|
|
2040
|
+
</dl>
|
|
2041
|
+
|
|
2042
|
+
<dl>
|
|
2043
|
+
<dd>
|
|
2044
|
+
|
|
2045
|
+
**requestOptions:** `Projects.RequestOptions`
|
|
2046
|
+
|
|
2047
|
+
</dd>
|
|
2048
|
+
</dl>
|
|
2049
|
+
</dd>
|
|
2050
|
+
</dl>
|
|
2051
|
+
|
|
2052
|
+
</dd>
|
|
2053
|
+
</dl>
|
|
2054
|
+
</details>
|
|
2055
|
+
|
|
2056
|
+
<details><summary><code>client.projects.<a href="/src/api/resources/projects/client/Client.ts">list</a>({ ...params }) -> Sync.PaginatedProjectsResponse</code></summary>
|
|
2057
|
+
<dl>
|
|
2058
|
+
<dd>
|
|
2059
|
+
|
|
2060
|
+
#### 📝 Description
|
|
2061
|
+
|
|
2062
|
+
<dl>
|
|
2063
|
+
<dd>
|
|
2064
|
+
|
|
2065
|
+
<dl>
|
|
2066
|
+
<dd>
|
|
2067
|
+
|
|
2068
|
+
List the projects in your organization, most recently updated first.
|
|
2069
|
+
</dd>
|
|
2070
|
+
</dl>
|
|
2071
|
+
</dd>
|
|
2072
|
+
</dl>
|
|
2073
|
+
|
|
2074
|
+
#### 🔌 Usage
|
|
2075
|
+
|
|
2076
|
+
<dl>
|
|
2077
|
+
<dd>
|
|
2078
|
+
|
|
2079
|
+
<dl>
|
|
2080
|
+
<dd>
|
|
2081
|
+
|
|
2082
|
+
```typescript
|
|
2083
|
+
await client.projects.list({
|
|
2084
|
+
limit: 10,
|
|
2085
|
+
sortBy: "updatedAt",
|
|
2086
|
+
});
|
|
2087
|
+
```
|
|
2088
|
+
|
|
2089
|
+
</dd>
|
|
2090
|
+
</dl>
|
|
2091
|
+
</dd>
|
|
2092
|
+
</dl>
|
|
2093
|
+
|
|
2094
|
+
#### ⚙️ Parameters
|
|
2095
|
+
|
|
2096
|
+
<dl>
|
|
2097
|
+
<dd>
|
|
2098
|
+
|
|
2099
|
+
<dl>
|
|
2100
|
+
<dd>
|
|
2101
|
+
|
|
2102
|
+
**request:** `Sync.ListProjectsRequest`
|
|
2103
|
+
|
|
2104
|
+
</dd>
|
|
2105
|
+
</dl>
|
|
2106
|
+
|
|
2107
|
+
<dl>
|
|
2108
|
+
<dd>
|
|
2109
|
+
|
|
2110
|
+
**requestOptions:** `Projects.RequestOptions`
|
|
2111
|
+
|
|
2112
|
+
</dd>
|
|
2113
|
+
</dl>
|
|
2114
|
+
</dd>
|
|
2115
|
+
</dl>
|
|
2116
|
+
|
|
2117
|
+
</dd>
|
|
2118
|
+
</dl>
|
|
2119
|
+
</details>
|
|
2120
|
+
|
|
2121
|
+
<details><summary><code>client.projects.<a href="/src/api/resources/projects/client/Client.ts">get</a>(id) -> Sync.Project</code></summary>
|
|
2122
|
+
<dl>
|
|
2123
|
+
<dd>
|
|
2124
|
+
|
|
2125
|
+
#### 📝 Description
|
|
2126
|
+
|
|
2127
|
+
<dl>
|
|
2128
|
+
<dd>
|
|
2129
|
+
|
|
2130
|
+
<dl>
|
|
2131
|
+
<dd>
|
|
2132
|
+
|
|
2133
|
+
Retrieve a project by id.
|
|
2134
|
+
</dd>
|
|
2135
|
+
</dl>
|
|
2136
|
+
</dd>
|
|
2137
|
+
</dl>
|
|
2138
|
+
|
|
2139
|
+
#### 🔌 Usage
|
|
2140
|
+
|
|
2141
|
+
<dl>
|
|
2142
|
+
<dd>
|
|
2143
|
+
|
|
2144
|
+
<dl>
|
|
2145
|
+
<dd>
|
|
2146
|
+
|
|
2147
|
+
```typescript
|
|
2148
|
+
await client.projects.get("612bb64a-e7f4-40c1-977b-3e9797845637");
|
|
2149
|
+
```
|
|
2150
|
+
|
|
2151
|
+
</dd>
|
|
2152
|
+
</dl>
|
|
2153
|
+
</dd>
|
|
2154
|
+
</dl>
|
|
2155
|
+
|
|
2156
|
+
#### ⚙️ Parameters
|
|
2157
|
+
|
|
2158
|
+
<dl>
|
|
2159
|
+
<dd>
|
|
2160
|
+
|
|
2161
|
+
<dl>
|
|
2162
|
+
<dd>
|
|
2163
|
+
|
|
2164
|
+
**id:** `Sync.ProjectId`
|
|
2165
|
+
|
|
2166
|
+
</dd>
|
|
2167
|
+
</dl>
|
|
2168
|
+
|
|
2169
|
+
<dl>
|
|
2170
|
+
<dd>
|
|
2171
|
+
|
|
2172
|
+
**requestOptions:** `Projects.RequestOptions`
|
|
2173
|
+
|
|
2174
|
+
</dd>
|
|
2175
|
+
</dl>
|
|
2176
|
+
</dd>
|
|
2177
|
+
</dl>
|
|
2178
|
+
|
|
2179
|
+
</dd>
|
|
2180
|
+
</dl>
|
|
2181
|
+
</details>
|
|
2182
|
+
|
|
2183
|
+
<details><summary><code>client.projects.<a href="/src/api/resources/projects/client/Client.ts">attachAsset</a>(id, { ...params }) -> void</code></summary>
|
|
2184
|
+
<dl>
|
|
2185
|
+
<dd>
|
|
2186
|
+
|
|
2187
|
+
#### 📝 Description
|
|
2188
|
+
|
|
2189
|
+
<dl>
|
|
2190
|
+
<dd>
|
|
2191
|
+
|
|
2192
|
+
<dl>
|
|
2193
|
+
<dd>
|
|
2194
|
+
|
|
2195
|
+
Attach an existing asset to a project so it is grouped under the project alongside its generations. The asset must belong to your organization and not be deleted. This is idempotent — re-attaching an asset that is already linked succeeds without creating a duplicate. Returns 204 No Content on success.
|
|
2196
|
+
</dd>
|
|
2197
|
+
</dl>
|
|
2198
|
+
</dd>
|
|
2199
|
+
</dl>
|
|
2200
|
+
|
|
2201
|
+
#### 🔌 Usage
|
|
2202
|
+
|
|
2203
|
+
<dl>
|
|
2204
|
+
<dd>
|
|
2205
|
+
|
|
2206
|
+
<dl>
|
|
2207
|
+
<dd>
|
|
2208
|
+
|
|
2209
|
+
```typescript
|
|
2210
|
+
await client.projects.attachAsset("612bb64a-e7f4-40c1-977b-3e9797845637", {
|
|
2211
|
+
assetId: "8f14e45f-ceea-467d-9a1b-3e4d5c6f7a8b",
|
|
2212
|
+
});
|
|
2213
|
+
```
|
|
2214
|
+
|
|
2215
|
+
</dd>
|
|
2216
|
+
</dl>
|
|
2217
|
+
</dd>
|
|
2218
|
+
</dl>
|
|
2219
|
+
|
|
2220
|
+
#### ⚙️ Parameters
|
|
2221
|
+
|
|
2222
|
+
<dl>
|
|
2223
|
+
<dd>
|
|
2224
|
+
|
|
2225
|
+
<dl>
|
|
2226
|
+
<dd>
|
|
2227
|
+
|
|
2228
|
+
**id:** `Sync.ProjectId`
|
|
2229
|
+
|
|
2230
|
+
</dd>
|
|
2231
|
+
</dl>
|
|
2232
|
+
|
|
2233
|
+
<dl>
|
|
2234
|
+
<dd>
|
|
2235
|
+
|
|
2236
|
+
**request:** `Sync.AttachProjectAssetRequest`
|
|
2237
|
+
|
|
2238
|
+
</dd>
|
|
2239
|
+
</dl>
|
|
2240
|
+
|
|
6
2241
|
<dl>
|
|
7
2242
|
<dd>
|
|
8
2243
|
|
|
9
|
-
|
|
2244
|
+
**requestOptions:** `Projects.RequestOptions`
|
|
2245
|
+
|
|
2246
|
+
</dd>
|
|
2247
|
+
</dl>
|
|
2248
|
+
</dd>
|
|
2249
|
+
</dl>
|
|
10
2250
|
|
|
2251
|
+
</dd>
|
|
2252
|
+
</dl>
|
|
2253
|
+
</details>
|
|
2254
|
+
|
|
2255
|
+
<details><summary><code>client.projects.<a href="/src/api/resources/projects/client/Client.ts">detachAsset</a>(id, assetId) -> void</code></summary>
|
|
11
2256
|
<dl>
|
|
12
2257
|
<dd>
|
|
13
2258
|
|
|
2259
|
+
#### 📝 Description
|
|
2260
|
+
|
|
14
2261
|
<dl>
|
|
15
2262
|
<dd>
|
|
16
2263
|
|
|
17
|
-
|
|
2264
|
+
<dl>
|
|
2265
|
+
<dd>
|
|
18
2266
|
|
|
2267
|
+
Detach an asset from the project's draft content, such as its thumbnail. The asset remains in the project's asset library and keeps its access grants. Attaching it again restores the link. This operation is idempotent, including when the link is already detached or absent. Returns 204 No Content. An inaccessible project returns 404. An API key without an owner returns 422.
|
|
19
2268
|
</dd>
|
|
20
2269
|
</dl>
|
|
21
2270
|
</dd>
|
|
@@ -30,10 +2279,7 @@ List all assets in your organization's media library.
|
|
|
30
2279
|
<dd>
|
|
31
2280
|
|
|
32
2281
|
```typescript
|
|
33
|
-
await client.
|
|
34
|
-
limit: 10,
|
|
35
|
-
sortBy: "dateDesc",
|
|
36
|
-
});
|
|
2282
|
+
await client.projects.detachAsset("id", "assetId");
|
|
37
2283
|
```
|
|
38
2284
|
|
|
39
2285
|
</dd>
|
|
@@ -49,7 +2295,7 @@ await client.assets.list({
|
|
|
49
2295
|
<dl>
|
|
50
2296
|
<dd>
|
|
51
2297
|
|
|
52
|
-
**
|
|
2298
|
+
**id:** `Sync.ProjectId`
|
|
53
2299
|
|
|
54
2300
|
</dd>
|
|
55
2301
|
</dl>
|
|
@@ -57,7 +2303,15 @@ await client.assets.list({
|
|
|
57
2303
|
<dl>
|
|
58
2304
|
<dd>
|
|
59
2305
|
|
|
60
|
-
**
|
|
2306
|
+
**assetId:** `Sync.AssetId`
|
|
2307
|
+
|
|
2308
|
+
</dd>
|
|
2309
|
+
</dl>
|
|
2310
|
+
|
|
2311
|
+
<dl>
|
|
2312
|
+
<dd>
|
|
2313
|
+
|
|
2314
|
+
**requestOptions:** `Projects.RequestOptions`
|
|
61
2315
|
|
|
62
2316
|
</dd>
|
|
63
2317
|
</dl>
|
|
@@ -68,7 +2322,7 @@ await client.assets.list({
|
|
|
68
2322
|
</dl>
|
|
69
2323
|
</details>
|
|
70
2324
|
|
|
71
|
-
<details><summary><code>client.
|
|
2325
|
+
<details><summary><code>client.projects.<a href="/src/api/resources/projects/client/Client.ts">update</a>(id, { ...params }) -> Sync.Project</code></summary>
|
|
72
2326
|
<dl>
|
|
73
2327
|
<dd>
|
|
74
2328
|
|
|
@@ -80,8 +2334,7 @@ await client.assets.list({
|
|
|
80
2334
|
<dl>
|
|
81
2335
|
<dd>
|
|
82
2336
|
|
|
83
|
-
|
|
84
|
-
|
|
2337
|
+
Update a project's name, description, visibility, or mode. Only the fields you provide are changed.
|
|
85
2338
|
</dd>
|
|
86
2339
|
</dl>
|
|
87
2340
|
</dd>
|
|
@@ -96,7 +2349,9 @@ Retrieve a specific asset by ID.
|
|
|
96
2349
|
<dd>
|
|
97
2350
|
|
|
98
2351
|
```typescript
|
|
99
|
-
await client.
|
|
2352
|
+
await client.projects.update("612bb64a-e7f4-40c1-977b-3e9797845637", {
|
|
2353
|
+
name: "Renamed Project",
|
|
2354
|
+
});
|
|
100
2355
|
```
|
|
101
2356
|
|
|
102
2357
|
</dd>
|
|
@@ -112,7 +2367,7 @@ await client.assets.get("550e8400-e29b-41d4-a716-446655440000");
|
|
|
112
2367
|
<dl>
|
|
113
2368
|
<dd>
|
|
114
2369
|
|
|
115
|
-
**id:** `Sync.
|
|
2370
|
+
**id:** `Sync.ProjectId`
|
|
116
2371
|
|
|
117
2372
|
</dd>
|
|
118
2373
|
</dl>
|
|
@@ -120,7 +2375,15 @@ await client.assets.get("550e8400-e29b-41d4-a716-446655440000");
|
|
|
120
2375
|
<dl>
|
|
121
2376
|
<dd>
|
|
122
2377
|
|
|
123
|
-
**
|
|
2378
|
+
**request:** `Sync.UpdateProjectRequest`
|
|
2379
|
+
|
|
2380
|
+
</dd>
|
|
2381
|
+
</dl>
|
|
2382
|
+
|
|
2383
|
+
<dl>
|
|
2384
|
+
<dd>
|
|
2385
|
+
|
|
2386
|
+
**requestOptions:** `Projects.RequestOptions`
|
|
124
2387
|
|
|
125
2388
|
</dd>
|
|
126
2389
|
</dl>
|
|
@@ -131,9 +2394,7 @@ await client.assets.get("550e8400-e29b-41d4-a716-446655440000");
|
|
|
131
2394
|
</dl>
|
|
132
2395
|
</details>
|
|
133
2396
|
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
<details><summary><code>client.batch.<a href="/src/api/resources/batch/client/Client.ts">create</a>(input, { ...params }) -> Sync.CreateBatchResponse</code></summary>
|
|
2397
|
+
<details><summary><code>client.projects.<a href="/src/api/resources/projects/client/Client.ts">delete</a>(id) -> Sync.DeleteProjectResponse</code></summary>
|
|
137
2398
|
<dl>
|
|
138
2399
|
<dd>
|
|
139
2400
|
|
|
@@ -145,8 +2406,7 @@ await client.assets.get("550e8400-e29b-41d4-a716-446655440000");
|
|
|
145
2406
|
<dl>
|
|
146
2407
|
<dd>
|
|
147
2408
|
|
|
148
|
-
|
|
149
|
-
|
|
2409
|
+
Delete a project. A project can't be deleted while any of its generations are queued or processing — wait for those to finish, then retry. Deletion soft-deletes the project and its generations, removes its asset links, and soft-deletes assets with no other active project. Assets linked to another active project are retained.
|
|
150
2410
|
</dd>
|
|
151
2411
|
</dl>
|
|
152
2412
|
</dd>
|
|
@@ -161,10 +2421,7 @@ API for [Batch Processing](/api-reference/guides/batch-processing). Available on
|
|
|
161
2421
|
<dd>
|
|
162
2422
|
|
|
163
2423
|
```typescript
|
|
164
|
-
await client.
|
|
165
|
-
webhook_url: "https://your-webhook-url.com/batch-webhook",
|
|
166
|
-
dry_run: false,
|
|
167
|
-
});
|
|
2424
|
+
await client.projects.delete("612bb64a-e7f4-40c1-977b-3e9797845637");
|
|
168
2425
|
```
|
|
169
2426
|
|
|
170
2427
|
</dd>
|
|
@@ -180,15 +2437,7 @@ await client.batch.create(fs.createReadStream("/path/to/your/file"), {
|
|
|
180
2437
|
<dl>
|
|
181
2438
|
<dd>
|
|
182
2439
|
|
|
183
|
-
**
|
|
184
|
-
|
|
185
|
-
</dd>
|
|
186
|
-
</dl>
|
|
187
|
-
|
|
188
|
-
<dl>
|
|
189
|
-
<dd>
|
|
190
|
-
|
|
191
|
-
**request:** `Sync.CreateBatchRequest`
|
|
2440
|
+
**id:** `Sync.ProjectId`
|
|
192
2441
|
|
|
193
2442
|
</dd>
|
|
194
2443
|
</dl>
|
|
@@ -196,7 +2445,7 @@ await client.batch.create(fs.createReadStream("/path/to/your/file"), {
|
|
|
196
2445
|
<dl>
|
|
197
2446
|
<dd>
|
|
198
2447
|
|
|
199
|
-
**requestOptions:** `
|
|
2448
|
+
**requestOptions:** `Projects.RequestOptions`
|
|
200
2449
|
|
|
201
2450
|
</dd>
|
|
202
2451
|
</dl>
|
|
@@ -207,7 +2456,9 @@ await client.batch.create(fs.createReadStream("/path/to/your/file"), {
|
|
|
207
2456
|
</dl>
|
|
208
2457
|
</details>
|
|
209
2458
|
|
|
210
|
-
|
|
2459
|
+
## Transcriptions
|
|
2460
|
+
|
|
2461
|
+
<details><summary><code>client.transcriptions.<a href="/src/api/resources/transcriptions/client/Client.ts">create</a>({ ...params }) -> Sync.TranscriptionJob</code></summary>
|
|
211
2462
|
<dl>
|
|
212
2463
|
<dd>
|
|
213
2464
|
|
|
@@ -219,8 +2470,7 @@ await client.batch.create(fs.createReadStream("/path/to/your/file"), {
|
|
|
219
2470
|
<dl>
|
|
220
2471
|
<dd>
|
|
221
2472
|
|
|
222
|
-
|
|
223
|
-
|
|
2473
|
+
Starts a word-level transcription of a window of a video, the first step of a dialogue edit. Provide exactly one of `sourceVideoUrl` or `sourceAudioUrl`, both hosted in sync. storage (upload via `POST /v2/assets/upload`). Passing pre-extracted audio skips the server-side download and transcode. Poll `GET /v2/transcriptions/{id}` until `status` is `COMPLETED`, then pass the `transcript` and your edits to `POST /v2/dialogue-edits`. An identical source and window returns the existing job instead of starting a new one. Transcription is not billed.
|
|
224
2474
|
</dd>
|
|
225
2475
|
</dl>
|
|
226
2476
|
</dd>
|
|
@@ -235,7 +2485,10 @@ Retrieve details about a specific batch, including its current status, processin
|
|
|
235
2485
|
<dd>
|
|
236
2486
|
|
|
237
2487
|
```typescript
|
|
238
|
-
await client.
|
|
2488
|
+
await client.transcriptions.create({
|
|
2489
|
+
sourceVideoUrl: "https://assets.sync.so/docs/example-video.mp4",
|
|
2490
|
+
endMs: 30000,
|
|
2491
|
+
});
|
|
239
2492
|
```
|
|
240
2493
|
|
|
241
2494
|
</dd>
|
|
@@ -251,7 +2504,7 @@ await client.batch.get("batch_abc123");
|
|
|
251
2504
|
<dl>
|
|
252
2505
|
<dd>
|
|
253
2506
|
|
|
254
|
-
**
|
|
2507
|
+
**request:** `Sync.CreateTranscriptionDto`
|
|
255
2508
|
|
|
256
2509
|
</dd>
|
|
257
2510
|
</dl>
|
|
@@ -259,7 +2512,7 @@ await client.batch.get("batch_abc123");
|
|
|
259
2512
|
<dl>
|
|
260
2513
|
<dd>
|
|
261
2514
|
|
|
262
|
-
**requestOptions:** `
|
|
2515
|
+
**requestOptions:** `Transcriptions.RequestOptions`
|
|
263
2516
|
|
|
264
2517
|
</dd>
|
|
265
2518
|
</dl>
|
|
@@ -270,7 +2523,7 @@ await client.batch.get("batch_abc123");
|
|
|
270
2523
|
</dl>
|
|
271
2524
|
</details>
|
|
272
2525
|
|
|
273
|
-
<details><summary><code>client.
|
|
2526
|
+
<details><summary><code>client.transcriptions.<a href="/src/api/resources/transcriptions/client/Client.ts">get</a>(id) -> Sync.TranscriptionJob</code></summary>
|
|
274
2527
|
<dl>
|
|
275
2528
|
<dd>
|
|
276
2529
|
|
|
@@ -282,8 +2535,7 @@ await client.batch.get("batch_abc123");
|
|
|
282
2535
|
<dl>
|
|
283
2536
|
<dd>
|
|
284
2537
|
|
|
285
|
-
|
|
286
|
-
|
|
2538
|
+
Returns the job status and, once `status` is `COMPLETED`, the word-level transcript. `COMPLETED` and `FAILED` are terminal; `error.code` says why a job failed.
|
|
287
2539
|
</dd>
|
|
288
2540
|
</dl>
|
|
289
2541
|
</dd>
|
|
@@ -298,7 +2550,7 @@ List all batches for your organization with optional filtering by status and cre
|
|
|
298
2550
|
<dd>
|
|
299
2551
|
|
|
300
2552
|
```typescript
|
|
301
|
-
await client.
|
|
2553
|
+
await client.transcriptions.get("6533643b-aceb-4c40-967e-d9ba9baac39e");
|
|
302
2554
|
```
|
|
303
2555
|
|
|
304
2556
|
</dd>
|
|
@@ -314,7 +2566,7 @@ await client.batch.list();
|
|
|
314
2566
|
<dl>
|
|
315
2567
|
<dd>
|
|
316
2568
|
|
|
317
|
-
**
|
|
2569
|
+
**id:** `Sync.TranscriptionJobId` — Transcription job id.
|
|
318
2570
|
|
|
319
2571
|
</dd>
|
|
320
2572
|
</dl>
|
|
@@ -322,7 +2574,7 @@ await client.batch.list();
|
|
|
322
2574
|
<dl>
|
|
323
2575
|
<dd>
|
|
324
2576
|
|
|
325
|
-
**requestOptions:** `
|
|
2577
|
+
**requestOptions:** `Transcriptions.RequestOptions`
|
|
326
2578
|
|
|
327
2579
|
</dd>
|
|
328
2580
|
</dl>
|
|
@@ -333,12 +2585,28 @@ await client.batch.list();
|
|
|
333
2585
|
</dl>
|
|
334
2586
|
</details>
|
|
335
2587
|
|
|
336
|
-
##
|
|
2588
|
+
## Tts
|
|
2589
|
+
|
|
2590
|
+
<details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">create</a>({ ...params }) -> Sync.TtsGenerationResponse</code></summary>
|
|
2591
|
+
<dl>
|
|
2592
|
+
<dd>
|
|
2593
|
+
|
|
2594
|
+
#### 📝 Description
|
|
2595
|
+
|
|
2596
|
+
<dl>
|
|
2597
|
+
<dd>
|
|
337
2598
|
|
|
338
|
-
<details><summary><code>client.generations.<a href="/src/api/resources/generations/client/Client.ts">create</a>({ ...params }) -> Sync.Generation</code></summary>
|
|
339
2599
|
<dl>
|
|
340
2600
|
<dd>
|
|
341
2601
|
|
|
2602
|
+
Synthesize speech from a script and get back a hosted audio URL. The returned url can be reused as an audio input in POST /v2/generate to lip sync the synthesized take. voiceId accepts an ElevenLabs voice id (discover via GET /v2/voices) or the id of a voice cloned via POST /v2/voices. Free-tier keys share the monthly ElevenLabs allowance; paid plans are billed per use.
|
|
2603
|
+
|
|
2604
|
+
A voiceId that does not resolve returns a 422 with errorCode voice_not_found. If a voice from your own ElevenLabs account stops resolving, the connected API key may be invalid — provider failures surface errorCode elevenlabs_api_key_invalid (reconnect it in Settings > Integrations) or elevenlabs_quota_exceeded (402) when your own ElevenLabs quota is exhausted. Temporary ElevenLabs provider failures return errorCode elevenlabs_service_unavailable: 504 for provider timeouts and 503 for other provider outages. Retry those requests with backoff and include the requestId if you contact support. A voice with an unresolved ElevenLabs restriction returns errorCode voice_verification_required or voice_blocked (both normally 422, or 400 when the pre-synthesis check was unavailable), or voice_access_denied (400). The required action depends on the code and on whether the voice is from your own connected ElevenLabs account — see the Error Handling guide.
|
|
2605
|
+
</dd>
|
|
2606
|
+
</dl>
|
|
2607
|
+
</dd>
|
|
2608
|
+
</dl>
|
|
2609
|
+
|
|
342
2610
|
#### 🔌 Usage
|
|
343
2611
|
|
|
344
2612
|
<dl>
|
|
@@ -348,21 +2616,10 @@ await client.batch.list();
|
|
|
348
2616
|
<dd>
|
|
349
2617
|
|
|
350
2618
|
```typescript
|
|
351
|
-
await client.
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
url: "https://assets.sync.so/docs/example-video.mp4",
|
|
356
|
-
},
|
|
357
|
-
{
|
|
358
|
-
type: "audio",
|
|
359
|
-
url: "https://assets.sync.so/docs/example-audio.wav",
|
|
360
|
-
},
|
|
361
|
-
],
|
|
362
|
-
model: "lipsync-2",
|
|
363
|
-
options: {
|
|
364
|
-
sync_mode: "loop",
|
|
365
|
-
},
|
|
2619
|
+
await client.tts.create({
|
|
2620
|
+
script: "Hey \u2014 thanks for trying sync. labs.",
|
|
2621
|
+
voiceId: "EXAVITQu4vr4xnSDxMaL",
|
|
2622
|
+
provider: "elevenlabs",
|
|
366
2623
|
});
|
|
367
2624
|
```
|
|
368
2625
|
|
|
@@ -379,7 +2636,7 @@ await client.generations.create({
|
|
|
379
2636
|
<dl>
|
|
380
2637
|
<dd>
|
|
381
2638
|
|
|
382
|
-
**request:** `Sync.
|
|
2639
|
+
**request:** `Sync.CreateTtsRequest`
|
|
383
2640
|
|
|
384
2641
|
</dd>
|
|
385
2642
|
</dl>
|
|
@@ -387,7 +2644,7 @@ await client.generations.create({
|
|
|
387
2644
|
<dl>
|
|
388
2645
|
<dd>
|
|
389
2646
|
|
|
390
|
-
**requestOptions:** `
|
|
2647
|
+
**requestOptions:** `Tts.RequestOptions`
|
|
391
2648
|
|
|
392
2649
|
</dd>
|
|
393
2650
|
</dl>
|
|
@@ -398,10 +2655,24 @@ await client.generations.create({
|
|
|
398
2655
|
</dl>
|
|
399
2656
|
</details>
|
|
400
2657
|
|
|
401
|
-
<details><summary><code>client.
|
|
2658
|
+
<details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">createJob</a>({ ...params }) -> Sync.TtsJob</code></summary>
|
|
2659
|
+
<dl>
|
|
2660
|
+
<dd>
|
|
2661
|
+
|
|
2662
|
+
#### 📝 Description
|
|
2663
|
+
|
|
2664
|
+
<dl>
|
|
2665
|
+
<dd>
|
|
2666
|
+
|
|
402
2667
|
<dl>
|
|
403
2668
|
<dd>
|
|
404
2669
|
|
|
2670
|
+
Submit a job for asynchronous speech synthesis. Returns 202 with the accepted job and a `Location` header pointing at GET /v2/tts/jobs/{id}; poll that endpoint for the result. Accepts the same body as POST /v2/tts. API-key requests require your organization to be enabled for the asynchronous TTS rollout; otherwise the request returns 503.
|
|
2671
|
+
</dd>
|
|
2672
|
+
</dl>
|
|
2673
|
+
</dd>
|
|
2674
|
+
</dl>
|
|
2675
|
+
|
|
405
2676
|
#### 🔌 Usage
|
|
406
2677
|
|
|
407
2678
|
<dl>
|
|
@@ -411,13 +2682,11 @@ await client.generations.create({
|
|
|
411
2682
|
<dd>
|
|
412
2683
|
|
|
413
2684
|
```typescript
|
|
414
|
-
await client.
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
},
|
|
420
|
-
);
|
|
2685
|
+
await client.tts.createJob({
|
|
2686
|
+
script: "Hey \u2014 thanks for trying sync. labs.",
|
|
2687
|
+
voiceId: "EXAVITQu4vr4xnSDxMaL",
|
|
2688
|
+
provider: "elevenlabs",
|
|
2689
|
+
});
|
|
421
2690
|
```
|
|
422
2691
|
|
|
423
2692
|
</dd>
|
|
@@ -433,7 +2702,7 @@ await client.generations.createWithFiles(
|
|
|
433
2702
|
<dl>
|
|
434
2703
|
<dd>
|
|
435
2704
|
|
|
436
|
-
**
|
|
2705
|
+
**request:** `Sync.SubmitTtsJobRequest`
|
|
437
2706
|
|
|
438
2707
|
</dd>
|
|
439
2708
|
</dl>
|
|
@@ -441,23 +2710,69 @@ await client.generations.createWithFiles(
|
|
|
441
2710
|
<dl>
|
|
442
2711
|
<dd>
|
|
443
2712
|
|
|
444
|
-
**
|
|
2713
|
+
**requestOptions:** `Tts.RequestOptions`
|
|
445
2714
|
|
|
446
2715
|
</dd>
|
|
447
2716
|
</dl>
|
|
2717
|
+
</dd>
|
|
2718
|
+
</dl>
|
|
2719
|
+
|
|
2720
|
+
</dd>
|
|
2721
|
+
</dl>
|
|
2722
|
+
</details>
|
|
448
2723
|
|
|
2724
|
+
<details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">getJob</a>(id) -> Sync.TtsJob</code></summary>
|
|
449
2725
|
<dl>
|
|
450
2726
|
<dd>
|
|
451
2727
|
|
|
452
|
-
|
|
2728
|
+
#### 📝 Description
|
|
453
2729
|
|
|
2730
|
+
<dl>
|
|
2731
|
+
<dd>
|
|
2732
|
+
|
|
2733
|
+
<dl>
|
|
2734
|
+
<dd>
|
|
2735
|
+
|
|
2736
|
+
Retrieve a text-to-speech job by id. While the job is PENDING or PROCESSING, the response carries a `Retry-After: 3` header. The header is absent once the job reaches a terminal state (SUCCESS or FAILED).
|
|
2737
|
+
</dd>
|
|
2738
|
+
</dl>
|
|
454
2739
|
</dd>
|
|
455
2740
|
</dl>
|
|
456
2741
|
|
|
2742
|
+
#### 🔌 Usage
|
|
2743
|
+
|
|
457
2744
|
<dl>
|
|
458
2745
|
<dd>
|
|
459
2746
|
|
|
460
|
-
|
|
2747
|
+
<dl>
|
|
2748
|
+
<dd>
|
|
2749
|
+
|
|
2750
|
+
```typescript
|
|
2751
|
+
await client.tts.getJob("6533643b-aceb-4c40-967e-d9ba9baac39e");
|
|
2752
|
+
```
|
|
2753
|
+
|
|
2754
|
+
</dd>
|
|
2755
|
+
</dl>
|
|
2756
|
+
</dd>
|
|
2757
|
+
</dl>
|
|
2758
|
+
|
|
2759
|
+
#### ⚙️ Parameters
|
|
2760
|
+
|
|
2761
|
+
<dl>
|
|
2762
|
+
<dd>
|
|
2763
|
+
|
|
2764
|
+
<dl>
|
|
2765
|
+
<dd>
|
|
2766
|
+
|
|
2767
|
+
**id:** `string` — The job id returned when the job was submitted.
|
|
2768
|
+
|
|
2769
|
+
</dd>
|
|
2770
|
+
</dl>
|
|
2771
|
+
|
|
2772
|
+
<dl>
|
|
2773
|
+
<dd>
|
|
2774
|
+
|
|
2775
|
+
**requestOptions:** `Tts.RequestOptions`
|
|
461
2776
|
|
|
462
2777
|
</dd>
|
|
463
2778
|
</dl>
|
|
@@ -468,10 +2783,26 @@ await client.generations.createWithFiles(
|
|
|
468
2783
|
</dl>
|
|
469
2784
|
</details>
|
|
470
2785
|
|
|
471
|
-
|
|
2786
|
+
## Voices
|
|
2787
|
+
|
|
2788
|
+
<details><summary><code>client.voices.<a href="/src/api/resources/voices/client/Client.ts">list</a>({ ...params }) -> Sync.Voice[]</code></summary>
|
|
2789
|
+
<dl>
|
|
2790
|
+
<dd>
|
|
2791
|
+
|
|
2792
|
+
#### 📝 Description
|
|
2793
|
+
|
|
2794
|
+
<dl>
|
|
2795
|
+
<dd>
|
|
2796
|
+
|
|
472
2797
|
<dl>
|
|
473
2798
|
<dd>
|
|
474
2799
|
|
|
2800
|
+
List the voices available to your organization — built-in ElevenLabs voices plus any you have cloned. Use a voice's id as voiceId in POST /v2/tts and in generation text inputs. A voice that carries a `restriction` cannot currently synthesize speech — check `restriction` and choose another voice. Voice availability can change over time, so re-check it rather than assuming a voice stays usable.
|
|
2801
|
+
</dd>
|
|
2802
|
+
</dl>
|
|
2803
|
+
</dd>
|
|
2804
|
+
</dl>
|
|
2805
|
+
|
|
475
2806
|
#### 🔌 Usage
|
|
476
2807
|
|
|
477
2808
|
<dl>
|
|
@@ -481,7 +2812,7 @@ await client.generations.createWithFiles(
|
|
|
481
2812
|
<dd>
|
|
482
2813
|
|
|
483
2814
|
```typescript
|
|
484
|
-
await client.
|
|
2815
|
+
await client.voices.list();
|
|
485
2816
|
```
|
|
486
2817
|
|
|
487
2818
|
</dd>
|
|
@@ -497,7 +2828,7 @@ await client.generations.get("6533643b-aceb-4c40-967e-d9ba9baac39e");
|
|
|
497
2828
|
<dl>
|
|
498
2829
|
<dd>
|
|
499
2830
|
|
|
500
|
-
**
|
|
2831
|
+
**request:** `Sync.ListVoicesRequest`
|
|
501
2832
|
|
|
502
2833
|
</dd>
|
|
503
2834
|
</dl>
|
|
@@ -505,7 +2836,7 @@ await client.generations.get("6533643b-aceb-4c40-967e-d9ba9baac39e");
|
|
|
505
2836
|
<dl>
|
|
506
2837
|
<dd>
|
|
507
2838
|
|
|
508
|
-
**requestOptions:** `
|
|
2839
|
+
**requestOptions:** `Voices.RequestOptions`
|
|
509
2840
|
|
|
510
2841
|
</dd>
|
|
511
2842
|
</dl>
|
|
@@ -516,10 +2847,24 @@ await client.generations.get("6533643b-aceb-4c40-967e-d9ba9baac39e");
|
|
|
516
2847
|
</dl>
|
|
517
2848
|
</details>
|
|
518
2849
|
|
|
519
|
-
<details><summary><code>client.
|
|
2850
|
+
<details><summary><code>client.voices.<a href="/src/api/resources/voices/client/Client.ts">get</a>(id, { ...params }) -> Sync.Voice</code></summary>
|
|
2851
|
+
<dl>
|
|
2852
|
+
<dd>
|
|
2853
|
+
|
|
2854
|
+
#### 📝 Description
|
|
2855
|
+
|
|
520
2856
|
<dl>
|
|
521
2857
|
<dd>
|
|
522
2858
|
|
|
2859
|
+
<dl>
|
|
2860
|
+
<dd>
|
|
2861
|
+
|
|
2862
|
+
Retrieve a single voice by the same id values GET /v2/voices exposes — a built-in ElevenLabs voice id or the UUID of a voice cloned by your organization. A missing or foreign-organization id returns a 404 with errorCode voice_not_found.
|
|
2863
|
+
</dd>
|
|
2864
|
+
</dl>
|
|
2865
|
+
</dd>
|
|
2866
|
+
</dl>
|
|
2867
|
+
|
|
523
2868
|
#### 🔌 Usage
|
|
524
2869
|
|
|
525
2870
|
<dl>
|
|
@@ -529,7 +2874,7 @@ await client.generations.get("6533643b-aceb-4c40-967e-d9ba9baac39e");
|
|
|
529
2874
|
<dd>
|
|
530
2875
|
|
|
531
2876
|
```typescript
|
|
532
|
-
await client.
|
|
2877
|
+
await client.voices.get("EXAVITQu4vr4xnSDxMaL");
|
|
533
2878
|
```
|
|
534
2879
|
|
|
535
2880
|
</dd>
|
|
@@ -545,7 +2890,7 @@ await client.generations.list();
|
|
|
545
2890
|
<dl>
|
|
546
2891
|
<dd>
|
|
547
2892
|
|
|
548
|
-
**
|
|
2893
|
+
**id:** `string` — The voice id — a built-in provider voice id or a cloned voice UUID.
|
|
549
2894
|
|
|
550
2895
|
</dd>
|
|
551
2896
|
</dl>
|
|
@@ -553,7 +2898,15 @@ await client.generations.list();
|
|
|
553
2898
|
<dl>
|
|
554
2899
|
<dd>
|
|
555
2900
|
|
|
556
|
-
**
|
|
2901
|
+
**request:** `Sync.GetVoiceRequest`
|
|
2902
|
+
|
|
2903
|
+
</dd>
|
|
2904
|
+
</dl>
|
|
2905
|
+
|
|
2906
|
+
<dl>
|
|
2907
|
+
<dd>
|
|
2908
|
+
|
|
2909
|
+
**requestOptions:** `Voices.RequestOptions`
|
|
557
2910
|
|
|
558
2911
|
</dd>
|
|
559
2912
|
</dl>
|
|
@@ -564,10 +2917,28 @@ await client.generations.list();
|
|
|
564
2917
|
</dl>
|
|
565
2918
|
</details>
|
|
566
2919
|
|
|
567
|
-
<details><summary><code>client.
|
|
2920
|
+
<details><summary><code>client.voices.<a href="/src/api/resources/voices/client/Client.ts">clone</a>({ ...params }) -> Sync.ClonedVoiceResponse</code></summary>
|
|
2921
|
+
<dl>
|
|
2922
|
+
<dd>
|
|
2923
|
+
|
|
2924
|
+
#### 📝 Description
|
|
2925
|
+
|
|
2926
|
+
<dl>
|
|
2927
|
+
<dd>
|
|
2928
|
+
|
|
568
2929
|
<dl>
|
|
569
2930
|
<dd>
|
|
570
2931
|
|
|
2932
|
+
Clone a custom voice from an audio or video sample and get back its id for use in POST /v2/tts and generation text inputs.
|
|
2933
|
+
|
|
2934
|
+
The exact sequence for a local file: (1) request a presigned URL via POST /v2/assets/upload, (2) PUT the file bytes to the returned uploadUrl, (3) clone from the returned url (or register it via POST /v2/assets and clone from the assetId). Samples must be hosted in sync. labs storage — external URLs are rejected with errorCode voice_sample_upload_required. Video sources have their audio track extracted automatically (first 2 minutes). Video sources staged for extraction are limited to 1 GiB (1,073,741,824 bytes); larger sources return 413 voice_sample_source_too_large. This endpoint allows 10 requests per hour per API key (or per signed-in user).
|
|
2935
|
+
|
|
2936
|
+
For best results use 30 seconds to 2 minutes of clear, single-speaker speech without background music or noise. Samples that are too short are rejected with errorCode voice_sample_too_short. Clone slots are limited per plan (403 voice_clone_limit_reached) and voice names must be unique within your organization (409 voice_name_conflict). Sample source problems return 422 (voice_sample_not_accessible, voice_sample_type_unsupported, voice_sample_upload_required, voice_sample_extraction_failed); invalid or too-short samples return 400 (voice_sample_invalid, voice_sample_too_short). A 429 may mean the request-rate limit was exceeded or shared provider capacity is busy (voice_clone_busy); follow the response retry guidance. Provider outages return 503 (elevenlabs_service_unavailable).
|
|
2937
|
+
</dd>
|
|
2938
|
+
</dl>
|
|
2939
|
+
</dd>
|
|
2940
|
+
</dl>
|
|
2941
|
+
|
|
571
2942
|
#### 🔌 Usage
|
|
572
2943
|
|
|
573
2944
|
<dl>
|
|
@@ -577,21 +2948,10 @@ await client.generations.list();
|
|
|
577
2948
|
<dd>
|
|
578
2949
|
|
|
579
2950
|
```typescript
|
|
580
|
-
await client.
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
url: "https://assets.sync.so/docs/example-video.mp4",
|
|
585
|
-
},
|
|
586
|
-
{
|
|
587
|
-
type: "audio",
|
|
588
|
-
url: "https://assets.sync.so/docs/example-audio.wav",
|
|
589
|
-
},
|
|
590
|
-
],
|
|
591
|
-
model: "lipsync-2",
|
|
592
|
-
options: {
|
|
593
|
-
sync_mode: "loop",
|
|
594
|
-
},
|
|
2951
|
+
await client.voices.clone({
|
|
2952
|
+
name: "My Narrator",
|
|
2953
|
+
provider: "elevenlabs",
|
|
2954
|
+
assetId: "550e8400-e29b-41d4-a716-446655440000",
|
|
595
2955
|
});
|
|
596
2956
|
```
|
|
597
2957
|
|
|
@@ -608,7 +2968,7 @@ await client.generations.estimateCost({
|
|
|
608
2968
|
<dl>
|
|
609
2969
|
<dd>
|
|
610
2970
|
|
|
611
|
-
**request:** `Sync.
|
|
2971
|
+
**request:** `Sync.CreateVoiceRequest`
|
|
612
2972
|
|
|
613
2973
|
</dd>
|
|
614
2974
|
</dl>
|
|
@@ -616,7 +2976,7 @@ await client.generations.estimateCost({
|
|
|
616
2976
|
<dl>
|
|
617
2977
|
<dd>
|
|
618
2978
|
|
|
619
|
-
**requestOptions:** `
|
|
2979
|
+
**requestOptions:** `Voices.RequestOptions`
|
|
620
2980
|
|
|
621
2981
|
</dd>
|
|
622
2982
|
</dl>
|
|
@@ -627,9 +2987,7 @@ await client.generations.estimateCost({
|
|
|
627
2987
|
</dl>
|
|
628
2988
|
</details>
|
|
629
2989
|
|
|
630
|
-
|
|
631
|
-
|
|
632
|
-
<details><summary><code>client.models.<a href="/src/api/resources/models/client/Client.ts">list</a>() -> Sync.ModelInfo[]</code></summary>
|
|
2990
|
+
<details><summary><code>client.voices.<a href="/src/api/resources/voices/client/Client.ts">delete</a>(id) -> boolean</code></summary>
|
|
633
2991
|
<dl>
|
|
634
2992
|
<dd>
|
|
635
2993
|
|
|
@@ -641,8 +2999,7 @@ await client.generations.estimateCost({
|
|
|
641
2999
|
<dl>
|
|
642
3000
|
<dd>
|
|
643
3001
|
|
|
644
|
-
|
|
645
|
-
|
|
3002
|
+
Delete a cloned voice, freeing a clone slot. Unknown ids return 404 with errorCode `voice_not_found`.
|
|
646
3003
|
</dd>
|
|
647
3004
|
</dl>
|
|
648
3005
|
</dd>
|
|
@@ -657,7 +3014,7 @@ List all available models for the authenticated user. Returns active (non-deprec
|
|
|
657
3014
|
<dd>
|
|
658
3015
|
|
|
659
3016
|
```typescript
|
|
660
|
-
await client.
|
|
3017
|
+
await client.voices.delete("7f9c2b3a-1d4e-4a8b-9c0d-2e3f4a5b6c7d");
|
|
661
3018
|
```
|
|
662
3019
|
|
|
663
3020
|
</dd>
|
|
@@ -673,7 +3030,15 @@ await client.models.list();
|
|
|
673
3030
|
<dl>
|
|
674
3031
|
<dd>
|
|
675
3032
|
|
|
676
|
-
**
|
|
3033
|
+
**id:** `string` — The Sync UUID returned as id when the voice was cloned.
|
|
3034
|
+
|
|
3035
|
+
</dd>
|
|
3036
|
+
</dl>
|
|
3037
|
+
|
|
3038
|
+
<dl>
|
|
3039
|
+
<dd>
|
|
3040
|
+
|
|
3041
|
+
**requestOptions:** `Voices.RequestOptions`
|
|
677
3042
|
|
|
678
3043
|
</dd>
|
|
679
3044
|
</dl>
|