Skip to main content
POST
Create AI Check

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"

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."

Response

Created — the new AI Check.

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).