---
title: "List AI Prompts"
method: GET
path: "/ai/prompts"
tags: ["AI"]
---

# List AI Prompts

`GET /ai/prompts`

## Request

- Base URL: `https://api.crowdin.com/api/v2`
- URL: `https://api.crowdin.com/api/v2/ai/prompts`
- Auth: none declared
- TypeScript: <https://skmtc.dev/crowdin/apis/crowdin-enterprise-api-v2/docs/ai/prompts/get.ts> (a function with typed inputs; its response is checked against the schema)

**Required scopes:** `ai.prompt` (Read only).

## Query parameters

- `projectId` integer
- `action` 'pre_translate' | 'alignment' | 'qa_check'
- `limit` integer
- `offset` integer

## Response `200`

AI prompts list

- EnterpriseAiPromptCollectionResource: Base schema of resource container. Container is a wrapper object that contains payload in required `data` property and provides space for adding any other metadata.
  - `data` EnterpriseAiPromptResource[], required
    - `data` EnterpriseAiPrompt, required
      - `id` integer
      - `name` string
      - `action` string
      - `aiProviderId` integer, nullable
      - `aiModelId` string, nullable
      - `isEnabled` boolean
      - `enabledProjectIds` integer[]
      - `config` union
        - object: AI prompt configuration
          - `mode` 'basic', required
          - `companyDescription` string: Use field `snippets` instead
          - `projectDescription` string: Use field `snippets` instead
          - `audienceDescription` string: Use field `snippets` instead
          - `customPlaceholders` string[]: Use field `snippets` instead
          - `snippets` string[]: Array of snippets. Get via [List AI Snippets](#operation/api.ai.snippets.getMany)
          - `otherLanguageTranslations` object
            - `isEnabled` boolean
            - `languageIds` string[]: Array of language ids. Get via [List Supported Languages](#operation/api.languages.getMany)
          - `glossaryTerms` boolean
          - `tmSuggestions` boolean
          - `fileContent` boolean
          - `fileContext` boolean
          - `generateFileSummary` boolean
          - `screenshots` boolean
          - `projectContext` boolean
          - `publicProjectDescription` boolean: Deprecated. Use field `projectContext` instead
          - `siblingsStrings` boolean
          - `retryOnQaIssues` boolean
          - `organizationContext` boolean: Include organization name and internal description into the prompt context.
        - object: AI prompt configuration
          - `mode` 'basic', required
          - `companyDescription` string: Use field `snippets` instead
          - `projectDescription` string: Use field `snippets` instead
          - `audienceDescription` string: Use field `snippets` instead
          - `customPlaceholders` string[]: Use field `snippets` instead
          - `snippets` string[]: Array of snippets. Get via [List AI Snippets](#operation/api.ai.snippets.getMany)
          - `projectContext` boolean
          - `publicProjectDescription` boolean: Deprecated. Use field `projectContext` instead
          - `organizationContext` boolean: Include organization name and internal description into the prompt context.
        - object: AI prompt configuration
          - `mode` 'basic', required
          - `evaluationSteps` string[], required
          - `customPlaceholders` string[]: Use field `snippets` instead
          - `snippets` string[]
          - `glossaryTerms` boolean
          - `tmSuggestions` boolean
          - `fileContext` boolean
          - `screenshots` boolean
          - `projectContext` boolean
          - `publicProjectDescription` boolean: Deprecated. Use field `projectContext` instead
          - `organizationContext` boolean: Include organization name and internal description into the prompt context.
        - object: AI prompt configuration
          - `mode` 'advanced', required
          - `generateFileSummary` boolean: __Note:__ Not available for alignment action
          - `glossaryTerms` boolean
          - `tmSuggestions` boolean
          - `screenshots` boolean: __Note:__ Not available for alignment action
          - `prompt` string, required
          - `otherLanguageTranslations` object: __Note:__ Not available for alignment and QA check actions
            - `isEnabled` boolean
            - `languageIds` string[]: Array of language ids. Get via [List Supported Languages](#operation/api.languages.getMany)
          - `retryOnQaIssues` boolean: Available only for pre-translate action
        - object: AI prompt configuration
          - `mode` 'external', required
          - `identifier` string, required: Application identifier. Get via [List Applications](#operation/api.applications.installations.getMany)
          - `key` string, required: Module key
          - `options` object: Options to compile the prompt. Get from configurator
          - `retryOnQaIssues` boolean: Available only for pre-translate action and may be disabled by AI prompt provider
      - `promptPreview` string, nullable
      - `isFineTuningAvailable` boolean
      - `createdBy` integer, nullable: Identifier of the user who created the prompt
      - `updatedBy` integer, nullable: Identifier of the user who last updated the prompt
      - `lastUsedBy` integer, nullable: Identifier of the user who last used the prompt
      - `lastUsedAt` string, date-time, nullable: Date and time when the prompt was last used
      - `usageCount` integer: Total number of times the prompt has been used
      - `createdAt` string, date-time
      - `updatedAt` string, date-time
  - `pagination` Pagination: Pagination Response Model
    - `offset` integer
    - `limit` integer

## Other responses

- `400`: Invalid Request Parameters
- `401`: Unauthorized
- `403`: Forbidden
- `405`: Method Not Allowed

---

[API](https://skmtc.dev/crowdin/apis/crowdin-enterprise-api-v2.md) - [All operations](https://skmtc.dev/crowdin/apis/crowdin-enterprise-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/crowdin/apis/crowdin-enterprise-api-v2/revisions/dc68744c5384?raw)