Class Ai

Hierarchy (view full)

CrowdinApi
- Ai

Index

Constructors

Methods

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:237

Methods

addAiUserCustomPlaceholder

addAiUserCustomPlaceholder(userId, request): Promise<ResponseObject<CustomPlaceholder>>
Parameters
- userId: number
  user identifier
- request: AddCustomPlaceholderRequest
  request body
Returns Promise<ResponseObject<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.post
- Defined in ai/index.ts:615

addAiUserPrompt

addAiUserPrompt(userId, request): Promise<ResponseObject<AiPromptResponse>>
Parameters
- userId: number
  user identifier
- request: AddAiPromptRequest
  request body
Returns Promise<ResponseObject<AiPromptResponse>>
See
https://developer.crowdin.com/api/v2/#operation/api.users.ai.prompts.post
- Defined in ai/index.ts:821

addAiUserProvider

addAiUserProvider(userId, request): Promise<ResponseObject<AiProviderResponse>>
Parameters
- userId: number
  user identifier
- request: AddAiProviderRequest
  request body
Returns Promise<ResponseObject<AiProviderResponse>>
See
https://developer.crowdin.com/api/v2/#operation/api.users.ai.providers.post
- Defined in ai/index.ts:947

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:497

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:247

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:1158

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:868

checkAiOrganizationReportStatus

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

checkAiUserReportStatus

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

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:183

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:789

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:139

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:400

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:739

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:1048

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:281

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:337

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:643

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:906

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:972

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:507

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:517

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:258

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:169

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:433

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:1169

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:1180

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:880

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:773

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:1085

editAiOrganizationCustomPlaceholder

editAiOrganizationCustomPlaceholder(aiCustomPlaceholderId, request): Promise<ResponseObject<CustomPlaceholder>>
Parameters
- aiCustomPlaceholderId: number
  ai custom placeholder identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseObject<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:292

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:348

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:451

editAiUserCustomPlaceholder

editAiUserCustomPlaceholder(userId, aiCustomPlaceholderId, request): Promise<ResponseObject<CustomPlaceholder>>
Parameters
- userId: number
  user identifier
- aiCustomPlaceholderId: number
  ai custom placeholder identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseObject<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:655

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:918

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:984

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:1105

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:219

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:79

generateAiOrganizationReport

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

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:836

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:671

generateAiUserReport

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

getAiOrganizationCustomPlaceholder

getAiOrganizationCustomPlaceholder(aiCustomPlaceholderId): Promise<ResponseObject<CustomPlaceholder>>
Parameters
- aiCustomPlaceholderId: number
  ai custom placeholder identifier
Returns Promise<ResponseObject<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:485

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:271

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:233

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:94

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:154

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:327

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:442

getAiUserCustomPlaceholder

getAiUserCustomPlaceholder(userId, aiCustomPlaceholderId): Promise<ResponseObject<CustomPlaceholder>>
Parameters
- userId: number
  user identifier
- aiCustomPlaceholderId: number
  ai custom placeholder identifier
Returns Promise<ResponseObject<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:629

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:1144

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:895

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:852

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:688

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:756

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:961

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:1095

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:272

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:374

listAiOrganizationCustomPlaceholders

listAiOrganizationCustomPlaceholders(options?): Promise<ResponseList<CustomPlaceholder>>
Parameters
- Optionaloptions: Partial<Pagination>
  request options
Returns Promise<ResponseList<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:110

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:124

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:196

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:362

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:305

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:385

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:1018

listAiUserCustomPlaceholders

listAiUserCustomPlaceholders(userId, options?): Promise<ResponseList<CustomPlaceholder>>
Parameters
- userId: number
  user identifier
- Optionaloptions: Partial<Pagination>
  request options
Returns Promise<ResponseList<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:601

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:706

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:722

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:804

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:1000

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:933

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:1031

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:587

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:528

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:572

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:540

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:556

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:473

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:1130

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:461

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:1116

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:1258

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:1192

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:1241

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:1205

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:1223

withFetchAll

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

Class Ai

Hierarchy (view full)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Ai

Methods

addAiOrganizationCustomPlaceholder

Parameters

Returns Promise<ResponseObject<CustomPlaceholder>>

Deprecated

See

addAiOrganizationPrompt

Parameters

Returns Promise<ResponseObject<AiPromptResponse>>

See

addAiOrganizationProvider

Parameters

Returns Promise<ResponseObject<AiProviderResponse>>

See

addAiUserCustomPlaceholder

Parameters

Returns Promise<ResponseObject<CustomPlaceholder>>

Deprecated

See

addAiUserPrompt

Parameters

Returns Promise<ResponseObject<AiPromptResponse>>

See

addAiUserProvider

Parameters

Returns Promise<ResponseObject<AiProviderResponse>>

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<AiReportTokenUsage>>>

See

checkAiUserReportStatus

Parameters

Returns Promise<ResponseObject<Status<AiReportTokenUsage>>>

See

cloneAiOrganizationPrompt

Parameters

Optionalname?: string

Returns Promise<ResponseObject<AiPromptResponse>>

See

cloneAiUserPrompt

Parameters

Optionalname?: string

Returns Promise<ResponseObject<AiPromptResponse>>

See

createAiOrganizationPromptFineTuningJob

Parameters

Returns Promise<ResponseObject<Status<FineTuningJob>>>

Deprecated

See

createAiOrganizationProxyChatCompletion

Parameters

Returns Promise<ResponseObject<AiProviderProxyResponseData>>

See

createAiUserPromptFineTuningJob

`Optional`name?: string

`Optional`name?: string