Skip to main content
POST
/
v1
/
aiChecks
Create AI Check
curl --request POST \
  --url https://eu.phrase.com/quality-evaluator/v1/aiChecks \
  --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."
}
'
{
  "uid": "6804a3f2e1b2c3d4e5f60789",
  "name": "No Yoda Speech",
  "qualityRequirements": "The translation must not use Yoda-style inverted sentence structure."
}

Documentation Index

Fetch the complete documentation index at: https://developers.phrase.com/llms.txt

Use this file to discover all available pages before exploring further.

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

AI Check created 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."