@sync.so/sdk 0.4.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 +3 -0
- package/Client.js +27 -22
- package/api/resources/account/client/Client.d.ts +19 -1
- package/api/resources/account/client/Client.js +79 -5
- package/api/resources/account/client/index.d.ts +1 -1
- package/api/resources/account/client/index.js +15 -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/types/AccountActiveJobs.d.ts +1 -1
- package/api/resources/account/types/AccountCredits.d.ts +1 -1
- package/api/resources/account/types/AccountFreeAllowance.d.ts +2 -2
- 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 +5 -1
- package/api/resources/account/types/index.d.ts +2 -0
- package/api/resources/account/types/index.js +2 -0
- package/api/resources/assets/client/Client.d.ts +71 -1
- package/api/resources/assets/client/Client.js +312 -8
- 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 +6 -2
- package/api/resources/batch/client/Client.js +18 -6
- package/api/resources/batch/client/requests/CreateBatchFromRowsRequest.d.ts +3 -3
- package/api/resources/batch/client/requests/CreateBatchRequest.d.ts +2 -2
- package/api/resources/common/errors/AudioTrimTooManyRequestsError.d.ts +9 -0
- package/api/resources/common/errors/AudioTrimTooManyRequestsError.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/SpeakerAnalysisTooManyRequestsError.d.ts +9 -0
- package/api/resources/common/errors/SpeakerAnalysisTooManyRequestsError.js +52 -0
- package/api/resources/common/errors/index.d.ts +4 -0
- package/api/resources/common/errors/index.js +4 -0
- package/api/resources/common/types/ActiveSpeaker.d.ts +3 -3
- package/api/resources/common/types/AnalyzeSpeakersRequest.d.ts +14 -0
- package/api/resources/common/types/AnalyzeSpeakersRequest.js +5 -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/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 +2 -4
- package/api/resources/common/types/BatchGetAssetsRequest.d.ts +8 -0
- package/api/resources/common/types/BatchGetAssetsRequest.js +5 -0
- package/api/resources/common/types/CreateAssetRequest.d.ts +3 -1
- package/api/resources/common/types/CreateAssetUploadRequest.d.ts +1 -1
- 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 +2 -2
- package/api/resources/common/types/CreateGenerationDto.d.ts +3 -3
- package/api/resources/common/types/CreateProjectRequest.d.ts +1 -1
- package/api/resources/common/types/CreateTranscriptionDto.d.ts +2 -2
- package/api/resources/common/types/DialogueEditChange.d.ts +1 -1
- package/api/resources/common/types/DialogueEditError.d.ts +5 -1
- package/api/resources/common/types/DialogueEditErrorCode.d.ts +4 -2
- package/api/resources/common/types/DialogueEditErrorCode.js +2 -0
- package/api/resources/common/types/DialogueEditFailedSlot.d.ts +3 -0
- package/api/resources/common/types/DialogueEditJob.d.ts +2 -2
- package/api/resources/common/types/DubDto.d.ts +6 -0
- package/api/resources/common/types/DubLanguage.d.ts +23 -3
- package/api/resources/common/types/DubLanguage.js +17 -0
- package/api/resources/common/types/DubSourceLanguage.d.ts +24 -4
- package/api/resources/common/types/DubSourceLanguage.js +17 -0
- package/api/resources/common/types/EstimateCostRequest.d.ts +1 -1
- 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 +9 -5
- 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 +4 -0
- package/api/resources/common/types/GenerationOptions.d.ts +3 -3
- 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/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 +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/ProjectGenerationError.d.ts +3 -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/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/Transcript.d.ts +2 -0
- package/api/resources/common/types/TranscriptSegment.d.ts +2 -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 +4 -0
- package/api/resources/common/types/TranscriptionJob.d.ts +5 -1
- package/api/resources/common/types/TranscriptionJobEstimate.d.ts +20 -0
- package/api/resources/common/types/TranscriptionJobEstimate.js +5 -0
- package/api/resources/common/types/Tts.d.ts +1 -1
- package/api/resources/common/types/UpdateProjectRequest.d.ts +1 -1
- package/api/resources/common/types/Video.d.ts +3 -3
- package/api/resources/common/types/index.d.ts +32 -0
- package/api/resources/common/types/index.js +32 -0
- package/api/resources/dialogueEdits/client/Client.d.ts +35 -31
- package/api/resources/dialogueEdits/client/Client.js +40 -33
- package/api/resources/dialogueEdits/client/index.d.ts +1 -1
- package/api/resources/dialogueEdits/client/index.js +15 -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/errors/client/Client.d.ts +1 -1
- package/api/resources/errors/client/Client.js +2 -2
- package/api/resources/feedback/client/Client.js +1 -1
- 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 +58 -13
- package/api/resources/generations/client/Client.js +245 -21
- 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/CreateGenerationRequest.d.ts +1 -1
- package/api/resources/generations/client/requests/GetGenerationRequest.d.ts +2 -2
- 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/index.d.ts +2 -0
- package/api/resources/index.d.ts +6 -0
- package/api/resources/index.js +7 -1
- package/api/resources/models/client/Client.js +1 -1
- package/api/resources/organizations/client/Client.js +1 -1
- package/api/resources/projects/client/Client.js +7 -7
- package/api/resources/projects/client/requests/ListProjectsRequest.d.ts +1 -1
- package/api/resources/transcriptions/client/Client.d.ts +66 -1
- package/api/resources/transcriptions/client/Client.js +236 -3
- package/api/resources/tts/client/Client.js +3 -3
- package/api/resources/voices/client/Client.d.ts +10 -6
- package/api/resources/voices/client/Client.js +22 -10
- package/api/resources/webhooks/types/GenerationNotification.d.ts +6 -2
- package/api/resources/webhooks/types/WebhookStatus.d.ts +2 -1
- package/api/resources/webhooks/types/WebhookStatus.js +1 -0
- package/dist/Client.d.ts +3 -0
- package/dist/Client.js +27 -22
- package/dist/api/resources/account/client/Client.d.ts +19 -1
- package/dist/api/resources/account/client/Client.js +79 -5
- package/dist/api/resources/account/client/index.d.ts +1 -1
- package/dist/api/resources/account/client/index.js +15 -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/types/AccountActiveJobs.d.ts +1 -1
- package/dist/api/resources/account/types/AccountCredits.d.ts +1 -1
- package/dist/api/resources/account/types/AccountFreeAllowance.d.ts +2 -2
- 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 +5 -1
- package/dist/api/resources/account/types/index.d.ts +2 -0
- package/dist/api/resources/account/types/index.js +2 -0
- package/dist/api/resources/assets/client/Client.d.ts +71 -1
- package/dist/api/resources/assets/client/Client.js +312 -8
- 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 +6 -2
- package/dist/api/resources/batch/client/Client.js +18 -6
- package/dist/api/resources/batch/client/requests/CreateBatchFromRowsRequest.d.ts +3 -3
- package/dist/api/resources/batch/client/requests/CreateBatchRequest.d.ts +2 -2
- 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/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/SpeakerAnalysisTooManyRequestsError.d.ts +9 -0
- package/dist/api/resources/common/errors/SpeakerAnalysisTooManyRequestsError.js +52 -0
- package/dist/api/resources/common/errors/index.d.ts +4 -0
- package/dist/api/resources/common/errors/index.js +4 -0
- package/dist/api/resources/common/types/ActiveSpeaker.d.ts +3 -3
- 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/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/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 +2 -4
- 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/CreateAssetRequest.d.ts +3 -1
- package/dist/api/resources/common/types/CreateAssetUploadRequest.d.ts +1 -1
- 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 +2 -2
- package/dist/api/resources/common/types/CreateGenerationDto.d.ts +3 -3
- package/dist/api/resources/common/types/CreateProjectRequest.d.ts +1 -1
- package/dist/api/resources/common/types/CreateTranscriptionDto.d.ts +2 -2
- package/dist/api/resources/common/types/DialogueEditChange.d.ts +1 -1
- package/dist/api/resources/common/types/DialogueEditError.d.ts +5 -1
- package/dist/api/resources/common/types/DialogueEditErrorCode.d.ts +4 -2
- package/dist/api/resources/common/types/DialogueEditErrorCode.js +2 -0
- package/dist/api/resources/common/types/DialogueEditFailedSlot.d.ts +3 -0
- package/dist/api/resources/common/types/DialogueEditJob.d.ts +2 -2
- package/dist/api/resources/common/types/DubDto.d.ts +6 -0
- package/dist/api/resources/common/types/DubLanguage.d.ts +23 -3
- package/dist/api/resources/common/types/DubLanguage.js +17 -0
- package/dist/api/resources/common/types/DubSourceLanguage.d.ts +24 -4
- package/dist/api/resources/common/types/DubSourceLanguage.js +17 -0
- package/dist/api/resources/common/types/EstimateCostRequest.d.ts +1 -1
- 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 +9 -5
- 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 +4 -0
- package/dist/api/resources/common/types/GenerationOptions.d.ts +3 -3
- 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/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 +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/ProjectGenerationError.d.ts +3 -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/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/Transcript.d.ts +2 -0
- package/dist/api/resources/common/types/TranscriptSegment.d.ts +2 -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 +4 -0
- package/dist/api/resources/common/types/TranscriptionJob.d.ts +5 -1
- 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/Tts.d.ts +1 -1
- package/dist/api/resources/common/types/UpdateProjectRequest.d.ts +1 -1
- package/dist/api/resources/common/types/Video.d.ts +3 -3
- package/dist/api/resources/common/types/index.d.ts +32 -0
- package/dist/api/resources/common/types/index.js +32 -0
- package/dist/api/resources/dialogueEdits/client/Client.d.ts +35 -31
- package/dist/api/resources/dialogueEdits/client/Client.js +40 -33
- package/dist/api/resources/dialogueEdits/client/index.d.ts +1 -1
- package/dist/api/resources/dialogueEdits/client/index.js +15 -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/errors/client/Client.d.ts +1 -1
- package/dist/api/resources/errors/client/Client.js +2 -2
- package/dist/api/resources/feedback/client/Client.js +1 -1
- 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 +58 -13
- package/dist/api/resources/generations/client/Client.js +245 -21
- 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/CreateGenerationRequest.d.ts +1 -1
- package/dist/api/resources/generations/client/requests/GetGenerationRequest.d.ts +2 -2
- 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/index.d.ts +2 -0
- package/dist/api/resources/index.d.ts +6 -0
- package/dist/api/resources/index.js +7 -1
- package/dist/api/resources/models/client/Client.js +1 -1
- package/dist/api/resources/organizations/client/Client.js +1 -1
- package/dist/api/resources/projects/client/Client.js +7 -7
- package/dist/api/resources/projects/client/requests/ListProjectsRequest.d.ts +1 -1
- package/dist/api/resources/transcriptions/client/Client.d.ts +66 -1
- package/dist/api/resources/transcriptions/client/Client.js +236 -3
- package/dist/api/resources/tts/client/Client.js +3 -3
- package/dist/api/resources/voices/client/Client.d.ts +10 -6
- package/dist/api/resources/voices/client/Client.js +22 -10
- package/dist/api/resources/webhooks/types/GenerationNotification.d.ts +6 -2
- package/dist/api/resources/webhooks/types/WebhookStatus.d.ts +2 -1
- package/dist/api/resources/webhooks/types/WebhookStatus.js +1 -0
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
- package/reference.md +995 -124
- package/version.d.ts +1 -1
- package/version.js +1 -1
package/reference.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
## Account
|
|
4
4
|
|
|
5
|
-
<details><summary><code>client.account.<a href="/src/api/resources/account/client/Client.ts">get</a>() -> Sync.AccountOverview</code></summary>
|
|
5
|
+
<details><summary><code>client.account.<a href="/src/api/resources/account/client/Client.ts">get</a>({ ...params }) -> Sync.AccountOverview</code></summary>
|
|
6
6
|
<dl>
|
|
7
7
|
<dd>
|
|
8
8
|
|
|
@@ -45,6 +45,76 @@ await client.account.get();
|
|
|
45
45
|
<dl>
|
|
46
46
|
<dd>
|
|
47
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
|
+
|
|
48
118
|
**requestOptions:** `Account.RequestOptions`
|
|
49
119
|
|
|
50
120
|
</dd>
|
|
@@ -123,6 +193,259 @@ await client.assets.list({
|
|
|
123
193
|
</dl>
|
|
124
194
|
</details>
|
|
125
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
|
+
|
|
126
449
|
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">get</a>(id) -> Sync.Asset</code></summary>
|
|
127
450
|
<dl>
|
|
128
451
|
<dd>
|
|
@@ -135,7 +458,139 @@ await client.assets.list({
|
|
|
135
458
|
<dl>
|
|
136
459
|
<dd>
|
|
137
460
|
|
|
138
|
-
Retrieve a specific asset by ID.
|
|
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).
|
|
139
594
|
</dd>
|
|
140
595
|
</dl>
|
|
141
596
|
</dd>
|
|
@@ -150,7 +605,11 @@ Retrieve a specific asset by ID.
|
|
|
150
605
|
<dd>
|
|
151
606
|
|
|
152
607
|
```typescript
|
|
153
|
-
await client.assets.
|
|
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
|
+
});
|
|
154
613
|
```
|
|
155
614
|
|
|
156
615
|
</dd>
|
|
@@ -166,7 +625,7 @@ await client.assets.get("550e8400-e29b-41d4-a716-446655440000");
|
|
|
166
625
|
<dl>
|
|
167
626
|
<dd>
|
|
168
627
|
|
|
169
|
-
**
|
|
628
|
+
**request:** `Sync.CreateAssetRequest`
|
|
170
629
|
|
|
171
630
|
</dd>
|
|
172
631
|
</dl>
|
|
@@ -185,7 +644,7 @@ await client.assets.get("550e8400-e29b-41d4-a716-446655440000");
|
|
|
185
644
|
</dl>
|
|
186
645
|
</details>
|
|
187
646
|
|
|
188
|
-
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">
|
|
647
|
+
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">update</a>(id, { ...params }) -> Sync.Asset</code></summary>
|
|
189
648
|
<dl>
|
|
190
649
|
<dd>
|
|
191
650
|
|
|
@@ -197,7 +656,7 @@ await client.assets.get("550e8400-e29b-41d4-a716-446655440000");
|
|
|
197
656
|
<dl>
|
|
198
657
|
<dd>
|
|
199
658
|
|
|
200
|
-
|
|
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.
|
|
201
660
|
</dd>
|
|
202
661
|
</dl>
|
|
203
662
|
</dd>
|
|
@@ -212,10 +671,8 @@ Request a presigned URL to upload a local file. PUT the file bytes to the return
|
|
|
212
671
|
<dd>
|
|
213
672
|
|
|
214
673
|
```typescript
|
|
215
|
-
await client.assets.
|
|
216
|
-
|
|
217
|
-
contentType: "video/mp4",
|
|
218
|
-
size: 10485760,
|
|
674
|
+
await client.assets.update("550e8400-e29b-41d4-a716-446655440000", {
|
|
675
|
+
name: "Renamed asset",
|
|
219
676
|
});
|
|
220
677
|
```
|
|
221
678
|
|
|
@@ -232,7 +689,15 @@ await client.assets.createUpload({
|
|
|
232
689
|
<dl>
|
|
233
690
|
<dd>
|
|
234
691
|
|
|
235
|
-
**
|
|
692
|
+
**id:** `Sync.AssetId`
|
|
693
|
+
|
|
694
|
+
</dd>
|
|
695
|
+
</dl>
|
|
696
|
+
|
|
697
|
+
<dl>
|
|
698
|
+
<dd>
|
|
699
|
+
|
|
700
|
+
**request:** `Sync.UpdateAssetRequest`
|
|
236
701
|
|
|
237
702
|
</dd>
|
|
238
703
|
</dl>
|
|
@@ -251,7 +716,7 @@ await client.assets.createUpload({
|
|
|
251
716
|
</dl>
|
|
252
717
|
</details>
|
|
253
718
|
|
|
254
|
-
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">
|
|
719
|
+
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">delete</a>(id) -> Sync.DeleteAssetResponse</code></summary>
|
|
255
720
|
<dl>
|
|
256
721
|
<dd>
|
|
257
722
|
|
|
@@ -263,9 +728,7 @@ await client.assets.createUpload({
|
|
|
263
728
|
<dl>
|
|
264
729
|
<dd>
|
|
265
730
|
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
projectId is optional. When provided it must reference a project in your organization — a stale or foreign id is rejected with a 422 and errorCode project_not_found; omit the field if you don't need the asset attached to a project.
|
|
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.
|
|
269
732
|
</dd>
|
|
270
733
|
</dl>
|
|
271
734
|
</dd>
|
|
@@ -280,11 +743,7 @@ projectId is optional. When provided it must reference a project in your organiz
|
|
|
280
743
|
<dd>
|
|
281
744
|
|
|
282
745
|
```typescript
|
|
283
|
-
await client.assets.
|
|
284
|
-
url: "https://assets.sync.so/org-123/my-video.mp4",
|
|
285
|
-
type: "VIDEO",
|
|
286
|
-
name: "my-video.mp4",
|
|
287
|
-
});
|
|
746
|
+
await client.assets.delete("550e8400-e29b-41d4-a716-446655440000");
|
|
288
747
|
```
|
|
289
748
|
|
|
290
749
|
</dd>
|
|
@@ -300,7 +759,7 @@ await client.assets.create({
|
|
|
300
759
|
<dl>
|
|
301
760
|
<dd>
|
|
302
761
|
|
|
303
|
-
**
|
|
762
|
+
**id:** `Sync.AssetId`
|
|
304
763
|
|
|
305
764
|
</dd>
|
|
306
765
|
</dl>
|
|
@@ -319,7 +778,9 @@ await client.assets.create({
|
|
|
319
778
|
</dl>
|
|
320
779
|
</details>
|
|
321
780
|
|
|
322
|
-
|
|
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>
|
|
323
784
|
<dl>
|
|
324
785
|
<dd>
|
|
325
786
|
|
|
@@ -331,7 +792,8 @@ await client.assets.create({
|
|
|
331
792
|
<dl>
|
|
332
793
|
<dd>
|
|
333
794
|
|
|
334
|
-
|
|
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.
|
|
335
797
|
</dd>
|
|
336
798
|
</dl>
|
|
337
799
|
</dd>
|
|
@@ -346,8 +808,12 @@ Update an asset's name or visibility. With API-key auth the asset must be owned
|
|
|
346
808
|
<dd>
|
|
347
809
|
|
|
348
810
|
```typescript
|
|
349
|
-
await client.
|
|
350
|
-
|
|
811
|
+
await client.audioTrims.create({
|
|
812
|
+
"Idempotency-Key": "trim-intro-20s",
|
|
813
|
+
body: {
|
|
814
|
+
assetId: "3f2b8c1e-5d4a-4e9b-8c7d-1a2b3c4d5e6f",
|
|
815
|
+
durationSeconds: 20,
|
|
816
|
+
},
|
|
351
817
|
});
|
|
352
818
|
```
|
|
353
819
|
|
|
@@ -364,15 +830,7 @@ await client.assets.update("550e8400-e29b-41d4-a716-446655440000", {
|
|
|
364
830
|
<dl>
|
|
365
831
|
<dd>
|
|
366
832
|
|
|
367
|
-
**
|
|
368
|
-
|
|
369
|
-
</dd>
|
|
370
|
-
</dl>
|
|
371
|
-
|
|
372
|
-
<dl>
|
|
373
|
-
<dd>
|
|
374
|
-
|
|
375
|
-
**request:** `Sync.UpdateAssetRequest`
|
|
833
|
+
**request:** `Sync.CreateAudioTrimRequest`
|
|
376
834
|
|
|
377
835
|
</dd>
|
|
378
836
|
</dl>
|
|
@@ -380,7 +838,7 @@ await client.assets.update("550e8400-e29b-41d4-a716-446655440000", {
|
|
|
380
838
|
<dl>
|
|
381
839
|
<dd>
|
|
382
840
|
|
|
383
|
-
**requestOptions:** `
|
|
841
|
+
**requestOptions:** `AudioTrims.RequestOptions`
|
|
384
842
|
|
|
385
843
|
</dd>
|
|
386
844
|
</dl>
|
|
@@ -391,7 +849,7 @@ await client.assets.update("550e8400-e29b-41d4-a716-446655440000", {
|
|
|
391
849
|
</dl>
|
|
392
850
|
</details>
|
|
393
851
|
|
|
394
|
-
<details><summary><code>client.
|
|
852
|
+
<details><summary><code>client.audioTrims.<a href="/src/api/resources/audioTrims/client/Client.ts">get</a>(id) -> Sync.AudioTrim</code></summary>
|
|
395
853
|
<dl>
|
|
396
854
|
<dd>
|
|
397
855
|
|
|
@@ -403,7 +861,7 @@ await client.assets.update("550e8400-e29b-41d4-a716-446655440000", {
|
|
|
403
861
|
<dl>
|
|
404
862
|
<dd>
|
|
405
863
|
|
|
406
|
-
|
|
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.
|
|
407
865
|
</dd>
|
|
408
866
|
</dl>
|
|
409
867
|
</dd>
|
|
@@ -418,7 +876,7 @@ Delete an asset. With API-key auth the asset must be owned by the key owner; org
|
|
|
418
876
|
<dd>
|
|
419
877
|
|
|
420
878
|
```typescript
|
|
421
|
-
await client.
|
|
879
|
+
await client.audioTrims.get("6533643b-aceb-4c40-967e-d9ba9baac39e");
|
|
422
880
|
```
|
|
423
881
|
|
|
424
882
|
</dd>
|
|
@@ -434,7 +892,7 @@ await client.assets.delete("550e8400-e29b-41d4-a716-446655440000");
|
|
|
434
892
|
<dl>
|
|
435
893
|
<dd>
|
|
436
894
|
|
|
437
|
-
**id:** `
|
|
895
|
+
**id:** `string` — The trim id returned by POST /v2/audio-trims.
|
|
438
896
|
|
|
439
897
|
</dd>
|
|
440
898
|
</dl>
|
|
@@ -442,7 +900,7 @@ await client.assets.delete("550e8400-e29b-41d4-a716-446655440000");
|
|
|
442
900
|
<dl>
|
|
443
901
|
<dd>
|
|
444
902
|
|
|
445
|
-
**requestOptions:** `
|
|
903
|
+
**requestOptions:** `AudioTrims.RequestOptions`
|
|
446
904
|
|
|
447
905
|
</dd>
|
|
448
906
|
</dl>
|
|
@@ -467,7 +925,7 @@ await client.assets.delete("550e8400-e29b-41d4-a716-446655440000");
|
|
|
467
925
|
<dl>
|
|
468
926
|
<dd>
|
|
469
927
|
|
|
470
|
-
Create a batch processing job from a JSONL file. Requires
|
|
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`.
|
|
471
929
|
</dd>
|
|
472
930
|
</dl>
|
|
473
931
|
</dd>
|
|
@@ -540,7 +998,7 @@ await client.batch.create(fs.createReadStream("/path/to/your/file"), {
|
|
|
540
998
|
<dl>
|
|
541
999
|
<dd>
|
|
542
1000
|
|
|
543
|
-
The `application/json` form of `POST /v2/batch`, the same endpoint as "Create Batch": send the records in a `rows` array instead of a JSONL file. Each row is the same object as one JSONL line and is validated the same way: 20-500 rows by default
|
|
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).
|
|
544
1002
|
</dd>
|
|
545
1003
|
</dl>
|
|
546
1004
|
</dd>
|
|
@@ -1052,7 +1510,8 @@ await client.batch.list();
|
|
|
1052
1510
|
<dl>
|
|
1053
1511
|
<dd>
|
|
1054
1512
|
|
|
1055
|
-
Applies word-level edits to a transcript from `POST /v2/transcriptions` and synthesizes preview audio for the same window: only the edited spans are re-spoken in a voice cloned from the source, everything else stays the original recording. Poll `GET /v2/dialogue-edits/{id}` until `status` is `COMPLETED`, `COMPLETED_PARTIAL` or `FAILED`; a completed or partially completed job carries `previewAudioUrl`, the retimed `resultTranscript` and the edited regions as `resultSlots`. Edits that cannot be applied
|
|
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.
|
|
1056
1515
|
</dd>
|
|
1057
1516
|
</dl>
|
|
1058
1517
|
</dd>
|
|
@@ -1068,42 +1527,44 @@ Applies word-level edits to a transcript from `POST /v2/transcriptions` and synt
|
|
|
1068
1527
|
|
|
1069
1528
|
```typescript
|
|
1070
1529
|
await client.dialogueEdits.create({
|
|
1071
|
-
|
|
1072
|
-
|
|
1073
|
-
|
|
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: [
|
|
1074
1561
|
{
|
|
1075
|
-
|
|
1076
|
-
|
|
1077
|
-
|
|
1078
|
-
id: "w_1",
|
|
1079
|
-
text: "The",
|
|
1080
|
-
startMs: 120,
|
|
1081
|
-
endMs: 260,
|
|
1082
|
-
},
|
|
1083
|
-
{
|
|
1084
|
-
id: "w_2",
|
|
1085
|
-
text: "quarterly",
|
|
1086
|
-
startMs: 260,
|
|
1087
|
-
endMs: 820,
|
|
1088
|
-
},
|
|
1089
|
-
{
|
|
1090
|
-
id: "w_3",
|
|
1091
|
-
text: "results",
|
|
1092
|
-
startMs: 820,
|
|
1093
|
-
endMs: 1240,
|
|
1094
|
-
},
|
|
1095
|
-
],
|
|
1562
|
+
kind: "change",
|
|
1563
|
+
wordId: "w_2",
|
|
1564
|
+
replacement: "annual",
|
|
1096
1565
|
},
|
|
1097
1566
|
],
|
|
1098
|
-
speakerCount: 1,
|
|
1099
1567
|
},
|
|
1100
|
-
edits: [
|
|
1101
|
-
{
|
|
1102
|
-
kind: "change",
|
|
1103
|
-
wordId: "w_2",
|
|
1104
|
-
replacement: "annual",
|
|
1105
|
-
},
|
|
1106
|
-
],
|
|
1107
1568
|
});
|
|
1108
1569
|
```
|
|
1109
1570
|
|
|
@@ -1120,7 +1581,197 @@ await client.dialogueEdits.create({
|
|
|
1120
1581
|
<dl>
|
|
1121
1582
|
<dd>
|
|
1122
1583
|
|
|
1123
|
-
**request:** `Sync.
|
|
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`
|
|
1124
1775
|
|
|
1125
1776
|
</dd>
|
|
1126
1777
|
</dl>
|
|
@@ -1128,7 +1779,7 @@ await client.dialogueEdits.create({
|
|
|
1128
1779
|
<dl>
|
|
1129
1780
|
<dd>
|
|
1130
1781
|
|
|
1131
|
-
**requestOptions:** `
|
|
1782
|
+
**requestOptions:** `Feedback.RequestOptions`
|
|
1132
1783
|
|
|
1133
1784
|
</dd>
|
|
1134
1785
|
</dl>
|
|
@@ -1139,7 +1790,9 @@ await client.dialogueEdits.create({
|
|
|
1139
1790
|
</dl>
|
|
1140
1791
|
</details>
|
|
1141
1792
|
|
|
1142
|
-
|
|
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>
|
|
1143
1796
|
<dl>
|
|
1144
1797
|
<dd>
|
|
1145
1798
|
|
|
@@ -1151,7 +1804,7 @@ await client.dialogueEdits.create({
|
|
|
1151
1804
|
<dl>
|
|
1152
1805
|
<dd>
|
|
1153
1806
|
|
|
1154
|
-
|
|
1807
|
+
Count generations visible to your credentials. All provided filters are combined.
|
|
1155
1808
|
</dd>
|
|
1156
1809
|
</dl>
|
|
1157
1810
|
</dd>
|
|
@@ -1166,7 +1819,7 @@ Returns the job status and, once it completed, the preview audio url, the retime
|
|
|
1166
1819
|
<dd>
|
|
1167
1820
|
|
|
1168
1821
|
```typescript
|
|
1169
|
-
await client.
|
|
1822
|
+
await client.generations.count();
|
|
1170
1823
|
```
|
|
1171
1824
|
|
|
1172
1825
|
</dd>
|
|
@@ -1182,7 +1835,7 @@ await client.dialogueEdits.get("7644754c-bdfc-4d51-a78f-e0cb0cbbd40f");
|
|
|
1182
1835
|
<dl>
|
|
1183
1836
|
<dd>
|
|
1184
1837
|
|
|
1185
|
-
**
|
|
1838
|
+
**request:** `Sync.CountGenerationsRequest`
|
|
1186
1839
|
|
|
1187
1840
|
</dd>
|
|
1188
1841
|
</dl>
|
|
@@ -1190,7 +1843,7 @@ await client.dialogueEdits.get("7644754c-bdfc-4d51-a78f-e0cb0cbbd40f");
|
|
|
1190
1843
|
<dl>
|
|
1191
1844
|
<dd>
|
|
1192
1845
|
|
|
1193
|
-
**requestOptions:** `
|
|
1846
|
+
**requestOptions:** `Generations.RequestOptions`
|
|
1194
1847
|
|
|
1195
1848
|
</dd>
|
|
1196
1849
|
</dl>
|
|
@@ -1201,9 +1854,7 @@ await client.dialogueEdits.get("7644754c-bdfc-4d51-a78f-e0cb0cbbd40f");
|
|
|
1201
1854
|
</dl>
|
|
1202
1855
|
</details>
|
|
1203
1856
|
|
|
1204
|
-
|
|
1205
|
-
|
|
1206
|
-
<details><summary><code>client.errors.<a href="/src/api/resources/errors/client/Client.ts">list</a>() -> Sync.ErrorCatalogEntry[]</code></summary>
|
|
1857
|
+
<details><summary><code>client.generations.<a href="/src/api/resources/generations/client/Client.ts">getCosts</a>(id) -> Sync.GenerationCosts</code></summary>
|
|
1207
1858
|
<dl>
|
|
1208
1859
|
<dd>
|
|
1209
1860
|
|
|
@@ -1215,7 +1866,7 @@ await client.dialogueEdits.get("7644754c-bdfc-4d51-a78f-e0cb0cbbd40f");
|
|
|
1215
1866
|
<dl>
|
|
1216
1867
|
<dd>
|
|
1217
1868
|
|
|
1218
|
-
|
|
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.
|
|
1219
1870
|
</dd>
|
|
1220
1871
|
</dl>
|
|
1221
1872
|
</dd>
|
|
@@ -1230,7 +1881,7 @@ Returns the full catalog of machine-readable error codes — each with a human-r
|
|
|
1230
1881
|
<dd>
|
|
1231
1882
|
|
|
1232
1883
|
```typescript
|
|
1233
|
-
await client.
|
|
1884
|
+
await client.generations.getCosts("id");
|
|
1234
1885
|
```
|
|
1235
1886
|
|
|
1236
1887
|
</dd>
|
|
@@ -1246,7 +1897,15 @@ await client.errors.list();
|
|
|
1246
1897
|
<dl>
|
|
1247
1898
|
<dd>
|
|
1248
1899
|
|
|
1249
|
-
**
|
|
1900
|
+
**id:** `Sync.GenerationId`
|
|
1901
|
+
|
|
1902
|
+
</dd>
|
|
1903
|
+
</dl>
|
|
1904
|
+
|
|
1905
|
+
<dl>
|
|
1906
|
+
<dd>
|
|
1907
|
+
|
|
1908
|
+
**requestOptions:** `Generations.RequestOptions`
|
|
1250
1909
|
|
|
1251
1910
|
</dd>
|
|
1252
1911
|
</dl>
|
|
@@ -1257,9 +1916,7 @@ await client.errors.list();
|
|
|
1257
1916
|
</dl>
|
|
1258
1917
|
</details>
|
|
1259
1918
|
|
|
1260
|
-
|
|
1261
|
-
|
|
1262
|
-
<details><summary><code>client.feedback.<a href="/src/api/resources/feedback/client/Client.ts">submit</a>({ ...params }) -> Sync.FeedbackReceipt</code></summary>
|
|
1919
|
+
<details><summary><code>client.generations.<a href="/src/api/resources/generations/client/Client.ts">listCosts</a>({ ...params }) -> Sync.GenerationCostsList</code></summary>
|
|
1263
1920
|
<dl>
|
|
1264
1921
|
<dd>
|
|
1265
1922
|
|
|
@@ -1271,7 +1928,7 @@ await client.errors.list();
|
|
|
1271
1928
|
<dl>
|
|
1272
1929
|
<dd>
|
|
1273
1930
|
|
|
1274
|
-
|
|
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).
|
|
1275
1932
|
</dd>
|
|
1276
1933
|
</dl>
|
|
1277
1934
|
</dd>
|
|
@@ -1286,14 +1943,10 @@ Report a problem you hit with the API or the sync. MCP server, such as an error
|
|
|
1286
1943
|
<dd>
|
|
1287
1944
|
|
|
1288
1945
|
```typescript
|
|
1289
|
-
await client.
|
|
1290
|
-
|
|
1291
|
-
|
|
1292
|
-
|
|
1293
|
-
"POST /v2/generate returned generation_input_video_inaccessible for a presigned URL that plays in a browser. Saying whether the URL had expired or was blocked would have helped.",
|
|
1294
|
-
tool: "generations.create",
|
|
1295
|
-
errorCode: "generation_input_video_inaccessible",
|
|
1296
|
-
generationId: "6533643b-acbb-4c4f-a5b3-5ba2e5ab6b5f",
|
|
1946
|
+
await client.generations.listCosts({
|
|
1947
|
+
startTime: "2026-11-12T00:00:00Z",
|
|
1948
|
+
endTime: "2026-11-13T00:00:00Z",
|
|
1949
|
+
limit: 500,
|
|
1297
1950
|
});
|
|
1298
1951
|
```
|
|
1299
1952
|
|
|
@@ -1310,7 +1963,7 @@ await client.feedback.submit({
|
|
|
1310
1963
|
<dl>
|
|
1311
1964
|
<dd>
|
|
1312
1965
|
|
|
1313
|
-
**request:** `Sync.
|
|
1966
|
+
**request:** `Sync.ListGenerationCostsRequest`
|
|
1314
1967
|
|
|
1315
1968
|
</dd>
|
|
1316
1969
|
</dl>
|
|
@@ -1318,7 +1971,7 @@ await client.feedback.submit({
|
|
|
1318
1971
|
<dl>
|
|
1319
1972
|
<dd>
|
|
1320
1973
|
|
|
1321
|
-
**requestOptions:** `
|
|
1974
|
+
**requestOptions:** `Generations.RequestOptions`
|
|
1322
1975
|
|
|
1323
1976
|
</dd>
|
|
1324
1977
|
</dl>
|
|
@@ -1329,8 +1982,6 @@ await client.feedback.submit({
|
|
|
1329
1982
|
</dl>
|
|
1330
1983
|
</details>
|
|
1331
1984
|
|
|
1332
|
-
## Generations
|
|
1333
|
-
|
|
1334
1985
|
<details><summary><code>client.generations.<a href="/src/api/resources/generations/client/Client.ts">create</a>({ ...params }) -> Sync.Generation</code></summary>
|
|
1335
1986
|
<dl>
|
|
1336
1987
|
<dd>
|
|
@@ -1343,7 +1994,7 @@ await client.feedback.submit({
|
|
|
1343
1994
|
<dl>
|
|
1344
1995
|
<dd>
|
|
1345
1996
|
|
|
1346
|
-
Create a lip sync generation with `application/json` — provide each input by `url` or by `assetId` from an uploaded asset. For reusable or large local files, upload them first with POST /v2/assets/upload and pass the returned `assetId`; see [Asset Uploads](/developer-guides/asset-uploads). Use the multipart "Create Generation with Files" form only when uploading direct audio, video, or image file fields; it has a 5 GiB per-file application parser limit, subject to your plan and any lower proxy limits. Nested fields such as input, options, segments, outputAudio, dubParams, and dialogueEdit must be JSON strings in multipart requests. If a `text` input requires speech synthesis and the ElevenLabs provider is temporarily unavailable, the request returns errorCode elevenlabs_service_unavailable: 504 for provider timeouts and 503 for other provider outages for unkeyed requests. Keyed uncertain outcomes return 503 IDEMPOTENCY_OUTCOME_UNKNOWN instead. An
|
|
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.
|
|
1347
1998
|
</dd>
|
|
1348
1999
|
</dl>
|
|
1349
2000
|
</dd>
|
|
@@ -1417,7 +2068,7 @@ await client.generations.create({
|
|
|
1417
2068
|
<dl>
|
|
1418
2069
|
<dd>
|
|
1419
2070
|
|
|
1420
|
-
The multipart/form-data form of `POST /v2/generate` — the same endpoint as "Create Generation", for uploading local files directly instead of passing URLs. Send each file under a field named for its type (`video`, `image`, `audio`), at most one of each. The application parser allows up to 5 GiB (5 × 1024³ bytes) per file, 3 files, 32 fields, 35 total parts, and 1 MiB per field. A file over the parser limit returns 413 generation_input_validation_failed, and a file over your plan limit returns 422 file_size_exceeds_plan_limit. Proxy limits may be lower; this ceiling does not guarantee a 5 GiB direct transfer. Each file is saved as an asset in your organization and passed to the generation by `assetId`. For large files, upload via POST /v2/assets/upload first and pass the `assetId`, so retries don't resend the file. Nested fields such as `input`, `options`, `segments`, `outputAudio`, `dubParams`, and `dialogueEdit` must be sent as JSON strings in multipart requests. Image inputs are sync-3 only. If a `text` input requires speech synthesis and the ElevenLabs provider is temporarily unavailable, the request returns errorCode elevenlabs_service_unavailable: 504 for provider timeouts and 503 for other provider outages for unkeyed requests. Keyed uncertain outcomes return 503 IDEMPOTENCY_OUTCOME_UNKNOWN instead. An
|
|
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.
|
|
1421
2072
|
</dd>
|
|
1422
2073
|
</dl>
|
|
1423
2074
|
</dd>
|
|
@@ -1602,18 +2253,12 @@ receive the watermarked derivative when present. Entitled plans (such
|
|
|
1602
2253
|
as v2 Creator and v3 Starter or higher) receive the clean output when
|
|
1603
2254
|
available. Historical outputs can have the watermark burned in, so an
|
|
1604
2255
|
upgrade does not guarantee every old output becomes watermark-free.
|
|
1605
|
-
|
|
1606
|
-
If no watermarked derivative exists, the resolver retains its existing
|
|
1607
|
-
fallback to the original output; changing plans does not rewrite files.
|
|
2256
|
+
Changing plans does not rewrite historical files.
|
|
1608
2257
|
This endpoint does not generate a new render or remove burned-in watermarks.
|
|
1609
2258
|
|
|
1610
|
-
Signed
|
|
1611
|
-
|
|
1612
|
-
|
|
1613
|
-
output is still available. The selected S3 file is checked before
|
|
1614
|
-
signing; a successful response does not guarantee future availability.
|
|
1615
|
-
Older URL-only records return their stored URL unchanged, without
|
|
1616
|
-
checking its availability or extending its original expiration.
|
|
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.
|
|
1617
2262
|
These URLs are download credentials: keep them private.
|
|
1618
2263
|
|
|
1619
2264
|
Errors use the standard JSON error body and stable `errorCode`:
|
|
@@ -1626,7 +2271,7 @@ Errors use the standard JSON error body and stable `errorCode`:
|
|
|
1626
2271
|
| 404 | `generation_output_unavailable` | No eligible output reference or the selected file is missing; contact support. |
|
|
1627
2272
|
| 409 | `generation_not_ready` | Pending or processing; poll Get Generation until COMPLETED. |
|
|
1628
2273
|
| 422 | `generation_not_downloadable` | Failed or rejected; inspect the generation error. |
|
|
1629
|
-
| 503 | `generation_download_unavailable` |
|
|
2274
|
+
| 503 | `generation_download_unavailable` | The download URL could not be prepared; retry with backoff. |
|
|
1630
2275
|
|
|
1631
2276
|
Authentication also returns 422 for draft organizations. Requesting a
|
|
1632
2277
|
download URL does not create a project, incur a generation charge, or
|
|
@@ -1692,6 +2337,20 @@ await client.generations.download("id");
|
|
|
1692
2337
|
<dl>
|
|
1693
2338
|
<dd>
|
|
1694
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
|
+
|
|
1695
2354
|
#### 🔌 Usage
|
|
1696
2355
|
|
|
1697
2356
|
<dl>
|
|
@@ -2470,7 +3129,7 @@ await client.projects.delete("612bb64a-e7f4-40c1-977b-3e9797845637");
|
|
|
2470
3129
|
<dl>
|
|
2471
3130
|
<dd>
|
|
2472
3131
|
|
|
2473
|
-
Starts a word-level transcription of a window of a video, the first step of a dialogue edit. Provide exactly one of `sourceVideoUrl` or `sourceAudioUrl`, both hosted in sync. storage (upload via `POST /v2/assets/upload`). Passing pre-extracted audio skips the server-side download and transcode. Poll `GET /v2/transcriptions/{id}` until `status` is `COMPLETED`, then pass the `transcript` and your edits to `POST /v2/dialogue-edits`. An identical source and window returns the existing job instead of starting a new one. Transcription is not billed.
|
|
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.
|
|
2474
3133
|
</dd>
|
|
2475
3134
|
</dl>
|
|
2476
3135
|
</dd>
|
|
@@ -2585,6 +3244,218 @@ await client.transcriptions.get("6533643b-aceb-4c40-967e-d9ba9baac39e");
|
|
|
2585
3244
|
</dl>
|
|
2586
3245
|
</details>
|
|
2587
3246
|
|
|
3247
|
+
<details><summary><code>client.transcriptions.<a href="/src/api/resources/transcriptions/client/Client.ts">getSpeakerAnalysis</a>(id) -> Sync.SpeakerAnalysis</code></summary>
|
|
3248
|
+
<dl>
|
|
3249
|
+
<dd>
|
|
3250
|
+
|
|
3251
|
+
#### 📝 Description
|
|
3252
|
+
|
|
3253
|
+
<dl>
|
|
3254
|
+
<dd>
|
|
3255
|
+
|
|
3256
|
+
<dl>
|
|
3257
|
+
<dd>
|
|
3258
|
+
|
|
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.
|
|
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.
|
|
3322
|
+
</dd>
|
|
3323
|
+
</dl>
|
|
3324
|
+
</dd>
|
|
3325
|
+
</dl>
|
|
3326
|
+
|
|
3327
|
+
#### 🔌 Usage
|
|
3328
|
+
|
|
3329
|
+
<dl>
|
|
3330
|
+
<dd>
|
|
3331
|
+
|
|
3332
|
+
<dl>
|
|
3333
|
+
<dd>
|
|
3334
|
+
|
|
3335
|
+
```typescript
|
|
3336
|
+
await client.transcriptions.analyzeSpeakers("id", {
|
|
3337
|
+
revision: "revision",
|
|
3338
|
+
sourceVideoUrl: "sourceVideoUrl",
|
|
3339
|
+
retry: undefined,
|
|
3340
|
+
});
|
|
3341
|
+
```
|
|
3342
|
+
|
|
3343
|
+
</dd>
|
|
3344
|
+
</dl>
|
|
3345
|
+
</dd>
|
|
3346
|
+
</dl>
|
|
3347
|
+
|
|
3348
|
+
#### ⚙️ Parameters
|
|
3349
|
+
|
|
3350
|
+
<dl>
|
|
3351
|
+
<dd>
|
|
3352
|
+
|
|
3353
|
+
<dl>
|
|
3354
|
+
<dd>
|
|
3355
|
+
|
|
3356
|
+
**id:** `Sync.TranscriptionJobId` — Transcription job id.
|
|
3357
|
+
|
|
3358
|
+
</dd>
|
|
3359
|
+
</dl>
|
|
3360
|
+
|
|
3361
|
+
<dl>
|
|
3362
|
+
<dd>
|
|
3363
|
+
|
|
3364
|
+
**request:** `Sync.AnalyzeSpeakersRequest`
|
|
3365
|
+
|
|
3366
|
+
</dd>
|
|
3367
|
+
</dl>
|
|
3368
|
+
|
|
3369
|
+
<dl>
|
|
3370
|
+
<dd>
|
|
3371
|
+
|
|
3372
|
+
**requestOptions:** `Transcriptions.RequestOptions`
|
|
3373
|
+
|
|
3374
|
+
</dd>
|
|
3375
|
+
</dl>
|
|
3376
|
+
</dd>
|
|
3377
|
+
</dl>
|
|
3378
|
+
|
|
3379
|
+
</dd>
|
|
3380
|
+
</dl>
|
|
3381
|
+
</details>
|
|
3382
|
+
|
|
3383
|
+
<details><summary><code>client.transcriptions.<a href="/src/api/resources/transcriptions/client/Client.ts">sliceFaceTrack</a>(id, { ...params }) -> Sync.SpeakerFaceTrackSlice</code></summary>
|
|
3384
|
+
<dl>
|
|
3385
|
+
<dd>
|
|
3386
|
+
|
|
3387
|
+
#### 📝 Description
|
|
3388
|
+
|
|
3389
|
+
<dl>
|
|
3390
|
+
<dd>
|
|
3391
|
+
|
|
3392
|
+
<dl>
|
|
3393
|
+
<dd>
|
|
3394
|
+
|
|
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.
|
|
3396
|
+
</dd>
|
|
3397
|
+
</dl>
|
|
3398
|
+
</dd>
|
|
3399
|
+
</dl>
|
|
3400
|
+
|
|
3401
|
+
#### 🔌 Usage
|
|
3402
|
+
|
|
3403
|
+
<dl>
|
|
3404
|
+
<dd>
|
|
3405
|
+
|
|
3406
|
+
<dl>
|
|
3407
|
+
<dd>
|
|
3408
|
+
|
|
3409
|
+
```typescript
|
|
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
|
+
});
|
|
3417
|
+
```
|
|
3418
|
+
|
|
3419
|
+
</dd>
|
|
3420
|
+
</dl>
|
|
3421
|
+
</dd>
|
|
3422
|
+
</dl>
|
|
3423
|
+
|
|
3424
|
+
#### ⚙️ Parameters
|
|
3425
|
+
|
|
3426
|
+
<dl>
|
|
3427
|
+
<dd>
|
|
3428
|
+
|
|
3429
|
+
<dl>
|
|
3430
|
+
<dd>
|
|
3431
|
+
|
|
3432
|
+
**id:** `Sync.TranscriptionJobId` — Transcription job id.
|
|
3433
|
+
|
|
3434
|
+
</dd>
|
|
3435
|
+
</dl>
|
|
3436
|
+
|
|
3437
|
+
<dl>
|
|
3438
|
+
<dd>
|
|
3439
|
+
|
|
3440
|
+
**request:** `Sync.SliceSpeakerFaceTrackRequest`
|
|
3441
|
+
|
|
3442
|
+
</dd>
|
|
3443
|
+
</dl>
|
|
3444
|
+
|
|
3445
|
+
<dl>
|
|
3446
|
+
<dd>
|
|
3447
|
+
|
|
3448
|
+
**requestOptions:** `Transcriptions.RequestOptions`
|
|
3449
|
+
|
|
3450
|
+
</dd>
|
|
3451
|
+
</dl>
|
|
3452
|
+
</dd>
|
|
3453
|
+
</dl>
|
|
3454
|
+
|
|
3455
|
+
</dd>
|
|
3456
|
+
</dl>
|
|
3457
|
+
</details>
|
|
3458
|
+
|
|
2588
3459
|
## Tts
|
|
2589
3460
|
|
|
2590
3461
|
<details><summary><code>client.tts.<a href="/src/api/resources/tts/client/Client.ts">create</a>({ ...params }) -> Sync.TtsGenerationResponse</code></summary>
|
|
@@ -2797,7 +3668,7 @@ await client.tts.getJob("6533643b-aceb-4c40-967e-d9ba9baac39e");
|
|
|
2797
3668
|
<dl>
|
|
2798
3669
|
<dd>
|
|
2799
3670
|
|
|
2800
|
-
List the voices available to your organization — built-in ElevenLabs voices plus any you have cloned. Use a voice's id as voiceId in POST /v2/tts and in generation text inputs. A voice that carries a `restriction` cannot currently synthesize speech — check `restriction` and choose another voice. Voice availability can change over time, so re-check it rather than assuming a voice stays usable.
|
|
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.
|
|
2801
3672
|
</dd>
|
|
2802
3673
|
</dl>
|
|
2803
3674
|
</dd>
|
|
@@ -2859,7 +3730,7 @@ await client.voices.list();
|
|
|
2859
3730
|
<dl>
|
|
2860
3731
|
<dd>
|
|
2861
3732
|
|
|
2862
|
-
Retrieve a single voice by the same id values GET /v2/voices exposes — a built-in ElevenLabs voice id or the UUID of a voice cloned by your organization. A missing or foreign-organization id returns a 404 with errorCode voice_not_found.
|
|
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.
|
|
2863
3734
|
</dd>
|
|
2864
3735
|
</dl>
|
|
2865
3736
|
</dd>
|
|
@@ -2929,11 +3800,11 @@ await client.voices.get("EXAVITQu4vr4xnSDxMaL");
|
|
|
2929
3800
|
<dl>
|
|
2930
3801
|
<dd>
|
|
2931
3802
|
|
|
2932
|
-
Clone a custom voice from an audio or video sample and get back its id for use in POST /v2/tts and generation text inputs.
|
|
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.
|
|
2933
3804
|
|
|
2934
|
-
The exact sequence for a local file: (1) request a presigned URL via POST /v2/assets/upload, (2) PUT the file bytes to the returned uploadUrl, (3) clone from the returned url (or register it via POST /v2/assets and clone from the assetId). Samples must be hosted in sync. labs storage — external URLs are rejected with errorCode voice_sample_upload_required. Video sources have their audio track extracted automatically (first 2 minutes). Video sources staged for extraction are limited to 1 GiB (1,073,741,824 bytes); larger sources return 413 voice_sample_source_too_large. This endpoint allows 10 requests per hour per API key (or per signed-in user).
|
|
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.
|
|
2935
3806
|
|
|
2936
|
-
For best results use 30 seconds to 2 minutes of clear, single-speaker speech without background music or noise. Samples that are too short are rejected with errorCode voice_sample_too_short. Clone slots are limited per plan (403 voice_clone_limit_reached) and voice names must be unique within your organization (409 voice_name_conflict). Sample source problems return 422 (voice_sample_not_accessible, voice_sample_type_unsupported, voice_sample_upload_required, voice_sample_extraction_failed); invalid or too-short samples return 400 (voice_sample_invalid, voice_sample_too_short). A 429 may mean the request-rate limit was exceeded or shared provider capacity is busy (voice_clone_busy); follow the response retry guidance. Provider outages return 503 (elevenlabs_service_unavailable).
|
|
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).
|
|
2937
3808
|
</dd>
|
|
2938
3809
|
</dl>
|
|
2939
3810
|
</dd>
|
|
@@ -2999,7 +3870,7 @@ await client.voices.clone({
|
|
|
2999
3870
|
<dl>
|
|
3000
3871
|
<dd>
|
|
3001
3872
|
|
|
3002
|
-
Delete a cloned voice, freeing a clone slot. Unknown ids return 404 with errorCode `voice_not_found`.
|
|
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.
|
|
3003
3874
|
</dd>
|
|
3004
3875
|
</dl>
|
|
3005
3876
|
</dd>
|