Class Ai

Hierarchy (view full)

CrowdinApi
- Ai

Index

Constructors

Methods

addAiOrganizationCustomPlaceholder addAiOrganizationPrompt addAiOrganizationProvider addAiOrganizationSnippet addAiUserCustomPlaceholder addAiUserPrompt addAiUserProvider addAiUserSnippet cancelAiOrganizationFileTranslation cancelAiOrganizationPromptCompletion cancelAiUserFileTranslation cancelAiUserPromptCompletion checkAiOrganizationReportStatus checkAiOrganizationRequestLogsExportStatus checkAiUserReportStatus checkAiUserRequestLogsExportStatus cloneAiOrganizationPrompt cloneAiUserPrompt createAiOrganizationPromptFineTuningJob createAiOrganizationProxyChatCompletion createAiUserPromptFineTuningJob createAiUserProxyChatCompletion deleteAiOrganizationCustomPlaceholder deleteAiOrganizationPrompt deleteAiOrganizationProvider deleteAiOrganizationSnippet deleteAiUserCustomPlaceholder deleteAiUserPrompt deleteAiUserProvider deleteAiUserSnippet downloadAiOrganizationFileTranslation downloadAiOrganizationFileTranslationStrings downloadAiOrganizationPromptCompletion downloadAiOrganizationPromptFineTuningDataset downloadAiOrganizationReport downloadAiOrganizationRequestLogsExport downloadAiUserFileTranslation downloadAiUserFileTranslationStrings downloadAiUserPromptCompletion downloadAiUserPromptFineTuningDataset downloadAiUserReport downloadAiUserRequestLogsExport editAiOrganizationCustomPlaceholder editAiOrganizationPrompt editAiOrganizationProvider editAiOrganizationSettings editAiOrganizationSnippet editAiUserCustomPlaceholder editAiUserPrompt editAiUserProvider editAiUserSettings editAiUserSnippet exportAiOrganizationRequestLogs exportAiUserRequestLogs generateAiOrganizationPromptCompletion generateAiOrganizationPromptFineTuningDataset generateAiOrganizationReport generateAiUserPromptCompletion generateAiUserPromptFineTuningDataset generateAiUserReport getAiOrganizationCustomPlaceholder getAiOrganizationFileTranslationStatus getAiOrganizationPrompt getAiOrganizationPromptCompletionStatus getAiOrganizationPromptFineTuningDatasetStatus getAiOrganizationPromptFineTuningJobStatus getAiOrganizationProvider getAiOrganizationSettings getAiOrganizationSnippet getAiOrganizationUsageMember getAiUserCustomPlaceholder getAiUserFileTranslationStatus getAiUserPrompt getAiUserPromptCompletionStatus getAiUserPromptFineTuningDatasetStatus getAiUserPromptFineTuningJobStatus getAiUserProvider getAiUserSettings getAiUserSnippet getAiUserUsageMember getProjectAiSettings graphql listAiOrganizationAllProviderModels listAiOrganizationCustomPlaceholders listAiOrganizationPromptFineTuningEvents listAiOrganizationPromptFineTuningJobs listAiOrganizationPrompts listAiOrganizationProviderModels listAiOrganizationProviders listAiOrganizationRequestLogs listAiOrganizationSnippets listAiOrganizationSupportedProviderModels listAiOrganizationUsageMembers listAiUserAllProviderModels listAiUserCustomPlaceholders listAiUserPromptFineTuningEvents listAiUserPromptFineTuningJobs listAiUserPrompts listAiUserProviderModels listAiUserProviders listAiUserRequestLogs listAiUserSnippets listAiUserSupportedProviderModels listAiUserUsageMembers organizationAiGatewayDelete organizationAiGatewayGet organizationAiGatewayPatch organizationAiGatewayPost organizationAiGatewayPut startAiOrganizationFileTranslation startAiUserFileTranslation translateAiOrganizationStrings translateAiUserStrings userAiGatewayDelete userAiGatewayGet userAiGatewayPatch userAiGatewayPost userAiGatewayPut withFetchAll

Constructors

constructor

new Ai(credentials, config?): Ai
Parameters
- credentials: Credentials
  credentials
- Optionalconfig: ClientConfig
  optional configuration of the client
Returns Ai
Inherited from CrowdinApi.constructor
- Defined in core/index.ts:143

Methods

cancelAiOrganizationFileTranslation

cancelAiOrganizationFileTranslation(jobIdentifier): Promise<void>
Parameters
- jobIdentifier: string
  job identifier
Returns Promise<void>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.file-translations.delete
- Defined in ai/index.ts:546

cancelAiOrganizationPromptCompletion

cancelAiOrganizationPromptCompletion(aiPromptId, completionId): Promise<void>
Parameters
- aiPromptId: number
  ai Prompt identifier
- completionId: string
  completion identifier
Returns Promise<void>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.prompts.completions.delete
- Defined in ai/index.ts:296

cancelAiUserFileTranslation

cancelAiUserFileTranslation(userId, jobIdentifier): Promise<void>
Parameters
- userId: number
  user identifier
- jobIdentifier: string
  job identifier
Returns Promise<void>
See
https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.users.ai.file-translations.delete
- Defined in ai/index.ts:1344

cancelAiUserPromptCompletion

cancelAiUserPromptCompletion(userId, aiPromptId, completionId): Promise<void>
Parameters
- userId: number
  user identifier
- aiPromptId: number
  ai Prompt identifier
- completionId: string
  completion identifier
Returns Promise<void>
See
https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.users.ai.prompts.completions.delete
- Defined in ai/index.ts:1054

checkAiOrganizationReportStatus

checkAiOrganizationReportStatus(aiReportId): Promise<ResponseObject<Status<AiReport>>>
Parameters
- aiReportId: string
  report identifier
Returns Promise<ResponseObject<Status<AiReport>>>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.reports.get
- Defined in ai/index.ts:472

checkAiOrganizationRequestLogsExportStatus

checkAiOrganizationRequestLogsExportStatus(exportId): Promise<ResponseObject<Status<AiRequestLogsExportAttributes>>>
Parameters
- exportId: string
  export identifier
Returns Promise<ResponseObject<Status<AiRequestLogsExportAttributes>>>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.requestLogs.exports.get
- Defined in ai/index.ts:613

checkAiUserReportStatus

checkAiUserReportStatus(userId, aiReportId): Promise<ResponseObject<Status<AiReport>>>
Parameters
- userId: number
  user identifier
- aiReportId: string
  report identifier
Returns Promise<ResponseObject<Status<AiReport>>>
See
https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.users.ai.reports.get
- Defined in ai/index.ts:1260

checkAiUserRequestLogsExportStatus

checkAiUserRequestLogsExportStatus(userId, exportId): Promise<ResponseObject<Status<AiRequestLogsExportAttributes>>>
Parameters
- userId: number
  user identifier
- exportId: string
  export identifier
Returns Promise<ResponseObject<Status<AiRequestLogsExportAttributes>>>
See
https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.ai.requestLogs.exports.get
- Defined in ai/index.ts:1418

cloneAiOrganizationPrompt

cloneAiOrganizationPrompt(aiPromptId, request?): Promise<ResponseObject<AiPromptResponse>>
Parameters
- aiPromptId: number
  ai prompt identifier
- request: {
  name?: string;
  } = {}
  request body
  - Optionalname?: string
Returns Promise<ResponseObject<AiPromptResponse>>
See
https://developer.crowdin.com/enterprise/api/v2/#operation/api.ai.prompts.clones.post
- Defined in ai/index.ts:232

cloneAiUserPrompt

cloneAiUserPrompt(userId, aiPromptId, request?): Promise<ResponseObject<AiPromptResponse>>
Parameters
- userId: number
  user identifier
- aiPromptId: number
  ai prompt identifier
- request: {
  name?: string;
  } = {}
  request body
  - Optionalname?: string
Returns Promise<ResponseObject<AiPromptResponse>>
See
https://developer.crowdin.com/api/v2/#operation/api.users.ai.prompts.clones.post
- Defined in ai/index.ts:975

createAiOrganizationPromptFineTuningJob

createAiOrganizationPromptFineTuningJob(aiPromptId, request): Promise<ResponseObject<Status<FineTuningJob>>>
Parameters
- aiPromptId: number
  ai prompt identifier
- request: GenerateFineTuningJob
  request body
Returns Promise<ResponseObject<Status<FineTuningJob>>>
Deprecated
Fine-tuning APIs are deprecated.

See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.prompts.fine-tuning.jobs.post
- Defined in ai/index.ts:188

createAiOrganizationProxyChatCompletion

createAiOrganizationProxyChatCompletion(aiProviderId, request?): Promise<ResponseObject<AiProviderProxyResponseData>>
Parameters
- aiProviderId: number
  ai Provider identifier
- Optionalrequest: OtherChatCompletionRequest | GoogleGeminiChatCompletionRequest
  request body
Returns Promise<ResponseObject<AiProviderProxyResponseData>>
See
https://developer.crowdin.com/enterprise/api/v2/#operation/api.ai.providers.chat.completions.post
- Defined in ai/index.ts:449

createAiUserPromptFineTuningJob

createAiUserPromptFineTuningJob(userId, aiPromptId, request): Promise<ResponseObject<Status<FineTuningJob>>>
Parameters
- userId: number
  user identifier
- aiPromptId: number
  ai prompt identifier
- request: GenerateFineTuningJob
  request body
Returns Promise<ResponseObject<Status<FineTuningJob>>>
Deprecated
Fine-tuning APIs are deprecated.

See
https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.ai.prompts.fine-tuning.jobs.post
- Defined in ai/index.ts:925

createAiUserProxyChatCompletion

createAiUserProxyChatCompletion(userId, aiProviderId, request?): Promise<ResponseObject<AiProviderProxyResponseData>>
Parameters
- userId: number
  user Identifier
- aiProviderId: number
  ai Provider identifier
- Optionalrequest: OtherChatCompletionRequest | GoogleGeminiChatCompletionRequest
  request body
Returns Promise<ResponseObject<AiProviderProxyResponseData>>
See
https://developer.crowdin.com/api/v2/#operation/api.users.ai.providers.chat.completions.post
- Defined in ai/index.ts:1234

deleteAiOrganizationCustomPlaceholder

deleteAiOrganizationCustomPlaceholder(aiCustomPlaceholderId): Promise<void>
Parameters
- aiCustomPlaceholderId: number
  ai custom placeholder identifier
Returns Promise<void>
Deprecated
AI Custom Placeholders APIs are deprecated.

See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.settings.custom-placeholders.delete
- Defined in ai/index.ts:54

deleteAiOrganizationPrompt

deleteAiOrganizationPrompt(aiPromptId): Promise<void>
Parameters
- aiPromptId: number
  ai Prompt identifier
Returns Promise<void>
See
https://developer.crowdin.com/enterprise/api/v2/#operation/api.ai.prompts.delete
- Defined in ai/index.ts:330

deleteAiOrganizationProvider

deleteAiOrganizationProvider(aiProviderId): Promise<void>
Parameters
- aiProviderId: number
  ai Provider identifier.
Returns Promise<void>
See
https://developer.crowdin.com/enterprise/api/v2/#operation/api.ai.providers.delete
- Defined in ai/index.ts:386

deleteAiOrganizationSnippet

deleteAiOrganizationSnippet(aiSnippetId): Promise<void>
Parameters
- aiSnippetId: number
  ai snippet identifier
Returns Promise<void>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.prompts.snippets.delete
- Defined in ai/index.ts:104

deleteAiUserCustomPlaceholder

deleteAiUserCustomPlaceholder(userId, aiCustomPlaceholderId): Promise<void>
Parameters
- userId: number
  user identifier
- aiCustomPlaceholderId: number
  ai custom placeholder identifier
Returns Promise<void>
Deprecated
AI Custom Placeholders APIs are deprecated.

See
https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.users.ai.settings.custom-placeholders.delete
- Defined in ai/index.ts:774

deleteAiUserPrompt

deleteAiUserPrompt(userId, aiPromptId): Promise<void>
Parameters
- userId: number
  user identifier
- aiPromptId: number
  ai Prompt identifier.
Returns Promise<void>
See
https://developer.crowdin.com/api/v2/#operation/api.users.ai.prompts.delete
- Defined in ai/index.ts:1092

deleteAiUserProvider

deleteAiUserProvider(userId, aiProviderId): Promise<void>
Parameters
- userId: number
  user identifier
- aiProviderId: number
  ai Provider identifier.
Returns Promise<void>
See
https://developer.crowdin.com/api/v2/#operation/api.users.ai.providers.delete
- Defined in ai/index.ts:1158

deleteAiUserSnippet

deleteAiUserSnippet(userId, aiSnippetId): Promise<void>
Parameters
- userId: number
  user identifier
- aiSnippetId: number
  ai snippet identifier
Returns Promise<void>
See
https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.ai.prompts.snippets.delete
- Defined in ai/index.ts:830

downloadAiOrganizationFileTranslation

downloadAiOrganizationFileTranslation(jobIdentifier): Promise<ResponseObject<DownloadLink>>
Parameters
- jobIdentifier: string
  job identifier
Returns Promise<ResponseObject<DownloadLink>>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.file-translations.download
- Defined in ai/index.ts:556

downloadAiOrganizationFileTranslationStrings

downloadAiOrganizationFileTranslationStrings(jobIdentifier): Promise<ResponseObject<DownloadLink>>
Parameters
- jobIdentifier: string
  job identifier
Returns Promise<ResponseObject<DownloadLink>>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.file-translations.download-strings
- Defined in ai/index.ts:566

downloadAiOrganizationPromptCompletion

downloadAiOrganizationPromptCompletion(aiPromptId, completionId): Promise<ResponseObject<DownloadLink>>
Parameters
- aiPromptId: number
  ai Prompt identifier
- completionId: string
  completion identifier
Returns Promise<ResponseObject<DownloadLink>>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.prompts.completions.download.download
- Defined in ai/index.ts:307

downloadAiOrganizationPromptFineTuningDataset

downloadAiOrganizationPromptFineTuningDataset(aiPromptId, jobIdentifier): Promise<ResponseObject<DownloadLink>>
Parameters
- aiPromptId: number
  ai prompt identifier
- jobIdentifier: string
  job identifier
Returns Promise<ResponseObject<DownloadLink>>
Deprecated
Fine-tuning APIs are deprecated.

See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.prompts.fine-tuning.jobs.get
- Defined in ai/index.ts:218

downloadAiOrganizationReport

downloadAiOrganizationReport(aiReportId): Promise<ResponseObject<DownloadLink>>
Parameters
- aiReportId: string
  report identifier
Returns Promise<ResponseObject<DownloadLink>>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.reports.download.download
- Defined in ai/index.ts:482

downloadAiOrganizationRequestLogsExport

downloadAiOrganizationRequestLogsExport(exportId): Promise<ResponseObject<DownloadLink>>
Parameters
- exportId: string
  export identifier
Returns Promise<ResponseObject<DownloadLink>>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.requestLogs.exports.download
- Defined in ai/index.ts:625

downloadAiUserFileTranslation

downloadAiUserFileTranslation(userId, jobIdentifier): Promise<ResponseObject<DownloadLink>>
Parameters
- userId: number
  user identifier
- jobIdentifier: string
  job identifier
Returns Promise<ResponseObject<DownloadLink>>
See
https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.users.ai.file-translations.download
- Defined in ai/index.ts:1355

downloadAiUserFileTranslationStrings

downloadAiUserFileTranslationStrings(userId, jobIdentifier): Promise<ResponseObject<DownloadLink>>
Parameters
- userId: number
  user identifier
- jobIdentifier: string
  job identifier
Returns Promise<ResponseObject<DownloadLink>>
See
https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.users.ai.file-translations.download-strings
- Defined in ai/index.ts:1366

downloadAiUserPromptCompletion

downloadAiUserPromptCompletion(userId, aiPromptId, completionId): Promise<ResponseObject<DownloadLink>>
Parameters
- userId: number
  user identifier
- aiPromptId: number
  ai Prompt identifier
- completionId: string
  completion identifier
Returns Promise<ResponseObject<DownloadLink>>
See
https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.users.ai.prompts.completions.download.download
- Defined in ai/index.ts:1066

downloadAiUserPromptFineTuningDataset

downloadAiUserPromptFineTuningDataset(userId, aiPromptId, jobIdentifier): Promise<ResponseObject<DownloadLink>>
Parameters
- userId: number
  user identifier
- aiPromptId: number
  ai prompt identifier
- jobIdentifier: string
  job identifier
Returns Promise<ResponseObject<DownloadLink>>
Deprecated
Fine-tuning APIs are deprecated.

See
https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.users.ai.prompts.fine-tuning.datasets.download.get
- Defined in ai/index.ts:959

downloadAiUserReport

downloadAiUserReport(userId, aiReportId): Promise<ResponseObject<DownloadLink>>
Parameters
- userId: number
  user identifier
- aiReportId: string
  report identifier
Returns Promise<ResponseObject<DownloadLink>>
See
https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.users.ai.reports.download.download
- Defined in ai/index.ts:1271

downloadAiUserRequestLogsExport

downloadAiUserRequestLogsExport(userId, exportId): Promise<ResponseObject<DownloadLink>>
Parameters
- userId: number
  user identifier
- exportId: string
  export identifier
Returns Promise<ResponseObject<DownloadLink>>
See
https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.ai.requestLogs.exports.download
- Defined in ai/index.ts:1432

editAiOrganizationCustomPlaceholder

editAiOrganizationCustomPlaceholder(aiCustomPlaceholderId, request): Promise<ResponseObject<AiModel.CustomPlaceholder>>
Parameters
- aiCustomPlaceholderId: number
  ai custom placeholder identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseObject<AiModel.CustomPlaceholder>>
Deprecated
AI Custom Placeholders APIs are deprecated.

See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.settings.custom-placeholders.patch
- Defined in ai/index.ts:65

editAiOrganizationPrompt

editAiOrganizationPrompt(aiPromptId, request): Promise<ResponseObject<AiPromptResponse>>
Parameters
- aiPromptId: number
  ai Prompt identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseObject<AiPromptResponse>>
See
https://developer.crowdin.com/enterprise/api/v2/#operation/api.ai.prompts.patch
- Defined in ai/index.ts:341

editAiOrganizationProvider

editAiOrganizationProvider(aiProviderId, request): Promise<ResponseObject<AiProviderResponse>>
Parameters
- aiProviderId: number
  ai Provider identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseObject<AiProviderResponse>>
See
https://developer.crowdin.com/enterprise/api/v2/#operation/api.ai.providers.patch
- Defined in ai/index.ts:397

editAiOrganizationSettings

editAiOrganizationSettings(request): Promise<ResponseObject<AiSettings>>
Parameters
- request: PatchRequest[]
  request body
Returns Promise<ResponseObject<AiSettings>>
See
https://developer.crowdin.com/enterprise/api/v2/#operation/api.ai.settings.patch
- Defined in ai/index.ts:500

editAiOrganizationSnippet

editAiOrganizationSnippet(aiSnippetId, request): Promise<ResponseObject<AiSnippet>>
Parameters
- aiSnippetId: number
  ai snippet identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseObject<AiSnippet>>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.prompts.snippets.patch
- Defined in ai/index.ts:114

editAiUserCustomPlaceholder

editAiUserCustomPlaceholder(userId, aiCustomPlaceholderId, request): Promise<ResponseObject<AiModel.CustomPlaceholder>>
Parameters
- userId: number
  user identifier
- aiCustomPlaceholderId: number
  ai custom placeholder identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseObject<AiModel.CustomPlaceholder>>
Deprecated
AI Custom Placeholders APIs are deprecated.

See
https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.users.ai.settings.custom-placeholders.patch
- Defined in ai/index.ts:786

editAiUserPrompt

editAiUserPrompt(userId, aiPromptId, request): Promise<ResponseObject<AiPromptResponse>>
Parameters
- userId: number
  user identifier
- aiPromptId: number
  ai Prompt identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseObject<AiPromptResponse>>
See
https://developer.crowdin.com/api/v2/#operation/api.users.ai.prompts.patch
- Defined in ai/index.ts:1104

editAiUserProvider

editAiUserProvider(userId, aiProviderId, request): Promise<ResponseObject<AiProviderResponse>>
Parameters
- userId: number
  user identifier
- aiProviderId: number
  ai Provider identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseObject<AiProviderResponse>>
See
https://developer.crowdin.com/api/v2/#operation/api.users.ai.providers.patch
- Defined in ai/index.ts:1170

editAiUserSettings

editAiUserSettings(userId, request): Promise<ResponseObject<AiSettings>>
Parameters
- userId: number
  user Identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseObject<AiSettings>>
See
https://developer.crowdin.com/api/v2/#operation/api.users.ai.settings.patch
- Defined in ai/index.ts:1291

editAiUserSnippet

editAiUserSnippet(userId, aiSnippetId, request): Promise<ResponseObject<AiSnippet>>
Parameters
- userId: number
  user identifier
- aiSnippetId: number
  ai snippet identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseObject<AiSnippet>>
See
https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.ai.prompts.snippets.patch
- Defined in ai/index.ts:841

exportAiOrganizationRequestLogs

exportAiOrganizationRequestLogs(request?): Promise<ResponseObject<Status<AiRequestLogsExportAttributes>>>
Parameters
- request: ExportAiRequestLogsRequest = {}
  request body
Returns Promise<ResponseObject<Status<AiRequestLogsExportAttributes>>>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.requestLogs.exports.post
- Defined in ai/index.ts:601

exportAiUserRequestLogs

exportAiUserRequestLogs(userId, request?): Promise<ResponseObject<Status<AiRequestLogsExportAttributes>>>
Parameters
- userId: number
  user identifier
- request: ExportAiRequestLogsRequest = {}
  request body
Returns Promise<ResponseObject<Status<AiRequestLogsExportAttributes>>>
See
https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.ai.requestLogs.exports.post
- Defined in ai/index.ts:1404

generateAiOrganizationPromptCompletion

generateAiOrganizationPromptCompletion(aiPromptId, request): Promise<ResponseObject<Status<AiPromptCompletionAttribute>>>
Parameters
- aiPromptId: number
  ai Prompt identifier
- request: GenerateAiPromptCompletionRequest
  request body
Returns Promise<ResponseObject<Status<AiPromptCompletionAttribute>>>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.prompts.completions.post
- Defined in ai/index.ts:268

generateAiOrganizationPromptFineTuningDataset

generateAiOrganizationPromptFineTuningDataset(aiPromptId, request): Promise<ResponseObject<Status<FineTuningDataset>>>
Parameters
- aiPromptId: number
  ai prompt identifier
- request: GenerateFineTuningDataset
  request body
Returns Promise<ResponseObject<Status<FineTuningDataset>>>
Deprecated
Fine-tuning APIs are deprecated.

See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.prompts.fine-tuning.datasets.post
- Defined in ai/index.ts:128

generateAiOrganizationReport

generateAiOrganizationReport(request): Promise<ResponseObject<Status<AiReport>>>
Parameters
- request: AiReport
  request body
Returns Promise<ResponseObject<Status<AiReport>>>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.reports.post
- Defined in ai/index.ts:462

generateAiUserPromptCompletion

generateAiUserPromptCompletion(userId, aiPromptId, request): Promise<ResponseObject<Status<AiPromptCompletionAttribute>>>
Parameters
- userId: number
  user identifier
- aiPromptId: number
  ai Prompt identifier
- request: GenerateAiPromptCompletionRequest
  request body
Returns Promise<ResponseObject<Status<AiPromptCompletionAttribute>>>
See
https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.ai.prompts.completions.post
- Defined in ai/index.ts:1022

generateAiUserPromptFineTuningDataset

generateAiUserPromptFineTuningDataset(userId, aiPromptId, request): Promise<ResponseObject<Status<FineTuningDataset>>>
Parameters
- userId: number
  user identifier
- aiPromptId: number
  ai prompt identifier
- request: GenerateFineTuningDataset
  request body
Returns Promise<ResponseObject<Status<FineTuningDataset>>>
Deprecated
Fine-tuning APIs are deprecated.

See
https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.ai.prompts.fine-tuning.datasets.post
- Defined in ai/index.ts:857

generateAiUserReport

generateAiUserReport(userId, request): Promise<ResponseObject<Status<AiReport>>>
Parameters
- userId: number
  user identifier
- request: AiReport
  request body
Returns Promise<ResponseObject<Status<AiReport>>>
See
https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.users.ai.reports.post
- Defined in ai/index.ts:1249

getAiOrganizationCustomPlaceholder

getAiOrganizationCustomPlaceholder(aiCustomPlaceholderId): Promise<ResponseObject<AiModel.CustomPlaceholder>>
Parameters
- aiCustomPlaceholderId: number
  ai custom placeholder identifier
Returns Promise<ResponseObject<AiModel.CustomPlaceholder>>
Deprecated
AI Custom Placeholders APIs are deprecated.

See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.settings.custom-placeholders.get
- Defined in ai/index.ts:42

getAiOrganizationFileTranslationStatus

getAiOrganizationFileTranslationStatus(jobIdentifier): Promise<ResponseObject<Status<AiFileTranslationAttribute>>>
Parameters
- jobIdentifier: string
  job identifier
Returns Promise<ResponseObject<Status<AiFileTranslationAttribute>>>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.file-translations.get
- Defined in ai/index.ts:534

getAiOrganizationPrompt

getAiOrganizationPrompt(aiPromptId): Promise<ResponseObject<AiPromptResponse>>
Parameters
- aiPromptId: number
  ai Prompt identifier.
Returns Promise<ResponseObject<AiPromptResponse>>
See
https://developer.crowdin.com/enterprise/api/v2/#operation/api.ai.prompts.get
- Defined in ai/index.ts:320

getAiOrganizationPromptCompletionStatus

getAiOrganizationPromptCompletionStatus(aiPromptId, completionId): Promise<ResponseObject<Status<AiPromptCompletionAttribute>>>
Parameters
- aiPromptId: number
  ai Prompt identifier
- completionId: string
  completion identifier
Returns Promise<ResponseObject<Status<AiPromptCompletionAttribute>>>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.prompts.completions.get
- Defined in ai/index.ts:282

getAiOrganizationPromptFineTuningDatasetStatus

getAiOrganizationPromptFineTuningDatasetStatus(aiPromptId, jobIdentifier): Promise<ResponseObject<Status<FineTuningDataset>>>
Parameters
- aiPromptId: number
  ai prompt identifier
- jobIdentifier: string
  job identifier
Returns Promise<ResponseObject<Status<FineTuningDataset>>>
Deprecated
Fine-tuning APIs are deprecated.

See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.prompts.fine-tuning.datasets.get
- Defined in ai/index.ts:143

getAiOrganizationPromptFineTuningJobStatus

getAiOrganizationPromptFineTuningJobStatus(aiPromptId, jobIdentifier): Promise<ResponseObject<Status<FineTuningJob>>>
Parameters
- aiPromptId: number
  ai prompt identifier
- jobIdentifier: string
  job identifier
Returns Promise<ResponseObject<Status<FineTuningJob>>>
Deprecated
Fine-tuning APIs are deprecated.

See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.prompts.fine-tuning.jobs.get
- Defined in ai/index.ts:203

getAiOrganizationProvider

getAiOrganizationProvider(aiProviderId): Promise<ResponseObject<AiProviderResponse>>
Parameters
- aiProviderId: number
  ai Provider identifier.
Returns Promise<ResponseObject<AiProviderResponse>>
See
https://developer.crowdin.com/enterprise/api/v2/#operation/api.ai.providers.get
- Defined in ai/index.ts:376

getAiOrganizationSettings

getAiOrganizationSettings(): Promise<ResponseObject<AiSettings>>
Returns Promise<ResponseObject<AiSettings>>
See
https://developer.crowdin.com/enterprise/api/v2/#operation/api.ai.settings.get
- Defined in ai/index.ts:491

getAiOrganizationSnippet

getAiOrganizationSnippet(aiSnippetId): Promise<ResponseObject<AiSnippet>>
Parameters
- aiSnippetId: number
  ai snippet identifier
Returns Promise<ResponseObject<AiSnippet>>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.prompts.snippets.get
- Defined in ai/index.ts:95

getAiOrganizationUsageMember

getAiOrganizationUsageMember(memberId): Promise<ResponseObject<AiUsageMember>>
Parameters
- memberId: number
  user identifier
Returns Promise<ResponseObject<AiUsageMember>>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.usage.members.get
- Defined in ai/index.ts:648

getAiUserCustomPlaceholder

getAiUserCustomPlaceholder(userId, aiCustomPlaceholderId): Promise<ResponseObject<AiModel.CustomPlaceholder>>
Parameters
- userId: number
  user identifier
- aiCustomPlaceholderId: number
  ai custom placeholder identifier
Returns Promise<ResponseObject<AiModel.CustomPlaceholder>>
Deprecated
AI Custom Placeholders APIs are deprecated.

See
https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.users.ai.settings.custom-placeholders.get
- Defined in ai/index.ts:760

getAiUserFileTranslationStatus

getAiUserFileTranslationStatus(userId, jobIdentifier): Promise<ResponseObject<Status<AiFileTranslationAttribute>>>
Parameters
- userId: number
  user identifier
- jobIdentifier: string
  job identifier
Returns Promise<ResponseObject<Status<AiFileTranslationAttribute>>>
See
https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.users.ai.file-translations.get
- Defined in ai/index.ts:1330

getAiUserPrompt

getAiUserPrompt(userId, aiPromptId): Promise<ResponseObject<AiPromptResponse>>
Parameters
- userId: number
  user identifier
- aiPromptId: number
  ai Prompt identifier.
Returns Promise<ResponseObject<AiPromptResponse>>
See
https://developer.crowdin.com/api/v2/#operation/api.users.ai.prompts.get
- Defined in ai/index.ts:1081

getAiUserPromptCompletionStatus

getAiUserPromptCompletionStatus(userId, aiPromptId, completionId): Promise<ResponseObject<Status<AiPromptCompletionAttribute>>>
Parameters
- userId: number
  user identifier
- aiPromptId: number
  ai Prompt identifier
- completionId: string
  completion identifier
Returns Promise<ResponseObject<Status<AiPromptCompletionAttribute>>>
See
https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.users.ai.prompts.completions.get
- Defined in ai/index.ts:1038

getAiUserPromptFineTuningDatasetStatus

getAiUserPromptFineTuningDatasetStatus(userId, aiPromptId, jobIdentifier): Promise<ResponseObject<Status<FineTuningDataset>>>
Parameters
- userId: number
  user identifier
- aiPromptId: number
  ai prompt identifier
- jobIdentifier: string
  job identifier
Returns Promise<ResponseObject<Status<FineTuningDataset>>>
Deprecated
Fine-tuning APIs are deprecated.

See
https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.users.ai.prompts.fine-tuning.datasets.get
- Defined in ai/index.ts:874

getAiUserPromptFineTuningJobStatus

getAiUserPromptFineTuningJobStatus(userId, aiPromptId, jobIdentifier): Promise<ResponseObject<Status<FineTuningJob>>>
Parameters
- userId: number
  user identifier
- aiPromptId: number
  ai prompt identifier
- jobIdentifier: string
  job identifier
Returns Promise<ResponseObject<Status<FineTuningJob>>>
Deprecated
Fine-tuning APIs are deprecated.

See
https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.users.ai.prompts.fine-tuning.jobs.get
- Defined in ai/index.ts:942

getAiUserProvider

getAiUserProvider(userId, aiProviderId): Promise<ResponseObject<AiProviderResponse>>
Parameters
- userId: number
  user identifier
- aiProviderId: number
  ai Provider identifier.
Returns Promise<ResponseObject<AiProviderResponse>>
See
https://developer.crowdin.com/api/v2/#operation/api.users.ai.providers.get
- Defined in ai/index.ts:1147

getAiUserSettings

getAiUserSettings(userId): Promise<ResponseObject<AiSettings>>
Parameters
- userId: number
  user Identifier
Returns Promise<ResponseObject<AiSettings>>
See
https://developer.crowdin.com/api/v2/#operation/api.users.ai.settings.get
- Defined in ai/index.ts:1281

getAiUserSnippet

getAiUserSnippet(userId, aiSnippetId): Promise<ResponseObject<AiSnippet>>
Parameters
- userId: number
  user identifier
- aiSnippetId: number
  ai snippet identifier
Returns Promise<ResponseObject<AiSnippet>>
See
https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.ai.prompts.snippets.get
- Defined in ai/index.ts:820

getAiUserUsageMember

getAiUserUsageMember(userId, memberId): Promise<ResponseObject<AiUsageMember>>
Parameters
- userId: number
  user identifier
- memberId: number
  user identifier
Returns Promise<ResponseObject<AiUsageMember>>
See
https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.ai.usage.members.get
- Defined in ai/index.ts:1458

getProjectAiSettings

getProjectAiSettings(projectId): Promise<ResponseObject<ProjectAiSettings>>
Parameters
- projectId: number
  project identifier
Returns Promise<ResponseObject<ProjectAiSettings>>
See
https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.projects.ai.settings.get
- Defined in ai/index.ts:1548

graphql

graphql<T>(req, config?): Promise<ResponseObject<T>>
Type Parameters
- T
Parameters
- req: {
      operationName?: string;
      query: string;
      variables?: any;
  }
  - OptionaloperationName?: string
  - query: string
  - Optionalvariables?: any
- config: {
  url?: string;
  } = {}
  - Optionalurl?: string
Returns Promise<ResponseObject<T>>
Inherited from CrowdinApi.graphql
- Defined in core/index.ts:178

listAiOrganizationAllProviderModels

listAiOrganizationAllProviderModels(options?): Promise<ResponseList<AiProviderModelResponse>>
Parameters
- Optionaloptions: Partial<Pagination>
  optional parameters for the request
Returns Promise<ResponseList<AiProviderModelResponse>>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.providers.models.enterprise.getMany
- Defined in ai/index.ts:423

listAiOrganizationCustomPlaceholders

listAiOrganizationCustomPlaceholders(options?): Promise<ResponseList<AiModel.CustomPlaceholder>>
Parameters
- Optionaloptions: Partial<Pagination>
  request options
Returns Promise<ResponseList<AiModel.CustomPlaceholder>>
Deprecated
AI Custom Placeholders APIs are deprecated.

See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.prompts.custom.placeholders.getMany
- Defined in ai/index.ts:18

listAiOrganizationPromptFineTuningEvents

listAiOrganizationPromptFineTuningEvents(aiPromptId, jobIdentifier, options?): Promise<ResponseList<PromptFineTuningEvent>>
Parameters
- aiPromptId: number
  ai prompt identifier
- jobIdentifier: string
  job identifier
- Optionaloptions: Partial<Pagination>
  request options
Returns Promise<ResponseList<PromptFineTuningEvent>>
Deprecated
Fine-tuning APIs are deprecated.

See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.prompts.fine-tuning.jobs.events.getMany
- Defined in ai/index.ts:159

listAiOrganizationPromptFineTuningJobs

listAiOrganizationPromptFineTuningJobs(options?): Promise<ResponseList<Status<FineTuningJob>>>
Parameters
- Optionaloptions: ListPromptFineTuningJobsOptions
  request options
Returns Promise<ResponseList<Status<FineTuningJob>>>
Deprecated
Fine-tuning APIs are deprecated.

See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.prompts.fine-tuning.jobs.getMany
- Defined in ai/index.ts:173

listAiOrganizationPrompts

listAiOrganizationPrompts(options?): Promise<ResponseList<AiPromptResponse>>
Parameters
- Optionaloptions: ListAiPromptsOptions
  optional parameters for the request
Returns Promise<ResponseList<AiPromptResponse>>
See
https://developer.crowdin.com/enterprise/api/v2/#operation/api.ai.prompts.getMany
- Defined in ai/index.ts:245

listAiOrganizationProviderModels

listAiOrganizationProviderModels(aiProviderId, options?): Promise<ResponseList<AiProviderModelResponse>>
Parameters
- aiProviderId: number
  ai Provider identifier
- Optionaloptions: Partial<Pagination>
  optional parameters for the request
Returns Promise<ResponseList<AiProviderModelResponse>>
See
https://developer.crowdin.com/enterprise/api/v2/#operation/api.ai.providers.models.getMany
- Defined in ai/index.ts:411

listAiOrganizationProviders

listAiOrganizationProviders(options?): Promise<ResponseList<AiProviderResponse>>
Parameters
- Optionaloptions: Partial<Pagination>
  optional parameters for the request
Returns Promise<ResponseList<AiProviderResponse>>
See
https://developer.crowdin.com/enterprise/api/v2/#operation/api.ai.providers.getMany
- Defined in ai/index.ts:354

listAiOrganizationRequestLogs

listAiOrganizationRequestLogs(options?): Promise<ResponseList<AiRequestLog>>
Parameters
- Optionaloptions: ListAiRequestLogsOptions
  optional parameters for the request
Returns Promise<ResponseList<AiRequestLog>>
See
https://developer.crowdin.com/enterprise/api/v2/#operation/api.ai.requestLogs.getMany
- Defined in ai/index.ts:576

listAiOrganizationSnippets

listAiOrganizationSnippets(options?): Promise<ResponseList<AiSnippet>>
Parameters
- Optionaloptions: Partial<Pagination>
  optional parameters for the request
Returns Promise<ResponseList<AiSnippet>>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.prompts.snippets.getMany
- Defined in ai/index.ts:77

listAiOrganizationSupportedProviderModels

listAiOrganizationSupportedProviderModels(options?): Promise<ResponseList<AiSupportedProviderModelResponse>>
Parameters
- Optionaloptions: ListSupportedProviderModelsOptions
  optional parameters for the request
Returns Promise<ResponseList<AiSupportedProviderModelResponse>>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.providers.supported-models.enterprise.getMany
- Defined in ai/index.ts:434

listAiOrganizationUsageMembers

listAiOrganizationUsageMembers(options?): Promise<ResponseList<AiUsageMember>>
Parameters
- Optionaloptions: ListAiUsageMembersOptions
  optional parameters for the request
Returns Promise<ResponseList<AiUsageMember>>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.usage.members.getMany
- Defined in ai/index.ts:635

listAiUserAllProviderModels

listAiUserAllProviderModels(userId, options?): Promise<ResponseList<AiProviderModelResponse>>
Parameters
- userId: number
  user identifier
- Optionaloptions: Partial<Pagination>
  optional parameters for the request
Returns Promise<ResponseList<AiProviderModelResponse>>
See
https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.ai.providers.models.crowdin.getMany
- Defined in ai/index.ts:1204

listAiUserCustomPlaceholders

listAiUserCustomPlaceholders(userId, options?): Promise<ResponseList<AiModel.CustomPlaceholder>>
Parameters
- userId: number
  user identifier
- Optionaloptions: Partial<Pagination>
  request options
Returns Promise<ResponseList<AiModel.CustomPlaceholder>>
Deprecated
AI Custom Placeholders APIs are deprecated.

See
https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.ai.prompt.custom.placeholders.getMany
- Defined in ai/index.ts:732

listAiUserPromptFineTuningEvents

listAiUserPromptFineTuningEvents(userId, aiPromptId, jobIdentifier, options?): Promise<ResponseList<PromptFineTuningEvent>>
Parameters
- userId: number
  user identifier
- aiPromptId: number
  ai prompt identifier
- jobIdentifier: string
  job identifier
- Optionaloptions: Partial<Pagination>
  request options
Returns Promise<ResponseList<PromptFineTuningEvent>>
Deprecated
Fine-tuning APIs are deprecated.

See
https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.ai.prompts.fine-tuning.jobs.events.getMany
- Defined in ai/index.ts:892

listAiUserPromptFineTuningJobs

listAiUserPromptFineTuningJobs(userId, options?): Promise<ResponseList<Status<FineTuningJob>>>
Parameters
- userId: number
  user identifier
- Optionaloptions: ListPromptFineTuningJobsOptions
  request options
Returns Promise<ResponseList<Status<FineTuningJob>>>
Deprecated
Fine-tuning APIs are deprecated.

See
https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.ai.prompts.fine-tuning.jobs.getMany
- Defined in ai/index.ts:908

listAiUserPrompts

listAiUserPrompts(userId, options?): Promise<ResponseList<AiPromptResponse>>
Parameters
- userId: number
  user identifier
- Optionaloptions: ListAiPromptsOptions
  optional parameters for the request
Returns Promise<ResponseList<AiPromptResponse>>
See
https://developer.crowdin.com/api/v2/#operation/api.users.ai.prompts.post
- Defined in ai/index.ts:990

listAiUserProviderModels

listAiUserProviderModels(userId, aiProviderId, options?): Promise<ResponseList<AiProviderModelResponse>>
Parameters
- userId: number
  user identifier
- aiProviderId: number
  ai Provider identifier
- Optionaloptions: Partial<Pagination>
  optional parameters for the request
Returns Promise<ResponseList<AiProviderModelResponse>>
See
https://developer.crowdin.com/api/v2/#operation/api.ai.providers.models.getMany
- Defined in ai/index.ts:1186

listAiUserProviders

listAiUserProviders(userId, options?): Promise<ResponseList<AiProviderResponse>>
Parameters
- userId: number
  user identifier
- Optionaloptions: Partial<Pagination>
  optional parameters for the request
Returns Promise<ResponseList<AiProviderResponse>>
See
https://developer.crowdin.com/api/v2/#operation/api.ai.providers.getMany
- Defined in ai/index.ts:1119

listAiUserRequestLogs

listAiUserRequestLogs(userId, options?): Promise<ResponseList<AiRequestLog>>
Parameters
- userId: number
  user identifier
- Optionaloptions: ListAiRequestLogsOptions
  optional parameters for the request
Returns Promise<ResponseList<AiRequestLog>>
See
https://developer.crowdin.com/api/v2/#operation/api.ai.requestLogs.getMany
- Defined in ai/index.ts:1377

listAiUserSnippets

listAiUserSnippets(userId, options?): Promise<ResponseList<AiSnippet>>
Parameters
- userId: number
  user identifier
- Optionaloptions: Partial<Pagination>
  optional parameters for the request
Returns Promise<ResponseList<AiSnippet>>
See
https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.ai.prompts.snippets.getMany
- Defined in ai/index.ts:800

listAiUserSupportedProviderModels

listAiUserSupportedProviderModels(userId, options?): Promise<ResponseList<AiSupportedProviderModelResponse>>
Parameters
- userId: number
  user identifier
- Optionaloptions: ListSupportedProviderModelsOptions
  optional parameters for the request
Returns Promise<ResponseList<AiSupportedProviderModelResponse>>
See
https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.ai.providers.supported-models.crowdin.getMany
- Defined in ai/index.ts:1217

listAiUserUsageMembers

listAiUserUsageMembers(userId, options?): Promise<ResponseList<AiUsageMember>>
Parameters
- userId: number
  user identifier
- Optionaloptions: ListAiUsageMembersOptions
  optional parameters for the request
Returns Promise<ResponseList<AiUsageMember>>
See
https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.ai.usage.members.getMany
- Defined in ai/index.ts:1443

organizationAiGatewayDelete

organizationAiGatewayDelete(aiProviderId, path): Promise<ResponseObject<PlainObject>>
Parameters
- aiProviderId: number
  ai Provider identifier
- path: string
  raw provider API path after /gateway/
Returns Promise<ResponseObject<PlainObject>>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI-Gateway/operation/api.ai.providers.gateway.enterprise.delete
- Defined in ai/index.ts:718

organizationAiGatewayGet

organizationAiGatewayGet(aiProviderId, path): Promise<ResponseObject<PlainObject>>
Parameters
- aiProviderId: number
  ai Provider identifier
- path: string
  raw provider API path after /gateway/
Returns Promise<ResponseObject<PlainObject>>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI-Gateway/operation/api.ai.providers.gateway.enterprise.get
- Defined in ai/index.ts:659

organizationAiGatewayPatch

organizationAiGatewayPatch(aiProviderId, path, request?): Promise<ResponseObject<PlainObject>>
Parameters
- aiProviderId: number
  ai Provider identifier
- path: string
  raw provider API path after /gateway/
- Optionalrequest: PlainObject
  request body
Returns Promise<ResponseObject<PlainObject>>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI-Gateway/operation/api.ai.providers.gateway.enterprise.patch
- Defined in ai/index.ts:703

organizationAiGatewayPost

organizationAiGatewayPost(aiProviderId, path, request?): Promise<ResponseObject<PlainObject>>
Parameters
- aiProviderId: number
  ai Provider identifier
- path: string
  raw provider API path after /gateway/
- Optionalrequest: PlainObject
  request body
Returns Promise<ResponseObject<PlainObject>>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI-Gateway/operation/api.ai.providers.gateway.enterprise.post
- Defined in ai/index.ts:671

organizationAiGatewayPut

organizationAiGatewayPut(aiProviderId, path, request?): Promise<ResponseObject<PlainObject>>
Parameters
- aiProviderId: number
  ai Provider identifier
- path: string
  raw provider API path after /gateway/
- Optionalrequest: PlainObject
  request body
Returns Promise<ResponseObject<PlainObject>>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI-Gateway/operation/api.ai.providers.gateway.enterprise.put
- Defined in ai/index.ts:687

startAiOrganizationFileTranslation

startAiOrganizationFileTranslation(request): Promise<ResponseObject<Status<AiFileTranslationAttribute>>>
Parameters
- request: AiFileTranslationRequest
  request body
Returns Promise<ResponseObject<Status<AiFileTranslationAttribute>>>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.file-translations.post
- Defined in ai/index.ts:522

startAiUserFileTranslation

startAiUserFileTranslation(userId, request): Promise<ResponseObject<Status<AiFileTranslationAttribute>>>
Parameters
- userId: number
  user identifier
- request: AiFileTranslationRequest
  request body
Returns Promise<ResponseObject<Status<AiFileTranslationAttribute>>>
See
https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.users.ai.file-translations.post
- Defined in ai/index.ts:1316

translateAiOrganizationStrings

translateAiOrganizationStrings(request): Promise<ResponseObject<AiTranslateStringsResponse>>
Parameters
- request: AiTranslateStringsRequest
  request body
Returns Promise<ResponseObject<AiTranslateStringsResponse>>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/AI/operation/api.ai.translate.strings.post
- Defined in ai/index.ts:510

translateAiUserStrings

translateAiUserStrings(userId, request): Promise<ResponseObject<AiTranslateStringsResponse>>
Parameters
- userId: number
  user identifier
- request: AiTranslateStringsRequest
  request body
Returns Promise<ResponseObject<AiTranslateStringsResponse>>
See
https://support.crowdin.com/developer/api/v2/#tag/AI/operation/api.users.ai.translate.strings.post
- Defined in ai/index.ts:1302

userAiGatewayDelete

userAiGatewayDelete(userId, aiProviderId, path): Promise<ResponseObject<PlainObject>>
Parameters
- userId: number
  user identifier
- aiProviderId: number
  ai Provider identifier
- path: string
  raw provider API path after /gateway/
Returns Promise<ResponseObject<PlainObject>>
See
https://support.crowdin.com/developer/api/v2/#tag/AI-Gateway/operation/api.ai.providers.gateway.crowdin.delete
- Defined in ai/index.ts:1536

userAiGatewayGet

userAiGatewayGet(userId, aiProviderId, path): Promise<ResponseObject<PlainObject>>
Parameters
- userId: number
  user identifier
- aiProviderId: number
  ai Provider identifier
- path: string
  raw provider API path after /gateway/
Returns Promise<ResponseObject<PlainObject>>
See
https://support.crowdin.com/developer/api/v2/#tag/AI-Gateway/operation/api.ai.providers.gateway.crowdin.get
- Defined in ai/index.ts:1470

userAiGatewayPatch

userAiGatewayPatch(userId, aiProviderId, path, request?): Promise<ResponseObject<PlainObject>>
Parameters
- userId: number
  user identifier
- aiProviderId: number
  ai Provider identifier
- path: string
  raw provider API path after /gateway/
- Optionalrequest: PlainObject
  request body
Returns Promise<ResponseObject<PlainObject>>
See
https://support.crowdin.com/developer/api/v2/#tag/AI-Gateway/operation/api.ai.providers.gateway.crowdin.patch
- Defined in ai/index.ts:1519

userAiGatewayPost

userAiGatewayPost(userId, aiProviderId, path, request?): Promise<ResponseObject<PlainObject>>
Parameters
- userId: number
  user identifier
- aiProviderId: number
  ai Provider identifier
- path: string
  raw provider API path after /gateway/
- Optionalrequest: PlainObject
  request body
Returns Promise<ResponseObject<PlainObject>>
See
https://support.crowdin.com/developer/api/v2/#tag/AI-Gateway/operation/api.ai.providers.gateway.crowdin.post
- Defined in ai/index.ts:1483

userAiGatewayPut

userAiGatewayPut(userId, aiProviderId, path, request?): Promise<ResponseObject<PlainObject>>
Parameters
- userId: number
  user identifier
- aiProviderId: number
  ai Provider identifier
- path: string
  raw provider API path after /gateway/
- Optionalrequest: PlainObject
  request body
Returns Promise<ResponseObject<PlainObject>>
See
https://support.crowdin.com/developer/api/v2/#tag/AI-Gateway/operation/api.ai.providers.gateway.crowdin.put
- Defined in ai/index.ts:1501

withFetchAll

withFetchAll(maxLimit?): this
Parameters
- OptionalmaxLimit: number
Returns this
Inherited from CrowdinApi.withFetchAll
- Defined in core/index.ts:240

Class Ai

Hierarchy (view full)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Ai

Methods

addAiOrganizationCustomPlaceholder

Parameters

Returns Promise<ResponseObject<AiModel.CustomPlaceholder>>

Deprecated

See

addAiOrganizationPrompt

Parameters

Returns Promise<ResponseObject<AiPromptResponse>>

See

addAiOrganizationProvider

Parameters

Returns Promise<ResponseObject<AiProviderResponse>>

See

addAiOrganizationSnippet

Parameters

Returns Promise<ResponseObject<AiSnippet>>

See

addAiUserCustomPlaceholder

Parameters

Returns Promise<ResponseObject<AiModel.CustomPlaceholder>>

Deprecated

See

addAiUserPrompt

Parameters

Returns Promise<ResponseObject<AiPromptResponse>>

See

addAiUserProvider

Parameters

Returns Promise<ResponseObject<AiProviderResponse>>

See

addAiUserSnippet

Parameters

Returns Promise<ResponseObject<AiSnippet>>

See

cancelAiOrganizationFileTranslation

Parameters

Returns Promise<void>

See

cancelAiOrganizationPromptCompletion

Parameters

Returns Promise<void>

See

cancelAiUserFileTranslation

Parameters

Returns Promise<void>

See

cancelAiUserPromptCompletion

Parameters

Returns Promise<void>

See

checkAiOrganizationReportStatus

Parameters

Returns Promise<ResponseObject<Status<AiReport>>>

See

checkAiOrganizationRequestLogsExportStatus

Parameters

Returns Promise<ResponseObject<Status<AiRequestLogsExportAttributes>>>

See

checkAiUserReportStatus

Parameters

Returns Promise<ResponseObject<Status<AiReport>>>

See

checkAiUserRequestLogsExportStatus

Parameters

Returns Promise<ResponseObject<Status<AiRequestLogsExportAttributes>>>

See

cloneAiOrganizationPrompt

Parameters

Optionalname?: string

Returns Promise<ResponseObject<AiPromptResponse>>

`Optional`name?: string

`Optional`name?: string