AI

Edit AI Prompt

Required scopes: ai.prompt (Read and Write).

patch/users/{userId}/ai/prompts/{aiPromptId}

Request

Path parameters

userIdinteger required

User Identifier

aiPromptIdinteger required

AI Prompt identifier. Get via List AI Prompts

Request body

op'replace' | 'test' required

Patch operation to perform

path'/name' | '/action' | '/aiProviderId' | '/aiModelId' | '/enabledProjectIds' | '/config' json-pointer required

A JSON Pointer as defined by <a href="https://tools.ietf.org/html/rfc6901" target="_blank">RFC 6901</a>

Response

AI prompt was successfully updated

Example response

{
  "data": {
    "id": 2,
    "name": "Pre-translate prompt",
    "action": "pre_translate",
    "aiProviderId": 2,
    "aiModelId": "gpt-5.4",
    "enabledProjectIds": [
      1
    ],
    "config": {
      "customPlaceholders": [
        "%custom:companyDescription%"
      ],
      "snippets": [
        "%custom:companyDescription%"
      ],
      "otherLanguageTranslations": {
        "languageIds": [
          "uk"
        ]
      }
    },
    "createdBy": 123,
    "updatedBy": 456,
    "lastUsedBy": 789,
    "lastUsedAt": "2019-09-25T14:30:00+00:00",
    "usageCount": 42,
    "createdAt": "2019-09-20T11:11:05+00:00",
    "updatedAt": "2019-09-20T12:22:20+00:00"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.