Add AI Snippet

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

post/users/{userId}/ai/settings/snippets

Request

Base URL
https://api.crowdin.com/api/v2
Auth
none declared
TypeScript
https://skmtc.dev/crowdin/apis/crowdin-api-v2/docs/users/:userId/ai/settings/snippets/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

userIdinteger required

User Identifier

Request body

descriptionstring required

The description must be unique and must be between 3 and 255 characters.

placeholderstring required

The placeholder must be unique and must start with %custom: and end with %. Allowed characters: a-z, A-Z, 0-9, -. The full length must not exceed 255 characters.

valuestring required

The text that will be utilized in the prompt. The value must not exceed 4000 characters.

Example request

{
  "description": "Product description",
  "placeholder": "%custom:productDescription%",
  "value": "The product is the professional consulting service that transform challenges into opportunities."
}

Response

AI Snippet was added successfully

Example response

{
  "data": {
    "id": 2,
    "description": "Product description",
    "placeholder": "%custom:productDescription%",
    "value": "The product is the professional consulting service that transform challenges into opportunities.",
    "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.