Skip to main content
PUT
/
v2
/
aiChecks
/
{uid}
curl --request PUT \
  --url https://eu.phrase.com/quality-evaluator/v2/aiChecks/{uid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "name": "No Yoda Speech",
  "qualityRequirements": "The translation must not use Yoda-style inverted sentence structure.",
  "locales": [
    "en_us",
    "en_gb"
  ]
}
'
{
  "uid": "6804a3f2e1b2c3d4e5f60789",
  "name": "No Yoda Speech",
  "qualityRequirements": "The translation must not use Yoda-style inverted sentence structure.",
  "locales": [
    "en_us",
    "en_gb"
  ]
}

Authorizations

Authorization
string
header
required

Use a Bearer token obtained from Phrase Platform authentication. See the Authentication guide for details on how to obtain a token.

Headers

Content-Type
string
required
Example:

"application/json"

Path Parameters

uid
string
required

Unique identifier of the AI Check.

Example:

"6804a3f2e1b2c3d4e5f60789"

Body

application/json
name
string
required

Display name for the AI Check.

Example:

"No Yoda Speech"

qualityRequirements
string
required

Natural language description of the quality requirements to check.

Maximum string length: 2000
Example:

"The translation must not use Yoda-style inverted sentence structure."

locales
string[]

Locale codes this AI Check applies to. When absent, existing locale restrictions are preserved. When an empty array, locale restrictions are cleared and the check applies to all locales.

Locale code compatible with Phrase locale format. Case-insensitive, supports both underscore and hyphen separators (e.g., en_us, en-US, de_de, fr_fr).

Response

AI Check updated successfully.

uid
string
required
Example:

"6804a3f2e1b2c3d4e5f60789"

name
string
required
Example:

"No Yoda Speech"

qualityRequirements
string
required
Maximum string length: 2000
Example:

"The translation must not use Yoda-style inverted sentence structure."

locales
string[]

Locale codes this AI Check applies to. Absent or empty means the check applies to all locales.

Locale code compatible with Phrase locale format. Case-insensitive, supports both underscore and hyphen separators (e.g., en_us, en-US, de_de, fr_fr).