@sync.so/sdk 0.3.0 → 0.5.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 +31 -1
- package/Client.js +58 -8
- package/api/resources/account/client/Client.d.ts +63 -0
- package/api/resources/account/client/Client.js +204 -0
- package/api/resources/account/client/index.d.ts +1 -0
- package/api/resources/account/client/index.js +17 -0
- package/api/resources/account/client/requests/GetAccountRequest.d.ts +13 -0
- package/api/resources/account/client/requests/GetAccountRequest.js +5 -0
- package/api/resources/account/client/requests/ListAccountOrganizationsRequest.d.ts +13 -0
- package/api/resources/account/client/requests/ListAccountOrganizationsRequest.js +5 -0
- package/api/resources/account/client/requests/index.d.ts +2 -0
- package/api/resources/account/client/requests/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/AccountOrganizationListItem.d.ts +9 -0
- package/api/resources/account/types/AccountOrganizationListItem.js +5 -0
- package/api/resources/account/types/AccountOrganizations.d.ts +7 -0
- package/api/resources/account/types/AccountOrganizations.js +5 -0
- package/api/resources/account/types/AccountOverview.d.ts +35 -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 +14 -0
- package/api/resources/account/types/index.js +30 -0
- package/api/resources/assets/client/Client.d.ts +150 -1
- package/api/resources/assets/client/Client.js +601 -3
- package/api/resources/assets/client/requests/CountAssetsRequest.d.ts +30 -0
- package/api/resources/assets/client/requests/CountAssetsRequest.js +5 -0
- package/api/resources/assets/client/requests/FindUploadedAssetRequest.d.ts +18 -0
- package/api/resources/assets/client/requests/FindUploadedAssetRequest.js +5 -0
- package/api/resources/assets/client/requests/ListAssetsRequest.d.ts +5 -1
- package/api/resources/assets/client/requests/index.d.ts +2 -0
- package/api/resources/audioTrims/client/Client.d.ts +72 -0
- package/api/resources/audioTrims/client/Client.js +217 -0
- package/api/resources/audioTrims/client/index.d.ts +1 -0
- package/api/resources/audioTrims/client/index.js +17 -0
- package/api/resources/audioTrims/client/requests/CreateAudioTrimRequest.d.ts +21 -0
- package/api/resources/audioTrims/client/requests/CreateAudioTrimRequest.js +5 -0
- package/api/resources/audioTrims/client/requests/index.d.ts +1 -0
- package/api/resources/audioTrims/client/requests/index.js +2 -0
- package/api/resources/audioTrims/index.d.ts +1 -0
- package/api/resources/audioTrims/index.js +17 -0
- package/api/resources/batch/client/Client.d.ts +287 -2
- package/api/resources/batch/client/Client.js +354 -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/AudioTrimTooManyRequestsError.d.ts +9 -0
- package/api/resources/common/errors/AudioTrimTooManyRequestsError.js +52 -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/LinkImportInProgressError.d.ts +9 -0
- package/api/resources/common/errors/LinkImportInProgressError.js +52 -0
- package/api/resources/common/errors/LinkImportTooManyRequestsError.d.ts +9 -0
- package/api/resources/common/errors/LinkImportTooManyRequestsError.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/SpeakerAnalysisTooManyRequestsError.d.ts +9 -0
- package/api/resources/common/errors/SpeakerAnalysisTooManyRequestsError.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 +13 -0
- package/api/resources/common/errors/index.js +13 -0
- package/api/resources/common/types/ActiveSpeaker.d.ts +10 -4
- package/api/resources/common/types/AnalyzeSpeakersRequest.d.ts +14 -0
- package/api/resources/common/types/AnalyzeSpeakersRequest.js +5 -0
- package/api/resources/common/types/Asset.d.ts +4 -0
- package/api/resources/common/types/AssetAudioSource.d.ts +17 -0
- package/api/resources/common/types/AssetAudioSource.js +10 -0
- package/api/resources/common/types/AssetIds.d.ts +4 -0
- package/api/resources/common/types/AssetIds.js +5 -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/Audio.d.ts +2 -2
- package/api/resources/common/types/AudioTrim.d.ts +20 -0
- package/api/resources/common/types/AudioTrim.js +5 -0
- package/api/resources/common/types/AudioTrimStatus.d.ts +13 -0
- package/api/resources/common/types/AudioTrimStatus.js +12 -0
- package/api/resources/common/types/BatchConcurrencyError.d.ts +21 -0
- package/api/resources/common/types/BatchConcurrencyError.js +5 -0
- package/api/resources/common/types/BatchGetAssetsRequest.d.ts +8 -0
- package/api/resources/common/types/BatchGetAssetsRequest.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 +35 -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/CreateAudioTrimDto.d.ts +16 -0
- package/api/resources/common/types/CreateAudioTrimDto.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 +12 -4
- 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 +19 -0
- package/api/resources/common/types/DialogueEditError.js +5 -0
- package/api/resources/common/types/DialogueEditErrorCode.d.ts +20 -0
- package/api/resources/common/types/DialogueEditErrorCode.js +19 -0
- package/api/resources/common/types/DialogueEditFailedSlot.d.ts +12 -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 +23 -0
- package/api/resources/common/types/DubDto.js +5 -0
- package/api/resources/common/types/DubLanguage.d.ts +125 -0
- package/api/resources/common/types/DubLanguage.js +118 -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 +126 -0
- package/api/resources/common/types/DubSourceLanguage.js +119 -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/FindUploadedAssetResponse.d.ts +8 -0
- package/api/resources/common/types/FindUploadedAssetResponse.js +5 -0
- package/api/resources/common/types/Generation.d.ts +17 -3
- package/api/resources/common/types/GenerationConcurrencyError.d.ts +21 -0
- package/api/resources/common/types/GenerationConcurrencyError.js +5 -0
- package/api/resources/common/types/GenerationCount.d.ts +6 -0
- package/api/resources/common/types/GenerationCount.js +5 -0
- package/api/resources/common/types/GenerationCountType.d.ts +8 -0
- package/api/resources/common/types/GenerationCountType.js +10 -0
- package/api/resources/common/types/GenerationError.d.ts +20 -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/GenerationProgress.d.ts +24 -0
- package/api/resources/common/types/GenerationProgress.js +5 -0
- package/api/resources/common/types/GenerationProgressStage.d.ts +13 -0
- package/api/resources/common/types/GenerationProgressStage.js +12 -0
- package/api/resources/common/types/GenerationSegment.d.ts +14 -6
- package/api/resources/common/types/GenerationSource.d.ts +17 -0
- package/api/resources/common/types/GenerationSource.js +19 -0
- package/api/resources/common/types/GenerationStatus.d.ts +3 -2
- package/api/resources/common/types/GenerationStatus.js +1 -0
- 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/LinkImportError.d.ts +33 -0
- package/api/resources/common/types/LinkImportError.js +5 -0
- package/api/resources/common/types/LinkImportStatus.d.ts +14 -0
- package/api/resources/common/types/LinkImportStatus.js +13 -0
- 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 +12 -0
- package/api/resources/common/types/ProjectGenerationError.js +5 -0
- package/api/resources/common/types/ProjectGenerationErrorReason.d.ts +7 -0
- package/api/resources/common/types/ProjectGenerationErrorReason.js +9 -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/SliceSpeakerFaceTrackRequest.d.ts +21 -0
- package/api/resources/common/types/SliceSpeakerFaceTrackRequest.js +5 -0
- package/api/resources/common/types/SpeakerAnalysis.d.ts +26 -0
- package/api/resources/common/types/SpeakerAnalysis.js +5 -0
- package/api/resources/common/types/SpeakerAnalysisSpeaker.d.ts +21 -0
- package/api/resources/common/types/SpeakerAnalysisSpeaker.js +5 -0
- package/api/resources/common/types/SpeakerAnalysisStatus.d.ts +12 -0
- package/api/resources/common/types/SpeakerAnalysisStatus.js +11 -0
- package/api/resources/common/types/SpeakerAvatar.d.ts +16 -0
- package/api/resources/common/types/SpeakerAvatar.js +5 -0
- package/api/resources/common/types/SpeakerAvatarBox.d.ts +12 -0
- package/api/resources/common/types/SpeakerAvatarBox.js +5 -0
- package/api/resources/common/types/SpeakerFaceSupport.d.ts +17 -0
- package/api/resources/common/types/SpeakerFaceSupport.js +5 -0
- package/api/resources/common/types/SpeakerFaceSupportInterval.d.ts +9 -0
- package/api/resources/common/types/SpeakerFaceSupportInterval.js +5 -0
- package/api/resources/common/types/SpeakerFaceTrack.d.ts +18 -0
- package/api/resources/common/types/SpeakerFaceTrack.js +5 -0
- package/api/resources/common/types/SpeakerFaceTrackSlice.d.ts +7 -0
- package/api/resources/common/types/SpeakerFaceTrackSlice.js +5 -0
- package/api/resources/common/types/SpeakerFaceTrackSliceFrames.d.ts +9 -0
- package/api/resources/common/types/SpeakerFaceTrackSliceFrames.js +5 -0
- package/api/resources/common/types/SpeakerMatchEvidence.d.ts +16 -0
- package/api/resources/common/types/SpeakerMatchEvidence.js +5 -0
- package/api/resources/common/types/SpeakerMatchStatus.d.ts +11 -0
- package/api/resources/common/types/SpeakerMatchStatus.js +10 -0
- package/api/resources/common/types/SyncMode.d.ts +1 -1
- package/api/resources/common/types/Transcript.d.ts +15 -0
- package/api/resources/common/types/Transcript.js +5 -0
- package/api/resources/common/types/TranscriptSegment.d.ts +15 -0
- package/api/resources/common/types/TranscriptSegment.js +5 -0
- package/api/resources/common/types/TranscriptSpeaker.d.ts +13 -0
- package/api/resources/common/types/TranscriptSpeaker.js +5 -0
- package/api/resources/common/types/TranscriptSpeakerLabelFlag.d.ts +11 -0
- package/api/resources/common/types/TranscriptSpeakerLabelFlag.js +10 -0
- package/api/resources/common/types/TranscriptWord.d.ts +20 -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 +39 -0
- package/api/resources/common/types/TranscriptionJob.js +5 -0
- package/api/resources/common/types/TranscriptionJobEstimate.d.ts +20 -0
- package/api/resources/common/types/TranscriptionJobEstimate.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/Tts.d.ts +1 -1
- 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 +5 -3
- 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 +119 -1
- package/api/resources/common/types/index.js +119 -1
- package/api/resources/dialogueEdits/client/Client.d.ts +99 -0
- package/api/resources/dialogueEdits/client/Client.js +248 -0
- package/api/resources/dialogueEdits/client/index.d.ts +1 -0
- package/api/resources/dialogueEdits/client/index.js +17 -0
- package/api/resources/dialogueEdits/client/requests/CreateDialogueEditRequest.d.ts +46 -0
- package/api/resources/dialogueEdits/client/requests/CreateDialogueEditRequest.js +5 -0
- package/api/resources/dialogueEdits/client/requests/index.d.ts +1 -0
- package/api/resources/dialogueEdits/client/requests/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/generationCosts/index.d.ts +1 -0
- package/api/resources/generationCosts/index.js +17 -0
- package/api/resources/generationCosts/types/CostAvailability.d.ts +10 -0
- package/api/resources/generationCosts/types/CostAvailability.js +12 -0
- package/api/resources/generationCosts/types/CostComponent.d.ts +19 -0
- package/api/resources/generationCosts/types/CostComponent.js +5 -0
- package/api/resources/generationCosts/types/CostComponentStatus.d.ts +10 -0
- package/api/resources/generationCosts/types/CostComponentStatus.js +12 -0
- package/api/resources/generationCosts/types/CostComponentType.d.ts +9 -0
- package/api/resources/generationCosts/types/CostComponentType.js +11 -0
- package/api/resources/generationCosts/types/CostSource.d.ts +9 -0
- package/api/resources/generationCosts/types/CostSource.js +11 -0
- package/api/resources/generationCosts/types/CostUnit.d.ts +8 -0
- package/api/resources/generationCosts/types/CostUnit.js +10 -0
- package/api/resources/generationCosts/types/CostValueBasis.d.ts +9 -0
- package/api/resources/generationCosts/types/CostValueBasis.js +11 -0
- package/api/resources/generationCosts/types/GenerationCosts.d.ts +23 -0
- package/api/resources/generationCosts/types/GenerationCosts.js +5 -0
- package/api/resources/generationCosts/types/GenerationCostsApiKey.d.ts +10 -0
- package/api/resources/generationCosts/types/GenerationCostsApiKey.js +5 -0
- package/api/resources/generationCosts/types/GenerationCostsList.d.ts +12 -0
- package/api/resources/generationCosts/types/GenerationCostsList.js +5 -0
- package/api/resources/generationCosts/types/GenerationCostsListItem.d.ts +17 -0
- package/api/resources/generationCosts/types/GenerationCostsListItem.js +5 -0
- package/api/resources/generationCosts/types/index.d.ts +11 -0
- package/api/resources/generationCosts/types/index.js +27 -0
- package/api/resources/generations/client/Client.d.ts +194 -19
- package/api/resources/generations/client/Client.js +591 -31
- package/api/resources/generations/client/requests/CountGenerationsRequest.d.ts +30 -0
- package/api/resources/generations/client/requests/CountGenerationsRequest.js +5 -0
- 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/ListGenerationCostsRequest.d.ts +29 -0
- package/api/resources/generations/client/requests/ListGenerationCostsRequest.js +5 -0
- package/api/resources/generations/client/requests/ListGenerationsRequest.d.ts +16 -0
- package/api/resources/generations/client/requests/index.d.ts +5 -0
- package/api/resources/index.d.ts +24 -0
- package/api/resources/index.js +25 -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 +132 -0
- package/api/resources/transcriptions/client/Client.js +442 -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 +111 -0
- package/api/resources/voices/client/Client.js +381 -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 +18 -16
- package/api/resources/webhooks/types/WebhookStatus.d.ts +4 -2
- package/api/resources/webhooks/types/WebhookStatus.js +2 -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 +31 -1
- package/dist/Client.js +58 -8
- package/dist/api/resources/account/client/Client.d.ts +63 -0
- package/dist/api/resources/account/client/Client.js +204 -0
- package/dist/api/resources/account/client/index.d.ts +1 -0
- package/dist/api/resources/account/client/index.js +17 -0
- package/dist/api/resources/account/client/requests/GetAccountRequest.d.ts +13 -0
- package/dist/api/resources/account/client/requests/GetAccountRequest.js +5 -0
- package/dist/api/resources/account/client/requests/ListAccountOrganizationsRequest.d.ts +13 -0
- package/dist/api/resources/account/client/requests/ListAccountOrganizationsRequest.js +5 -0
- package/dist/api/resources/account/client/requests/index.d.ts +2 -0
- package/dist/api/resources/account/client/requests/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/AccountOrganizationListItem.d.ts +9 -0
- package/dist/api/resources/account/types/AccountOrganizationListItem.js +5 -0
- package/dist/api/resources/account/types/AccountOrganizations.d.ts +7 -0
- package/dist/api/resources/account/types/AccountOrganizations.js +5 -0
- package/dist/api/resources/account/types/AccountOverview.d.ts +35 -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 +14 -0
- package/dist/api/resources/account/types/index.js +30 -0
- package/dist/api/resources/assets/client/Client.d.ts +150 -1
- package/dist/api/resources/assets/client/Client.js +601 -3
- package/dist/api/resources/assets/client/requests/CountAssetsRequest.d.ts +30 -0
- package/dist/api/resources/assets/client/requests/CountAssetsRequest.js +5 -0
- package/dist/api/resources/assets/client/requests/FindUploadedAssetRequest.d.ts +18 -0
- package/dist/api/resources/assets/client/requests/FindUploadedAssetRequest.js +5 -0
- package/dist/api/resources/assets/client/requests/ListAssetsRequest.d.ts +5 -1
- package/dist/api/resources/assets/client/requests/index.d.ts +2 -0
- package/dist/api/resources/audioTrims/client/Client.d.ts +72 -0
- package/dist/api/resources/audioTrims/client/Client.js +217 -0
- package/dist/api/resources/audioTrims/client/index.d.ts +1 -0
- package/dist/api/resources/audioTrims/client/index.js +17 -0
- package/dist/api/resources/audioTrims/client/requests/CreateAudioTrimRequest.d.ts +21 -0
- package/dist/api/resources/audioTrims/client/requests/CreateAudioTrimRequest.js +5 -0
- package/dist/api/resources/audioTrims/client/requests/index.d.ts +1 -0
- package/dist/api/resources/audioTrims/client/requests/index.js +2 -0
- package/dist/api/resources/audioTrims/index.d.ts +1 -0
- package/dist/api/resources/audioTrims/index.js +17 -0
- package/dist/api/resources/batch/client/Client.d.ts +287 -2
- package/dist/api/resources/batch/client/Client.js +354 -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/AudioTrimTooManyRequestsError.d.ts +9 -0
- package/dist/api/resources/common/errors/AudioTrimTooManyRequestsError.js +52 -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/LinkImportInProgressError.d.ts +9 -0
- package/dist/api/resources/common/errors/LinkImportInProgressError.js +52 -0
- package/dist/api/resources/common/errors/LinkImportTooManyRequestsError.d.ts +9 -0
- package/dist/api/resources/common/errors/LinkImportTooManyRequestsError.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/SpeakerAnalysisTooManyRequestsError.d.ts +9 -0
- package/dist/api/resources/common/errors/SpeakerAnalysisTooManyRequestsError.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 +13 -0
- package/dist/api/resources/common/errors/index.js +13 -0
- package/dist/api/resources/common/types/ActiveSpeaker.d.ts +10 -4
- package/dist/api/resources/common/types/AnalyzeSpeakersRequest.d.ts +14 -0
- package/dist/api/resources/common/types/AnalyzeSpeakersRequest.js +5 -0
- package/dist/api/resources/common/types/Asset.d.ts +4 -0
- package/dist/api/resources/common/types/AssetAudioSource.d.ts +17 -0
- package/dist/api/resources/common/types/AssetAudioSource.js +10 -0
- package/dist/api/resources/common/types/AssetIds.d.ts +4 -0
- package/dist/api/resources/common/types/AssetIds.js +5 -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/Audio.d.ts +2 -2
- package/dist/api/resources/common/types/AudioTrim.d.ts +20 -0
- package/dist/api/resources/common/types/AudioTrim.js +5 -0
- package/dist/api/resources/common/types/AudioTrimStatus.d.ts +13 -0
- package/dist/api/resources/common/types/AudioTrimStatus.js +12 -0
- package/dist/api/resources/common/types/BatchConcurrencyError.d.ts +21 -0
- package/dist/api/resources/common/types/BatchConcurrencyError.js +5 -0
- package/dist/api/resources/common/types/BatchGetAssetsRequest.d.ts +8 -0
- package/dist/api/resources/common/types/BatchGetAssetsRequest.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 +35 -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/CreateAudioTrimDto.d.ts +16 -0
- package/dist/api/resources/common/types/CreateAudioTrimDto.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 +12 -4
- 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 +19 -0
- package/dist/api/resources/common/types/DialogueEditError.js +5 -0
- package/dist/api/resources/common/types/DialogueEditErrorCode.d.ts +20 -0
- package/dist/api/resources/common/types/DialogueEditErrorCode.js +19 -0
- package/dist/api/resources/common/types/DialogueEditFailedSlot.d.ts +12 -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 +23 -0
- package/dist/api/resources/common/types/DubDto.js +5 -0
- package/dist/api/resources/common/types/DubLanguage.d.ts +125 -0
- package/dist/api/resources/common/types/DubLanguage.js +118 -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 +126 -0
- package/dist/api/resources/common/types/DubSourceLanguage.js +119 -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/FindUploadedAssetResponse.d.ts +8 -0
- package/dist/api/resources/common/types/FindUploadedAssetResponse.js +5 -0
- package/dist/api/resources/common/types/Generation.d.ts +17 -3
- 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/GenerationCount.d.ts +6 -0
- package/dist/api/resources/common/types/GenerationCount.js +5 -0
- package/dist/api/resources/common/types/GenerationCountType.d.ts +8 -0
- package/dist/api/resources/common/types/GenerationCountType.js +10 -0
- package/dist/api/resources/common/types/GenerationError.d.ts +20 -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/GenerationProgress.d.ts +24 -0
- package/dist/api/resources/common/types/GenerationProgress.js +5 -0
- package/dist/api/resources/common/types/GenerationProgressStage.d.ts +13 -0
- package/dist/api/resources/common/types/GenerationProgressStage.js +12 -0
- package/dist/api/resources/common/types/GenerationSegment.d.ts +14 -6
- package/dist/api/resources/common/types/GenerationSource.d.ts +17 -0
- package/dist/api/resources/common/types/GenerationSource.js +19 -0
- package/dist/api/resources/common/types/GenerationStatus.d.ts +3 -2
- package/dist/api/resources/common/types/GenerationStatus.js +1 -0
- 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/LinkImportError.d.ts +33 -0
- package/dist/api/resources/common/types/LinkImportError.js +5 -0
- package/dist/api/resources/common/types/LinkImportStatus.d.ts +14 -0
- package/dist/api/resources/common/types/LinkImportStatus.js +13 -0
- 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 +12 -0
- package/dist/api/resources/common/types/ProjectGenerationError.js +5 -0
- package/dist/api/resources/common/types/ProjectGenerationErrorReason.d.ts +7 -0
- package/dist/api/resources/common/types/ProjectGenerationErrorReason.js +9 -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/SliceSpeakerFaceTrackRequest.d.ts +21 -0
- package/dist/api/resources/common/types/SliceSpeakerFaceTrackRequest.js +5 -0
- package/dist/api/resources/common/types/SpeakerAnalysis.d.ts +26 -0
- package/dist/api/resources/common/types/SpeakerAnalysis.js +5 -0
- package/dist/api/resources/common/types/SpeakerAnalysisSpeaker.d.ts +21 -0
- package/dist/api/resources/common/types/SpeakerAnalysisSpeaker.js +5 -0
- package/dist/api/resources/common/types/SpeakerAnalysisStatus.d.ts +12 -0
- package/dist/api/resources/common/types/SpeakerAnalysisStatus.js +11 -0
- package/dist/api/resources/common/types/SpeakerAvatar.d.ts +16 -0
- package/dist/api/resources/common/types/SpeakerAvatar.js +5 -0
- package/dist/api/resources/common/types/SpeakerAvatarBox.d.ts +12 -0
- package/dist/api/resources/common/types/SpeakerAvatarBox.js +5 -0
- package/dist/api/resources/common/types/SpeakerFaceSupport.d.ts +17 -0
- package/dist/api/resources/common/types/SpeakerFaceSupport.js +5 -0
- package/dist/api/resources/common/types/SpeakerFaceSupportInterval.d.ts +9 -0
- package/dist/api/resources/common/types/SpeakerFaceSupportInterval.js +5 -0
- package/dist/api/resources/common/types/SpeakerFaceTrack.d.ts +18 -0
- package/dist/api/resources/common/types/SpeakerFaceTrack.js +5 -0
- package/dist/api/resources/common/types/SpeakerFaceTrackSlice.d.ts +7 -0
- package/dist/api/resources/common/types/SpeakerFaceTrackSlice.js +5 -0
- package/dist/api/resources/common/types/SpeakerFaceTrackSliceFrames.d.ts +9 -0
- package/dist/api/resources/common/types/SpeakerFaceTrackSliceFrames.js +5 -0
- package/dist/api/resources/common/types/SpeakerMatchEvidence.d.ts +16 -0
- package/dist/api/resources/common/types/SpeakerMatchEvidence.js +5 -0
- package/dist/api/resources/common/types/SpeakerMatchStatus.d.ts +11 -0
- package/dist/api/resources/common/types/SpeakerMatchStatus.js +10 -0
- package/dist/api/resources/common/types/SyncMode.d.ts +1 -1
- package/dist/api/resources/common/types/Transcript.d.ts +15 -0
- package/dist/api/resources/common/types/Transcript.js +5 -0
- package/dist/api/resources/common/types/TranscriptSegment.d.ts +15 -0
- package/dist/api/resources/common/types/TranscriptSegment.js +5 -0
- package/dist/api/resources/common/types/TranscriptSpeaker.d.ts +13 -0
- package/dist/api/resources/common/types/TranscriptSpeaker.js +5 -0
- package/dist/api/resources/common/types/TranscriptSpeakerLabelFlag.d.ts +11 -0
- package/dist/api/resources/common/types/TranscriptSpeakerLabelFlag.js +10 -0
- package/dist/api/resources/common/types/TranscriptWord.d.ts +20 -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 +39 -0
- package/dist/api/resources/common/types/TranscriptionJob.js +5 -0
- package/dist/api/resources/common/types/TranscriptionJobEstimate.d.ts +20 -0
- package/dist/api/resources/common/types/TranscriptionJobEstimate.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/Tts.d.ts +1 -1
- 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 +5 -3
- 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 +119 -1
- package/dist/api/resources/common/types/index.js +119 -1
- package/dist/api/resources/dialogueEdits/client/Client.d.ts +99 -0
- package/dist/api/resources/dialogueEdits/client/Client.js +248 -0
- package/dist/api/resources/dialogueEdits/client/index.d.ts +1 -0
- package/dist/api/resources/dialogueEdits/client/index.js +17 -0
- package/dist/api/resources/dialogueEdits/client/requests/CreateDialogueEditRequest.d.ts +46 -0
- package/dist/api/resources/dialogueEdits/client/requests/CreateDialogueEditRequest.js +5 -0
- package/dist/api/resources/dialogueEdits/client/requests/index.d.ts +1 -0
- package/dist/api/resources/dialogueEdits/client/requests/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/generationCosts/index.d.ts +1 -0
- package/dist/api/resources/generationCosts/index.js +17 -0
- package/dist/api/resources/generationCosts/types/CostAvailability.d.ts +10 -0
- package/dist/api/resources/generationCosts/types/CostAvailability.js +12 -0
- package/dist/api/resources/generationCosts/types/CostComponent.d.ts +19 -0
- package/dist/api/resources/generationCosts/types/CostComponent.js +5 -0
- package/dist/api/resources/generationCosts/types/CostComponentStatus.d.ts +10 -0
- package/dist/api/resources/generationCosts/types/CostComponentStatus.js +12 -0
- package/dist/api/resources/generationCosts/types/CostComponentType.d.ts +9 -0
- package/dist/api/resources/generationCosts/types/CostComponentType.js +11 -0
- package/dist/api/resources/generationCosts/types/CostSource.d.ts +9 -0
- package/dist/api/resources/generationCosts/types/CostSource.js +11 -0
- package/dist/api/resources/generationCosts/types/CostUnit.d.ts +8 -0
- package/dist/api/resources/generationCosts/types/CostUnit.js +10 -0
- package/dist/api/resources/generationCosts/types/CostValueBasis.d.ts +9 -0
- package/dist/api/resources/generationCosts/types/CostValueBasis.js +11 -0
- package/dist/api/resources/generationCosts/types/GenerationCosts.d.ts +23 -0
- package/dist/api/resources/generationCosts/types/GenerationCosts.js +5 -0
- package/dist/api/resources/generationCosts/types/GenerationCostsApiKey.d.ts +10 -0
- package/dist/api/resources/generationCosts/types/GenerationCostsApiKey.js +5 -0
- package/dist/api/resources/generationCosts/types/GenerationCostsList.d.ts +12 -0
- package/dist/api/resources/generationCosts/types/GenerationCostsList.js +5 -0
- package/dist/api/resources/generationCosts/types/GenerationCostsListItem.d.ts +17 -0
- package/dist/api/resources/generationCosts/types/GenerationCostsListItem.js +5 -0
- package/dist/api/resources/generationCosts/types/index.d.ts +11 -0
- package/dist/api/resources/generationCosts/types/index.js +27 -0
- package/dist/api/resources/generations/client/Client.d.ts +194 -19
- package/dist/api/resources/generations/client/Client.js +591 -31
- package/dist/api/resources/generations/client/requests/CountGenerationsRequest.d.ts +30 -0
- package/dist/api/resources/generations/client/requests/CountGenerationsRequest.js +5 -0
- 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/ListGenerationCostsRequest.d.ts +29 -0
- package/dist/api/resources/generations/client/requests/ListGenerationCostsRequest.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 +5 -0
- package/dist/api/resources/index.d.ts +24 -0
- package/dist/api/resources/index.js +25 -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 +132 -0
- package/dist/api/resources/transcriptions/client/Client.js +442 -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 +111 -0
- package/dist/api/resources/voices/client/Client.js +381 -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 +18 -16
- package/dist/api/resources/webhooks/types/WebhookStatus.d.ts +4 -2
- package/dist/api/resources/webhooks/types/WebhookStatus.js +2 -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 +3344 -108
- 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,3135 @@
|
|
|
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>({ ...params }) -> 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
|
+
**request:** `Sync.GetAccountRequest`
|
|
49
|
+
|
|
50
|
+
</dd>
|
|
51
|
+
</dl>
|
|
52
|
+
|
|
53
|
+
<dl>
|
|
54
|
+
<dd>
|
|
55
|
+
|
|
56
|
+
**requestOptions:** `Account.RequestOptions`
|
|
57
|
+
|
|
58
|
+
</dd>
|
|
59
|
+
</dl>
|
|
60
|
+
</dd>
|
|
61
|
+
</dl>
|
|
62
|
+
|
|
63
|
+
</dd>
|
|
64
|
+
</dl>
|
|
65
|
+
</details>
|
|
66
|
+
|
|
67
|
+
<details><summary><code>client.account.<a href="/src/api/resources/account/client/Client.ts">listOrganizations</a>({ ...params }) -> Sync.AccountOrganizations</code></summary>
|
|
68
|
+
<dl>
|
|
69
|
+
<dd>
|
|
70
|
+
|
|
71
|
+
#### 📝 Description
|
|
72
|
+
|
|
73
|
+
<dl>
|
|
74
|
+
<dd>
|
|
75
|
+
|
|
76
|
+
<dl>
|
|
77
|
+
<dd>
|
|
78
|
+
|
|
79
|
+
List the organizations these credentials can access, current one first. An API key lists only its own organization. An OAuth connection lists the organizations selected when it was connected. Send an ID as x-sync-organization-id on subsequent requests to select that organization. An inaccessible organization returns 403; an invalid ID returns 400.
|
|
80
|
+
</dd>
|
|
81
|
+
</dl>
|
|
82
|
+
</dd>
|
|
83
|
+
</dl>
|
|
84
|
+
|
|
85
|
+
#### 🔌 Usage
|
|
86
|
+
|
|
87
|
+
<dl>
|
|
88
|
+
<dd>
|
|
89
|
+
|
|
90
|
+
<dl>
|
|
91
|
+
<dd>
|
|
92
|
+
|
|
93
|
+
```typescript
|
|
94
|
+
await client.account.listOrganizations();
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
</dd>
|
|
98
|
+
</dl>
|
|
99
|
+
</dd>
|
|
100
|
+
</dl>
|
|
101
|
+
|
|
102
|
+
#### ⚙️ Parameters
|
|
103
|
+
|
|
104
|
+
<dl>
|
|
105
|
+
<dd>
|
|
106
|
+
|
|
107
|
+
<dl>
|
|
108
|
+
<dd>
|
|
109
|
+
|
|
110
|
+
**request:** `Sync.ListAccountOrganizationsRequest`
|
|
111
|
+
|
|
112
|
+
</dd>
|
|
113
|
+
</dl>
|
|
114
|
+
|
|
115
|
+
<dl>
|
|
116
|
+
<dd>
|
|
117
|
+
|
|
118
|
+
**requestOptions:** `Account.RequestOptions`
|
|
119
|
+
|
|
120
|
+
</dd>
|
|
121
|
+
</dl>
|
|
122
|
+
</dd>
|
|
123
|
+
</dl>
|
|
124
|
+
|
|
125
|
+
</dd>
|
|
126
|
+
</dl>
|
|
127
|
+
</details>
|
|
128
|
+
|
|
3
129
|
## Assets
|
|
4
130
|
|
|
5
|
-
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">list</a>({ ...params }) -> Sync.PaginatedAssetsResponse</code></summary>
|
|
131
|
+
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">list</a>({ ...params }) -> Sync.PaginatedAssetsResponse</code></summary>
|
|
132
|
+
<dl>
|
|
133
|
+
<dd>
|
|
134
|
+
|
|
135
|
+
#### 📝 Description
|
|
136
|
+
|
|
137
|
+
<dl>
|
|
138
|
+
<dd>
|
|
139
|
+
|
|
140
|
+
<dl>
|
|
141
|
+
<dd>
|
|
142
|
+
|
|
143
|
+
List all assets in your organization's media library.
|
|
144
|
+
</dd>
|
|
145
|
+
</dl>
|
|
146
|
+
</dd>
|
|
147
|
+
</dl>
|
|
148
|
+
|
|
149
|
+
#### 🔌 Usage
|
|
150
|
+
|
|
151
|
+
<dl>
|
|
152
|
+
<dd>
|
|
153
|
+
|
|
154
|
+
<dl>
|
|
155
|
+
<dd>
|
|
156
|
+
|
|
157
|
+
```typescript
|
|
158
|
+
await client.assets.list({
|
|
159
|
+
limit: 10,
|
|
160
|
+
sortBy: "dateDesc",
|
|
161
|
+
});
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
</dd>
|
|
165
|
+
</dl>
|
|
166
|
+
</dd>
|
|
167
|
+
</dl>
|
|
168
|
+
|
|
169
|
+
#### ⚙️ Parameters
|
|
170
|
+
|
|
171
|
+
<dl>
|
|
172
|
+
<dd>
|
|
173
|
+
|
|
174
|
+
<dl>
|
|
175
|
+
<dd>
|
|
176
|
+
|
|
177
|
+
**request:** `Sync.ListAssetsRequest`
|
|
178
|
+
|
|
179
|
+
</dd>
|
|
180
|
+
</dl>
|
|
181
|
+
|
|
182
|
+
<dl>
|
|
183
|
+
<dd>
|
|
184
|
+
|
|
185
|
+
**requestOptions:** `Assets.RequestOptions`
|
|
186
|
+
|
|
187
|
+
</dd>
|
|
188
|
+
</dl>
|
|
189
|
+
</dd>
|
|
190
|
+
</dl>
|
|
191
|
+
|
|
192
|
+
</dd>
|
|
193
|
+
</dl>
|
|
194
|
+
</details>
|
|
195
|
+
|
|
196
|
+
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">count</a>({ ...params }) -> number</code></summary>
|
|
197
|
+
<dl>
|
|
198
|
+
<dd>
|
|
199
|
+
|
|
200
|
+
#### 📝 Description
|
|
201
|
+
|
|
202
|
+
<dl>
|
|
203
|
+
<dd>
|
|
204
|
+
|
|
205
|
+
<dl>
|
|
206
|
+
<dd>
|
|
207
|
+
|
|
208
|
+
Count the assets visible to your organization after applying the filters.
|
|
209
|
+
</dd>
|
|
210
|
+
</dl>
|
|
211
|
+
</dd>
|
|
212
|
+
</dl>
|
|
213
|
+
|
|
214
|
+
#### 🔌 Usage
|
|
215
|
+
|
|
216
|
+
<dl>
|
|
217
|
+
<dd>
|
|
218
|
+
|
|
219
|
+
<dl>
|
|
220
|
+
<dd>
|
|
221
|
+
|
|
222
|
+
```typescript
|
|
223
|
+
await client.assets.count();
|
|
224
|
+
```
|
|
225
|
+
|
|
226
|
+
</dd>
|
|
227
|
+
</dl>
|
|
228
|
+
</dd>
|
|
229
|
+
</dl>
|
|
230
|
+
|
|
231
|
+
#### ⚙️ Parameters
|
|
232
|
+
|
|
233
|
+
<dl>
|
|
234
|
+
<dd>
|
|
235
|
+
|
|
236
|
+
<dl>
|
|
237
|
+
<dd>
|
|
238
|
+
|
|
239
|
+
**request:** `Sync.CountAssetsRequest`
|
|
240
|
+
|
|
241
|
+
</dd>
|
|
242
|
+
</dl>
|
|
243
|
+
|
|
244
|
+
<dl>
|
|
245
|
+
<dd>
|
|
246
|
+
|
|
247
|
+
**requestOptions:** `Assets.RequestOptions`
|
|
248
|
+
|
|
249
|
+
</dd>
|
|
250
|
+
</dl>
|
|
251
|
+
</dd>
|
|
252
|
+
</dl>
|
|
253
|
+
|
|
254
|
+
</dd>
|
|
255
|
+
</dl>
|
|
256
|
+
</details>
|
|
257
|
+
|
|
258
|
+
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">getMany</a>({ ...params }) -> Sync.Asset[]</code></summary>
|
|
259
|
+
<dl>
|
|
260
|
+
<dd>
|
|
261
|
+
|
|
262
|
+
#### 📝 Description
|
|
263
|
+
|
|
264
|
+
<dl>
|
|
265
|
+
<dd>
|
|
266
|
+
|
|
267
|
+
<dl>
|
|
268
|
+
<dd>
|
|
269
|
+
|
|
270
|
+
Retrieve multiple assets by ID. Assets you cannot access are omitted from the response.
|
|
271
|
+
</dd>
|
|
272
|
+
</dl>
|
|
273
|
+
</dd>
|
|
274
|
+
</dl>
|
|
275
|
+
|
|
276
|
+
#### 🔌 Usage
|
|
277
|
+
|
|
278
|
+
<dl>
|
|
279
|
+
<dd>
|
|
280
|
+
|
|
281
|
+
<dl>
|
|
282
|
+
<dd>
|
|
283
|
+
|
|
284
|
+
```typescript
|
|
285
|
+
await client.assets.getMany({
|
|
286
|
+
ids: "ids",
|
|
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.BatchGetAssetsRequest`
|
|
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">getDownloadUrl</a>(id) -> string</code></summary>
|
|
323
|
+
<dl>
|
|
324
|
+
<dd>
|
|
325
|
+
|
|
326
|
+
#### 📝 Description
|
|
327
|
+
|
|
328
|
+
<dl>
|
|
329
|
+
<dd>
|
|
330
|
+
|
|
331
|
+
<dl>
|
|
332
|
+
<dd>
|
|
333
|
+
|
|
334
|
+
Get a URL for downloading an asset. The response body is a plain-text URL. Fetch that URL separately; do not send your API key to it.
|
|
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.getDownloadUrl("id");
|
|
350
|
+
```
|
|
351
|
+
|
|
352
|
+
</dd>
|
|
353
|
+
</dl>
|
|
354
|
+
</dd>
|
|
355
|
+
</dl>
|
|
356
|
+
|
|
357
|
+
#### ⚙️ Parameters
|
|
358
|
+
|
|
359
|
+
<dl>
|
|
360
|
+
<dd>
|
|
361
|
+
|
|
362
|
+
<dl>
|
|
363
|
+
<dd>
|
|
364
|
+
|
|
365
|
+
**id:** `Sync.AssetId`
|
|
366
|
+
|
|
367
|
+
</dd>
|
|
368
|
+
</dl>
|
|
369
|
+
|
|
370
|
+
<dl>
|
|
371
|
+
<dd>
|
|
372
|
+
|
|
373
|
+
**requestOptions:** `Assets.RequestOptions`
|
|
374
|
+
|
|
375
|
+
</dd>
|
|
376
|
+
</dl>
|
|
377
|
+
</dd>
|
|
378
|
+
</dl>
|
|
379
|
+
|
|
380
|
+
</dd>
|
|
381
|
+
</dl>
|
|
382
|
+
</details>
|
|
383
|
+
|
|
384
|
+
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">findUploaded</a>({ ...params }) -> Sync.FindUploadedAssetResponse</code></summary>
|
|
385
|
+
<dl>
|
|
386
|
+
<dd>
|
|
387
|
+
|
|
388
|
+
#### 📝 Description
|
|
389
|
+
|
|
390
|
+
<dl>
|
|
391
|
+
<dd>
|
|
392
|
+
|
|
393
|
+
<dl>
|
|
394
|
+
<dd>
|
|
395
|
+
|
|
396
|
+
Find the newest live asset registered with the same API key, SHA-256 digest, and type. Reuse its id instead of uploading the file again. Assets registered with another API key do not match, even within the same organization. Returns asset null when no asset matches.
|
|
397
|
+
</dd>
|
|
398
|
+
</dl>
|
|
399
|
+
</dd>
|
|
400
|
+
</dl>
|
|
401
|
+
|
|
402
|
+
#### 🔌 Usage
|
|
403
|
+
|
|
404
|
+
<dl>
|
|
405
|
+
<dd>
|
|
406
|
+
|
|
407
|
+
<dl>
|
|
408
|
+
<dd>
|
|
409
|
+
|
|
410
|
+
```typescript
|
|
411
|
+
await client.assets.findUploaded({
|
|
412
|
+
contentSha256: "contentSha256",
|
|
413
|
+
type: "AUDIO",
|
|
414
|
+
});
|
|
415
|
+
```
|
|
416
|
+
|
|
417
|
+
</dd>
|
|
418
|
+
</dl>
|
|
419
|
+
</dd>
|
|
420
|
+
</dl>
|
|
421
|
+
|
|
422
|
+
#### ⚙️ Parameters
|
|
423
|
+
|
|
424
|
+
<dl>
|
|
425
|
+
<dd>
|
|
426
|
+
|
|
427
|
+
<dl>
|
|
428
|
+
<dd>
|
|
429
|
+
|
|
430
|
+
**request:** `Sync.FindUploadedAssetRequest`
|
|
431
|
+
|
|
432
|
+
</dd>
|
|
433
|
+
</dl>
|
|
434
|
+
|
|
435
|
+
<dl>
|
|
436
|
+
<dd>
|
|
437
|
+
|
|
438
|
+
**requestOptions:** `Assets.RequestOptions`
|
|
439
|
+
|
|
440
|
+
</dd>
|
|
441
|
+
</dl>
|
|
442
|
+
</dd>
|
|
443
|
+
</dl>
|
|
444
|
+
|
|
445
|
+
</dd>
|
|
446
|
+
</dl>
|
|
447
|
+
</details>
|
|
448
|
+
|
|
449
|
+
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">get</a>(id) -> Sync.Asset</code></summary>
|
|
450
|
+
<dl>
|
|
451
|
+
<dd>
|
|
452
|
+
|
|
453
|
+
#### 📝 Description
|
|
454
|
+
|
|
455
|
+
<dl>
|
|
456
|
+
<dd>
|
|
457
|
+
|
|
458
|
+
<dl>
|
|
459
|
+
<dd>
|
|
460
|
+
|
|
461
|
+
Retrieve a specific asset by ID.
|
|
462
|
+
</dd>
|
|
463
|
+
</dl>
|
|
464
|
+
</dd>
|
|
465
|
+
</dl>
|
|
466
|
+
|
|
467
|
+
#### 🔌 Usage
|
|
468
|
+
|
|
469
|
+
<dl>
|
|
470
|
+
<dd>
|
|
471
|
+
|
|
472
|
+
<dl>
|
|
473
|
+
<dd>
|
|
474
|
+
|
|
475
|
+
```typescript
|
|
476
|
+
await client.assets.get("550e8400-e29b-41d4-a716-446655440000");
|
|
477
|
+
```
|
|
478
|
+
|
|
479
|
+
</dd>
|
|
480
|
+
</dl>
|
|
481
|
+
</dd>
|
|
482
|
+
</dl>
|
|
483
|
+
|
|
484
|
+
#### ⚙️ Parameters
|
|
485
|
+
|
|
486
|
+
<dl>
|
|
487
|
+
<dd>
|
|
488
|
+
|
|
489
|
+
<dl>
|
|
490
|
+
<dd>
|
|
491
|
+
|
|
492
|
+
**id:** `Sync.AssetId`
|
|
493
|
+
|
|
494
|
+
</dd>
|
|
495
|
+
</dl>
|
|
496
|
+
|
|
497
|
+
<dl>
|
|
498
|
+
<dd>
|
|
499
|
+
|
|
500
|
+
**requestOptions:** `Assets.RequestOptions`
|
|
501
|
+
|
|
502
|
+
</dd>
|
|
503
|
+
</dl>
|
|
504
|
+
</dd>
|
|
505
|
+
</dl>
|
|
506
|
+
|
|
507
|
+
</dd>
|
|
508
|
+
</dl>
|
|
509
|
+
</details>
|
|
510
|
+
|
|
511
|
+
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">createUpload</a>({ ...params }) -> Sync.AssetUploadResponse</code></summary>
|
|
512
|
+
<dl>
|
|
513
|
+
<dd>
|
|
514
|
+
|
|
515
|
+
#### 📝 Description
|
|
516
|
+
|
|
517
|
+
<dl>
|
|
518
|
+
<dd>
|
|
519
|
+
|
|
520
|
+
<dl>
|
|
521
|
+
<dd>
|
|
522
|
+
|
|
523
|
+
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 5 GiB (5,368,709,120 bytes).
|
|
524
|
+
</dd>
|
|
525
|
+
</dl>
|
|
526
|
+
</dd>
|
|
527
|
+
</dl>
|
|
528
|
+
|
|
529
|
+
#### 🔌 Usage
|
|
530
|
+
|
|
531
|
+
<dl>
|
|
532
|
+
<dd>
|
|
533
|
+
|
|
534
|
+
<dl>
|
|
535
|
+
<dd>
|
|
536
|
+
|
|
537
|
+
```typescript
|
|
538
|
+
await client.assets.createUpload({
|
|
539
|
+
fileName: "my-video.mp4",
|
|
540
|
+
contentType: "video/mp4",
|
|
541
|
+
size: 10485760,
|
|
542
|
+
});
|
|
543
|
+
```
|
|
544
|
+
|
|
545
|
+
</dd>
|
|
546
|
+
</dl>
|
|
547
|
+
</dd>
|
|
548
|
+
</dl>
|
|
549
|
+
|
|
550
|
+
#### ⚙️ Parameters
|
|
551
|
+
|
|
552
|
+
<dl>
|
|
553
|
+
<dd>
|
|
554
|
+
|
|
555
|
+
<dl>
|
|
556
|
+
<dd>
|
|
557
|
+
|
|
558
|
+
**request:** `Sync.CreateAssetUploadRequest`
|
|
559
|
+
|
|
560
|
+
</dd>
|
|
561
|
+
</dl>
|
|
562
|
+
|
|
563
|
+
<dl>
|
|
564
|
+
<dd>
|
|
565
|
+
|
|
566
|
+
**requestOptions:** `Assets.RequestOptions`
|
|
567
|
+
|
|
568
|
+
</dd>
|
|
569
|
+
</dl>
|
|
570
|
+
</dd>
|
|
571
|
+
</dl>
|
|
572
|
+
|
|
573
|
+
</dd>
|
|
574
|
+
</dl>
|
|
575
|
+
</details>
|
|
576
|
+
|
|
577
|
+
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">create</a>({ ...params }) -> Sync.Asset</code></summary>
|
|
578
|
+
<dl>
|
|
579
|
+
<dd>
|
|
580
|
+
|
|
581
|
+
#### 📝 Description
|
|
582
|
+
|
|
583
|
+
<dl>
|
|
584
|
+
<dd>
|
|
585
|
+
|
|
586
|
+
<dl>
|
|
587
|
+
<dd>
|
|
588
|
+
|
|
589
|
+
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.
|
|
590
|
+
|
|
591
|
+
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.
|
|
592
|
+
|
|
593
|
+
A link to a single TikTok, Instagram, Facebook, or YouTube video is imported instead of registered. The response is 409 import_in_progress until the video is downloaded; send the same request again after Retry-After to get the imported VIDEO asset, named after the video. A failed import returns 422 import_failed; check the message or upload the file instead. A 429 means the concurrent or daily import limit was reached; follow Retry-After. Link imports return 403 import_not_enabled when unavailable for your account and 503 import_unavailable when temporarily unavailable. See [Asset Uploads](/docs/developer-guides/asset-uploads#import-a-social-video-link).
|
|
594
|
+
</dd>
|
|
595
|
+
</dl>
|
|
596
|
+
</dd>
|
|
597
|
+
</dl>
|
|
598
|
+
|
|
599
|
+
#### 🔌 Usage
|
|
600
|
+
|
|
601
|
+
<dl>
|
|
602
|
+
<dd>
|
|
603
|
+
|
|
604
|
+
<dl>
|
|
605
|
+
<dd>
|
|
606
|
+
|
|
607
|
+
```typescript
|
|
608
|
+
await client.assets.create({
|
|
609
|
+
url: "https://assets.sync.so/org-123/my-video.mp4",
|
|
610
|
+
type: "VIDEO",
|
|
611
|
+
name: "my-video.mp4",
|
|
612
|
+
});
|
|
613
|
+
```
|
|
614
|
+
|
|
615
|
+
</dd>
|
|
616
|
+
</dl>
|
|
617
|
+
</dd>
|
|
618
|
+
</dl>
|
|
619
|
+
|
|
620
|
+
#### ⚙️ Parameters
|
|
621
|
+
|
|
622
|
+
<dl>
|
|
623
|
+
<dd>
|
|
624
|
+
|
|
625
|
+
<dl>
|
|
626
|
+
<dd>
|
|
627
|
+
|
|
628
|
+
**request:** `Sync.CreateAssetRequest`
|
|
629
|
+
|
|
630
|
+
</dd>
|
|
631
|
+
</dl>
|
|
632
|
+
|
|
633
|
+
<dl>
|
|
634
|
+
<dd>
|
|
635
|
+
|
|
636
|
+
**requestOptions:** `Assets.RequestOptions`
|
|
637
|
+
|
|
638
|
+
</dd>
|
|
639
|
+
</dl>
|
|
640
|
+
</dd>
|
|
641
|
+
</dl>
|
|
642
|
+
|
|
643
|
+
</dd>
|
|
644
|
+
</dl>
|
|
645
|
+
</details>
|
|
646
|
+
|
|
647
|
+
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">update</a>(id, { ...params }) -> Sync.Asset</code></summary>
|
|
648
|
+
<dl>
|
|
649
|
+
<dd>
|
|
650
|
+
|
|
651
|
+
#### 📝 Description
|
|
652
|
+
|
|
653
|
+
<dl>
|
|
654
|
+
<dd>
|
|
655
|
+
|
|
656
|
+
<dl>
|
|
657
|
+
<dd>
|
|
658
|
+
|
|
659
|
+
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.
|
|
660
|
+
</dd>
|
|
661
|
+
</dl>
|
|
662
|
+
</dd>
|
|
663
|
+
</dl>
|
|
664
|
+
|
|
665
|
+
#### 🔌 Usage
|
|
666
|
+
|
|
667
|
+
<dl>
|
|
668
|
+
<dd>
|
|
669
|
+
|
|
670
|
+
<dl>
|
|
671
|
+
<dd>
|
|
672
|
+
|
|
673
|
+
```typescript
|
|
674
|
+
await client.assets.update("550e8400-e29b-41d4-a716-446655440000", {
|
|
675
|
+
name: "Renamed asset",
|
|
676
|
+
});
|
|
677
|
+
```
|
|
678
|
+
|
|
679
|
+
</dd>
|
|
680
|
+
</dl>
|
|
681
|
+
</dd>
|
|
682
|
+
</dl>
|
|
683
|
+
|
|
684
|
+
#### ⚙️ Parameters
|
|
685
|
+
|
|
686
|
+
<dl>
|
|
687
|
+
<dd>
|
|
688
|
+
|
|
689
|
+
<dl>
|
|
690
|
+
<dd>
|
|
691
|
+
|
|
692
|
+
**id:** `Sync.AssetId`
|
|
693
|
+
|
|
694
|
+
</dd>
|
|
695
|
+
</dl>
|
|
696
|
+
|
|
697
|
+
<dl>
|
|
698
|
+
<dd>
|
|
699
|
+
|
|
700
|
+
**request:** `Sync.UpdateAssetRequest`
|
|
701
|
+
|
|
702
|
+
</dd>
|
|
703
|
+
</dl>
|
|
704
|
+
|
|
705
|
+
<dl>
|
|
706
|
+
<dd>
|
|
707
|
+
|
|
708
|
+
**requestOptions:** `Assets.RequestOptions`
|
|
709
|
+
|
|
710
|
+
</dd>
|
|
711
|
+
</dl>
|
|
712
|
+
</dd>
|
|
713
|
+
</dl>
|
|
714
|
+
|
|
715
|
+
</dd>
|
|
716
|
+
</dl>
|
|
717
|
+
</details>
|
|
718
|
+
|
|
719
|
+
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">delete</a>(id) -> Sync.DeleteAssetResponse</code></summary>
|
|
720
|
+
<dl>
|
|
721
|
+
<dd>
|
|
722
|
+
|
|
723
|
+
#### 📝 Description
|
|
724
|
+
|
|
725
|
+
<dl>
|
|
726
|
+
<dd>
|
|
727
|
+
|
|
728
|
+
<dl>
|
|
729
|
+
<dd>
|
|
730
|
+
|
|
731
|
+
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.
|
|
732
|
+
</dd>
|
|
733
|
+
</dl>
|
|
734
|
+
</dd>
|
|
735
|
+
</dl>
|
|
736
|
+
|
|
737
|
+
#### 🔌 Usage
|
|
738
|
+
|
|
739
|
+
<dl>
|
|
740
|
+
<dd>
|
|
741
|
+
|
|
742
|
+
<dl>
|
|
743
|
+
<dd>
|
|
744
|
+
|
|
745
|
+
```typescript
|
|
746
|
+
await client.assets.delete("550e8400-e29b-41d4-a716-446655440000");
|
|
747
|
+
```
|
|
748
|
+
|
|
749
|
+
</dd>
|
|
750
|
+
</dl>
|
|
751
|
+
</dd>
|
|
752
|
+
</dl>
|
|
753
|
+
|
|
754
|
+
#### ⚙️ Parameters
|
|
755
|
+
|
|
756
|
+
<dl>
|
|
757
|
+
<dd>
|
|
758
|
+
|
|
759
|
+
<dl>
|
|
760
|
+
<dd>
|
|
761
|
+
|
|
762
|
+
**id:** `Sync.AssetId`
|
|
763
|
+
|
|
764
|
+
</dd>
|
|
765
|
+
</dl>
|
|
766
|
+
|
|
767
|
+
<dl>
|
|
768
|
+
<dd>
|
|
769
|
+
|
|
770
|
+
**requestOptions:** `Assets.RequestOptions`
|
|
771
|
+
|
|
772
|
+
</dd>
|
|
773
|
+
</dl>
|
|
774
|
+
</dd>
|
|
775
|
+
</dl>
|
|
776
|
+
|
|
777
|
+
</dd>
|
|
778
|
+
</dl>
|
|
779
|
+
</details>
|
|
780
|
+
|
|
781
|
+
## AudioTrims
|
|
782
|
+
|
|
783
|
+
<details><summary><code>client.audioTrims.<a href="/src/api/resources/audioTrims/client/Client.ts">create</a>({ ...params }) -> Sync.AudioTrim</code></summary>
|
|
784
|
+
<dl>
|
|
785
|
+
<dd>
|
|
786
|
+
|
|
787
|
+
#### 📝 Description
|
|
788
|
+
|
|
789
|
+
<dl>
|
|
790
|
+
<dd>
|
|
791
|
+
|
|
792
|
+
<dl>
|
|
793
|
+
<dd>
|
|
794
|
+
|
|
795
|
+
Prepare a new audio asset from the first durationSeconds of an audio file. Provide exactly one source: assetId or a sourceUrl for audio hosted in Sync storage that you can access. Returns 202 with the trim. Poll GET /v2/audio-trims/{id} until status is completed or failed. Use the completed assetId as an audio input to a generation.
|
|
796
|
+
A source you cannot access returns 404. Unsupported sources can return 422 audio_trim_source_not_hosted or audio_trim_source_not_allowed. Each organization can have 4 trims in progress and start 60 per hour; requests beyond these limits return 429 audio_trim_rate_limited.
|
|
797
|
+
</dd>
|
|
798
|
+
</dl>
|
|
799
|
+
</dd>
|
|
800
|
+
</dl>
|
|
801
|
+
|
|
802
|
+
#### 🔌 Usage
|
|
803
|
+
|
|
804
|
+
<dl>
|
|
805
|
+
<dd>
|
|
806
|
+
|
|
807
|
+
<dl>
|
|
808
|
+
<dd>
|
|
809
|
+
|
|
810
|
+
```typescript
|
|
811
|
+
await client.audioTrims.create({
|
|
812
|
+
"Idempotency-Key": "trim-intro-20s",
|
|
813
|
+
body: {
|
|
814
|
+
assetId: "3f2b8c1e-5d4a-4e9b-8c7d-1a2b3c4d5e6f",
|
|
815
|
+
durationSeconds: 20,
|
|
816
|
+
},
|
|
817
|
+
});
|
|
818
|
+
```
|
|
819
|
+
|
|
820
|
+
</dd>
|
|
821
|
+
</dl>
|
|
822
|
+
</dd>
|
|
823
|
+
</dl>
|
|
824
|
+
|
|
825
|
+
#### ⚙️ Parameters
|
|
826
|
+
|
|
827
|
+
<dl>
|
|
828
|
+
<dd>
|
|
829
|
+
|
|
830
|
+
<dl>
|
|
831
|
+
<dd>
|
|
832
|
+
|
|
833
|
+
**request:** `Sync.CreateAudioTrimRequest`
|
|
834
|
+
|
|
835
|
+
</dd>
|
|
836
|
+
</dl>
|
|
837
|
+
|
|
838
|
+
<dl>
|
|
839
|
+
<dd>
|
|
840
|
+
|
|
841
|
+
**requestOptions:** `AudioTrims.RequestOptions`
|
|
842
|
+
|
|
843
|
+
</dd>
|
|
844
|
+
</dl>
|
|
845
|
+
</dd>
|
|
846
|
+
</dl>
|
|
847
|
+
|
|
848
|
+
</dd>
|
|
849
|
+
</dl>
|
|
850
|
+
</details>
|
|
851
|
+
|
|
852
|
+
<details><summary><code>client.audioTrims.<a href="/src/api/resources/audioTrims/client/Client.ts">get</a>(id) -> Sync.AudioTrim</code></summary>
|
|
853
|
+
<dl>
|
|
854
|
+
<dd>
|
|
855
|
+
|
|
856
|
+
#### 📝 Description
|
|
857
|
+
|
|
858
|
+
<dl>
|
|
859
|
+
<dd>
|
|
860
|
+
|
|
861
|
+
<dl>
|
|
862
|
+
<dd>
|
|
863
|
+
|
|
864
|
+
Retrieve an audio trim created by the same user or API key. While status is queued or processing, wait retryAfterMs before polling again. When status is completed, assetId is the trimmed WAV audio asset and durationSeconds is its measured length. A failed trim has errorCode audio_trim_failed; start a new trim with a new Idempotency-Key.
|
|
865
|
+
</dd>
|
|
866
|
+
</dl>
|
|
867
|
+
</dd>
|
|
868
|
+
</dl>
|
|
869
|
+
|
|
870
|
+
#### 🔌 Usage
|
|
871
|
+
|
|
872
|
+
<dl>
|
|
873
|
+
<dd>
|
|
874
|
+
|
|
875
|
+
<dl>
|
|
876
|
+
<dd>
|
|
877
|
+
|
|
878
|
+
```typescript
|
|
879
|
+
await client.audioTrims.get("6533643b-aceb-4c40-967e-d9ba9baac39e");
|
|
880
|
+
```
|
|
881
|
+
|
|
882
|
+
</dd>
|
|
883
|
+
</dl>
|
|
884
|
+
</dd>
|
|
885
|
+
</dl>
|
|
886
|
+
|
|
887
|
+
#### ⚙️ Parameters
|
|
888
|
+
|
|
889
|
+
<dl>
|
|
890
|
+
<dd>
|
|
891
|
+
|
|
892
|
+
<dl>
|
|
893
|
+
<dd>
|
|
894
|
+
|
|
895
|
+
**id:** `string` — The trim id returned by POST /v2/audio-trims.
|
|
896
|
+
|
|
897
|
+
</dd>
|
|
898
|
+
</dl>
|
|
899
|
+
|
|
900
|
+
<dl>
|
|
901
|
+
<dd>
|
|
902
|
+
|
|
903
|
+
**requestOptions:** `AudioTrims.RequestOptions`
|
|
904
|
+
|
|
905
|
+
</dd>
|
|
906
|
+
</dl>
|
|
907
|
+
</dd>
|
|
908
|
+
</dl>
|
|
909
|
+
|
|
910
|
+
</dd>
|
|
911
|
+
</dl>
|
|
912
|
+
</details>
|
|
913
|
+
|
|
914
|
+
## Batch
|
|
915
|
+
|
|
916
|
+
<details><summary><code>client.batch.<a href="/src/api/resources/batch/client/Client.ts">create</a>(input, { ...params }) -> Sync.CreateBatchResponse</code></summary>
|
|
917
|
+
<dl>
|
|
918
|
+
<dd>
|
|
919
|
+
|
|
920
|
+
#### 📝 Description
|
|
921
|
+
|
|
922
|
+
<dl>
|
|
923
|
+
<dd>
|
|
924
|
+
|
|
925
|
+
<dl>
|
|
926
|
+
<dd>
|
|
927
|
+
|
|
928
|
+
Create a batch processing job from a JSONL file. Requires the Scale plan or above and approval for your organization. Access is disabled by default, including for new Scale subscriptions. Contact support@sync.so to request access. Without approval, creation and dry runs return 403 `batch_access_not_enabled`. Approved organizations on other plans get 402 `plan_feature_unavailable` with `requiredPlan`. Send the file in multipart field `input` (or the accepted `file` alias); it must be 5 MB or smaller and contain 20-500 records by default. A batch is queued and holds one slot of your plan's batch concurrency limit; more active batches than that returns 429 `concurrency_limit_reached`. 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`.
|
|
929
|
+
</dd>
|
|
930
|
+
</dl>
|
|
931
|
+
</dd>
|
|
932
|
+
</dl>
|
|
933
|
+
|
|
934
|
+
#### 🔌 Usage
|
|
935
|
+
|
|
936
|
+
<dl>
|
|
937
|
+
<dd>
|
|
938
|
+
|
|
939
|
+
<dl>
|
|
940
|
+
<dd>
|
|
941
|
+
|
|
942
|
+
```typescript
|
|
943
|
+
await client.batch.create(fs.createReadStream("/path/to/your/file"), {
|
|
944
|
+
webhook_url: "https://your-webhook-url.com/batch-webhook",
|
|
945
|
+
dry_run: false,
|
|
946
|
+
});
|
|
947
|
+
```
|
|
948
|
+
|
|
949
|
+
</dd>
|
|
950
|
+
</dl>
|
|
951
|
+
</dd>
|
|
952
|
+
</dl>
|
|
953
|
+
|
|
954
|
+
#### ⚙️ Parameters
|
|
955
|
+
|
|
956
|
+
<dl>
|
|
957
|
+
<dd>
|
|
958
|
+
|
|
959
|
+
<dl>
|
|
960
|
+
<dd>
|
|
961
|
+
|
|
962
|
+
**input:** `File | fs.ReadStream | Blob`
|
|
963
|
+
|
|
964
|
+
</dd>
|
|
965
|
+
</dl>
|
|
966
|
+
|
|
967
|
+
<dl>
|
|
968
|
+
<dd>
|
|
969
|
+
|
|
970
|
+
**request:** `Sync.CreateBatchRequest`
|
|
971
|
+
|
|
972
|
+
</dd>
|
|
973
|
+
</dl>
|
|
974
|
+
|
|
975
|
+
<dl>
|
|
976
|
+
<dd>
|
|
977
|
+
|
|
978
|
+
**requestOptions:** `Batch.RequestOptions`
|
|
979
|
+
|
|
980
|
+
</dd>
|
|
981
|
+
</dl>
|
|
982
|
+
</dd>
|
|
983
|
+
</dl>
|
|
984
|
+
|
|
985
|
+
</dd>
|
|
986
|
+
</dl>
|
|
987
|
+
</details>
|
|
988
|
+
|
|
989
|
+
<details><summary><code>client.batch.<a href="/src/api/resources/batch/client/Client.ts">createFromRows</a>({ ...params }) -> Sync.CreateBatchResponse</code></summary>
|
|
990
|
+
<dl>
|
|
991
|
+
<dd>
|
|
992
|
+
|
|
993
|
+
#### 📝 Description
|
|
994
|
+
|
|
995
|
+
<dl>
|
|
996
|
+
<dd>
|
|
997
|
+
|
|
998
|
+
<dl>
|
|
999
|
+
<dd>
|
|
1000
|
+
|
|
1001
|
+
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, 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 the Scale plan or above and approval for your organization. Access is disabled by default; contact support@sync.so to request access. Without approval, creation and dry runs return 403 `batch_access_not_enabled`. 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. The expanded batch must also be 5 MB or smaller. 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](/docs/api-reference/guides/batch-processing).
|
|
1002
|
+
</dd>
|
|
1003
|
+
</dl>
|
|
1004
|
+
</dd>
|
|
1005
|
+
</dl>
|
|
1006
|
+
|
|
1007
|
+
#### 🔌 Usage
|
|
1008
|
+
|
|
1009
|
+
<dl>
|
|
1010
|
+
<dd>
|
|
1011
|
+
|
|
1012
|
+
<dl>
|
|
1013
|
+
<dd>
|
|
1014
|
+
|
|
1015
|
+
```typescript
|
|
1016
|
+
await client.batch.createFromRows({
|
|
1017
|
+
rows: [
|
|
1018
|
+
{
|
|
1019
|
+
request_id: "line-2",
|
|
1020
|
+
endpoint: "/v2/generate",
|
|
1021
|
+
payload: {
|
|
1022
|
+
model: "sync-3",
|
|
1023
|
+
input: [
|
|
1024
|
+
{
|
|
1025
|
+
type: "video",
|
|
1026
|
+
url: "https://assets.sync.so/docs/example-video.mp4",
|
|
1027
|
+
},
|
|
1028
|
+
],
|
|
1029
|
+
dialogueEdit: {
|
|
1030
|
+
id: "fa350e8a-0c6b-50c3-96de-7e4ce81ed0ce",
|
|
1031
|
+
},
|
|
1032
|
+
},
|
|
1033
|
+
},
|
|
1034
|
+
{
|
|
1035
|
+
request_id: "line-3",
|
|
1036
|
+
endpoint: "/v2/generate",
|
|
1037
|
+
payload: {
|
|
1038
|
+
model: "sync-3",
|
|
1039
|
+
input: [
|
|
1040
|
+
{
|
|
1041
|
+
type: "video",
|
|
1042
|
+
url: "https://assets.sync.so/docs/example-video.mp4",
|
|
1043
|
+
},
|
|
1044
|
+
],
|
|
1045
|
+
dialogueEdit: {
|
|
1046
|
+
id: "ddaea593-cf1f-5916-aaef-c60ab5f63090",
|
|
1047
|
+
},
|
|
1048
|
+
},
|
|
1049
|
+
},
|
|
1050
|
+
{
|
|
1051
|
+
request_id: "line-4",
|
|
1052
|
+
endpoint: "/v2/generate",
|
|
1053
|
+
payload: {
|
|
1054
|
+
model: "sync-3",
|
|
1055
|
+
input: [
|
|
1056
|
+
{
|
|
1057
|
+
type: "video",
|
|
1058
|
+
url: "https://assets.sync.so/docs/example-video.mp4",
|
|
1059
|
+
},
|
|
1060
|
+
],
|
|
1061
|
+
dialogueEdit: {
|
|
1062
|
+
id: "532a08cd-becc-5630-8109-58d22206db7e",
|
|
1063
|
+
},
|
|
1064
|
+
},
|
|
1065
|
+
},
|
|
1066
|
+
{
|
|
1067
|
+
request_id: "line-5",
|
|
1068
|
+
endpoint: "/v2/generate",
|
|
1069
|
+
payload: {
|
|
1070
|
+
model: "sync-3",
|
|
1071
|
+
input: [
|
|
1072
|
+
{
|
|
1073
|
+
type: "video",
|
|
1074
|
+
url: "https://assets.sync.so/docs/example-video.mp4",
|
|
1075
|
+
},
|
|
1076
|
+
],
|
|
1077
|
+
dialogueEdit: {
|
|
1078
|
+
id: "68f897e5-78e3-55d3-9ca3-d8ba0d16c5c4",
|
|
1079
|
+
},
|
|
1080
|
+
},
|
|
1081
|
+
},
|
|
1082
|
+
{
|
|
1083
|
+
request_id: "line-6",
|
|
1084
|
+
endpoint: "/v2/generate",
|
|
1085
|
+
payload: {
|
|
1086
|
+
model: "sync-3",
|
|
1087
|
+
input: [
|
|
1088
|
+
{
|
|
1089
|
+
type: "video",
|
|
1090
|
+
url: "https://assets.sync.so/docs/example-video.mp4",
|
|
1091
|
+
},
|
|
1092
|
+
],
|
|
1093
|
+
dialogueEdit: {
|
|
1094
|
+
id: "f4aa2ca8-006d-5301-baf7-4ce543188328",
|
|
1095
|
+
},
|
|
1096
|
+
},
|
|
1097
|
+
},
|
|
1098
|
+
{
|
|
1099
|
+
request_id: "line-7",
|
|
1100
|
+
endpoint: "/v2/generate",
|
|
1101
|
+
payload: {
|
|
1102
|
+
model: "sync-3",
|
|
1103
|
+
input: [
|
|
1104
|
+
{
|
|
1105
|
+
type: "video",
|
|
1106
|
+
url: "https://assets.sync.so/docs/example-video.mp4",
|
|
1107
|
+
},
|
|
1108
|
+
],
|
|
1109
|
+
dialogueEdit: {
|
|
1110
|
+
id: "636f1dd4-f4e1-508d-8cdd-6dac1dd002a3",
|
|
1111
|
+
},
|
|
1112
|
+
},
|
|
1113
|
+
},
|
|
1114
|
+
{
|
|
1115
|
+
request_id: "line-8",
|
|
1116
|
+
endpoint: "/v2/generate",
|
|
1117
|
+
payload: {
|
|
1118
|
+
model: "sync-3",
|
|
1119
|
+
input: [
|
|
1120
|
+
{
|
|
1121
|
+
type: "video",
|
|
1122
|
+
url: "https://assets.sync.so/docs/example-video.mp4",
|
|
1123
|
+
},
|
|
1124
|
+
],
|
|
1125
|
+
dialogueEdit: {
|
|
1126
|
+
id: "8f6640f5-6139-5271-ab33-f43fc91fc1ad",
|
|
1127
|
+
},
|
|
1128
|
+
},
|
|
1129
|
+
},
|
|
1130
|
+
{
|
|
1131
|
+
request_id: "line-9",
|
|
1132
|
+
endpoint: "/v2/generate",
|
|
1133
|
+
payload: {
|
|
1134
|
+
model: "sync-3",
|
|
1135
|
+
input: [
|
|
1136
|
+
{
|
|
1137
|
+
type: "video",
|
|
1138
|
+
url: "https://assets.sync.so/docs/example-video.mp4",
|
|
1139
|
+
},
|
|
1140
|
+
],
|
|
1141
|
+
dialogueEdit: {
|
|
1142
|
+
id: "6c101a02-cdd8-5ec0-9df9-1ffea33a11bd",
|
|
1143
|
+
},
|
|
1144
|
+
},
|
|
1145
|
+
},
|
|
1146
|
+
{
|
|
1147
|
+
request_id: "line-10",
|
|
1148
|
+
endpoint: "/v2/generate",
|
|
1149
|
+
payload: {
|
|
1150
|
+
model: "sync-3",
|
|
1151
|
+
input: [
|
|
1152
|
+
{
|
|
1153
|
+
type: "video",
|
|
1154
|
+
url: "https://assets.sync.so/docs/example-video.mp4",
|
|
1155
|
+
},
|
|
1156
|
+
],
|
|
1157
|
+
dialogueEdit: {
|
|
1158
|
+
id: "258f60c2-b635-5ab6-a565-ae81a709e221",
|
|
1159
|
+
},
|
|
1160
|
+
},
|
|
1161
|
+
},
|
|
1162
|
+
{
|
|
1163
|
+
request_id: "line-11",
|
|
1164
|
+
endpoint: "/v2/generate",
|
|
1165
|
+
payload: {
|
|
1166
|
+
model: "sync-3",
|
|
1167
|
+
input: [
|
|
1168
|
+
{
|
|
1169
|
+
type: "video",
|
|
1170
|
+
url: "https://assets.sync.so/docs/example-video.mp4",
|
|
1171
|
+
},
|
|
1172
|
+
],
|
|
1173
|
+
dialogueEdit: {
|
|
1174
|
+
id: "09dc425b-4d7e-5813-8c6c-81bd38993a7b",
|
|
1175
|
+
},
|
|
1176
|
+
},
|
|
1177
|
+
},
|
|
1178
|
+
{
|
|
1179
|
+
request_id: "line-12",
|
|
1180
|
+
endpoint: "/v2/generate",
|
|
1181
|
+
payload: {
|
|
1182
|
+
model: "sync-3",
|
|
1183
|
+
input: [
|
|
1184
|
+
{
|
|
1185
|
+
type: "video",
|
|
1186
|
+
url: "https://assets.sync.so/docs/example-video.mp4",
|
|
1187
|
+
},
|
|
1188
|
+
],
|
|
1189
|
+
dialogueEdit: {
|
|
1190
|
+
id: "b93c54d3-28d6-5fa3-abaf-5220c38e31a1",
|
|
1191
|
+
},
|
|
1192
|
+
},
|
|
1193
|
+
},
|
|
1194
|
+
{
|
|
1195
|
+
request_id: "line-13",
|
|
1196
|
+
endpoint: "/v2/generate",
|
|
1197
|
+
payload: {
|
|
1198
|
+
model: "sync-3",
|
|
1199
|
+
input: [
|
|
1200
|
+
{
|
|
1201
|
+
type: "video",
|
|
1202
|
+
url: "https://assets.sync.so/docs/example-video.mp4",
|
|
1203
|
+
},
|
|
1204
|
+
],
|
|
1205
|
+
dialogueEdit: {
|
|
1206
|
+
id: "e8a1dea0-b3f9-5266-badd-f8a2aae77ea3",
|
|
1207
|
+
},
|
|
1208
|
+
},
|
|
1209
|
+
},
|
|
1210
|
+
{
|
|
1211
|
+
request_id: "line-14",
|
|
1212
|
+
endpoint: "/v2/generate",
|
|
1213
|
+
payload: {
|
|
1214
|
+
model: "sync-3",
|
|
1215
|
+
input: [
|
|
1216
|
+
{
|
|
1217
|
+
type: "video",
|
|
1218
|
+
url: "https://assets.sync.so/docs/example-video.mp4",
|
|
1219
|
+
},
|
|
1220
|
+
],
|
|
1221
|
+
dialogueEdit: {
|
|
1222
|
+
id: "a09967c4-8171-582f-8dba-1ba07d55f918",
|
|
1223
|
+
},
|
|
1224
|
+
},
|
|
1225
|
+
},
|
|
1226
|
+
{
|
|
1227
|
+
request_id: "line-15",
|
|
1228
|
+
endpoint: "/v2/generate",
|
|
1229
|
+
payload: {
|
|
1230
|
+
model: "sync-3",
|
|
1231
|
+
input: [
|
|
1232
|
+
{
|
|
1233
|
+
type: "video",
|
|
1234
|
+
url: "https://assets.sync.so/docs/example-video.mp4",
|
|
1235
|
+
},
|
|
1236
|
+
],
|
|
1237
|
+
dialogueEdit: {
|
|
1238
|
+
id: "39df4e4f-b23d-54ca-99a8-f29ec567790b",
|
|
1239
|
+
},
|
|
1240
|
+
},
|
|
1241
|
+
},
|
|
1242
|
+
{
|
|
1243
|
+
request_id: "line-16",
|
|
1244
|
+
endpoint: "/v2/generate",
|
|
1245
|
+
payload: {
|
|
1246
|
+
model: "sync-3",
|
|
1247
|
+
input: [
|
|
1248
|
+
{
|
|
1249
|
+
type: "video",
|
|
1250
|
+
url: "https://assets.sync.so/docs/example-video.mp4",
|
|
1251
|
+
},
|
|
1252
|
+
],
|
|
1253
|
+
dialogueEdit: {
|
|
1254
|
+
id: "0370783a-12d5-5dfb-8736-49118428df47",
|
|
1255
|
+
},
|
|
1256
|
+
},
|
|
1257
|
+
},
|
|
1258
|
+
{
|
|
1259
|
+
request_id: "line-17",
|
|
1260
|
+
endpoint: "/v2/generate",
|
|
1261
|
+
payload: {
|
|
1262
|
+
model: "sync-3",
|
|
1263
|
+
input: [
|
|
1264
|
+
{
|
|
1265
|
+
type: "video",
|
|
1266
|
+
url: "https://assets.sync.so/docs/example-video.mp4",
|
|
1267
|
+
},
|
|
1268
|
+
],
|
|
1269
|
+
dialogueEdit: {
|
|
1270
|
+
id: "a65eecc2-ad79-5123-acf7-e81a57b2422f",
|
|
1271
|
+
},
|
|
1272
|
+
},
|
|
1273
|
+
},
|
|
1274
|
+
{
|
|
1275
|
+
request_id: "line-18",
|
|
1276
|
+
endpoint: "/v2/generate",
|
|
1277
|
+
payload: {
|
|
1278
|
+
model: "sync-3",
|
|
1279
|
+
input: [
|
|
1280
|
+
{
|
|
1281
|
+
type: "video",
|
|
1282
|
+
url: "https://assets.sync.so/docs/example-video.mp4",
|
|
1283
|
+
},
|
|
1284
|
+
],
|
|
1285
|
+
dialogueEdit: {
|
|
1286
|
+
id: "a0200ef6-d140-50bb-9784-3b9e265be374",
|
|
1287
|
+
},
|
|
1288
|
+
},
|
|
1289
|
+
},
|
|
1290
|
+
{
|
|
1291
|
+
request_id: "line-19",
|
|
1292
|
+
endpoint: "/v2/generate",
|
|
1293
|
+
payload: {
|
|
1294
|
+
model: "sync-3",
|
|
1295
|
+
input: [
|
|
1296
|
+
{
|
|
1297
|
+
type: "video",
|
|
1298
|
+
url: "https://assets.sync.so/docs/example-video.mp4",
|
|
1299
|
+
},
|
|
1300
|
+
],
|
|
1301
|
+
dialogueEdit: {
|
|
1302
|
+
id: "06cc754a-b625-58c2-ad2d-74ec08fb517a",
|
|
1303
|
+
},
|
|
1304
|
+
},
|
|
1305
|
+
},
|
|
1306
|
+
{
|
|
1307
|
+
request_id: "line-20",
|
|
1308
|
+
endpoint: "/v2/generate",
|
|
1309
|
+
payload: {
|
|
1310
|
+
model: "sync-3",
|
|
1311
|
+
input: [
|
|
1312
|
+
{
|
|
1313
|
+
type: "video",
|
|
1314
|
+
url: "https://assets.sync.so/docs/example-video.mp4",
|
|
1315
|
+
},
|
|
1316
|
+
],
|
|
1317
|
+
dialogueEdit: {
|
|
1318
|
+
id: "32889341-cc9e-59c6-b18a-32bbb525c26e",
|
|
1319
|
+
},
|
|
1320
|
+
},
|
|
1321
|
+
},
|
|
1322
|
+
{
|
|
1323
|
+
request_id: "line-21",
|
|
1324
|
+
endpoint: "/v2/generate",
|
|
1325
|
+
payload: {
|
|
1326
|
+
model: "sync-3",
|
|
1327
|
+
input: [
|
|
1328
|
+
{
|
|
1329
|
+
type: "video",
|
|
1330
|
+
url: "https://assets.sync.so/docs/example-video.mp4",
|
|
1331
|
+
},
|
|
1332
|
+
],
|
|
1333
|
+
dialogueEdit: {
|
|
1334
|
+
id: "f6568dbc-0390-5227-b107-64c3842adb3b",
|
|
1335
|
+
},
|
|
1336
|
+
},
|
|
1337
|
+
},
|
|
1338
|
+
],
|
|
1339
|
+
dry_run: true,
|
|
1340
|
+
});
|
|
1341
|
+
```
|
|
1342
|
+
|
|
1343
|
+
</dd>
|
|
1344
|
+
</dl>
|
|
1345
|
+
</dd>
|
|
1346
|
+
</dl>
|
|
1347
|
+
|
|
1348
|
+
#### ⚙️ Parameters
|
|
1349
|
+
|
|
1350
|
+
<dl>
|
|
1351
|
+
<dd>
|
|
1352
|
+
|
|
1353
|
+
<dl>
|
|
1354
|
+
<dd>
|
|
1355
|
+
|
|
1356
|
+
**request:** `Sync.CreateBatchFromRowsRequest`
|
|
1357
|
+
|
|
1358
|
+
</dd>
|
|
1359
|
+
</dl>
|
|
1360
|
+
|
|
1361
|
+
<dl>
|
|
1362
|
+
<dd>
|
|
1363
|
+
|
|
1364
|
+
**requestOptions:** `Batch.RequestOptions`
|
|
1365
|
+
|
|
1366
|
+
</dd>
|
|
1367
|
+
</dl>
|
|
1368
|
+
</dd>
|
|
1369
|
+
</dl>
|
|
1370
|
+
|
|
1371
|
+
</dd>
|
|
1372
|
+
</dl>
|
|
1373
|
+
</details>
|
|
1374
|
+
|
|
1375
|
+
<details><summary><code>client.batch.<a href="/src/api/resources/batch/client/Client.ts">get</a>(id) -> Sync.BatchResponse</code></summary>
|
|
1376
|
+
<dl>
|
|
1377
|
+
<dd>
|
|
1378
|
+
|
|
1379
|
+
#### 📝 Description
|
|
1380
|
+
|
|
1381
|
+
<dl>
|
|
1382
|
+
<dd>
|
|
1383
|
+
|
|
1384
|
+
<dl>
|
|
1385
|
+
<dd>
|
|
1386
|
+
|
|
1387
|
+
Retrieve details about a specific batch, including its current status, processing metrics, and output file URL when available.
|
|
1388
|
+
</dd>
|
|
1389
|
+
</dl>
|
|
1390
|
+
</dd>
|
|
1391
|
+
</dl>
|
|
1392
|
+
|
|
1393
|
+
#### 🔌 Usage
|
|
1394
|
+
|
|
1395
|
+
<dl>
|
|
1396
|
+
<dd>
|
|
1397
|
+
|
|
1398
|
+
<dl>
|
|
1399
|
+
<dd>
|
|
1400
|
+
|
|
1401
|
+
```typescript
|
|
1402
|
+
await client.batch.get("batch_abc123");
|
|
1403
|
+
```
|
|
1404
|
+
|
|
1405
|
+
</dd>
|
|
1406
|
+
</dl>
|
|
1407
|
+
</dd>
|
|
1408
|
+
</dl>
|
|
1409
|
+
|
|
1410
|
+
#### ⚙️ Parameters
|
|
1411
|
+
|
|
1412
|
+
<dl>
|
|
1413
|
+
<dd>
|
|
1414
|
+
|
|
1415
|
+
<dl>
|
|
1416
|
+
<dd>
|
|
1417
|
+
|
|
1418
|
+
**id:** `Sync.BatchId` — The unique identifier of the batch
|
|
1419
|
+
|
|
1420
|
+
</dd>
|
|
1421
|
+
</dl>
|
|
1422
|
+
|
|
1423
|
+
<dl>
|
|
1424
|
+
<dd>
|
|
1425
|
+
|
|
1426
|
+
**requestOptions:** `Batch.RequestOptions`
|
|
1427
|
+
|
|
1428
|
+
</dd>
|
|
1429
|
+
</dl>
|
|
1430
|
+
</dd>
|
|
1431
|
+
</dl>
|
|
1432
|
+
|
|
1433
|
+
</dd>
|
|
1434
|
+
</dl>
|
|
1435
|
+
</details>
|
|
1436
|
+
|
|
1437
|
+
<details><summary><code>client.batch.<a href="/src/api/resources/batch/client/Client.ts">list</a>({ ...params }) -> Sync.BatchResponse[]</code></summary>
|
|
1438
|
+
<dl>
|
|
1439
|
+
<dd>
|
|
1440
|
+
|
|
1441
|
+
#### 📝 Description
|
|
1442
|
+
|
|
1443
|
+
<dl>
|
|
1444
|
+
<dd>
|
|
1445
|
+
|
|
1446
|
+
<dl>
|
|
1447
|
+
<dd>
|
|
1448
|
+
|
|
1449
|
+
List all batches for your organization with optional filtering by status and creation date. Results are ordered by creation date (newest first).
|
|
1450
|
+
</dd>
|
|
1451
|
+
</dl>
|
|
1452
|
+
</dd>
|
|
1453
|
+
</dl>
|
|
1454
|
+
|
|
1455
|
+
#### 🔌 Usage
|
|
1456
|
+
|
|
1457
|
+
<dl>
|
|
1458
|
+
<dd>
|
|
1459
|
+
|
|
1460
|
+
<dl>
|
|
1461
|
+
<dd>
|
|
1462
|
+
|
|
1463
|
+
```typescript
|
|
1464
|
+
await client.batch.list();
|
|
1465
|
+
```
|
|
1466
|
+
|
|
1467
|
+
</dd>
|
|
1468
|
+
</dl>
|
|
1469
|
+
</dd>
|
|
1470
|
+
</dl>
|
|
1471
|
+
|
|
1472
|
+
#### ⚙️ Parameters
|
|
1473
|
+
|
|
1474
|
+
<dl>
|
|
1475
|
+
<dd>
|
|
1476
|
+
|
|
1477
|
+
<dl>
|
|
1478
|
+
<dd>
|
|
1479
|
+
|
|
1480
|
+
**request:** `Sync.ListBatchesRequest`
|
|
1481
|
+
|
|
1482
|
+
</dd>
|
|
1483
|
+
</dl>
|
|
1484
|
+
|
|
1485
|
+
<dl>
|
|
1486
|
+
<dd>
|
|
1487
|
+
|
|
1488
|
+
**requestOptions:** `Batch.RequestOptions`
|
|
1489
|
+
|
|
1490
|
+
</dd>
|
|
1491
|
+
</dl>
|
|
1492
|
+
</dd>
|
|
1493
|
+
</dl>
|
|
1494
|
+
|
|
1495
|
+
</dd>
|
|
1496
|
+
</dl>
|
|
1497
|
+
</details>
|
|
1498
|
+
|
|
1499
|
+
## DialogueEdits
|
|
1500
|
+
|
|
1501
|
+
<details><summary><code>client.dialogueEdits.<a href="/src/api/resources/dialogueEdits/client/Client.ts">create</a>({ ...params }) -> Sync.DialogueEditJob</code></summary>
|
|
1502
|
+
<dl>
|
|
1503
|
+
<dd>
|
|
1504
|
+
|
|
1505
|
+
#### 📝 Description
|
|
1506
|
+
|
|
1507
|
+
<dl>
|
|
1508
|
+
<dd>
|
|
1509
|
+
|
|
1510
|
+
<dl>
|
|
1511
|
+
<dd>
|
|
1512
|
+
|
|
1513
|
+
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 return 400 PLAN_FAILED. Requests with more than 100 edits return 400 dialogue_edit_too_many_edits. API-key requests must cover the whole video: omit startMs and endMs. A partial window returns 422 dialogue_edit_unsupported. A source longer than the 10-minute dialogue limit returns 422 SOURCE_TOO_LONG.
|
|
1514
|
+
Send Idempotency-Key on the first request and reuse it with the same body on retries. A replay returns 200 with the original job's current state and Idempotency-Replayed: true. Reusing a key with different inputs returns 409 IDEMPOTENCY_KEY_CONFLICT. A malformed key returns 400 INVALID_IDEMPOTENCY_KEY. If the job cannot be queued, retry the 503 with the same key and body. Honor Retry-After when present.
|
|
1515
|
+
</dd>
|
|
1516
|
+
</dl>
|
|
1517
|
+
</dd>
|
|
1518
|
+
</dl>
|
|
1519
|
+
|
|
1520
|
+
#### 🔌 Usage
|
|
1521
|
+
|
|
1522
|
+
<dl>
|
|
1523
|
+
<dd>
|
|
1524
|
+
|
|
1525
|
+
<dl>
|
|
1526
|
+
<dd>
|
|
1527
|
+
|
|
1528
|
+
```typescript
|
|
1529
|
+
await client.dialogueEdits.create({
|
|
1530
|
+
body: {
|
|
1531
|
+
sourceVideoUrl: "https://assets.sync.so/docs/example-video.mp4",
|
|
1532
|
+
transcript: {
|
|
1533
|
+
segments: [
|
|
1534
|
+
{
|
|
1535
|
+
id: "seg_1",
|
|
1536
|
+
words: [
|
|
1537
|
+
{
|
|
1538
|
+
id: "w_1",
|
|
1539
|
+
text: "The",
|
|
1540
|
+
startMs: 120,
|
|
1541
|
+
endMs: 260,
|
|
1542
|
+
},
|
|
1543
|
+
{
|
|
1544
|
+
id: "w_2",
|
|
1545
|
+
text: "quarterly",
|
|
1546
|
+
startMs: 260,
|
|
1547
|
+
endMs: 820,
|
|
1548
|
+
},
|
|
1549
|
+
{
|
|
1550
|
+
id: "w_3",
|
|
1551
|
+
text: "results",
|
|
1552
|
+
startMs: 820,
|
|
1553
|
+
endMs: 1240,
|
|
1554
|
+
},
|
|
1555
|
+
],
|
|
1556
|
+
},
|
|
1557
|
+
],
|
|
1558
|
+
speakerCount: 1,
|
|
1559
|
+
},
|
|
1560
|
+
edits: [
|
|
1561
|
+
{
|
|
1562
|
+
kind: "change",
|
|
1563
|
+
wordId: "w_2",
|
|
1564
|
+
replacement: "annual",
|
|
1565
|
+
},
|
|
1566
|
+
],
|
|
1567
|
+
},
|
|
1568
|
+
});
|
|
1569
|
+
```
|
|
1570
|
+
|
|
1571
|
+
</dd>
|
|
1572
|
+
</dl>
|
|
1573
|
+
</dd>
|
|
1574
|
+
</dl>
|
|
1575
|
+
|
|
1576
|
+
#### ⚙️ Parameters
|
|
1577
|
+
|
|
1578
|
+
<dl>
|
|
1579
|
+
<dd>
|
|
1580
|
+
|
|
1581
|
+
<dl>
|
|
1582
|
+
<dd>
|
|
1583
|
+
|
|
1584
|
+
**request:** `Sync.CreateDialogueEditRequest`
|
|
1585
|
+
|
|
1586
|
+
</dd>
|
|
1587
|
+
</dl>
|
|
1588
|
+
|
|
1589
|
+
<dl>
|
|
1590
|
+
<dd>
|
|
1591
|
+
|
|
1592
|
+
**requestOptions:** `DialogueEdits.RequestOptions`
|
|
1593
|
+
|
|
1594
|
+
</dd>
|
|
1595
|
+
</dl>
|
|
1596
|
+
</dd>
|
|
1597
|
+
</dl>
|
|
1598
|
+
|
|
1599
|
+
</dd>
|
|
1600
|
+
</dl>
|
|
1601
|
+
</details>
|
|
1602
|
+
|
|
1603
|
+
<details><summary><code>client.dialogueEdits.<a href="/src/api/resources/dialogueEdits/client/Client.ts">get</a>(id) -> Sync.DialogueEditJob</code></summary>
|
|
1604
|
+
<dl>
|
|
1605
|
+
<dd>
|
|
1606
|
+
|
|
1607
|
+
#### 📝 Description
|
|
1608
|
+
|
|
1609
|
+
<dl>
|
|
1610
|
+
<dd>
|
|
1611
|
+
|
|
1612
|
+
<dl>
|
|
1613
|
+
<dd>
|
|
1614
|
+
|
|
1615
|
+
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.
|
|
1616
|
+
</dd>
|
|
1617
|
+
</dl>
|
|
1618
|
+
</dd>
|
|
1619
|
+
</dl>
|
|
1620
|
+
|
|
1621
|
+
#### 🔌 Usage
|
|
1622
|
+
|
|
1623
|
+
<dl>
|
|
1624
|
+
<dd>
|
|
1625
|
+
|
|
1626
|
+
<dl>
|
|
1627
|
+
<dd>
|
|
1628
|
+
|
|
1629
|
+
```typescript
|
|
1630
|
+
await client.dialogueEdits.get("7644754c-bdfc-4d51-a78f-e0cb0cbbd40f");
|
|
1631
|
+
```
|
|
1632
|
+
|
|
1633
|
+
</dd>
|
|
1634
|
+
</dl>
|
|
1635
|
+
</dd>
|
|
1636
|
+
</dl>
|
|
1637
|
+
|
|
1638
|
+
#### ⚙️ Parameters
|
|
1639
|
+
|
|
1640
|
+
<dl>
|
|
1641
|
+
<dd>
|
|
1642
|
+
|
|
1643
|
+
<dl>
|
|
1644
|
+
<dd>
|
|
1645
|
+
|
|
1646
|
+
**id:** `Sync.DialogueEditJobId` — Dialogue edit job id.
|
|
1647
|
+
|
|
1648
|
+
</dd>
|
|
1649
|
+
</dl>
|
|
1650
|
+
|
|
1651
|
+
<dl>
|
|
1652
|
+
<dd>
|
|
1653
|
+
|
|
1654
|
+
**requestOptions:** `DialogueEdits.RequestOptions`
|
|
1655
|
+
|
|
1656
|
+
</dd>
|
|
1657
|
+
</dl>
|
|
1658
|
+
</dd>
|
|
1659
|
+
</dl>
|
|
1660
|
+
|
|
1661
|
+
</dd>
|
|
1662
|
+
</dl>
|
|
1663
|
+
</details>
|
|
1664
|
+
|
|
1665
|
+
## Errors
|
|
1666
|
+
|
|
1667
|
+
<details><summary><code>client.errors.<a href="/src/api/resources/errors/client/Client.ts">list</a>() -> Sync.ErrorCatalogEntry[]</code></summary>
|
|
1668
|
+
<dl>
|
|
1669
|
+
<dd>
|
|
1670
|
+
|
|
1671
|
+
#### 📝 Description
|
|
1672
|
+
|
|
1673
|
+
<dl>
|
|
1674
|
+
<dd>
|
|
1675
|
+
|
|
1676
|
+
<dl>
|
|
1677
|
+
<dd>
|
|
1678
|
+
|
|
1679
|
+
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) and by TikTok, Instagram, Facebook, and YouTube link imports (e.g. import_in_progress, import_failed). 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.
|
|
1680
|
+
</dd>
|
|
1681
|
+
</dl>
|
|
1682
|
+
</dd>
|
|
1683
|
+
</dl>
|
|
1684
|
+
|
|
1685
|
+
#### 🔌 Usage
|
|
1686
|
+
|
|
1687
|
+
<dl>
|
|
1688
|
+
<dd>
|
|
1689
|
+
|
|
1690
|
+
<dl>
|
|
1691
|
+
<dd>
|
|
1692
|
+
|
|
1693
|
+
```typescript
|
|
1694
|
+
await client.errors.list();
|
|
1695
|
+
```
|
|
1696
|
+
|
|
1697
|
+
</dd>
|
|
1698
|
+
</dl>
|
|
1699
|
+
</dd>
|
|
1700
|
+
</dl>
|
|
1701
|
+
|
|
1702
|
+
#### ⚙️ Parameters
|
|
1703
|
+
|
|
1704
|
+
<dl>
|
|
1705
|
+
<dd>
|
|
1706
|
+
|
|
1707
|
+
<dl>
|
|
1708
|
+
<dd>
|
|
1709
|
+
|
|
1710
|
+
**requestOptions:** `Errors.RequestOptions`
|
|
1711
|
+
|
|
1712
|
+
</dd>
|
|
1713
|
+
</dl>
|
|
1714
|
+
</dd>
|
|
1715
|
+
</dl>
|
|
1716
|
+
|
|
1717
|
+
</dd>
|
|
1718
|
+
</dl>
|
|
1719
|
+
</details>
|
|
1720
|
+
|
|
1721
|
+
## Feedback
|
|
1722
|
+
|
|
1723
|
+
<details><summary><code>client.feedback.<a href="/src/api/resources/feedback/client/Client.ts">submit</a>({ ...params }) -> Sync.FeedbackReceipt</code></summary>
|
|
1724
|
+
<dl>
|
|
1725
|
+
<dd>
|
|
1726
|
+
|
|
1727
|
+
#### 📝 Description
|
|
1728
|
+
|
|
1729
|
+
<dl>
|
|
1730
|
+
<dd>
|
|
1731
|
+
|
|
1732
|
+
<dl>
|
|
1733
|
+
<dd>
|
|
1734
|
+
|
|
1735
|
+
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.
|
|
1736
|
+
</dd>
|
|
1737
|
+
</dl>
|
|
1738
|
+
</dd>
|
|
1739
|
+
</dl>
|
|
1740
|
+
|
|
1741
|
+
#### 🔌 Usage
|
|
1742
|
+
|
|
1743
|
+
<dl>
|
|
1744
|
+
<dd>
|
|
1745
|
+
|
|
1746
|
+
<dl>
|
|
1747
|
+
<dd>
|
|
1748
|
+
|
|
1749
|
+
```typescript
|
|
1750
|
+
await client.feedback.submit({
|
|
1751
|
+
kind: "confusing_error",
|
|
1752
|
+
severity: "major",
|
|
1753
|
+
message:
|
|
1754
|
+
"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.",
|
|
1755
|
+
tool: "generations.create",
|
|
1756
|
+
errorCode: "generation_input_video_inaccessible",
|
|
1757
|
+
generationId: "6533643b-acbb-4c4f-a5b3-5ba2e5ab6b5f",
|
|
1758
|
+
});
|
|
1759
|
+
```
|
|
1760
|
+
|
|
1761
|
+
</dd>
|
|
1762
|
+
</dl>
|
|
1763
|
+
</dd>
|
|
1764
|
+
</dl>
|
|
1765
|
+
|
|
1766
|
+
#### ⚙️ Parameters
|
|
1767
|
+
|
|
1768
|
+
<dl>
|
|
1769
|
+
<dd>
|
|
1770
|
+
|
|
1771
|
+
<dl>
|
|
1772
|
+
<dd>
|
|
1773
|
+
|
|
1774
|
+
**request:** `Sync.SubmitFeedbackRequest`
|
|
1775
|
+
|
|
1776
|
+
</dd>
|
|
1777
|
+
</dl>
|
|
1778
|
+
|
|
1779
|
+
<dl>
|
|
1780
|
+
<dd>
|
|
1781
|
+
|
|
1782
|
+
**requestOptions:** `Feedback.RequestOptions`
|
|
1783
|
+
|
|
1784
|
+
</dd>
|
|
1785
|
+
</dl>
|
|
1786
|
+
</dd>
|
|
1787
|
+
</dl>
|
|
1788
|
+
|
|
1789
|
+
</dd>
|
|
1790
|
+
</dl>
|
|
1791
|
+
</details>
|
|
1792
|
+
|
|
1793
|
+
## Generations
|
|
1794
|
+
|
|
1795
|
+
<details><summary><code>client.generations.<a href="/src/api/resources/generations/client/Client.ts">count</a>({ ...params }) -> Sync.GenerationCount</code></summary>
|
|
1796
|
+
<dl>
|
|
1797
|
+
<dd>
|
|
1798
|
+
|
|
1799
|
+
#### 📝 Description
|
|
1800
|
+
|
|
1801
|
+
<dl>
|
|
1802
|
+
<dd>
|
|
1803
|
+
|
|
1804
|
+
<dl>
|
|
1805
|
+
<dd>
|
|
1806
|
+
|
|
1807
|
+
Count generations visible to your credentials. All provided filters are combined.
|
|
1808
|
+
</dd>
|
|
1809
|
+
</dl>
|
|
1810
|
+
</dd>
|
|
1811
|
+
</dl>
|
|
1812
|
+
|
|
1813
|
+
#### 🔌 Usage
|
|
1814
|
+
|
|
1815
|
+
<dl>
|
|
1816
|
+
<dd>
|
|
1817
|
+
|
|
1818
|
+
<dl>
|
|
1819
|
+
<dd>
|
|
1820
|
+
|
|
1821
|
+
```typescript
|
|
1822
|
+
await client.generations.count();
|
|
1823
|
+
```
|
|
1824
|
+
|
|
1825
|
+
</dd>
|
|
1826
|
+
</dl>
|
|
1827
|
+
</dd>
|
|
1828
|
+
</dl>
|
|
1829
|
+
|
|
1830
|
+
#### ⚙️ Parameters
|
|
1831
|
+
|
|
1832
|
+
<dl>
|
|
1833
|
+
<dd>
|
|
1834
|
+
|
|
1835
|
+
<dl>
|
|
1836
|
+
<dd>
|
|
1837
|
+
|
|
1838
|
+
**request:** `Sync.CountGenerationsRequest`
|
|
1839
|
+
|
|
1840
|
+
</dd>
|
|
1841
|
+
</dl>
|
|
1842
|
+
|
|
1843
|
+
<dl>
|
|
1844
|
+
<dd>
|
|
1845
|
+
|
|
1846
|
+
**requestOptions:** `Generations.RequestOptions`
|
|
1847
|
+
|
|
1848
|
+
</dd>
|
|
1849
|
+
</dl>
|
|
1850
|
+
</dd>
|
|
1851
|
+
</dl>
|
|
1852
|
+
|
|
1853
|
+
</dd>
|
|
1854
|
+
</dl>
|
|
1855
|
+
</details>
|
|
1856
|
+
|
|
1857
|
+
<details><summary><code>client.generations.<a href="/src/api/resources/generations/client/Client.ts">getCosts</a>(id) -> Sync.GenerationCosts</code></summary>
|
|
1858
|
+
<dl>
|
|
1859
|
+
<dd>
|
|
1860
|
+
|
|
1861
|
+
#### 📝 Description
|
|
1862
|
+
|
|
1863
|
+
<dl>
|
|
1864
|
+
<dd>
|
|
1865
|
+
|
|
1866
|
+
<dl>
|
|
1867
|
+
<dd>
|
|
1868
|
+
|
|
1869
|
+
Read the recorded costs for a generation. Credit amounts are USD face value, not cash paid. Metered amounts exclude invoice adjustments and tax. A null total means one or more components are pending or unavailable. This endpoint does not estimate prices or change billing.
|
|
1870
|
+
</dd>
|
|
1871
|
+
</dl>
|
|
1872
|
+
</dd>
|
|
1873
|
+
</dl>
|
|
1874
|
+
|
|
1875
|
+
#### 🔌 Usage
|
|
1876
|
+
|
|
1877
|
+
<dl>
|
|
1878
|
+
<dd>
|
|
1879
|
+
|
|
1880
|
+
<dl>
|
|
1881
|
+
<dd>
|
|
1882
|
+
|
|
1883
|
+
```typescript
|
|
1884
|
+
await client.generations.getCosts("id");
|
|
1885
|
+
```
|
|
1886
|
+
|
|
1887
|
+
</dd>
|
|
1888
|
+
</dl>
|
|
1889
|
+
</dd>
|
|
1890
|
+
</dl>
|
|
1891
|
+
|
|
1892
|
+
#### ⚙️ Parameters
|
|
1893
|
+
|
|
1894
|
+
<dl>
|
|
1895
|
+
<dd>
|
|
1896
|
+
|
|
1897
|
+
<dl>
|
|
1898
|
+
<dd>
|
|
1899
|
+
|
|
1900
|
+
**id:** `Sync.GenerationId`
|
|
1901
|
+
|
|
1902
|
+
</dd>
|
|
1903
|
+
</dl>
|
|
1904
|
+
|
|
1905
|
+
<dl>
|
|
1906
|
+
<dd>
|
|
1907
|
+
|
|
1908
|
+
**requestOptions:** `Generations.RequestOptions`
|
|
1909
|
+
|
|
1910
|
+
</dd>
|
|
1911
|
+
</dl>
|
|
1912
|
+
</dd>
|
|
1913
|
+
</dl>
|
|
1914
|
+
|
|
1915
|
+
</dd>
|
|
1916
|
+
</dl>
|
|
1917
|
+
</details>
|
|
1918
|
+
|
|
1919
|
+
<details><summary><code>client.generations.<a href="/src/api/resources/generations/client/Client.ts">listCosts</a>({ ...params }) -> Sync.GenerationCostsList</code></summary>
|
|
1920
|
+
<dl>
|
|
1921
|
+
<dd>
|
|
1922
|
+
|
|
1923
|
+
#### 📝 Description
|
|
1924
|
+
|
|
1925
|
+
<dl>
|
|
1926
|
+
<dd>
|
|
1927
|
+
|
|
1928
|
+
<dl>
|
|
1929
|
+
<dd>
|
|
1930
|
+
|
|
1931
|
+
List the recorded costs of every generation that finished in a time range, for loading usage and spend in bulk. Each item is the same cost object as Get Generation Costs, plus `createdAt`, `finishedAt`, `model` and `apiKey`. The range filters on `finishedAt`, with `startTime` inclusive and `endTime` exclusive, and items are ordered oldest first, so back-to-back ranges such as one per UTC day neither overlap nor skip. Page with `cursor` until `nextCursor` is null, keeping the same `startTime` and `endTime`; changing the range between pages can skip items. Costs are normally recorded within about 10 minutes of completion. A null total means one or more components are pending or unavailable; `availability` is `pending`, `partial` or `unavailable`, and `partial` or `unavailable` items may not change. If recorded usage can't be read, the whole page fails with 503 `usage_dependency_unavailable` and no partial page is returned; retry the same request. See [Export usage and costs](/docs/api-reference/guides/usage-export).
|
|
1932
|
+
</dd>
|
|
1933
|
+
</dl>
|
|
1934
|
+
</dd>
|
|
1935
|
+
</dl>
|
|
1936
|
+
|
|
1937
|
+
#### 🔌 Usage
|
|
1938
|
+
|
|
1939
|
+
<dl>
|
|
1940
|
+
<dd>
|
|
1941
|
+
|
|
1942
|
+
<dl>
|
|
1943
|
+
<dd>
|
|
1944
|
+
|
|
1945
|
+
```typescript
|
|
1946
|
+
await client.generations.listCosts({
|
|
1947
|
+
startTime: "2026-11-12T00:00:00Z",
|
|
1948
|
+
endTime: "2026-11-13T00:00:00Z",
|
|
1949
|
+
limit: 500,
|
|
1950
|
+
});
|
|
1951
|
+
```
|
|
1952
|
+
|
|
1953
|
+
</dd>
|
|
1954
|
+
</dl>
|
|
1955
|
+
</dd>
|
|
1956
|
+
</dl>
|
|
1957
|
+
|
|
1958
|
+
#### ⚙️ Parameters
|
|
1959
|
+
|
|
1960
|
+
<dl>
|
|
1961
|
+
<dd>
|
|
1962
|
+
|
|
1963
|
+
<dl>
|
|
1964
|
+
<dd>
|
|
1965
|
+
|
|
1966
|
+
**request:** `Sync.ListGenerationCostsRequest`
|
|
1967
|
+
|
|
1968
|
+
</dd>
|
|
1969
|
+
</dl>
|
|
1970
|
+
|
|
1971
|
+
<dl>
|
|
1972
|
+
<dd>
|
|
1973
|
+
|
|
1974
|
+
**requestOptions:** `Generations.RequestOptions`
|
|
1975
|
+
|
|
1976
|
+
</dd>
|
|
1977
|
+
</dl>
|
|
1978
|
+
</dd>
|
|
1979
|
+
</dl>
|
|
1980
|
+
|
|
1981
|
+
</dd>
|
|
1982
|
+
</dl>
|
|
1983
|
+
</details>
|
|
1984
|
+
|
|
1985
|
+
<details><summary><code>client.generations.<a href="/src/api/resources/generations/client/Client.ts">create</a>({ ...params }) -> Sync.Generation</code></summary>
|
|
1986
|
+
<dl>
|
|
1987
|
+
<dd>
|
|
1988
|
+
|
|
1989
|
+
#### 📝 Description
|
|
1990
|
+
|
|
1991
|
+
<dl>
|
|
1992
|
+
<dd>
|
|
1993
|
+
|
|
1994
|
+
<dl>
|
|
1995
|
+
<dd>
|
|
1996
|
+
|
|
1997
|
+
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](/docs/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 older dialogueEdit preview without segment lipsync and section expansion returns dialogue_edit_retime_required (422). Create a new preview from the same transcript and edits. 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. A video input `url` that links to a single TikTok, Instagram, Facebook, or YouTube video is imported first: the generation is created PENDING and starts once the video is downloaded, or ends FAILED with errorCode import_failed if the import fails. A linked audio input, or a linked video in a segments or dubbing request, returns 409 import_in_progress until its import finishes; send the same request (with the same Idempotency-Key, if any) again after Retry-After. Link imports can also return 403 import_not_enabled, 422 import_failed, 429 import_daily_limit_reached or concurrency_limit_reached, and 503 import_unavailable. See [Asset Uploads](/docs/developer-guides/asset-uploads#import-a-social-video-link). 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](/docs/api-reference/guides/idempotency) for key validation, conflicts, retention, duplicates, and uncertain-outcome recovery.
|
|
1998
|
+
</dd>
|
|
1999
|
+
</dl>
|
|
2000
|
+
</dd>
|
|
2001
|
+
</dl>
|
|
2002
|
+
|
|
2003
|
+
#### 🔌 Usage
|
|
2004
|
+
|
|
2005
|
+
<dl>
|
|
2006
|
+
<dd>
|
|
2007
|
+
|
|
2008
|
+
<dl>
|
|
2009
|
+
<dd>
|
|
2010
|
+
|
|
2011
|
+
```typescript
|
|
2012
|
+
await client.generations.create({
|
|
2013
|
+
input: [
|
|
2014
|
+
{
|
|
2015
|
+
type: "video",
|
|
2016
|
+
url: "https://assets.sync.so/docs/example-video.mp4",
|
|
2017
|
+
},
|
|
2018
|
+
{
|
|
2019
|
+
type: "audio",
|
|
2020
|
+
url: "https://assets.sync.so/docs/example-audio.wav",
|
|
2021
|
+
},
|
|
2022
|
+
],
|
|
2023
|
+
model: "sync-3",
|
|
2024
|
+
});
|
|
2025
|
+
```
|
|
2026
|
+
|
|
2027
|
+
</dd>
|
|
2028
|
+
</dl>
|
|
2029
|
+
</dd>
|
|
2030
|
+
</dl>
|
|
2031
|
+
|
|
2032
|
+
#### ⚙️ Parameters
|
|
2033
|
+
|
|
2034
|
+
<dl>
|
|
2035
|
+
<dd>
|
|
2036
|
+
|
|
2037
|
+
<dl>
|
|
2038
|
+
<dd>
|
|
2039
|
+
|
|
2040
|
+
**request:** `Sync.CreateGenerationJsonRequest`
|
|
2041
|
+
|
|
2042
|
+
</dd>
|
|
2043
|
+
</dl>
|
|
2044
|
+
|
|
2045
|
+
<dl>
|
|
2046
|
+
<dd>
|
|
2047
|
+
|
|
2048
|
+
**requestOptions:** `Generations.RequestOptions`
|
|
2049
|
+
|
|
2050
|
+
</dd>
|
|
2051
|
+
</dl>
|
|
2052
|
+
</dd>
|
|
2053
|
+
</dl>
|
|
2054
|
+
|
|
2055
|
+
</dd>
|
|
2056
|
+
</dl>
|
|
2057
|
+
</details>
|
|
2058
|
+
|
|
2059
|
+
<details><summary><code>client.generations.<a href="/src/api/resources/generations/client/Client.ts">createWithFiles</a>(video, image, audio, { ...params }) -> Sync.Generation</code></summary>
|
|
2060
|
+
<dl>
|
|
2061
|
+
<dd>
|
|
2062
|
+
|
|
2063
|
+
#### 📝 Description
|
|
2064
|
+
|
|
2065
|
+
<dl>
|
|
2066
|
+
<dd>
|
|
2067
|
+
|
|
2068
|
+
<dl>
|
|
2069
|
+
<dd>
|
|
2070
|
+
|
|
2071
|
+
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. A malformed or truncated multipart body, an unsupported file field, or too many fields or parts returns 400 generation_input_validation_failed. Let your HTTP client build the multipart boundaries and send only the documented fields. 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 older dialogueEdit preview without segment lipsync and section expansion returns dialogue_edit_retime_required (422). Create a new preview from the same transcript and edits. 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](/docs/api-reference/guides/idempotency) for key validation, conflicts, retention, duplicates, and uncertain-outcome recovery.
|
|
2072
|
+
</dd>
|
|
2073
|
+
</dl>
|
|
2074
|
+
</dd>
|
|
2075
|
+
</dl>
|
|
2076
|
+
|
|
2077
|
+
#### 🔌 Usage
|
|
2078
|
+
|
|
2079
|
+
<dl>
|
|
2080
|
+
<dd>
|
|
2081
|
+
|
|
2082
|
+
<dl>
|
|
2083
|
+
<dd>
|
|
2084
|
+
|
|
2085
|
+
```typescript
|
|
2086
|
+
await client.generations.createWithFiles(
|
|
2087
|
+
fs.createReadStream("/path/to/your/file"),
|
|
2088
|
+
fs.createReadStream("/path/to/your/file"),
|
|
2089
|
+
fs.createReadStream("/path/to/your/file"),
|
|
2090
|
+
{
|
|
2091
|
+
model: "lipsync-2",
|
|
2092
|
+
},
|
|
2093
|
+
);
|
|
2094
|
+
```
|
|
2095
|
+
|
|
2096
|
+
</dd>
|
|
2097
|
+
</dl>
|
|
2098
|
+
</dd>
|
|
2099
|
+
</dl>
|
|
2100
|
+
|
|
2101
|
+
#### ⚙️ Parameters
|
|
2102
|
+
|
|
2103
|
+
<dl>
|
|
2104
|
+
<dd>
|
|
2105
|
+
|
|
2106
|
+
<dl>
|
|
2107
|
+
<dd>
|
|
2108
|
+
|
|
2109
|
+
**video:** `File | fs.ReadStream | Blob | undefined`
|
|
2110
|
+
|
|
2111
|
+
</dd>
|
|
2112
|
+
</dl>
|
|
2113
|
+
|
|
2114
|
+
<dl>
|
|
2115
|
+
<dd>
|
|
2116
|
+
|
|
2117
|
+
**image:** `File | fs.ReadStream | Blob | undefined`
|
|
2118
|
+
|
|
2119
|
+
</dd>
|
|
2120
|
+
</dl>
|
|
2121
|
+
|
|
2122
|
+
<dl>
|
|
2123
|
+
<dd>
|
|
2124
|
+
|
|
2125
|
+
**audio:** `File | fs.ReadStream | Blob | undefined`
|
|
2126
|
+
|
|
2127
|
+
</dd>
|
|
2128
|
+
</dl>
|
|
2129
|
+
|
|
2130
|
+
<dl>
|
|
2131
|
+
<dd>
|
|
2132
|
+
|
|
2133
|
+
**request:** `Sync.CreateGenerationRequest`
|
|
2134
|
+
|
|
2135
|
+
</dd>
|
|
2136
|
+
</dl>
|
|
2137
|
+
|
|
2138
|
+
<dl>
|
|
2139
|
+
<dd>
|
|
2140
|
+
|
|
2141
|
+
**requestOptions:** `Generations.RequestOptions`
|
|
2142
|
+
|
|
2143
|
+
</dd>
|
|
2144
|
+
</dl>
|
|
2145
|
+
</dd>
|
|
2146
|
+
</dl>
|
|
2147
|
+
|
|
2148
|
+
</dd>
|
|
2149
|
+
</dl>
|
|
2150
|
+
</details>
|
|
2151
|
+
|
|
2152
|
+
<details><summary><code>client.generations.<a href="/src/api/resources/generations/client/Client.ts">get</a>(id, { ...params }) -> Sync.Generation</code></summary>
|
|
2153
|
+
<dl>
|
|
2154
|
+
<dd>
|
|
2155
|
+
|
|
2156
|
+
#### 📝 Description
|
|
2157
|
+
|
|
2158
|
+
<dl>
|
|
2159
|
+
<dd>
|
|
2160
|
+
|
|
2161
|
+
<dl>
|
|
2162
|
+
<dd>
|
|
2163
|
+
|
|
2164
|
+
Retrieve the current generation state. This /v2/generate/{id} route supports the wait, timeout and include options below.
|
|
2165
|
+
</dd>
|
|
2166
|
+
</dl>
|
|
2167
|
+
</dd>
|
|
2168
|
+
</dl>
|
|
2169
|
+
|
|
2170
|
+
#### 🔌 Usage
|
|
2171
|
+
|
|
2172
|
+
<dl>
|
|
2173
|
+
<dd>
|
|
2174
|
+
|
|
2175
|
+
<dl>
|
|
2176
|
+
<dd>
|
|
2177
|
+
|
|
2178
|
+
```typescript
|
|
2179
|
+
await client.generations.get("6533643b-aceb-4c40-967e-d9ba9baac39e");
|
|
2180
|
+
```
|
|
2181
|
+
|
|
2182
|
+
</dd>
|
|
2183
|
+
</dl>
|
|
2184
|
+
</dd>
|
|
2185
|
+
</dl>
|
|
2186
|
+
|
|
2187
|
+
#### ⚙️ Parameters
|
|
2188
|
+
|
|
2189
|
+
<dl>
|
|
2190
|
+
<dd>
|
|
2191
|
+
|
|
2192
|
+
<dl>
|
|
2193
|
+
<dd>
|
|
2194
|
+
|
|
2195
|
+
**id:** `Sync.GenerationId`
|
|
2196
|
+
|
|
2197
|
+
</dd>
|
|
2198
|
+
</dl>
|
|
2199
|
+
|
|
2200
|
+
<dl>
|
|
2201
|
+
<dd>
|
|
2202
|
+
|
|
2203
|
+
**request:** `Sync.GetGenerationRequest`
|
|
2204
|
+
|
|
2205
|
+
</dd>
|
|
2206
|
+
</dl>
|
|
2207
|
+
|
|
2208
|
+
<dl>
|
|
2209
|
+
<dd>
|
|
2210
|
+
|
|
2211
|
+
**requestOptions:** `Generations.RequestOptions`
|
|
2212
|
+
|
|
2213
|
+
</dd>
|
|
2214
|
+
</dl>
|
|
2215
|
+
</dd>
|
|
2216
|
+
</dl>
|
|
2217
|
+
|
|
2218
|
+
</dd>
|
|
2219
|
+
</dl>
|
|
2220
|
+
</details>
|
|
2221
|
+
|
|
2222
|
+
<details><summary><code>client.generations.<a href="/src/api/resources/generations/client/Client.ts">download</a>(id, { ...params }) -> string</code></summary>
|
|
2223
|
+
<dl>
|
|
2224
|
+
<dd>
|
|
2225
|
+
|
|
2226
|
+
#### 📝 Description
|
|
2227
|
+
|
|
2228
|
+
<dl>
|
|
2229
|
+
<dd>
|
|
2230
|
+
|
|
2231
|
+
<dl>
|
|
2232
|
+
<dd>
|
|
2233
|
+
|
|
2234
|
+
Obtain the available full output of a completed generation in your
|
|
2235
|
+
organization. Authenticate with `x-api-key`; no Studio project or user
|
|
2236
|
+
session is required. Any valid API key belonging to the generation's
|
|
2237
|
+
organization can request the URL.
|
|
2238
|
+
|
|
2239
|
+
The successful response is an **unquoted URL in a text/plain body**,
|
|
2240
|
+
not JSON, a redirect, or the video itself. Fetch that URL separately
|
|
2241
|
+
without forwarding your API key.
|
|
2242
|
+
|
|
2243
|
+
```bash
|
|
2244
|
+
download_url=$(curl --fail-with-body --silent --show-error \
|
|
2245
|
+
-H "x-api-key: $SYNC_API_KEY" \
|
|
2246
|
+
"https://api.sync.so/v2/generations/$GENERATION_ID/download") &&
|
|
2247
|
+
curl --fail --location "$download_url" --output output.mov
|
|
2248
|
+
```
|
|
2249
|
+
|
|
2250
|
+
The URL resolves an existing output using your organization's current
|
|
2251
|
+
plan and billing-version eligibility. Free and watermark-required plans
|
|
2252
|
+
receive the watermarked derivative when present. Entitled plans (such
|
|
2253
|
+
as v2 Creator and v3 Starter or higher) receive the clean output when
|
|
2254
|
+
available. Historical outputs can have the watermark burned in, so an
|
|
2255
|
+
upgrade does not guarantee every old output becomes watermark-free.
|
|
2256
|
+
Changing plans does not rewrite historical files.
|
|
2257
|
+
This endpoint does not generate a new render or remove burned-in watermarks.
|
|
2258
|
+
|
|
2259
|
+
Signed URLs can expire or become unavailable before their nominal
|
|
2260
|
+
validity. Request this endpoint again for a fresh URL while the output
|
|
2261
|
+
is still available.
|
|
2262
|
+
These URLs are download credentials: keep them private.
|
|
2263
|
+
|
|
2264
|
+
Errors use the standard JSON error body and stable `errorCode`:
|
|
2265
|
+
|
|
2266
|
+
| Status | Code | Meaning / next step |
|
|
2267
|
+
| ------ | --------------------------------- | ------------------------------------------------------------------------------ |
|
|
2268
|
+
| 400 | — | Invalid generation UUID. |
|
|
2269
|
+
| 401 | — | API key missing, invalid, or revoked. |
|
|
2270
|
+
| 404 | `generation_not_found` | Missing, deleted, or outside your organization. |
|
|
2271
|
+
| 404 | `generation_output_unavailable` | No eligible output reference or the selected file is missing; contact support. |
|
|
2272
|
+
| 409 | `generation_not_ready` | Pending or processing; poll Get Generation until COMPLETED. |
|
|
2273
|
+
| 422 | `generation_not_downloadable` | Failed or rejected; inspect the generation error. |
|
|
2274
|
+
| 503 | `generation_download_unavailable` | The download URL could not be prepared; retry with backoff. |
|
|
2275
|
+
|
|
2276
|
+
Authentication also returns 422 for draft organizations. Requesting a
|
|
2277
|
+
download URL does not create a project, incur a generation charge, or
|
|
2278
|
+
restore deleted files.
|
|
2279
|
+
</dd>
|
|
2280
|
+
</dl>
|
|
2281
|
+
</dd>
|
|
2282
|
+
</dl>
|
|
2283
|
+
|
|
2284
|
+
#### 🔌 Usage
|
|
2285
|
+
|
|
2286
|
+
<dl>
|
|
2287
|
+
<dd>
|
|
2288
|
+
|
|
2289
|
+
<dl>
|
|
2290
|
+
<dd>
|
|
2291
|
+
|
|
2292
|
+
```typescript
|
|
2293
|
+
await client.generations.download("id");
|
|
2294
|
+
```
|
|
2295
|
+
|
|
2296
|
+
</dd>
|
|
2297
|
+
</dl>
|
|
2298
|
+
</dd>
|
|
2299
|
+
</dl>
|
|
2300
|
+
|
|
2301
|
+
#### ⚙️ Parameters
|
|
2302
|
+
|
|
2303
|
+
<dl>
|
|
2304
|
+
<dd>
|
|
2305
|
+
|
|
2306
|
+
<dl>
|
|
2307
|
+
<dd>
|
|
2308
|
+
|
|
2309
|
+
**id:** `Sync.GenerationId`
|
|
2310
|
+
|
|
2311
|
+
</dd>
|
|
2312
|
+
</dl>
|
|
2313
|
+
|
|
2314
|
+
<dl>
|
|
2315
|
+
<dd>
|
|
2316
|
+
|
|
2317
|
+
**request:** `Sync.GetGenerationDownloadRequest`
|
|
2318
|
+
|
|
2319
|
+
</dd>
|
|
2320
|
+
</dl>
|
|
2321
|
+
|
|
2322
|
+
<dl>
|
|
2323
|
+
<dd>
|
|
2324
|
+
|
|
2325
|
+
**requestOptions:** `Generations.RequestOptions`
|
|
2326
|
+
|
|
2327
|
+
</dd>
|
|
2328
|
+
</dl>
|
|
2329
|
+
</dd>
|
|
2330
|
+
</dl>
|
|
2331
|
+
|
|
2332
|
+
</dd>
|
|
2333
|
+
</dl>
|
|
2334
|
+
</details>
|
|
2335
|
+
|
|
2336
|
+
<details><summary><code>client.generations.<a href="/src/api/resources/generations/client/Client.ts">list</a>({ ...params }) -> Sync.Generation[]</code></summary>
|
|
2337
|
+
<dl>
|
|
2338
|
+
<dd>
|
|
2339
|
+
|
|
2340
|
+
#### 📝 Description
|
|
2341
|
+
|
|
2342
|
+
<dl>
|
|
2343
|
+
<dd>
|
|
2344
|
+
|
|
2345
|
+
<dl>
|
|
2346
|
+
<dd>
|
|
2347
|
+
|
|
2348
|
+
list sync. labs generations and filter jobs by status or generation id. review authentication, request parameters, response objects, and api errors.
|
|
2349
|
+
</dd>
|
|
2350
|
+
</dl>
|
|
2351
|
+
</dd>
|
|
2352
|
+
</dl>
|
|
2353
|
+
|
|
2354
|
+
#### 🔌 Usage
|
|
2355
|
+
|
|
2356
|
+
<dl>
|
|
2357
|
+
<dd>
|
|
2358
|
+
|
|
2359
|
+
<dl>
|
|
2360
|
+
<dd>
|
|
2361
|
+
|
|
2362
|
+
```typescript
|
|
2363
|
+
await client.generations.list();
|
|
2364
|
+
```
|
|
2365
|
+
|
|
2366
|
+
</dd>
|
|
2367
|
+
</dl>
|
|
2368
|
+
</dd>
|
|
2369
|
+
</dl>
|
|
2370
|
+
|
|
2371
|
+
#### ⚙️ Parameters
|
|
2372
|
+
|
|
2373
|
+
<dl>
|
|
2374
|
+
<dd>
|
|
2375
|
+
|
|
2376
|
+
<dl>
|
|
2377
|
+
<dd>
|
|
2378
|
+
|
|
2379
|
+
**request:** `Sync.ListGenerationsRequest`
|
|
2380
|
+
|
|
2381
|
+
</dd>
|
|
2382
|
+
</dl>
|
|
2383
|
+
|
|
2384
|
+
<dl>
|
|
2385
|
+
<dd>
|
|
2386
|
+
|
|
2387
|
+
**requestOptions:** `Generations.RequestOptions`
|
|
2388
|
+
|
|
2389
|
+
</dd>
|
|
2390
|
+
</dl>
|
|
2391
|
+
</dd>
|
|
2392
|
+
</dl>
|
|
2393
|
+
|
|
2394
|
+
</dd>
|
|
2395
|
+
</dl>
|
|
2396
|
+
</details>
|
|
2397
|
+
|
|
2398
|
+
<details><summary><code>client.generations.<a href="/src/api/resources/generations/client/Client.ts">estimateCost</a>({ ...params }) -> Sync.EstimatedGenerationCost</code></summary>
|
|
2399
|
+
<dl>
|
|
2400
|
+
<dd>
|
|
2401
|
+
|
|
2402
|
+
#### 📝 Description
|
|
2403
|
+
|
|
2404
|
+
<dl>
|
|
2405
|
+
<dd>
|
|
2406
|
+
|
|
2407
|
+
<dl>
|
|
2408
|
+
<dd>
|
|
2409
|
+
|
|
2410
|
+
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.
|
|
2411
|
+
</dd>
|
|
2412
|
+
</dl>
|
|
2413
|
+
</dd>
|
|
2414
|
+
</dl>
|
|
2415
|
+
|
|
2416
|
+
#### 🔌 Usage
|
|
2417
|
+
|
|
2418
|
+
<dl>
|
|
2419
|
+
<dd>
|
|
2420
|
+
|
|
2421
|
+
<dl>
|
|
2422
|
+
<dd>
|
|
2423
|
+
|
|
2424
|
+
```typescript
|
|
2425
|
+
await client.generations.estimateCost({
|
|
2426
|
+
model: "model",
|
|
2427
|
+
duration: 1.1,
|
|
2428
|
+
fps: undefined,
|
|
2429
|
+
workflow: undefined,
|
|
2430
|
+
reasoningEnabled: undefined,
|
|
2431
|
+
});
|
|
2432
|
+
```
|
|
2433
|
+
|
|
2434
|
+
</dd>
|
|
2435
|
+
</dl>
|
|
2436
|
+
</dd>
|
|
2437
|
+
</dl>
|
|
2438
|
+
|
|
2439
|
+
#### ⚙️ Parameters
|
|
2440
|
+
|
|
2441
|
+
<dl>
|
|
2442
|
+
<dd>
|
|
2443
|
+
|
|
2444
|
+
<dl>
|
|
2445
|
+
<dd>
|
|
2446
|
+
|
|
2447
|
+
**request:** `Sync.EstimateCostRequest`
|
|
2448
|
+
|
|
2449
|
+
</dd>
|
|
2450
|
+
</dl>
|
|
2451
|
+
|
|
2452
|
+
<dl>
|
|
2453
|
+
<dd>
|
|
2454
|
+
|
|
2455
|
+
**requestOptions:** `Generations.RequestOptions`
|
|
2456
|
+
|
|
2457
|
+
</dd>
|
|
2458
|
+
</dl>
|
|
2459
|
+
</dd>
|
|
2460
|
+
</dl>
|
|
2461
|
+
|
|
2462
|
+
</dd>
|
|
2463
|
+
</dl>
|
|
2464
|
+
</details>
|
|
2465
|
+
|
|
2466
|
+
<details><summary><code>client.generations.<a href="/src/api/resources/generations/client/Client.ts">delete</a>(id) -> Sync.ProjectGeneration</code></summary>
|
|
2467
|
+
<dl>
|
|
2468
|
+
<dd>
|
|
2469
|
+
|
|
2470
|
+
#### 📝 Description
|
|
2471
|
+
|
|
2472
|
+
<dl>
|
|
2473
|
+
<dd>
|
|
2474
|
+
|
|
2475
|
+
<dl>
|
|
2476
|
+
<dd>
|
|
2477
|
+
|
|
2478
|
+
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.
|
|
2479
|
+
</dd>
|
|
2480
|
+
</dl>
|
|
2481
|
+
</dd>
|
|
2482
|
+
</dl>
|
|
2483
|
+
|
|
2484
|
+
#### 🔌 Usage
|
|
2485
|
+
|
|
2486
|
+
<dl>
|
|
2487
|
+
<dd>
|
|
2488
|
+
|
|
2489
|
+
<dl>
|
|
2490
|
+
<dd>
|
|
2491
|
+
|
|
2492
|
+
```typescript
|
|
2493
|
+
await client.generations.delete("6533643b-aceb-4c40-967e-d9ba9baac39e");
|
|
2494
|
+
```
|
|
2495
|
+
|
|
2496
|
+
</dd>
|
|
2497
|
+
</dl>
|
|
2498
|
+
</dd>
|
|
2499
|
+
</dl>
|
|
2500
|
+
|
|
2501
|
+
#### ⚙️ Parameters
|
|
2502
|
+
|
|
2503
|
+
<dl>
|
|
2504
|
+
<dd>
|
|
2505
|
+
|
|
2506
|
+
<dl>
|
|
2507
|
+
<dd>
|
|
2508
|
+
|
|
2509
|
+
**id:** `Sync.GenerationId`
|
|
2510
|
+
|
|
2511
|
+
</dd>
|
|
2512
|
+
</dl>
|
|
2513
|
+
|
|
2514
|
+
<dl>
|
|
2515
|
+
<dd>
|
|
2516
|
+
|
|
2517
|
+
**requestOptions:** `Generations.RequestOptions`
|
|
2518
|
+
|
|
2519
|
+
</dd>
|
|
2520
|
+
</dl>
|
|
2521
|
+
</dd>
|
|
2522
|
+
</dl>
|
|
2523
|
+
|
|
2524
|
+
</dd>
|
|
2525
|
+
</dl>
|
|
2526
|
+
</details>
|
|
2527
|
+
|
|
2528
|
+
## Models
|
|
2529
|
+
|
|
2530
|
+
<details><summary><code>client.models.<a href="/src/api/resources/models/client/Client.ts">list</a>() -> Sync.ModelInfo[]</code></summary>
|
|
2531
|
+
<dl>
|
|
2532
|
+
<dd>
|
|
2533
|
+
|
|
2534
|
+
#### 📝 Description
|
|
2535
|
+
|
|
2536
|
+
<dl>
|
|
2537
|
+
<dd>
|
|
2538
|
+
|
|
2539
|
+
<dl>
|
|
2540
|
+
<dd>
|
|
2541
|
+
|
|
2542
|
+
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.
|
|
2543
|
+
</dd>
|
|
2544
|
+
</dl>
|
|
2545
|
+
</dd>
|
|
2546
|
+
</dl>
|
|
2547
|
+
|
|
2548
|
+
#### 🔌 Usage
|
|
2549
|
+
|
|
2550
|
+
<dl>
|
|
2551
|
+
<dd>
|
|
2552
|
+
|
|
2553
|
+
<dl>
|
|
2554
|
+
<dd>
|
|
2555
|
+
|
|
2556
|
+
```typescript
|
|
2557
|
+
await client.models.list();
|
|
2558
|
+
```
|
|
2559
|
+
|
|
2560
|
+
</dd>
|
|
2561
|
+
</dl>
|
|
2562
|
+
</dd>
|
|
2563
|
+
</dl>
|
|
2564
|
+
|
|
2565
|
+
#### ⚙️ Parameters
|
|
2566
|
+
|
|
2567
|
+
<dl>
|
|
2568
|
+
<dd>
|
|
2569
|
+
|
|
2570
|
+
<dl>
|
|
2571
|
+
<dd>
|
|
2572
|
+
|
|
2573
|
+
**requestOptions:** `Models.RequestOptions`
|
|
2574
|
+
|
|
2575
|
+
</dd>
|
|
2576
|
+
</dl>
|
|
2577
|
+
</dd>
|
|
2578
|
+
</dl>
|
|
2579
|
+
|
|
2580
|
+
</dd>
|
|
2581
|
+
</dl>
|
|
2582
|
+
</details>
|
|
2583
|
+
|
|
2584
|
+
## Organizations
|
|
2585
|
+
|
|
2586
|
+
<details><summary><code>client.organizations.<a href="/src/api/resources/organizations/client/Client.ts">getWebhookSecret</a>({ ...params }) -> Sync.WebhookSecretResponse</code></summary>
|
|
2587
|
+
<dl>
|
|
2588
|
+
<dd>
|
|
2589
|
+
|
|
2590
|
+
#### 📝 Description
|
|
2591
|
+
|
|
2592
|
+
<dl>
|
|
2593
|
+
<dd>
|
|
2594
|
+
|
|
2595
|
+
<dl>
|
|
2596
|
+
<dd>
|
|
2597
|
+
|
|
2598
|
+
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).
|
|
2599
|
+
</dd>
|
|
2600
|
+
</dl>
|
|
2601
|
+
</dd>
|
|
2602
|
+
</dl>
|
|
2603
|
+
|
|
2604
|
+
#### 🔌 Usage
|
|
2605
|
+
|
|
2606
|
+
<dl>
|
|
2607
|
+
<dd>
|
|
2608
|
+
|
|
2609
|
+
<dl>
|
|
2610
|
+
<dd>
|
|
2611
|
+
|
|
2612
|
+
```typescript
|
|
2613
|
+
await client.organizations.getWebhookSecret();
|
|
2614
|
+
```
|
|
2615
|
+
|
|
2616
|
+
</dd>
|
|
2617
|
+
</dl>
|
|
2618
|
+
</dd>
|
|
2619
|
+
</dl>
|
|
2620
|
+
|
|
2621
|
+
#### ⚙️ Parameters
|
|
2622
|
+
|
|
2623
|
+
<dl>
|
|
2624
|
+
<dd>
|
|
2625
|
+
|
|
2626
|
+
<dl>
|
|
2627
|
+
<dd>
|
|
2628
|
+
|
|
2629
|
+
**request:** `Sync.GetWebhookSecretRequest`
|
|
2630
|
+
|
|
2631
|
+
</dd>
|
|
2632
|
+
</dl>
|
|
2633
|
+
|
|
2634
|
+
<dl>
|
|
2635
|
+
<dd>
|
|
2636
|
+
|
|
2637
|
+
**requestOptions:** `Organizations.RequestOptions`
|
|
2638
|
+
|
|
2639
|
+
</dd>
|
|
2640
|
+
</dl>
|
|
2641
|
+
</dd>
|
|
2642
|
+
</dl>
|
|
2643
|
+
|
|
2644
|
+
</dd>
|
|
2645
|
+
</dl>
|
|
2646
|
+
</details>
|
|
2647
|
+
|
|
2648
|
+
## Projects
|
|
2649
|
+
|
|
2650
|
+
<details><summary><code>client.projects.<a href="/src/api/resources/projects/client/Client.ts">create</a>({ ...params }) -> Sync.Project</code></summary>
|
|
2651
|
+
<dl>
|
|
2652
|
+
<dd>
|
|
2653
|
+
|
|
2654
|
+
#### 📝 Description
|
|
2655
|
+
|
|
2656
|
+
<dl>
|
|
2657
|
+
<dd>
|
|
2658
|
+
|
|
2659
|
+
<dl>
|
|
2660
|
+
<dd>
|
|
2661
|
+
|
|
2662
|
+
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.
|
|
2663
|
+
</dd>
|
|
2664
|
+
</dl>
|
|
2665
|
+
</dd>
|
|
2666
|
+
</dl>
|
|
2667
|
+
|
|
2668
|
+
#### 🔌 Usage
|
|
2669
|
+
|
|
2670
|
+
<dl>
|
|
2671
|
+
<dd>
|
|
2672
|
+
|
|
2673
|
+
<dl>
|
|
2674
|
+
<dd>
|
|
2675
|
+
|
|
2676
|
+
```typescript
|
|
2677
|
+
await client.projects.create({
|
|
2678
|
+
id: "612bb64a-e7f4-40c1-977b-3e9797845637",
|
|
2679
|
+
name: "My API Project",
|
|
2680
|
+
});
|
|
2681
|
+
```
|
|
2682
|
+
|
|
2683
|
+
</dd>
|
|
2684
|
+
</dl>
|
|
2685
|
+
</dd>
|
|
2686
|
+
</dl>
|
|
2687
|
+
|
|
2688
|
+
#### ⚙️ Parameters
|
|
2689
|
+
|
|
2690
|
+
<dl>
|
|
2691
|
+
<dd>
|
|
2692
|
+
|
|
2693
|
+
<dl>
|
|
2694
|
+
<dd>
|
|
2695
|
+
|
|
2696
|
+
**request:** `Sync.CreateProjectRequest`
|
|
2697
|
+
|
|
2698
|
+
</dd>
|
|
2699
|
+
</dl>
|
|
2700
|
+
|
|
2701
|
+
<dl>
|
|
2702
|
+
<dd>
|
|
2703
|
+
|
|
2704
|
+
**requestOptions:** `Projects.RequestOptions`
|
|
2705
|
+
|
|
2706
|
+
</dd>
|
|
2707
|
+
</dl>
|
|
2708
|
+
</dd>
|
|
2709
|
+
</dl>
|
|
2710
|
+
|
|
2711
|
+
</dd>
|
|
2712
|
+
</dl>
|
|
2713
|
+
</details>
|
|
2714
|
+
|
|
2715
|
+
<details><summary><code>client.projects.<a href="/src/api/resources/projects/client/Client.ts">list</a>({ ...params }) -> Sync.PaginatedProjectsResponse</code></summary>
|
|
2716
|
+
<dl>
|
|
2717
|
+
<dd>
|
|
2718
|
+
|
|
2719
|
+
#### 📝 Description
|
|
2720
|
+
|
|
2721
|
+
<dl>
|
|
2722
|
+
<dd>
|
|
2723
|
+
|
|
2724
|
+
<dl>
|
|
2725
|
+
<dd>
|
|
2726
|
+
|
|
2727
|
+
List the projects in your organization, most recently updated first.
|
|
2728
|
+
</dd>
|
|
2729
|
+
</dl>
|
|
2730
|
+
</dd>
|
|
2731
|
+
</dl>
|
|
2732
|
+
|
|
2733
|
+
#### 🔌 Usage
|
|
2734
|
+
|
|
2735
|
+
<dl>
|
|
2736
|
+
<dd>
|
|
2737
|
+
|
|
2738
|
+
<dl>
|
|
2739
|
+
<dd>
|
|
2740
|
+
|
|
2741
|
+
```typescript
|
|
2742
|
+
await client.projects.list({
|
|
2743
|
+
limit: 10,
|
|
2744
|
+
sortBy: "updatedAt",
|
|
2745
|
+
});
|
|
2746
|
+
```
|
|
2747
|
+
|
|
2748
|
+
</dd>
|
|
2749
|
+
</dl>
|
|
2750
|
+
</dd>
|
|
2751
|
+
</dl>
|
|
2752
|
+
|
|
2753
|
+
#### ⚙️ Parameters
|
|
2754
|
+
|
|
2755
|
+
<dl>
|
|
2756
|
+
<dd>
|
|
2757
|
+
|
|
2758
|
+
<dl>
|
|
2759
|
+
<dd>
|
|
2760
|
+
|
|
2761
|
+
**request:** `Sync.ListProjectsRequest`
|
|
2762
|
+
|
|
2763
|
+
</dd>
|
|
2764
|
+
</dl>
|
|
2765
|
+
|
|
2766
|
+
<dl>
|
|
2767
|
+
<dd>
|
|
2768
|
+
|
|
2769
|
+
**requestOptions:** `Projects.RequestOptions`
|
|
2770
|
+
|
|
2771
|
+
</dd>
|
|
2772
|
+
</dl>
|
|
2773
|
+
</dd>
|
|
2774
|
+
</dl>
|
|
2775
|
+
|
|
2776
|
+
</dd>
|
|
2777
|
+
</dl>
|
|
2778
|
+
</details>
|
|
2779
|
+
|
|
2780
|
+
<details><summary><code>client.projects.<a href="/src/api/resources/projects/client/Client.ts">get</a>(id) -> Sync.Project</code></summary>
|
|
2781
|
+
<dl>
|
|
2782
|
+
<dd>
|
|
2783
|
+
|
|
2784
|
+
#### 📝 Description
|
|
2785
|
+
|
|
2786
|
+
<dl>
|
|
2787
|
+
<dd>
|
|
2788
|
+
|
|
2789
|
+
<dl>
|
|
2790
|
+
<dd>
|
|
2791
|
+
|
|
2792
|
+
Retrieve a project by id.
|
|
2793
|
+
</dd>
|
|
2794
|
+
</dl>
|
|
2795
|
+
</dd>
|
|
2796
|
+
</dl>
|
|
2797
|
+
|
|
2798
|
+
#### 🔌 Usage
|
|
2799
|
+
|
|
2800
|
+
<dl>
|
|
2801
|
+
<dd>
|
|
2802
|
+
|
|
2803
|
+
<dl>
|
|
2804
|
+
<dd>
|
|
2805
|
+
|
|
2806
|
+
```typescript
|
|
2807
|
+
await client.projects.get("612bb64a-e7f4-40c1-977b-3e9797845637");
|
|
2808
|
+
```
|
|
2809
|
+
|
|
2810
|
+
</dd>
|
|
2811
|
+
</dl>
|
|
2812
|
+
</dd>
|
|
2813
|
+
</dl>
|
|
2814
|
+
|
|
2815
|
+
#### ⚙️ Parameters
|
|
2816
|
+
|
|
2817
|
+
<dl>
|
|
2818
|
+
<dd>
|
|
2819
|
+
|
|
2820
|
+
<dl>
|
|
2821
|
+
<dd>
|
|
2822
|
+
|
|
2823
|
+
**id:** `Sync.ProjectId`
|
|
2824
|
+
|
|
2825
|
+
</dd>
|
|
2826
|
+
</dl>
|
|
2827
|
+
|
|
2828
|
+
<dl>
|
|
2829
|
+
<dd>
|
|
2830
|
+
|
|
2831
|
+
**requestOptions:** `Projects.RequestOptions`
|
|
2832
|
+
|
|
2833
|
+
</dd>
|
|
2834
|
+
</dl>
|
|
2835
|
+
</dd>
|
|
2836
|
+
</dl>
|
|
2837
|
+
|
|
2838
|
+
</dd>
|
|
2839
|
+
</dl>
|
|
2840
|
+
</details>
|
|
2841
|
+
|
|
2842
|
+
<details><summary><code>client.projects.<a href="/src/api/resources/projects/client/Client.ts">attachAsset</a>(id, { ...params }) -> void</code></summary>
|
|
2843
|
+
<dl>
|
|
2844
|
+
<dd>
|
|
2845
|
+
|
|
2846
|
+
#### 📝 Description
|
|
2847
|
+
|
|
2848
|
+
<dl>
|
|
2849
|
+
<dd>
|
|
2850
|
+
|
|
2851
|
+
<dl>
|
|
2852
|
+
<dd>
|
|
2853
|
+
|
|
2854
|
+
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.
|
|
2855
|
+
</dd>
|
|
2856
|
+
</dl>
|
|
2857
|
+
</dd>
|
|
2858
|
+
</dl>
|
|
2859
|
+
|
|
2860
|
+
#### 🔌 Usage
|
|
2861
|
+
|
|
2862
|
+
<dl>
|
|
2863
|
+
<dd>
|
|
2864
|
+
|
|
2865
|
+
<dl>
|
|
2866
|
+
<dd>
|
|
2867
|
+
|
|
2868
|
+
```typescript
|
|
2869
|
+
await client.projects.attachAsset("612bb64a-e7f4-40c1-977b-3e9797845637", {
|
|
2870
|
+
assetId: "8f14e45f-ceea-467d-9a1b-3e4d5c6f7a8b",
|
|
2871
|
+
});
|
|
2872
|
+
```
|
|
2873
|
+
|
|
2874
|
+
</dd>
|
|
2875
|
+
</dl>
|
|
2876
|
+
</dd>
|
|
2877
|
+
</dl>
|
|
2878
|
+
|
|
2879
|
+
#### ⚙️ Parameters
|
|
2880
|
+
|
|
2881
|
+
<dl>
|
|
2882
|
+
<dd>
|
|
2883
|
+
|
|
2884
|
+
<dl>
|
|
2885
|
+
<dd>
|
|
2886
|
+
|
|
2887
|
+
**id:** `Sync.ProjectId`
|
|
2888
|
+
|
|
2889
|
+
</dd>
|
|
2890
|
+
</dl>
|
|
2891
|
+
|
|
2892
|
+
<dl>
|
|
2893
|
+
<dd>
|
|
2894
|
+
|
|
2895
|
+
**request:** `Sync.AttachProjectAssetRequest`
|
|
2896
|
+
|
|
2897
|
+
</dd>
|
|
2898
|
+
</dl>
|
|
2899
|
+
|
|
2900
|
+
<dl>
|
|
2901
|
+
<dd>
|
|
2902
|
+
|
|
2903
|
+
**requestOptions:** `Projects.RequestOptions`
|
|
2904
|
+
|
|
2905
|
+
</dd>
|
|
2906
|
+
</dl>
|
|
2907
|
+
</dd>
|
|
2908
|
+
</dl>
|
|
2909
|
+
|
|
2910
|
+
</dd>
|
|
2911
|
+
</dl>
|
|
2912
|
+
</details>
|
|
2913
|
+
|
|
2914
|
+
<details><summary><code>client.projects.<a href="/src/api/resources/projects/client/Client.ts">detachAsset</a>(id, assetId) -> void</code></summary>
|
|
2915
|
+
<dl>
|
|
2916
|
+
<dd>
|
|
2917
|
+
|
|
2918
|
+
#### 📝 Description
|
|
2919
|
+
|
|
2920
|
+
<dl>
|
|
2921
|
+
<dd>
|
|
2922
|
+
|
|
2923
|
+
<dl>
|
|
2924
|
+
<dd>
|
|
2925
|
+
|
|
2926
|
+
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.
|
|
2927
|
+
</dd>
|
|
2928
|
+
</dl>
|
|
2929
|
+
</dd>
|
|
2930
|
+
</dl>
|
|
2931
|
+
|
|
2932
|
+
#### 🔌 Usage
|
|
2933
|
+
|
|
2934
|
+
<dl>
|
|
2935
|
+
<dd>
|
|
2936
|
+
|
|
2937
|
+
<dl>
|
|
2938
|
+
<dd>
|
|
2939
|
+
|
|
2940
|
+
```typescript
|
|
2941
|
+
await client.projects.detachAsset("id", "assetId");
|
|
2942
|
+
```
|
|
2943
|
+
|
|
2944
|
+
</dd>
|
|
2945
|
+
</dl>
|
|
2946
|
+
</dd>
|
|
2947
|
+
</dl>
|
|
2948
|
+
|
|
2949
|
+
#### ⚙️ Parameters
|
|
2950
|
+
|
|
2951
|
+
<dl>
|
|
2952
|
+
<dd>
|
|
2953
|
+
|
|
2954
|
+
<dl>
|
|
2955
|
+
<dd>
|
|
2956
|
+
|
|
2957
|
+
**id:** `Sync.ProjectId`
|
|
2958
|
+
|
|
2959
|
+
</dd>
|
|
2960
|
+
</dl>
|
|
2961
|
+
|
|
2962
|
+
<dl>
|
|
2963
|
+
<dd>
|
|
2964
|
+
|
|
2965
|
+
**assetId:** `Sync.AssetId`
|
|
2966
|
+
|
|
2967
|
+
</dd>
|
|
2968
|
+
</dl>
|
|
2969
|
+
|
|
2970
|
+
<dl>
|
|
2971
|
+
<dd>
|
|
2972
|
+
|
|
2973
|
+
**requestOptions:** `Projects.RequestOptions`
|
|
2974
|
+
|
|
2975
|
+
</dd>
|
|
2976
|
+
</dl>
|
|
2977
|
+
</dd>
|
|
2978
|
+
</dl>
|
|
2979
|
+
|
|
2980
|
+
</dd>
|
|
2981
|
+
</dl>
|
|
2982
|
+
</details>
|
|
2983
|
+
|
|
2984
|
+
<details><summary><code>client.projects.<a href="/src/api/resources/projects/client/Client.ts">update</a>(id, { ...params }) -> Sync.Project</code></summary>
|
|
2985
|
+
<dl>
|
|
2986
|
+
<dd>
|
|
2987
|
+
|
|
2988
|
+
#### 📝 Description
|
|
2989
|
+
|
|
2990
|
+
<dl>
|
|
2991
|
+
<dd>
|
|
2992
|
+
|
|
2993
|
+
<dl>
|
|
2994
|
+
<dd>
|
|
2995
|
+
|
|
2996
|
+
Update a project's name, description, visibility, or mode. Only the fields you provide are changed.
|
|
2997
|
+
</dd>
|
|
2998
|
+
</dl>
|
|
2999
|
+
</dd>
|
|
3000
|
+
</dl>
|
|
3001
|
+
|
|
3002
|
+
#### 🔌 Usage
|
|
3003
|
+
|
|
3004
|
+
<dl>
|
|
3005
|
+
<dd>
|
|
3006
|
+
|
|
3007
|
+
<dl>
|
|
3008
|
+
<dd>
|
|
3009
|
+
|
|
3010
|
+
```typescript
|
|
3011
|
+
await client.projects.update("612bb64a-e7f4-40c1-977b-3e9797845637", {
|
|
3012
|
+
name: "Renamed Project",
|
|
3013
|
+
});
|
|
3014
|
+
```
|
|
3015
|
+
|
|
3016
|
+
</dd>
|
|
3017
|
+
</dl>
|
|
3018
|
+
</dd>
|
|
3019
|
+
</dl>
|
|
3020
|
+
|
|
3021
|
+
#### ⚙️ Parameters
|
|
3022
|
+
|
|
3023
|
+
<dl>
|
|
3024
|
+
<dd>
|
|
3025
|
+
|
|
3026
|
+
<dl>
|
|
3027
|
+
<dd>
|
|
3028
|
+
|
|
3029
|
+
**id:** `Sync.ProjectId`
|
|
3030
|
+
|
|
3031
|
+
</dd>
|
|
3032
|
+
</dl>
|
|
3033
|
+
|
|
3034
|
+
<dl>
|
|
3035
|
+
<dd>
|
|
3036
|
+
|
|
3037
|
+
**request:** `Sync.UpdateProjectRequest`
|
|
3038
|
+
|
|
3039
|
+
</dd>
|
|
3040
|
+
</dl>
|
|
3041
|
+
|
|
3042
|
+
<dl>
|
|
3043
|
+
<dd>
|
|
3044
|
+
|
|
3045
|
+
**requestOptions:** `Projects.RequestOptions`
|
|
3046
|
+
|
|
3047
|
+
</dd>
|
|
3048
|
+
</dl>
|
|
3049
|
+
</dd>
|
|
3050
|
+
</dl>
|
|
3051
|
+
|
|
3052
|
+
</dd>
|
|
3053
|
+
</dl>
|
|
3054
|
+
</details>
|
|
3055
|
+
|
|
3056
|
+
<details><summary><code>client.projects.<a href="/src/api/resources/projects/client/Client.ts">delete</a>(id) -> Sync.DeleteProjectResponse</code></summary>
|
|
3057
|
+
<dl>
|
|
3058
|
+
<dd>
|
|
3059
|
+
|
|
3060
|
+
#### 📝 Description
|
|
3061
|
+
|
|
3062
|
+
<dl>
|
|
3063
|
+
<dd>
|
|
3064
|
+
|
|
3065
|
+
<dl>
|
|
3066
|
+
<dd>
|
|
3067
|
+
|
|
3068
|
+
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.
|
|
3069
|
+
</dd>
|
|
3070
|
+
</dl>
|
|
3071
|
+
</dd>
|
|
3072
|
+
</dl>
|
|
3073
|
+
|
|
3074
|
+
#### 🔌 Usage
|
|
3075
|
+
|
|
3076
|
+
<dl>
|
|
3077
|
+
<dd>
|
|
3078
|
+
|
|
3079
|
+
<dl>
|
|
3080
|
+
<dd>
|
|
3081
|
+
|
|
3082
|
+
```typescript
|
|
3083
|
+
await client.projects.delete("612bb64a-e7f4-40c1-977b-3e9797845637");
|
|
3084
|
+
```
|
|
3085
|
+
|
|
3086
|
+
</dd>
|
|
3087
|
+
</dl>
|
|
3088
|
+
</dd>
|
|
3089
|
+
</dl>
|
|
3090
|
+
|
|
3091
|
+
#### ⚙️ Parameters
|
|
3092
|
+
|
|
3093
|
+
<dl>
|
|
3094
|
+
<dd>
|
|
3095
|
+
|
|
3096
|
+
<dl>
|
|
3097
|
+
<dd>
|
|
3098
|
+
|
|
3099
|
+
**id:** `Sync.ProjectId`
|
|
3100
|
+
|
|
3101
|
+
</dd>
|
|
3102
|
+
</dl>
|
|
3103
|
+
|
|
6
3104
|
<dl>
|
|
7
3105
|
<dd>
|
|
8
3106
|
|
|
9
|
-
|
|
3107
|
+
**requestOptions:** `Projects.RequestOptions`
|
|
3108
|
+
|
|
3109
|
+
</dd>
|
|
3110
|
+
</dl>
|
|
3111
|
+
</dd>
|
|
3112
|
+
</dl>
|
|
3113
|
+
|
|
3114
|
+
</dd>
|
|
3115
|
+
</dl>
|
|
3116
|
+
</details>
|
|
3117
|
+
|
|
3118
|
+
## Transcriptions
|
|
10
3119
|
|
|
3120
|
+
<details><summary><code>client.transcriptions.<a href="/src/api/resources/transcriptions/client/Client.ts">create</a>({ ...params }) -> Sync.TranscriptionJob</code></summary>
|
|
11
3121
|
<dl>
|
|
12
3122
|
<dd>
|
|
13
3123
|
|
|
3124
|
+
#### 📝 Description
|
|
3125
|
+
|
|
14
3126
|
<dl>
|
|
15
3127
|
<dd>
|
|
16
3128
|
|
|
17
|
-
|
|
3129
|
+
<dl>
|
|
3130
|
+
<dd>
|
|
18
3131
|
|
|
3132
|
+
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. An `endMs` past the end of the source is clamped to it, and the job echoes the effective end in `sourceEndMs`. Transcription is not billed.
|
|
19
3133
|
</dd>
|
|
20
3134
|
</dl>
|
|
21
3135
|
</dd>
|
|
@@ -30,9 +3144,9 @@ List all assets in your organization's media library.
|
|
|
30
3144
|
<dd>
|
|
31
3145
|
|
|
32
3146
|
```typescript
|
|
33
|
-
await client.
|
|
34
|
-
|
|
35
|
-
|
|
3147
|
+
await client.transcriptions.create({
|
|
3148
|
+
sourceVideoUrl: "https://assets.sync.so/docs/example-video.mp4",
|
|
3149
|
+
endMs: 30000,
|
|
36
3150
|
});
|
|
37
3151
|
```
|
|
38
3152
|
|
|
@@ -49,7 +3163,7 @@ await client.assets.list({
|
|
|
49
3163
|
<dl>
|
|
50
3164
|
<dd>
|
|
51
3165
|
|
|
52
|
-
**request:** `Sync.
|
|
3166
|
+
**request:** `Sync.CreateTranscriptionDto`
|
|
53
3167
|
|
|
54
3168
|
</dd>
|
|
55
3169
|
</dl>
|
|
@@ -57,7 +3171,7 @@ await client.assets.list({
|
|
|
57
3171
|
<dl>
|
|
58
3172
|
<dd>
|
|
59
3173
|
|
|
60
|
-
**requestOptions:** `
|
|
3174
|
+
**requestOptions:** `Transcriptions.RequestOptions`
|
|
61
3175
|
|
|
62
3176
|
</dd>
|
|
63
3177
|
</dl>
|
|
@@ -68,7 +3182,7 @@ await client.assets.list({
|
|
|
68
3182
|
</dl>
|
|
69
3183
|
</details>
|
|
70
3184
|
|
|
71
|
-
<details><summary><code>client.
|
|
3185
|
+
<details><summary><code>client.transcriptions.<a href="/src/api/resources/transcriptions/client/Client.ts">get</a>(id) -> Sync.TranscriptionJob</code></summary>
|
|
72
3186
|
<dl>
|
|
73
3187
|
<dd>
|
|
74
3188
|
|
|
@@ -80,8 +3194,7 @@ await client.assets.list({
|
|
|
80
3194
|
<dl>
|
|
81
3195
|
<dd>
|
|
82
3196
|
|
|
83
|
-
|
|
84
|
-
|
|
3197
|
+
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.
|
|
85
3198
|
</dd>
|
|
86
3199
|
</dl>
|
|
87
3200
|
</dd>
|
|
@@ -96,7 +3209,7 @@ Retrieve a specific asset by ID.
|
|
|
96
3209
|
<dd>
|
|
97
3210
|
|
|
98
3211
|
```typescript
|
|
99
|
-
await client.
|
|
3212
|
+
await client.transcriptions.get("6533643b-aceb-4c40-967e-d9ba9baac39e");
|
|
100
3213
|
```
|
|
101
3214
|
|
|
102
3215
|
</dd>
|
|
@@ -112,7 +3225,7 @@ await client.assets.get("550e8400-e29b-41d4-a716-446655440000");
|
|
|
112
3225
|
<dl>
|
|
113
3226
|
<dd>
|
|
114
3227
|
|
|
115
|
-
**id:** `Sync.
|
|
3228
|
+
**id:** `Sync.TranscriptionJobId` — Transcription job id.
|
|
116
3229
|
|
|
117
3230
|
</dd>
|
|
118
3231
|
</dl>
|
|
@@ -120,7 +3233,7 @@ await client.assets.get("550e8400-e29b-41d4-a716-446655440000");
|
|
|
120
3233
|
<dl>
|
|
121
3234
|
<dd>
|
|
122
3235
|
|
|
123
|
-
**requestOptions:** `
|
|
3236
|
+
**requestOptions:** `Transcriptions.RequestOptions`
|
|
124
3237
|
|
|
125
3238
|
</dd>
|
|
126
3239
|
</dl>
|
|
@@ -131,9 +3244,7 @@ await client.assets.get("550e8400-e29b-41d4-a716-446655440000");
|
|
|
131
3244
|
</dl>
|
|
132
3245
|
</details>
|
|
133
3246
|
|
|
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>
|
|
3247
|
+
<details><summary><code>client.transcriptions.<a href="/src/api/resources/transcriptions/client/Client.ts">getSpeakerAnalysis</a>(id) -> Sync.SpeakerAnalysis</code></summary>
|
|
137
3248
|
<dl>
|
|
138
3249
|
<dd>
|
|
139
3250
|
|
|
@@ -145,8 +3256,69 @@ await client.assets.get("550e8400-e29b-41d4-a716-446655440000");
|
|
|
145
3256
|
<dl>
|
|
146
3257
|
<dd>
|
|
147
3258
|
|
|
148
|
-
|
|
3259
|
+
Returns which face belongs to each transcript speaker. Each speaker is matched, with an avatar, evidence and a face track, or uncertain, with a reason. Analysis may already be available for video transcriptions of your own media. Read this endpoint before starting an analysis. Poll while `status` is `processing`, until it is `completed` or `unavailable`. Requires a completed transcription.
|
|
3260
|
+
</dd>
|
|
3261
|
+
</dl>
|
|
3262
|
+
</dd>
|
|
3263
|
+
</dl>
|
|
3264
|
+
|
|
3265
|
+
#### 🔌 Usage
|
|
3266
|
+
|
|
3267
|
+
<dl>
|
|
3268
|
+
<dd>
|
|
3269
|
+
|
|
3270
|
+
<dl>
|
|
3271
|
+
<dd>
|
|
3272
|
+
|
|
3273
|
+
```typescript
|
|
3274
|
+
await client.transcriptions.getSpeakerAnalysis("6533643b-aceb-4c40-967e-d9ba9baac39e");
|
|
3275
|
+
```
|
|
3276
|
+
|
|
3277
|
+
</dd>
|
|
3278
|
+
</dl>
|
|
3279
|
+
</dd>
|
|
3280
|
+
</dl>
|
|
3281
|
+
|
|
3282
|
+
#### ⚙️ Parameters
|
|
3283
|
+
|
|
3284
|
+
<dl>
|
|
3285
|
+
<dd>
|
|
3286
|
+
|
|
3287
|
+
<dl>
|
|
3288
|
+
<dd>
|
|
3289
|
+
|
|
3290
|
+
**id:** `Sync.TranscriptionJobId` — Transcription job id.
|
|
149
3291
|
|
|
3292
|
+
</dd>
|
|
3293
|
+
</dl>
|
|
3294
|
+
|
|
3295
|
+
<dl>
|
|
3296
|
+
<dd>
|
|
3297
|
+
|
|
3298
|
+
**requestOptions:** `Transcriptions.RequestOptions`
|
|
3299
|
+
|
|
3300
|
+
</dd>
|
|
3301
|
+
</dl>
|
|
3302
|
+
</dd>
|
|
3303
|
+
</dl>
|
|
3304
|
+
|
|
3305
|
+
</dd>
|
|
3306
|
+
</dl>
|
|
3307
|
+
</details>
|
|
3308
|
+
|
|
3309
|
+
<details><summary><code>client.transcriptions.<a href="/src/api/resources/transcriptions/client/Client.ts">analyzeSpeakers</a>(id, { ...params }) -> Sync.SpeakerAnalysis</code></summary>
|
|
3310
|
+
<dl>
|
|
3311
|
+
<dd>
|
|
3312
|
+
|
|
3313
|
+
#### 📝 Description
|
|
3314
|
+
|
|
3315
|
+
<dl>
|
|
3316
|
+
<dd>
|
|
3317
|
+
|
|
3318
|
+
<dl>
|
|
3319
|
+
<dd>
|
|
3320
|
+
|
|
3321
|
+
Matches each transcript speaker to the face that talks during their words. Read `GET /v2/transcriptions/{id}/speaker-analysis` first, and call this to start an analysis that wasn't run or to retry one that ended `unavailable`. Pass the job's `revision` and `sourceVideoUrl`. Supports up to 2 minutes of video and 8 speakers, and 3 requests per minute.
|
|
150
3322
|
</dd>
|
|
151
3323
|
</dl>
|
|
152
3324
|
</dd>
|
|
@@ -161,9 +3333,10 @@ API for [Batch Processing](/api-reference/guides/batch-processing). Available on
|
|
|
161
3333
|
<dd>
|
|
162
3334
|
|
|
163
3335
|
```typescript
|
|
164
|
-
await client.
|
|
165
|
-
|
|
166
|
-
|
|
3336
|
+
await client.transcriptions.analyzeSpeakers("id", {
|
|
3337
|
+
revision: "revision",
|
|
3338
|
+
sourceVideoUrl: "sourceVideoUrl",
|
|
3339
|
+
retry: undefined,
|
|
167
3340
|
});
|
|
168
3341
|
```
|
|
169
3342
|
|
|
@@ -180,7 +3353,7 @@ await client.batch.create(fs.createReadStream("/path/to/your/file"), {
|
|
|
180
3353
|
<dl>
|
|
181
3354
|
<dd>
|
|
182
3355
|
|
|
183
|
-
**
|
|
3356
|
+
**id:** `Sync.TranscriptionJobId` — Transcription job id.
|
|
184
3357
|
|
|
185
3358
|
</dd>
|
|
186
3359
|
</dl>
|
|
@@ -188,7 +3361,7 @@ await client.batch.create(fs.createReadStream("/path/to/your/file"), {
|
|
|
188
3361
|
<dl>
|
|
189
3362
|
<dd>
|
|
190
3363
|
|
|
191
|
-
**request:** `Sync.
|
|
3364
|
+
**request:** `Sync.AnalyzeSpeakersRequest`
|
|
192
3365
|
|
|
193
3366
|
</dd>
|
|
194
3367
|
</dl>
|
|
@@ -196,7 +3369,7 @@ await client.batch.create(fs.createReadStream("/path/to/your/file"), {
|
|
|
196
3369
|
<dl>
|
|
197
3370
|
<dd>
|
|
198
3371
|
|
|
199
|
-
**requestOptions:** `
|
|
3372
|
+
**requestOptions:** `Transcriptions.RequestOptions`
|
|
200
3373
|
|
|
201
3374
|
</dd>
|
|
202
3375
|
</dl>
|
|
@@ -207,7 +3380,7 @@ await client.batch.create(fs.createReadStream("/path/to/your/file"), {
|
|
|
207
3380
|
</dl>
|
|
208
3381
|
</details>
|
|
209
3382
|
|
|
210
|
-
<details><summary><code>client.
|
|
3383
|
+
<details><summary><code>client.transcriptions.<a href="/src/api/resources/transcriptions/client/Client.ts">sliceFaceTrack</a>(id, { ...params }) -> Sync.SpeakerFaceTrackSlice</code></summary>
|
|
211
3384
|
<dl>
|
|
212
3385
|
<dd>
|
|
213
3386
|
|
|
@@ -219,8 +3392,7 @@ await client.batch.create(fs.createReadStream("/path/to/your/file"), {
|
|
|
219
3392
|
<dl>
|
|
220
3393
|
<dd>
|
|
221
3394
|
|
|
222
|
-
|
|
223
|
-
|
|
3395
|
+
Cuts frames [`startFrame`, `endFrame`) at `fps` from a matched speaker's face track and returns a bounding-boxes file for that segment. Pass the `url` as the segment's `active_speaker_detection.bounding_boxes_url` so the segment lipsyncs that speaker. `url` is null when the face is on none of those frames; leave that segment unlipsynced or use auto-detect. 60 requests per minute.
|
|
224
3396
|
</dd>
|
|
225
3397
|
</dl>
|
|
226
3398
|
</dd>
|
|
@@ -235,7 +3407,13 @@ Retrieve details about a specific batch, including its current status, processin
|
|
|
235
3407
|
<dd>
|
|
236
3408
|
|
|
237
3409
|
```typescript
|
|
238
|
-
await client.
|
|
3410
|
+
await client.transcriptions.sliceFaceTrack("6533643b-aceb-4c40-967e-d9ba9baac39e", {
|
|
3411
|
+
revision: "3f9a1c0e7b2d4a6f8e1c3b5d7f9a0c2e4b6d8f0a1c3e5b7d9f1a3c5e7b9d0f2a",
|
|
3412
|
+
speakerId: "speaker_0",
|
|
3413
|
+
startFrame: 100,
|
|
3414
|
+
endFrame: 250,
|
|
3415
|
+
fps: 25,
|
|
3416
|
+
});
|
|
239
3417
|
```
|
|
240
3418
|
|
|
241
3419
|
</dd>
|
|
@@ -251,7 +3429,7 @@ await client.batch.get("batch_abc123");
|
|
|
251
3429
|
<dl>
|
|
252
3430
|
<dd>
|
|
253
3431
|
|
|
254
|
-
**id:** `Sync.
|
|
3432
|
+
**id:** `Sync.TranscriptionJobId` — Transcription job id.
|
|
255
3433
|
|
|
256
3434
|
</dd>
|
|
257
3435
|
</dl>
|
|
@@ -259,7 +3437,15 @@ await client.batch.get("batch_abc123");
|
|
|
259
3437
|
<dl>
|
|
260
3438
|
<dd>
|
|
261
3439
|
|
|
262
|
-
**
|
|
3440
|
+
**request:** `Sync.SliceSpeakerFaceTrackRequest`
|
|
3441
|
+
|
|
3442
|
+
</dd>
|
|
3443
|
+
</dl>
|
|
3444
|
+
|
|
3445
|
+
<dl>
|
|
3446
|
+
<dd>
|
|
3447
|
+
|
|
3448
|
+
**requestOptions:** `Transcriptions.RequestOptions`
|
|
263
3449
|
|
|
264
3450
|
</dd>
|
|
265
3451
|
</dl>
|
|
@@ -270,7 +3456,9 @@ await client.batch.get("batch_abc123");
|
|
|
270
3456
|
</dl>
|
|
271
3457
|
</details>
|
|
272
3458
|
|
|
273
|
-
|
|
3459
|
+
## Tts
|
|
3460
|
+
|
|
3461
|
+
<details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">create</a>({ ...params }) -> Sync.TtsGenerationResponse</code></summary>
|
|
274
3462
|
<dl>
|
|
275
3463
|
<dd>
|
|
276
3464
|
|
|
@@ -282,8 +3470,9 @@ await client.batch.get("batch_abc123");
|
|
|
282
3470
|
<dl>
|
|
283
3471
|
<dd>
|
|
284
3472
|
|
|
285
|
-
|
|
3473
|
+
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.
|
|
286
3474
|
|
|
3475
|
+
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.
|
|
287
3476
|
</dd>
|
|
288
3477
|
</dl>
|
|
289
3478
|
</dd>
|
|
@@ -298,7 +3487,11 @@ List all batches for your organization with optional filtering by status and cre
|
|
|
298
3487
|
<dd>
|
|
299
3488
|
|
|
300
3489
|
```typescript
|
|
301
|
-
await client.
|
|
3490
|
+
await client.tts.create({
|
|
3491
|
+
script: "Hey \u2014 thanks for trying sync. labs.",
|
|
3492
|
+
voiceId: "EXAVITQu4vr4xnSDxMaL",
|
|
3493
|
+
provider: "elevenlabs",
|
|
3494
|
+
});
|
|
302
3495
|
```
|
|
303
3496
|
|
|
304
3497
|
</dd>
|
|
@@ -314,7 +3507,7 @@ await client.batch.list();
|
|
|
314
3507
|
<dl>
|
|
315
3508
|
<dd>
|
|
316
3509
|
|
|
317
|
-
**request:** `Sync.
|
|
3510
|
+
**request:** `Sync.CreateTtsRequest`
|
|
318
3511
|
|
|
319
3512
|
</dd>
|
|
320
3513
|
</dl>
|
|
@@ -322,7 +3515,7 @@ await client.batch.list();
|
|
|
322
3515
|
<dl>
|
|
323
3516
|
<dd>
|
|
324
3517
|
|
|
325
|
-
**requestOptions:** `
|
|
3518
|
+
**requestOptions:** `Tts.RequestOptions`
|
|
326
3519
|
|
|
327
3520
|
</dd>
|
|
328
3521
|
</dl>
|
|
@@ -333,12 +3526,24 @@ await client.batch.list();
|
|
|
333
3526
|
</dl>
|
|
334
3527
|
</details>
|
|
335
3528
|
|
|
336
|
-
|
|
3529
|
+
<details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">createJob</a>({ ...params }) -> Sync.TtsJob</code></summary>
|
|
3530
|
+
<dl>
|
|
3531
|
+
<dd>
|
|
3532
|
+
|
|
3533
|
+
#### 📝 Description
|
|
337
3534
|
|
|
338
|
-
<details><summary><code>client.generations.<a href="/src/api/resources/generations/client/Client.ts">create</a>({ ...params }) -> Sync.Generation</code></summary>
|
|
339
3535
|
<dl>
|
|
340
3536
|
<dd>
|
|
341
3537
|
|
|
3538
|
+
<dl>
|
|
3539
|
+
<dd>
|
|
3540
|
+
|
|
3541
|
+
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.
|
|
3542
|
+
</dd>
|
|
3543
|
+
</dl>
|
|
3544
|
+
</dd>
|
|
3545
|
+
</dl>
|
|
3546
|
+
|
|
342
3547
|
#### 🔌 Usage
|
|
343
3548
|
|
|
344
3549
|
<dl>
|
|
@@ -348,21 +3553,10 @@ await client.batch.list();
|
|
|
348
3553
|
<dd>
|
|
349
3554
|
|
|
350
3555
|
```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
|
-
},
|
|
3556
|
+
await client.tts.createJob({
|
|
3557
|
+
script: "Hey \u2014 thanks for trying sync. labs.",
|
|
3558
|
+
voiceId: "EXAVITQu4vr4xnSDxMaL",
|
|
3559
|
+
provider: "elevenlabs",
|
|
366
3560
|
});
|
|
367
3561
|
```
|
|
368
3562
|
|
|
@@ -379,7 +3573,7 @@ await client.generations.create({
|
|
|
379
3573
|
<dl>
|
|
380
3574
|
<dd>
|
|
381
3575
|
|
|
382
|
-
**request:** `Sync.
|
|
3576
|
+
**request:** `Sync.SubmitTtsJobRequest`
|
|
383
3577
|
|
|
384
3578
|
</dd>
|
|
385
3579
|
</dl>
|
|
@@ -387,7 +3581,7 @@ await client.generations.create({
|
|
|
387
3581
|
<dl>
|
|
388
3582
|
<dd>
|
|
389
3583
|
|
|
390
|
-
**requestOptions:** `
|
|
3584
|
+
**requestOptions:** `Tts.RequestOptions`
|
|
391
3585
|
|
|
392
3586
|
</dd>
|
|
393
3587
|
</dl>
|
|
@@ -398,11 +3592,11 @@ await client.generations.create({
|
|
|
398
3592
|
</dl>
|
|
399
3593
|
</details>
|
|
400
3594
|
|
|
401
|
-
<details><summary><code>client.
|
|
3595
|
+
<details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">getJob</a>(id) -> Sync.TtsJob</code></summary>
|
|
402
3596
|
<dl>
|
|
403
3597
|
<dd>
|
|
404
3598
|
|
|
405
|
-
####
|
|
3599
|
+
#### 📝 Description
|
|
406
3600
|
|
|
407
3601
|
<dl>
|
|
408
3602
|
<dd>
|
|
@@ -410,22 +3604,13 @@ await client.generations.create({
|
|
|
410
3604
|
<dl>
|
|
411
3605
|
<dd>
|
|
412
3606
|
|
|
413
|
-
|
|
414
|
-
await client.generations.createWithFiles(
|
|
415
|
-
fs.createReadStream("/path/to/your/file"),
|
|
416
|
-
fs.createReadStream("/path/to/your/file"),
|
|
417
|
-
{
|
|
418
|
-
model: "lipsync-2",
|
|
419
|
-
},
|
|
420
|
-
);
|
|
421
|
-
```
|
|
422
|
-
|
|
3607
|
+
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).
|
|
423
3608
|
</dd>
|
|
424
3609
|
</dl>
|
|
425
3610
|
</dd>
|
|
426
3611
|
</dl>
|
|
427
3612
|
|
|
428
|
-
####
|
|
3613
|
+
#### 🔌 Usage
|
|
429
3614
|
|
|
430
3615
|
<dl>
|
|
431
3616
|
<dd>
|
|
@@ -433,23 +3618,24 @@ await client.generations.createWithFiles(
|
|
|
433
3618
|
<dl>
|
|
434
3619
|
<dd>
|
|
435
3620
|
|
|
436
|
-
|
|
3621
|
+
```typescript
|
|
3622
|
+
await client.tts.getJob("6533643b-aceb-4c40-967e-d9ba9baac39e");
|
|
3623
|
+
```
|
|
437
3624
|
|
|
3625
|
+
</dd>
|
|
3626
|
+
</dl>
|
|
438
3627
|
</dd>
|
|
439
3628
|
</dl>
|
|
440
3629
|
|
|
3630
|
+
#### ⚙️ Parameters
|
|
3631
|
+
|
|
441
3632
|
<dl>
|
|
442
3633
|
<dd>
|
|
443
3634
|
|
|
444
|
-
**audio:** `File | fs.ReadStream | Blob | undefined`
|
|
445
|
-
|
|
446
|
-
</dd>
|
|
447
|
-
</dl>
|
|
448
|
-
|
|
449
3635
|
<dl>
|
|
450
3636
|
<dd>
|
|
451
3637
|
|
|
452
|
-
**
|
|
3638
|
+
**id:** `string` — The job id returned when the job was submitted.
|
|
453
3639
|
|
|
454
3640
|
</dd>
|
|
455
3641
|
</dl>
|
|
@@ -457,7 +3643,7 @@ await client.generations.createWithFiles(
|
|
|
457
3643
|
<dl>
|
|
458
3644
|
<dd>
|
|
459
3645
|
|
|
460
|
-
**requestOptions:** `
|
|
3646
|
+
**requestOptions:** `Tts.RequestOptions`
|
|
461
3647
|
|
|
462
3648
|
</dd>
|
|
463
3649
|
</dl>
|
|
@@ -468,10 +3654,26 @@ await client.generations.createWithFiles(
|
|
|
468
3654
|
</dl>
|
|
469
3655
|
</details>
|
|
470
3656
|
|
|
471
|
-
|
|
3657
|
+
## Voices
|
|
3658
|
+
|
|
3659
|
+
<details><summary><code>client.voices.<a href="/src/api/resources/voices/client/Client.ts">list</a>({ ...params }) -> Sync.Voice[]</code></summary>
|
|
3660
|
+
<dl>
|
|
3661
|
+
<dd>
|
|
3662
|
+
|
|
3663
|
+
#### 📝 Description
|
|
3664
|
+
|
|
3665
|
+
<dl>
|
|
3666
|
+
<dd>
|
|
3667
|
+
|
|
472
3668
|
<dl>
|
|
473
3669
|
<dd>
|
|
474
3670
|
|
|
3671
|
+
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. During a provider outage, x-sync-voices-stale: true indicates the last complete list, up to 24 hours old. Retry later for current voices.
|
|
3672
|
+
</dd>
|
|
3673
|
+
</dl>
|
|
3674
|
+
</dd>
|
|
3675
|
+
</dl>
|
|
3676
|
+
|
|
475
3677
|
#### 🔌 Usage
|
|
476
3678
|
|
|
477
3679
|
<dl>
|
|
@@ -481,7 +3683,7 @@ await client.generations.createWithFiles(
|
|
|
481
3683
|
<dd>
|
|
482
3684
|
|
|
483
3685
|
```typescript
|
|
484
|
-
await client.
|
|
3686
|
+
await client.voices.list();
|
|
485
3687
|
```
|
|
486
3688
|
|
|
487
3689
|
</dd>
|
|
@@ -497,7 +3699,7 @@ await client.generations.get("6533643b-aceb-4c40-967e-d9ba9baac39e");
|
|
|
497
3699
|
<dl>
|
|
498
3700
|
<dd>
|
|
499
3701
|
|
|
500
|
-
**
|
|
3702
|
+
**request:** `Sync.ListVoicesRequest`
|
|
501
3703
|
|
|
502
3704
|
</dd>
|
|
503
3705
|
</dl>
|
|
@@ -505,7 +3707,7 @@ await client.generations.get("6533643b-aceb-4c40-967e-d9ba9baac39e");
|
|
|
505
3707
|
<dl>
|
|
506
3708
|
<dd>
|
|
507
3709
|
|
|
508
|
-
**requestOptions:** `
|
|
3710
|
+
**requestOptions:** `Voices.RequestOptions`
|
|
509
3711
|
|
|
510
3712
|
</dd>
|
|
511
3713
|
</dl>
|
|
@@ -516,10 +3718,24 @@ await client.generations.get("6533643b-aceb-4c40-967e-d9ba9baac39e");
|
|
|
516
3718
|
</dl>
|
|
517
3719
|
</details>
|
|
518
3720
|
|
|
519
|
-
<details><summary><code>client.
|
|
3721
|
+
<details><summary><code>client.voices.<a href="/src/api/resources/voices/client/Client.ts">get</a>(id, { ...params }) -> Sync.Voice</code></summary>
|
|
3722
|
+
<dl>
|
|
3723
|
+
<dd>
|
|
3724
|
+
|
|
3725
|
+
#### 📝 Description
|
|
3726
|
+
|
|
520
3727
|
<dl>
|
|
521
3728
|
<dd>
|
|
522
3729
|
|
|
3730
|
+
<dl>
|
|
3731
|
+
<dd>
|
|
3732
|
+
|
|
3733
|
+
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. During a provider outage, a saved voice can be returned with x-sync-voices-stale: true. An ID absent from that saved list returns 503 rather than 404; retry after recovery. A pending clone returns 409 voice_clone_pending. Poll this GET until 200 (ready) or 404 (no voice was created); do not submit another clone while it is pending.
|
|
3734
|
+
</dd>
|
|
3735
|
+
</dl>
|
|
3736
|
+
</dd>
|
|
3737
|
+
</dl>
|
|
3738
|
+
|
|
523
3739
|
#### 🔌 Usage
|
|
524
3740
|
|
|
525
3741
|
<dl>
|
|
@@ -529,7 +3745,7 @@ await client.generations.get("6533643b-aceb-4c40-967e-d9ba9baac39e");
|
|
|
529
3745
|
<dd>
|
|
530
3746
|
|
|
531
3747
|
```typescript
|
|
532
|
-
await client.
|
|
3748
|
+
await client.voices.get("EXAVITQu4vr4xnSDxMaL");
|
|
533
3749
|
```
|
|
534
3750
|
|
|
535
3751
|
</dd>
|
|
@@ -545,7 +3761,7 @@ await client.generations.list();
|
|
|
545
3761
|
<dl>
|
|
546
3762
|
<dd>
|
|
547
3763
|
|
|
548
|
-
**
|
|
3764
|
+
**id:** `string` — The voice id — a built-in provider voice id or a cloned voice UUID.
|
|
549
3765
|
|
|
550
3766
|
</dd>
|
|
551
3767
|
</dl>
|
|
@@ -553,7 +3769,15 @@ await client.generations.list();
|
|
|
553
3769
|
<dl>
|
|
554
3770
|
<dd>
|
|
555
3771
|
|
|
556
|
-
**
|
|
3772
|
+
**request:** `Sync.GetVoiceRequest`
|
|
3773
|
+
|
|
3774
|
+
</dd>
|
|
3775
|
+
</dl>
|
|
3776
|
+
|
|
3777
|
+
<dl>
|
|
3778
|
+
<dd>
|
|
3779
|
+
|
|
3780
|
+
**requestOptions:** `Voices.RequestOptions`
|
|
557
3781
|
|
|
558
3782
|
</dd>
|
|
559
3783
|
</dl>
|
|
@@ -564,10 +3788,28 @@ await client.generations.list();
|
|
|
564
3788
|
</dl>
|
|
565
3789
|
</details>
|
|
566
3790
|
|
|
567
|
-
<details><summary><code>client.
|
|
3791
|
+
<details><summary><code>client.voices.<a href="/src/api/resources/voices/client/Client.ts">clone</a>({ ...params }) -> Sync.ClonedVoiceResponse</code></summary>
|
|
3792
|
+
<dl>
|
|
3793
|
+
<dd>
|
|
3794
|
+
|
|
3795
|
+
#### 📝 Description
|
|
3796
|
+
|
|
3797
|
+
<dl>
|
|
3798
|
+
<dd>
|
|
3799
|
+
|
|
568
3800
|
<dl>
|
|
569
3801
|
<dd>
|
|
570
3802
|
|
|
3803
|
+
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. Provide exactly one sample source: url, assetId, or sampleUrls with 1–10 hosted URLs.
|
|
3804
|
+
|
|
3805
|
+
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). Audio samples are limited to 10 MiB (10,485,760 bytes), or 50 MiB (52,428,800 bytes) when you connect your own ElevenLabs API key.
|
|
3806
|
+
|
|
3807
|
+
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). An uncertain clone returns 409 voice_clone_pending with voiceId. Poll GET /v2/voices/{voiceId} until 200 or 404 instead of submitting another clone. 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).
|
|
3808
|
+
</dd>
|
|
3809
|
+
</dl>
|
|
3810
|
+
</dd>
|
|
3811
|
+
</dl>
|
|
3812
|
+
|
|
571
3813
|
#### 🔌 Usage
|
|
572
3814
|
|
|
573
3815
|
<dl>
|
|
@@ -577,21 +3819,10 @@ await client.generations.list();
|
|
|
577
3819
|
<dd>
|
|
578
3820
|
|
|
579
3821
|
```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
|
-
},
|
|
3822
|
+
await client.voices.clone({
|
|
3823
|
+
name: "My Narrator",
|
|
3824
|
+
provider: "elevenlabs",
|
|
3825
|
+
assetId: "550e8400-e29b-41d4-a716-446655440000",
|
|
595
3826
|
});
|
|
596
3827
|
```
|
|
597
3828
|
|
|
@@ -608,7 +3839,7 @@ await client.generations.estimateCost({
|
|
|
608
3839
|
<dl>
|
|
609
3840
|
<dd>
|
|
610
3841
|
|
|
611
|
-
**request:** `Sync.
|
|
3842
|
+
**request:** `Sync.CreateVoiceRequest`
|
|
612
3843
|
|
|
613
3844
|
</dd>
|
|
614
3845
|
</dl>
|
|
@@ -616,7 +3847,7 @@ await client.generations.estimateCost({
|
|
|
616
3847
|
<dl>
|
|
617
3848
|
<dd>
|
|
618
3849
|
|
|
619
|
-
**requestOptions:** `
|
|
3850
|
+
**requestOptions:** `Voices.RequestOptions`
|
|
620
3851
|
|
|
621
3852
|
</dd>
|
|
622
3853
|
</dl>
|
|
@@ -627,9 +3858,7 @@ await client.generations.estimateCost({
|
|
|
627
3858
|
</dl>
|
|
628
3859
|
</details>
|
|
629
3860
|
|
|
630
|
-
|
|
631
|
-
|
|
632
|
-
<details><summary><code>client.models.<a href="/src/api/resources/models/client/Client.ts">list</a>() -> Sync.ModelInfo[]</code></summary>
|
|
3861
|
+
<details><summary><code>client.voices.<a href="/src/api/resources/voices/client/Client.ts">delete</a>(id) -> boolean</code></summary>
|
|
633
3862
|
<dl>
|
|
634
3863
|
<dd>
|
|
635
3864
|
|
|
@@ -641,8 +3870,7 @@ await client.generations.estimateCost({
|
|
|
641
3870
|
<dl>
|
|
642
3871
|
<dd>
|
|
643
3872
|
|
|
644
|
-
|
|
645
|
-
|
|
3873
|
+
Delete a cloned voice, freeing a clone slot. Unknown ids return 404 with errorCode `voice_not_found`. Deletion returns 409 while a clone is still processing. If it returns 503, the voice is retained; retry after the provider recovers.
|
|
646
3874
|
</dd>
|
|
647
3875
|
</dl>
|
|
648
3876
|
</dd>
|
|
@@ -657,7 +3885,7 @@ List all available models for the authenticated user. Returns active (non-deprec
|
|
|
657
3885
|
<dd>
|
|
658
3886
|
|
|
659
3887
|
```typescript
|
|
660
|
-
await client.
|
|
3888
|
+
await client.voices.delete("7f9c2b3a-1d4e-4a8b-9c0d-2e3f4a5b6c7d");
|
|
661
3889
|
```
|
|
662
3890
|
|
|
663
3891
|
</dd>
|
|
@@ -673,7 +3901,15 @@ await client.models.list();
|
|
|
673
3901
|
<dl>
|
|
674
3902
|
<dd>
|
|
675
3903
|
|
|
676
|
-
**
|
|
3904
|
+
**id:** `string` — The Sync UUID returned as id when the voice was cloned.
|
|
3905
|
+
|
|
3906
|
+
</dd>
|
|
3907
|
+
</dl>
|
|
3908
|
+
|
|
3909
|
+
<dl>
|
|
3910
|
+
<dd>
|
|
3911
|
+
|
|
3912
|
+
**requestOptions:** `Voices.RequestOptions`
|
|
677
3913
|
|
|
678
3914
|
</dd>
|
|
679
3915
|
</dl>
|